lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-09-18 17:48:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Polish contribution

Browse Source 
This commit makes sure that each dependency link is HAL compliant (like
the project types in the metadata). Links are grouped by relation with
well known relations to be defined (i.e. 'how-to', 'reference', 'home'
and so forth).

Each link can be "templated" (in the HAL sense) and only `{bootVersion}`
is supported at the moment. This is useful if a precise documentation
section should reference to the actual Stpring Boot version chosen by the
user.

Closes gh-279
This commit is contained in:
Stephane Nicoll
2017-01-27 09:58:50 +01:00
parent d8a1927a36
commit 981b726a12
13 changed files with 444 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
initializr-web/src/main/groovy/io/spring/initializr/web/mapper/DependencyMetadataV21JsonMapper.groovy
View File

@@ -57,9 +57,6 @@ class DependencyMetadataV21JsonMapper implements DependencyMetadataJsonMapper {
if (dep.repository) {
result.repository = dep.repository
}
if (dep.links) {
result.links = dep.links
}
result
}

2
initializr-web/src/main/groovy/io/spring/initializr/web/mapper/InitializrMetadataV21JsonMapper.groovy
View File

@@ -53,7 +53,7 @@ class InitializrMetadataV21JsonMapper extends InitializrMetadataV2JsonMapper {
content['versionRange'] = dependency.versionRange
}
if (dependency.links) {
content.links = dependency.links
content._links = LinkMapper.mapLinks(dependency.links)
}
content
}

73
initializr-web/src/main/groovy/io/spring/initializr/web/mapper/LinkMapper.groovy Normal file
View File

@@ -0,0 +1,73 @@
/*
* Copyright 2012-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.spring.initializr.web.mapper
import io.spring.initializr.metadata.Link
/**
* Generate a json representation for {@link Link}
*
* @author Stephane Nicoll
*/
class LinkMapper {
/**
* Map the specified links to a json model. If several links share
* the same relation, they are grouped together.
* @param links the links to map
* @return a model for the specified links
*/
static mapLinks(List<Link> links) {
def result = [:]
Map<String, List<Link>> byRel = new LinkedHashMap<>()
links.each {
def relLinks = byRel[it.rel]
if (!relLinks) {
relLinks = []
byRel[it.rel] = relLinks
}
relLinks.add(it)
}
byRel.forEach { rel, l ->
if (l.size() == 1) {
def root = [:]
mapLink(l[0], root)
result[rel] = root
} else {
def root = []
l.each {
def model = [:]
mapLink(it, model)
root << model
}
result[rel] = root
}
}
result
}
private static mapLink(Link link, def model) {
model.href = link.href
if (link.templated) {
model.templated = true
}
if (link.description) {
model.title = link.description
}
}
}

4
initializr-web/src/main/groovy/io/spring/initializr/web/ui/UiController.groovy
View File

@@ -82,10 +82,6 @@ class UiController {
if (d.description) {
result.description = d.description
}
if (d.links) {
result.url = d.links[0].url
result.links = d.links
}
if (d.weight) {
result.weight = d.weight
}

17
initializr-web/src/test/groovy/io/spring/initializr/web/mapper/InitializrMetadataJsonMapperTests.groovy
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2015 the original author or authors.
* Copyright 2012-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
package io.spring.initializr.web.mapper
import groovy.json.JsonSlurper
import io.spring.initializr.metadata.Dependency
import io.spring.initializr.metadata.InitializrMetadata
import io.spring.initializr.metadata.Link
import io.spring.initializr.test.metadata.InitializrMetadataTestBuilder
import org.junit.Test
@@ -52,4 +54,17 @@ class InitializrMetadataJsonMapperTests {
result._links.foo.href
}
@Test
void keepLinksOrdering() {
def dependency = new Dependency(id: 'foo')
dependency.links << new Link(rel: 'guide', href: 'https://example.com/how-to')
dependency.links << new Link(rel: 'reference', href: 'https://example.com/doc')
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup('test', dependency).build()
def json = jsonMapper.write(metadata, null)
def first = json.indexOf('https://example.com/how-to')
def second = json.indexOf('https://example.com/doc')
assert first < second
}
}

95
initializr-web/src/test/groovy/io/spring/initializr/web/mapper/LinkMapperTests.groovy Normal file
View File

