Code Improvements in Spring Shell Module (#713)

bsmahi · fabapp2 · web-flow · commit e333a9c5af8e · 2023-03-21T16:03:09.000+07:00
* Code Improvements

Done some code improvements like Pattern Matching for switchExpressions and Method References

* Added author details

* Replaced with Lambda Expression

* Resolved feedback comments

---------

Co-authored-by: Fabian Krüger &lt;56278322+fabapp2@users.noreply.github.com&gt;
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplicableRecipeListRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplicableRecipeListRenderer.java
@@ -47,7 +47,7 @@ public void listenForStartedScanningEvent(StartedScanningProjectResourceSetEvent
             // reset progressbar
             pb = null;
             long numJavaSources = e.getSize();
-            if(numJavaSources != 0) {
+            if (numJavaSources != 0) {
                 String message = e.getMessage();
                 message = message.length() > MAX_LENGTH ? message.substring(0, MAX_LENGTH) : message + " ".repeat(MAX_LENGTH - message.length());
                 pb = createProgressBar(message, numJavaSources);
@@ -60,7 +60,7 @@ public ProgressBar createProgressBar(String message, long numJavaSources) {
 
         @EventListener
         public void listenForFinishedScanningProjectResourceSetEvent(FinishedScanningProjectResourceSetEvent e) {
-            if(pb != null) {
+            if (pb != null) {
 //                pb.stepTo(pb.getMax());
                 pb.close();
             }
@@ -69,7 +69,7 @@ public void listenForFinishedScanningProjectResourceSetEvent(FinishedScanningPro
         @EventListener
         // TODO: listen for finish instead of start here
         public void listenForStartedScanningEvent(StartedScanningProjectResourceEvent e) {
-            if(pb != null) {
+            if (pb != null) {
                 pb.stepBy(1);
             }
         }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplyCommandRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplyCommandRenderer.java
@@ -22,7 +22,6 @@
 import org.springframework.context.event.EventListener;
 import org.springframework.sbm.engine.events.*;
 import org.springframework.sbm.engine.recipe.Action;
-import org.springframework.sbm.engine.recipe.Recipe;
 import org.springframework.sbm.shell.renderer.Printer;
 import org.springframework.sbm.shell.renderer.RecipeProgressRenderer;
 import org.springframework.stereotype.Component;
@@ -36,11 +35,11 @@
 
 /**
  * Renders progress information during the runtime of a recipe.
- *
+ * <p>
  * {@code RecipeProgressRenderer} handles the rendering of action progress.
  * A {@code ScheduledExecutorService} is used to periodically call the {@link RecipeProgressRenderer#render()} method
  * which renders a process as loading to provide visual feedback to users during a potentially long-running Action.
- *
+ * <p>
  * Logging to console will be disabled and log messages to info, warn and error level are redirected to the matching
  * {@link RecipeProgressRenderer#logError(String)},
  * {@link RecipeProgressRenderer#logWarning(String)} or
@@ -79,12 +78,12 @@ public AttributedString render(String recipeName, List<Action> actions) {
     }
 
     private String getDescriptionWithIndent(Action a) {
-        if(a == null || a.getDescription() == null) return "";
+        if (a == null || a.getDescription() == null) return "";
 
         String[] lines = a.getDescription().split("\\r?\\n");
         List<String> strings = Arrays.asList(lines);
         String collect = "";
-        if(lines.length > 1) {
+        if (lines.length > 1) {
             collect = strings.subList(1, strings.size()).stream()
                     .map(l -> String.format("        %s", l))
                     .collect(Collectors.joining("\n"));
@@ -94,11 +93,11 @@ private String getDescriptionWithIndent(Action a) {
 
     @EventListener
     public void onActionStarted(ActionStartedEvent e) {
-        if(scheduledExecutorService != null && ! scheduledExecutorService.isTerminated()) {
+        if (scheduledExecutorService != null && !scheduledExecutorService.isTerminated()) {
             scheduledExecutorService.shutdown();
         }
         scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
-        scheduledExecutorService.scheduleWithFixedDelay(() -> recipeProgressRenderer.render(), initialDelay, delay, TimeUnit.MILLISECONDS);
+        scheduledExecutorService.scheduleWithFixedDelay(recipeProgressRenderer::render, initialDelay, delay, TimeUnit.MILLISECONDS);
         recipeProgressRenderer.startProcess(e.getDescription());
     }
 
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplyShellCommand.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ApplyShellCommand.java
@@ -64,22 +64,26 @@ public AttributedString apply(@ShellOption(arity = 1, valueProvider = ApplyRecip
         List<Recipe> applicableRecipes = applicableRecipeListCommand.execute(projectContext);
         AttributedString applicableRecipesOutput = applicableRecipeListRenderer.render(applicableRecipes);
 
-        AttributedString output = new AttributedStringBuilder().append(applyCommandOutput).append(System.lineSeparator()).append(applicableRecipesOutput).toAttributedString();
-
-        return output;
+        return new AttributedStringBuilder()
+                .append(applyCommandOutput)
+                .append(System.lineSeparator())
+                .append(applicableRecipesOutput)
+                .toAttributedString();
     }
 
     @NotNull
     private AttributedStringBuilder buildHeader(String recipeName) {
         AttributedStringBuilder builder = new AttributedStringBuilder();
         builder.append("Applying recipe ");
         builder.style(AttributedStyle.DEFAULT.italicDefault().boldDefault().foreground(Colors.rgbColor("yellow")));
-        builder.append("'" + recipeName + "'");
+        builder.append("'")
+                .append(recipeName)
+                .append("'");
         return builder;
     }
 
     public Availability availabilityCheck() {
-        if(projectContextHolder.getProjectContext() != null) {
+        if (projectContextHolder.getProjectContext() != null) {
             return Availability.available();
         } else {
             return Availability.unavailable("You need to scan first");
@@ -89,7 +93,7 @@ public Availability availabilityCheck() {
 
 @Component
 @RequiredArgsConstructor
-class ApplyRecipeValueProvider implements ValueProvider{
+class ApplyRecipeValueProvider implements ValueProvider {
 
     private final ProjectContextHolder projectContextHolder;
     private final ApplicableRecipeListCommand applicableRecipeListCommand;
@@ -98,7 +102,11 @@ class ApplyRecipeValueProvider implements ValueProvider{
     public List<CompletionProposal> complete(CompletionContext completionContext) {
         ProjectContext projectContext = projectContextHolder.getProjectContext();
         List<Recipe> applicableRecipes = applicableRecipeListCommand.execute(projectContext);
-        return applicableRecipes.stream().map(Recipe::getName).map(CompletionProposal::new).toList();
+
+        return applicableRecipes.stream()
+                .map(Recipe::getName)
+                .map(CompletionProposal::new)
+                .toList();
     }
 
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/DescribeCommandRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/DescribeCommandRenderer.java
@@ -25,6 +25,7 @@ public class DescribeCommandRenderer {
     public AttributedString render(Recipe recipe) {
         AttributedStringBuilder builder = new AttributedStringBuilder();
         builder.append(recipe.getDetails());
+
         return builder.toAttributedString();
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/DescribeShellCommand.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/DescribeShellCommand.java
@@ -33,6 +33,7 @@ public class DescribeShellCommand {
     @ShellMethod(key = {"describe", "d"}, value = "Describe a given recipe.")
     public AttributedString describe(@ShellOption(help = "The name of the recipe.") String recipe) {
         final Recipe recipeResult = describeCommand.execute(recipe);
+
         return describeCommandRenderer.render(recipeResult);
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ExceptionUtil.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ExceptionUtil.java
@@ -23,23 +23,25 @@
  */
 public class ExceptionUtil {
 
-	public static Throwable getDeepestCause(Throwable e) {
-		Throwable cause = e;
-		Throwable parent = e.getCause();
-		while (parent != null && parent != e) {
-			cause = parent;
-			parent = cause.getCause();
-		}
-		return cause;
-	}
+    public static Throwable getDeepestCause(Throwable e) {
+        Throwable cause = e;
+        Throwable parent = e.getCause();
+        while (parent != null && parent != e) {
+            cause = parent;
+            parent = cause.getCause();
+        }
+
+        return cause;
+    }
+
+    public static String getMessage(Throwable e) {
+        // The message of nested exception is usually more interesting than the
+        // one on top.
+        Throwable cause = getDeepestCause(e);
+        String errorType = cause.getClass().getSimpleName();
+        String msg = cause.getMessage();
+
+        return errorType + ": " + msg;
+    }
 
-	public static String getMessage(Throwable e) {
-		// The message of nested exception is usually more interesting than the
-		// one on top.
-		Throwable cause = getDeepestCause(e);
-		String errorType = cause.getClass().getSimpleName();
-		String msg = cause.getMessage();
-		return errorType + ": " + msg;
-	}
-	
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ListShellCommand.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ListShellCommand.java
@@ -34,6 +34,7 @@ public class ListShellCommand {
     @ShellMethod(key = {"list", "l"}, value = "List all existing (applicable and non-applicable) recipes.")
     public AttributedString list() {
         final List<Recipe> recipes = listCommand.execute();
+
         return recipeListRenderer.render(recipes);
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/PreconditionVerificationRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/PreconditionVerificationRenderer.java
@@ -31,30 +31,29 @@ public String renderPreconditionCheckResults(PreconditionVerificationResult resu
         stringBuilder.style(stringBuilder.style().DEFAULT.bold().foreground(Colors.rgbColor("black")));
         stringBuilder.append("\n\n").append(String.format("Checked preconditions for '%s'", result.getProjectRoot())).append("\n");
 
-        result.getResults().forEach(r -> {
-            stringBuilder.append(renderCheckResult(r));
-        });
+        result.getResults().forEach(r -> stringBuilder.append(renderCheckResult(r)));
         stringBuilder.append("\n");
+
         return stringBuilder.toAnsi();
     }
 
     private String renderCheckResult(PreconditionCheckResult r) {
         AttributedStringBuilder builder = new AttributedStringBuilder();
 
         // TODO: move rendering of status into central place
-        if(r.getState().equals(PreconditionCheck.ResultState.FAILED)) {
+        if (r.getState().equals(PreconditionCheck.ResultState.FAILED)) {
             builder.style(builder.style().DEFAULT.bold().foreground(Colors.rgbColor("red")));
             builder.append(" [X]");
             builder.style(builder.style().DEFAULT);
         }
 
-        if(r.getState().equals(PreconditionCheck.ResultState.PASSED)) {
+        if (r.getState().equals(PreconditionCheck.ResultState.PASSED)) {
             builder.style(AttributedStyle.DEFAULT.bold().foreground(Colors.rgbColor("green")));
             builder.append("[ok]");
             builder.style(AttributedStyle.DEFAULT);
         }
 
-        if(r.getState().equals(PreconditionCheck.ResultState.WARN)) {
+        if (r.getState().equals(PreconditionCheck.ResultState.WARN)) {
             builder.style(AttributedStyle.DEFAULT.bold().foreground(Colors.rgbColor("yellow")));
             builder.append(" [!]");
             builder.style(AttributedStyle.DEFAULT);
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/RecipeRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/RecipeRenderer.java
@@ -65,8 +65,8 @@ public AttributedStringBuilder buildRecipePresentation(AttributedStringBuilder b
         builder.style(AttributedStyle.DEFAULT.italicDefault().boldDefault().foreground(Colors.rgbColor("yellow")));
         builder.append(recipe.getName());
         builder.style(AttributedStyle.DEFAULT);
-        builder.append(" [" + getAutomationEmoji(recipe.getAutomationInfo()) + "]");
-        builder.append("\n     -> " + recipe.getDescription());
+        builder.append(" [").append(getAutomationEmoji(recipe.getAutomationInfo())).append("]");
+        builder.append("\n     -> ").append(recipe.getDescription());
         builder.append("\n");
         return builder;
     }
@@ -81,13 +81,10 @@ private AttributedString renderTitle(String title) {
     }
 
     private String getAutomationEmoji(RecipeAutomation recipeAutomation) {
-        switch (recipeAutomation) {
-            case AUTOMATED:
-                return AUTOMATED_EMOJI;
-            case PARTIALLY_AUTOMATED:
-                return MANUAL_EMOJI + " " + AUTOMATED_EMOJI;
-            default:
-                return MANUAL_EMOJI;
-        }
+        return switch (recipeAutomation) {
+            case AUTOMATED -> AUTOMATED_EMOJI;
+            case PARTIALLY_AUTOMATED -> MANUAL_EMOJI + " " + AUTOMATED_EMOJI;
+            default -> MANUAL_EMOJI;
+        };
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ScanCommandHeaderRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ScanCommandHeaderRenderer.java
@@ -26,7 +26,7 @@ public String renderHeader(String projectRoot) {
         AttributedStringBuilder builder = new AttributedStringBuilder();
         builder.append("\n");
         builder.style(AttributedStyle.DEFAULT.italicDefault().boldDefault().foreground(Colors.rgbColor("green")));
-        builder.append("scanning '" + projectRoot + "'");
+        builder.append("scanning '").append(projectRoot).append("'");
         return builder.toAnsi();
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ScanShellCommand.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ScanShellCommand.java
@@ -36,11 +36,8 @@
 public class ScanShellCommand {
 
     private final ScanCommand scanCommand;
-
     private final ApplicableRecipeListRenderer applicableRecipeListRenderer;
-
     private final ApplicableRecipeListCommand applicableRecipeListCommand;
-
     private final ProjectContextHolder contextHolder;
     private final PreconditionVerificationRenderer preconditionVerificationRenderer;
     private final ScanCommandHeaderRenderer scanCommandHeaderRenderer;
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ShellPromptProvider.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ShellPromptProvider.java
@@ -26,6 +26,8 @@
 @Component
 public class ShellPromptProvider implements PromptProvider {
 
+	private static final String MIGRATOR_CONSTANT = "migrator";
+
 	@Autowired
 	ProjectContextHolder holder;
 	
@@ -35,12 +37,9 @@ public AttributedString getPrompt() {
 	}
 
 	private String promptString() {
-		ProjectContext pc = holder.getProjectContext();
-		if (pc==null) {
-			return "migrator";
-		} else {
-			return pc.getProjectRootDirectory().getFileName().toString();
-		}
+		ProjectContext projectContext = holder.getProjectContext();
+
+		return projectContext == null ? MIGRATOR_CONSTANT : projectContext.getProjectRootDirectory().getFileName().toString();
 	}
 
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ShellUserInteractions.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/ShellUserInteractions.java
@@ -40,6 +40,7 @@ public boolean askUserYesOrNo(String question) {
         while (!YES_RESPONSE.equalsIgnoreCase(input) && !NO_RESPONSE.equalsIgnoreCase(input)) {
             input = lineReader.get().readLine("\n" + question + " > ").trim();
         }
+
         return YES_RESPONSE.equalsIgnoreCase(input);
     }
 
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/LogStep.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/LogStep.java
@@ -39,6 +39,7 @@ public String render() {
         AttributedStringBuilder builder = new AttributedStringBuilder();
         builder.style(AttributedStyle.DEFAULT.bold().foreground(Colors.rgbColor("green")));
         builder.append("[ok]");
+
         return " ".repeat(indent.get()) + "    " + builder.toAttributedString().toAnsi() + " " + logMessage;
     }
 
@@ -51,6 +52,7 @@ public String renderError() {
                 .style(AttributedStyle.DEFAULT)
                 .append(" ")
                 .append(logMessage);
+
         return builder.toAttributedString().toAnsi();
     }
 
@@ -63,6 +65,7 @@ public String renderWarning() {
                 .style(AttributedStyle.DEFAULT)
                 .append(" ")
                 .append(logMessage);
+
         return builder.toAttributedString().toAnsi();
     }
 }
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/Printer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/Printer.java
@@ -31,7 +31,7 @@ public void println(String out) {
     }
 
     synchronized public void print(String text) {
-        if(previousLine != null && previousLine.get() != null && !previousLine.get().isEmpty()) {
+        if(previousLine.get() != null && !previousLine.get().isEmpty()) {
             clearPreviousLine();
         }
         previousLine.set(text);
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/ProcessStep.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/ProcessStep.java
@@ -80,7 +80,7 @@ public boolean isPaused() {
         return isPaused;
     }
 
-    private class Loader {
+    private static class Loader {
         private static final int LENGTH = 4;
         private int cnt = 0;
         private String renderLoader() {
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/ProgressRendererLogbackLogAdapter.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/ProgressRendererLogbackLogAdapter.java
diff --git a/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/RecipeProgressRenderer.java b/applications/spring-shell/src/main/java/org/springframework/sbm/shell/renderer/RecipeProgressRenderer.java

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public class DescribeCommandRenderer {`
`25`	`25`	`public AttributedString render(Recipe recipe) {`
`26`	`26`	`AttributedStringBuilder builder = new AttributedStringBuilder();`
`27`	`27`	`builder.append(recipe.getDetails());`
	`28`	`+`
`28`	`29`	`return builder.toAttributedString();`
`29`	`30`	`}`
`30`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ public class DescribeShellCommand {`
`33`	`33`	`@ShellMethod(key = {"describe", "d"}, value = "Describe a given recipe.")`
`34`	`34`	`public AttributedString describe(@ShellOption(help = "The name of the recipe.") String recipe) {`
`35`	`35`	`final Recipe recipeResult = describeCommand.execute(recipe);`
	`36`	`+`
`36`	`37`	`return describeCommandRenderer.render(recipeResult);`
`37`	`38`	`}`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public class ListShellCommand {`
`34`	`34`	`@ShellMethod(key = {"list", "l"}, value = "List all existing (applicable and non-applicable) recipes.")`
`35`	`35`	`public AttributedString list() {`
`36`	`36`	`final List<Recipe> recipes = listCommand.execute();`
	`37`	`+`
`37`	`38`	`return recipeListRenderer.render(recipes);`
`38`	`39`	`}`
`39`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public String renderHeader(String projectRoot) {`
`26`	`26`	`AttributedStringBuilder builder = new AttributedStringBuilder();`
`27`	`27`	`builder.append("\n");`
`28`	`28`	`builder.style(AttributedStyle.DEFAULT.italicDefault().boldDefault().foreground(Colors.rgbColor("green")));`
`29`		`- builder.append("scanning '" + projectRoot + "'");`
	`29`	`+ builder.append("scanning '").append(projectRoot).append("'");`
`30`	`30`	`return builder.toAnsi();`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ public boolean askUserYesOrNo(String question) {`
`40`	`40`	`while (!YES_RESPONSE.equalsIgnoreCase(input) && !NO_RESPONSE.equalsIgnoreCase(input)) {`
`41`	`41`	`input = lineReader.get().readLine("\n" + question + " > ").trim();`
`42`	`42`	`}`
	`43`	`+`
`43`	`44`	`return YES_RESPONSE.equalsIgnoreCase(input);`
`44`	`45`	`}`
`45`	`46`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ public String render() {`
`39`	`39`	`AttributedStringBuilder builder = new AttributedStringBuilder();`
`40`	`40`	`builder.style(AttributedStyle.DEFAULT.bold().foreground(Colors.rgbColor("green")));`
`41`	`41`	`builder.append("[ok]");`
	`42`	`+`
`42`	`43`	`return " ".repeat(indent.get()) + " " + builder.toAttributedString().toAnsi() + " " + logMessage;`
`43`	`44`	`}`
`44`	`45`
`@@ -51,6 +52,7 @@ public String renderError() {`
`51`	`52`	`.style(AttributedStyle.DEFAULT)`
`52`	`53`	`.append(" ")`
`53`	`54`	`.append(logMessage);`
	`55`	`+`
`54`	`56`	`return builder.toAttributedString().toAnsi();`
`55`	`57`	`}`
`56`	`58`
`@@ -63,6 +65,7 @@ public String renderWarning() {`
`63`	`65`	`.style(AttributedStyle.DEFAULT)`
`64`	`66`	`.append(" ")`
`65`	`67`	`.append(logMessage);`
	`68`	`+`
`66`	`69`	`return builder.toAttributedString().toAnsi();`
`67`	`70`	`}`
`68`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public void println(String out) {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`synchronized public void print(String text) {`
`34`		`- if(previousLine != null && previousLine.get() != null && !previousLine.get().isEmpty()) {`
	`34`	`+ if(previousLine.get() != null && !previousLine.get().isEmpty()) {`
`35`	`35`	`clearPreviousLine();`
`36`	`36`	`}`
`37`	`37`	`previousLine.set(text);`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public boolean isPaused() {`
`80`	`80`	`return isPaused;`
`81`	`81`	`}`
`82`	`82`
`83`		`- private class Loader {`
	`83`	`+ private static class Loader {`
`84`	`84`	`private static final int LENGTH = 4;`
`85`	`85`	`private int cnt = 0;`
`86`	`86`	`private String renderLoader() {`