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

Polish "Make sure project descriptions line-wrap at a decent length"

Browse Source 
See gh-966
This commit is contained in:
Stephane Nicoll
2019-07-31 16:15:13 +02:00
parent 4772f4219f
commit e67f2bb0ac
4 changed files with 82 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
initializr-web/pom.xml
View File

@@ -44,6 +44,10 @@
<groupId>org.apache.commons</groupId>
<artifactId>commons-compress</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-text</artifactId>
</dependency>
<dependency>
<groupId>javax.cache</groupId>
@@ -114,11 +118,6 @@
<artifactId>jsonassert</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-text</artifactId>
<version>1.7</version>
</dependency>
</dependencies>
<build>

62
initializr-web/src/main/java/io/spring/initializr/web/support/CommandLineHelpGenerator.java
View File

@@ -46,12 +46,19 @@ public class CommandLineHelpGenerator {
+ " \\\\/ ___)| |_)| | | | | || (_| | ) ) ) )\n" + " ' |____| .__|_| |_|_| |_\\__, | / / / /\n"
+ " =========|_|==============|___/=/_/_/_/";
private static final String NEW_LINE = System.getProperty("line.separator");
private final TemplateRenderer template;
private final int desiredWidth = 100;
private final int maxColumnWidth;
public CommandLineHelpGenerator(TemplateRenderer template) {
this(template, 60);
}
public CommandLineHelpGenerator(TemplateRenderer template, int maxColumnWidth) {
this.template = template;
this.maxColumnWidth = maxColumnWidth;
}
/**
@@ -79,7 +86,6 @@ public class CommandLineHelpGenerator {
Map<String, Object> model = initializeCommandLineModel(metadata, serviceUrl);
model.put("examples", this.template.render("cli/curl-examples", model));
model.put("hasExamples", true);
return this.template.render("cli/cli-capabilities", model);
}
@@ -135,7 +141,7 @@ public class CommandLineHelpGenerator {
data[2] = (String) defaults.get(id);
parameterTable[i++] = data;
}
model.put("parameters", TableGenerator.generate(parameterTable, false, this.desiredWidth));
model.put("parameters", TableGenerator.generate(parameterTable, false, this.maxColumnWidth));
return model;
}
@@ -159,7 +165,7 @@ public class CommandLineHelpGenerator {
data[2] = (String) defaults.get(id);
parameterTable[i++] = data;
}
model.put("parameters", TableGenerator.generate(parameterTable, false, this.desiredWidth));
model.put("parameters", TableGenerator.generate(parameterTable, false, this.maxColumnWidth));
return model;
}
@@ -175,7 +181,7 @@ public class CommandLineHelpGenerator {
data[2] = dep.getVersionRequirement();
dependencyTable[i++] = data;
}
return TableGenerator.generate(dependencyTable, true, this.desiredWidth);
return TableGenerator.generate(dependencyTable, true, this.maxColumnWidth);
}
protected String generateTypeTable(InitializrMetadata metadata, String linkHeader, boolean addTags) {
@@ -197,7 +203,7 @@ public class CommandLineHelpGenerator {
}
typeTable[i++] = data;
}
return TableGenerator.generate(typeTable, false, this.desiredWidth);
return TableGenerator.generate(typeTable, false, this.maxColumnWidth);
}
protected Map<String, Object> buildParametersDescription(InitializrMetadata metadata) {
@@ -228,27 +234,25 @@ public class CommandLineHelpGenerator {
*/
private static class TableGenerator {
static final String NEW_LINE = System.getProperty("line.separator");
/**
* Generate a table description for the specified {@code content}.
* <p>
* The {@code content} is a two-dimensional array holding the rows of the table.
* The first entry holds the header of the table.
* @param content the table content
* @param emptyRowSeparation add an empty row separator
* @param desiredWidth the width bound for each column
* @param emptyRow add an empty row separator
* @param maxWidth the width bound for each column
* @return the generated table
*/
static String generate(String[][] content, boolean emptyRowSeparation, int desiredWidth) {
static String generate(String[][] content, boolean emptyRow, int maxWidth) {
StringBuilder sb = new StringBuilder();
int[] columnsLength = computeColumnsLength(content, desiredWidth);
int[] columnsLength = computeColumnsLength(content, maxWidth);
appendTableSeparation(sb, columnsLength);
appendRow(sb, content, columnsLength, 0, desiredWidth); // Headers
appendRow(sb, content, columnsLength, 0, maxWidth); // Headers
appendTableSeparation(sb, columnsLength);
for (int i = 1; i < content.length; i++) {
appendRow(sb, content, columnsLength, i, desiredWidth);
if (emptyRowSeparation && i < content.length - 1) {
appendRow(sb, content, columnsLength, i, maxWidth);
if (emptyRow && i < content.length - 1) {
appendEmptyRow(sb, columnsLength);
}
}
@@ -257,10 +261,9 @@ public class CommandLineHelpGenerator {
}
private static void appendRow(StringBuilder sb, String[][] content, int[] columnsLength, int rowIndex,
int desiredWidth) {
int maxWidth) {
String[] line = content[rowIndex];
List<String[]> rows = HelpFormatter.format(line, desiredWidth);
if (rows != null) {
List<String[]> rows = HelpFormatter.format(line, maxWidth);
for (String[] row : rows) {
for (int i = 0; i < row.length; i++) {
sb.append("| ").append(fill(row[i], columnsLength[i])).append(" ");
@@ -269,7 +272,6 @@ public class CommandLineHelpGenerator {
sb.append(NEW_LINE);
}
}
}
private static void appendEmptyRow(StringBuilder sb, int[] columnsLength) {
for (int columnLength : columnsLength) {
@@ -305,16 +307,16 @@ public class CommandLineHelpGenerator {
return s.toString();
}
private static int[] computeColumnsLength(String[][] content, int desiredWidth) {
private static int[] computeColumnsLength(String[][] content, int maxWidth) {
int count = content[0].length;
int[] result = new int[count];
for (int i = 0; i < count; i++) {
result[i] = largest(content, i, desiredWidth);
result[i] = largest(content, i, maxWidth);
}
return result;
}
private static int largest(String[][] content, int column, int desiredWidth) {
private static int largest(String[][] content, int column, int maxWidth) {
int max = 0;
for (String[] rows : content) {
if (rows != null) {
@@ -324,23 +326,21 @@ public class CommandLineHelpGenerator {
}
}
}
return (max < desiredWidth) ? max : desiredWidth;
return Math.min(max, maxWidth);
}
}
private static class HelpFormatter {
private static final String NEW_LINE = System.getProperty("line.separator");
/**
* Formats a given content to a desired width.
* Formats a given content to a max width.
* @param content the content to format.
* @param desiredWidth the desired width of each column
* @param maxWidth the max width of each column
* @return the formatted rows.
*/
private static List<String[]> format(String[] content, int desiredWidth) {
List<String[]> columns = lineWrap(content, desiredWidth);
private static List<String[]> format(String[] content, int maxWidth) {
List<String[]> columns = lineWrap(content, maxWidth);
List<String[]> rows = new ArrayList<>();
for (int i = 0; i < largest(columns); ++i) {
rows.add(computeRow(columns, i));
@@ -358,14 +358,14 @@ public class CommandLineHelpGenerator {
return line;
}
private static List<String[]> lineWrap(String[] content, int desiredWidth) {
private static List<String[]> lineWrap(String[] content, int maxWidth) {
List<String[]> lineWrapped = new ArrayList<>();
for (String column : content) {
if (column == null) {
lineWrapped.add(new String[0]);
}
else {
lineWrapped.add(WordUtils.wrap(column, desiredWidth).split(NEW_LINE));
lineWrapped.add(WordUtils.wrap(column, maxWidth).split(NEW_LINE));
}
}
return lineWrapped;

50
initializr-web/src/test/java/io/spring/initializr/web/support/CommandLineHelpGeneratorTests.java
View File

@@ -18,13 +18,13 @@ package io.spring.initializr.web.support;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import io.spring.initializr.generator.io.template.MustacheTemplateRenderer;
import io.spring.initializr.generator.spring.test.InitializrMetadataTestBuilder;
import io.spring.initializr.metadata.Dependency;
import io.spring.initializr.metadata.InitializrMetadata;
import io.spring.initializr.metadata.Type;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
@@ -36,12 +36,9 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
class CommandLineHelpGeneratorTests {
private CommandLineHelpGenerator generator;
private static final MustacheTemplateRenderer template = new MustacheTemplateRenderer("classpath:/templates");
@BeforeEach
void init() {
this.generator = new CommandLineHelpGenerator(new MustacheTemplateRenderer("classpath:/templates"));
}
private CommandLineHelpGenerator generator = new CommandLineHelpGenerator(template);
@Test
void generateGenericCapabilities() throws IOException {
@@ -95,17 +92,37 @@ class CommandLineHelpGeneratorTests {
}
@Test
void generateGeneralCapabilitiesWithLineWrap() throws IOException {
void generateGeneralCapabilitiesWithDefaultLineWrap() throws IOException {
CommandLineHelpGenerator lineWrapTemplateGenerator = new CommandLineHelpGenerator(template);
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup("test", createDependency("id-b",
"Ratpack is a set of Java libraries that facilitate fast, efficient, evolvable and well tested HTTP applications. Built on Netty the event-driven networking engine."))
.addDependencyGroup("test", createDependency("id-a", "Short description"), createDependency("id-b",
"Version control for your database so you can migrate from any version (incl. an empty database) to the latest version of the schema."))
.build();
String content = this.generator.generateGenericCapabilities(metadata, "https://fake-service");
String content = lineWrapTemplateGenerator.generateGenericCapabilities(metadata, "https://fake-service");
assertCommandLineCapabilities(content);
assertThat(content).contains(
"id-b | Ratpack is a set of Java libraries that facilitate fast, efficient, evolvable and well tested HTTP |");
assertThat(content).contains(
" | applications. Built on Netty the event-driven networking engine. |");
assertThat(readAllLines(content)).containsSequence(
"| id-a | Short description | |",
"| | | |",
"| id-b | Version control for your database so you can migrate from | |",
"| | any version (incl. an empty database) to the latest version | |",
"| | of the schema. | |");
assertThat(content).contains("https://fake-service");
}
@Test
void generateGeneralCapabilitiesWithCustomLineWrap() throws IOException {
CommandLineHelpGenerator lineWrapTemplateGenerator = new CommandLineHelpGenerator(template, 100);
InitializrMetadata metadata = InitializrMetadataTestBuilder.withDefaults()
.addDependencyGroup("test", createDependency("id-a", "Short description"), createDependency("id-b",
"Version control for your database so you can migrate from any version (incl. an empty database) to the latest version of the schema."))
.build();
String content = lineWrapTemplateGenerator.generateGenericCapabilities(metadata, "https://fake-service");
assertCommandLineCapabilities(content);
assertThat(readAllLines(content)).containsSequence(
"| id-a | Short description | |",
"| | | |",
"| id-b | Version control for your database so you can migrate from any version (incl. an empty database) to | |",
"| | the latest version of the schema. | |");
assertThat(content).contains("https://fake-service");
}
@@ -175,4 +192,9 @@ class CommandLineHelpGeneratorTests {
return dependency;
}
private static List<String> readAllLines(String source) {
String[] lines = source.split("\\r?\\n");
return Arrays.asList(lines);
}
}

6
pom.xml
View File

@@ -42,6 +42,7 @@
<main.basedir>${basedir}</main.basedir>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<commons-compress.version>1.18</commons-compress.version>
<commons-text.version>1.7</commons-text.version>
<junit-jupiter.version>5.4.2</junit-jupiter.version>
<maven.version>3.6.1</maven.version>
<maven-resolver.version>1.3.3</maven-resolver.version>
@@ -111,6 +112,11 @@
<artifactId>commons-compress</artifactId>
<version>${commons-compress.version}</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-text</artifactId>
<version>${commons-text.version}</version>
</dependency>
<dependency>
<groupId>org.apache.maven</groupId>
<artifactId>maven-resolver-provider</artifactId>