@@ -0,0 +1,95 @@
/*
* Copyright 2012-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.spring.initializr.web.mapper
import io.spring.initializr.metadata.Link
import org.junit.Test
/**
* Tests for {@link LinkMapper}.
*
* @author Stephane Nicoll
*/
class LinkMapperTests {
@Test
void mapSimpleRel() {
def links = new ArrayList()
links << new Link(rel: 'a', 'href': 'https://example.com',
description: 'some description')
def model = LinkMapper.mapLinks(links)
assert model.size() == 1
assert model.containsKey('a')
def linkModel = model['a']
assert linkModel.size() == 2
assert linkModel['href'] == 'https://example.com'
assert linkModel['title'] == 'some description'
}
@Test
void mapTemplatedRel() {
def links = new ArrayList()
links << new Link(rel: 'a', 'href': 'https://example.com/{bootVersion}/a',
templated: true)
def model = LinkMapper.mapLinks(links)
assert model.size() == 1
assert model.containsKey('a')
def linkModel = model['a']
assert linkModel.size() == 2
assert linkModel['href'] == 'https://example.com/{bootVersion}/a'
assert linkModel['templated'] == true
}
@Test
void mergeSeveralLinksInArray() {
def links = new ArrayList()
links << new Link(rel: 'a', 'href': 'https://example.com',
description: 'some description')
links << new Link(rel: 'a', 'href': 'https://example.com/2')
def model = LinkMapper.mapLinks(links)
assert model.size() == 1
assert model.containsKey('a')
def linksModel = model['a']
assert linksModel.size() == 2
assert linksModel[0]['href'] == 'https://example.com'
assert linksModel[1]['href'] == 'https://example.com/2'
}
@Test
void keepOrdering() {
def links = new ArrayList()
links << new Link(rel: 'a', 'href': 'https://example.com')
links << new Link(rel: 'b', 'href': 'https://example.com')
def model = LinkMapper.mapLinks(links)
def iterator = model.keySet().iterator()
assert ++iterator == 'a'
assert ++iterator == 'b'
}
@Test
void keepOrderingWithMultipleUrlForSameRel() {
def links = new ArrayList()
links << new Link(rel: 'a', 'href': 'https://example.com')
links << new Link(rel: 'b', 'href': 'https://example.com')
links << new Link(rel: 'a', 'href': 'https://example.com')
def model = LinkMapper.mapLinks(links)
def iterator = model.keySet().iterator()
assert ++iterator == 'a'
assert ++iterator == 'b'
}
}

31
initializr-web/src/test/resources/metadata/config/test-default.json
View File

@@ -131,7 +131,18 @@
"groupId": "org.springframework.boot",
"id": "web",
"name": "Web",
"scope": "compile"
"scope": "compile",
"links": [
{
"rel": "guide",
"description": "Building a RESTful Web Service",
"href": "https://example.com/guide"
},
{
"rel": "reference",
"href": "https://example.com/doc"
}
]
},
{
"starter": true,
@@ -164,7 +175,23 @@
"starter": true,
"keywords": ["thefoo", "dafoo"],
"scope": "compile",
"version": "1.3.5"
"version": "1.3.5",
"links": [
{
"rel": "guide",
"href": "https://example.com/guide1"
},
{
"rel": "reference",
"href": "https://example.com/{bootVersion}/doc",
"templated": true
},
{
"rel": "guide",
"description": "Some guide for foo",
"href": "https://example.com/guide2"
}
]
},
{
"starter": true,

28
initializr-web/src/test/resources/metadata/test-default-2.1.0.json
View File

@@ -30,7 +30,16 @@
{
"id": "web",
"name": "Web",
"description": "Web dependency description"
"description": "Web dependency description",
"_links": {
"guide": {
"href": "https://example.com/guide",
"title": "Building a RESTful Web Service"
},
"reference": {
"href": "https://example.com/doc"
}
}
},
{
"id": "security",
@@ -47,7 +56,22 @@
"values": [
{
"id": "org.acme:foo",
"name": "Foo"
"name": "Foo",
"_links": {
"guide": [
{
"href": "https://example.com/guide1"
},
{
"href": "https://example.com/guide2",
"title": "Some guide for foo"
}
],
"reference": {
"href": "https://example.com/{bootVersion}/doc",
"templated": true
}
}
},
{
"id": "org.acme:bar",