lsm/initializr
1
0
Fork 0
mirror of https://gitee.com/dcren/initializr.git synced 2025-07-15 14:04:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #924 HaiTao Zhang

Browse Source 
* pr/924:
  Polish "Clean artifactId and groupId"
  Clean artifactId and groupId
This commit is contained in:
Madhura Bhave 2019-06-17 16:21:13 -07:00
commit 41e3c2c8bb
2 changed files with 155 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
initializr-web/src/main/java/io/spring/initializr/web/project/ProjectRequestToDescriptionConverter.java
View File

@ -37,11 +37,14 @@ import org.springframework.util.StringUtils;
* Validates a {@link ProjectRequest} and creates a {@link ProjectDescription} from it.
*
* @author Madhura Bhave
* @author HaiTao Zhang
*/
public class ProjectRequestToDescriptionConverter {
private static final Version VERSION_1_5_0 = Version.parse("1.5.0.RELEASE");
private static final char[] VALID_MAVEN_SPECIAL_CHARACTERS = new char[] { '_', '-', '.' };
public ProjectDescription convert(ProjectRequest request, InitializrMetadata metadata) {
validate(request, metadata);
String springBootVersion = getSpringBootVersion(request, metadata);
@ -49,20 +52,21 @@ public class ProjectRequestToDescriptionConverter {
validateDependencyRange(springBootVersion, resolvedDependencies);
ProjectDescription description = new ProjectDescription();
description.setApplicationName(getApplicationName(request, metadata));
description.setArtifactId(determineValue(request.getArtifactId(), () -> metadata.getArtifactId().getContent()));
description.setBaseDirectory(request.getBaseDir());
description.setArtifactId(getArtifactId(request, metadata));
description.setBaseDirectory(getBaseDirectory(request.getBaseDir(), request.getArtifactId()));
description.setBuildSystem(getBuildSystem(request, metadata));
description
.setDescription(determineValue(request.getDescription(), () -> metadata.getDescription().getContent()));
description.setGroupId(determineValue(request.getGroupId(), () -> metadata.getGroupId().getContent()));
description.setGroupId(getGroupId(request, metadata));
description.setLanguage(Language.forId(request.getLanguage(), request.getJavaVersion()));
description.setName(determineValue(request.getName(), () -> metadata.getName().getContent()));
description.setName(getName(request, metadata));
description.setPackageName(getPackageName(request, metadata));
description.setPackaging(Packaging.forId(request.getPackaging()));
description.setPlatformVersion(Version.parse(springBootVersion));
description.setVersion(determineValue(request.getVersion(), () -> metadata.getVersion().getContent()));
resolvedDependencies.forEach((dependency) -> description.addDependency(dependency.getId(),
MetadataBuildItemMapper.toDependency(dependency)));
return description;
}
@ -70,6 +74,66 @@ public class ProjectRequestToDescriptionConverter {
return (StringUtils.hasText(candidate)) ? candidate : fallback.get();
}
private String getBaseDirectory(String baseDir, String artifactId) {
if (baseDir != null && baseDir.equals(artifactId)) {
return cleanMavenCoordinate(baseDir, "-");
}
return baseDir;
}
private String getName(ProjectRequest request, InitializrMetadata metadata) {
String name = request.getName();
if (!StringUtils.hasText(name)) {
return metadata.getName().getContent();
}
if (name.equals(request.getArtifactId())) {
return cleanMavenCoordinate(name, "-");
}
return name;
}
private String getGroupId(ProjectRequest request, InitializrMetadata metadata) {
if (!StringUtils.hasText(request.getGroupId())) {
return metadata.getGroupId().getContent();
}
return cleanMavenCoordinate(request.getGroupId(), ".");
}
private String getArtifactId(ProjectRequest request, InitializrMetadata metadata) {
if (!StringUtils.hasText(request.getArtifactId())) {
return metadata.getArtifactId().getContent();
}
return cleanMavenCoordinate(request.getArtifactId(), "-");
}
private String cleanMavenCoordinate(String coordinate, String delimiter) {
String[] elements = coordinate.split("[^\\w\\-.]+");
if (elements.length == 1) {
return coordinate;
}
StringBuilder builder = new StringBuilder();
for (String element : elements) {
if (shouldAppendDelimiter(element, builder)) {
builder.append(delimiter);
}
builder.append(element);
}
return builder.toString();
}
private boolean shouldAppendDelimiter(String element, StringBuilder builder) {
if (builder.length() == 0) {
return false;
}
for (char c : VALID_MAVEN_SPECIAL_CHARACTERS) {
int prevIndex = builder.length() - 1;
if (element.charAt(0) == c || builder.charAt(prevIndex) == c) {
return false;
}
}
return true;
}
private void validate(ProjectRequest request, InitializrMetadata metadata) {
validateSpringBootVersion(request);
validateType(request.getType(), metadata);

87
initializr-web/src/test/java/io/spring/initializr/web/project/ProjectRequestToDescriptionConverterTests.java
View File

@ -36,6 +36,7 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
*
* @author Madhura Bhave
* @author Stephane Nicoll
* @author HaiTao Zhang
*/
public class ProjectRequestToDescriptionConverterTests {
@ -270,6 +271,92 @@ public class ProjectRequestToDescriptionConverterTests {
assertThat(description.getPackageName()).isEqualTo("com.example.demo");
}
@Test
void baseDirWhenNotSameAsArtifactIdShouldNotBeCleaned() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct ! ID @";
request.setArtifactId(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getBaseDirectory()).isEqualTo(request.getBaseDir());
}
@Test
void baseDirWhenSameAsArtifactIdShouldBeCleaned() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct ! ID @";
request.setArtifactId(artifactId);
request.setBaseDir(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getBaseDirectory()).isEqualTo("correct-ID");
}
@Test
void nameWhenNotSameAsArtifactIdShouldNotBeCleaned() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct ! ID @";
request.setArtifactId(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getName()).isEqualTo(request.getName());
}
@Test
void nameWhenSameAsArtifactIdShouldBeCleaned() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct ! ID @";
request.setArtifactId(artifactId);
request.setName(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getName()).isEqualTo("correct-ID");
}
@Test
void artifactIdWhenHasValidCharsOnlyShouldNotBeCleaned() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct_test";
request.setArtifactId(artifactId);
request.setBaseDir(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getArtifactId()).isEqualTo("correct_test");
}
@Test
void artifactIdWhenInvalidShouldBeCleanedWithHyphenDelimiter() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct ! ID @";
request.setArtifactId(artifactId);
request.setBaseDir(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getArtifactId()).isEqualTo("correct-ID");
}
@Test
void artifactIdWhenCleanedShouldNotContainHyphenBeforeOrAfterValidSpecialCharacter() {
ProjectRequest request = createProjectRequest();
String artifactId = "correct !_!ID @";
request.setArtifactId(artifactId);
request.setBaseDir(artifactId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getArtifactId()).isEqualTo("correct_ID");
}
@Test
void groupIdWhenInvalidShouldBeCleanedWithDotDelimiter() {
ProjectRequest request = createProjectRequest();
String groupId = "correct ! ID12 @";
request.setGroupId(groupId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getGroupId()).isEqualTo("correct.ID12");
}
@Test
void groupIdWhenHasValidCharactersOnlyShouldNotBeCleaned() {
ProjectRequest request = createProjectRequest();
String groupId = "correct_ID12";
request.setGroupId(groupId);
ProjectDescription description = this.converter.convert(request, this.metadata);
assertThat(description.getGroupId()).isEqualTo("correct_ID12");
}
private ProjectRequest createProjectRequest() {
WebProjectRequest request = new WebProjectRequest();
request.initialize(this.metadata);