Merge command utilities in the existing Utils class

Author: fmbenhassine

spring-shell-core/src/main/java/org/springframework/shell/core/InteractiveShellRunner.java

@@ -28,7 +28,7 @@
 import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.command.ExitStatus;
 import org.springframework.shell.core.command.ParsedInput;
-import org.springframework.shell.core.utils.CommandUtils;
+import org.springframework.shell.core.utils.Utils;
 
 /**
  * Base class for interactive shell runners. Implementations must provide concrete methods
@@ -111,7 +111,7 @@ public void run(String[] args) throws Exception {
 			}
 			catch (CommandNotFoundException exception) {
 				print(String.format("Command %s not found", exception.getCommandName()));
-				print(CommandUtils.formatAvailableCommands(this.commandRegistry));
+				print(Utils.formatAvailableCommands(this.commandRegistry));
 			}
 			finally {
 				flush();

spring-shell-core/src/main/java/org/springframework/shell/core/command/Help.java

@@ -17,7 +17,7 @@
 
 import java.io.PrintWriter;
 
-import org.springframework.shell.core.utils.CommandUtils;
+import org.springframework.shell.core.utils.Utils;
 
 /**
  * A command to display help about all available commands.
@@ -41,7 +41,7 @@ public String getGroup() {
 
 	@Override
 	public ExitStatus execute(CommandContext commandContext) throws Exception {
-		String helpMessage = CommandUtils.formatAvailableCommands(commandContext.commandRegistry());
+		String helpMessage = Utils.formatAvailableCommands(commandContext.commandRegistry());
 		PrintWriter outputWriter = commandContext.outputWriter();
 		outputWriter.println(helpMessage);
 		outputWriter.flush();

spring-shell-core/src/main/java/org/springframework/shell/core/command/Script.java

@@ -19,7 +19,7 @@
 import java.util.List;
 
 import org.springframework.shell.core.FileInputProvider;
-import org.springframework.shell.core.utils.CommandUtils;
+import org.springframework.shell.core.utils.Utils;
 
 /**
  * A command that can read and execute other commands from a file.
@@ -50,7 +50,7 @@ public ExitStatus doExecute(CommandContext commandContext) throws Exception {
 	private void executeCommand(CommandContext commandContext, String input) throws Exception {
 		Command command = commandContext.commandRegistry().getCommandByName(input);
 		if (command == null) {
-			String availableCommands = CommandUtils.formatAvailableCommands(commandContext.commandRegistry());
+			String availableCommands = Utils.formatAvailableCommands(commandContext.commandRegistry());
 			throw new CommandNotFoundException("No command found for name: " + input + ". " + availableCommands);
 		}
 		CommandContext singleCommandContext = new CommandContext(commandContext.parsedInput(),

spring-shell-core/src/main/java/org/springframework/shell/core/utils/CommandUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015-2022 the original author or authors.
+ * Copyright 2015-present 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.
@@ -34,14 +34,48 @@
 
 import org.springframework.core.DefaultParameterNameDiscoverer;
 import org.springframework.core.MethodParameter;
+import org.springframework.shell.core.command.Command;
+import org.springframework.shell.core.command.CommandRegistry;
 
 /**
  * Some text utilities.
  *
  * @author Eric Bottard
+ * @author Mahmoud Ben Hassine
  */
 public class Utils {
 
+	/**
+	 * Get a formatted string of available non-hidden commands from the command registry.
+	 * @param commandRegistry the command registry
+	 * @return a string of available commands with their descriptions
+	 * @since 4.0.0
+	 */
+	public static String formatAvailableCommands(CommandRegistry commandRegistry) {
+		StringBuilder stringBuilder = new StringBuilder("Available commands: ");
+		stringBuilder.append(System.lineSeparator());
+		List<String> groups = commandRegistry.getCommands()
+			.stream()
+			.filter(command -> !command.isHidden())
+			.map(Command::getGroup)
+			.distinct()
+			.sorted()
+			.toList();
+		for (String group : groups) {
+			stringBuilder.append(group).append(System.lineSeparator());
+			for (Command command : commandRegistry.getCommands()) {
+				if (command.getGroup().equals(group)) {
+					stringBuilder.append("\t")
+						.append(command.getName())
+						.append(": ")
+						.append(command.getDescription())
+						.append(System.lineSeparator());
+				}
+			}
+		}
+		return stringBuilder.toString();
+	}
+
 	/**
 	 * Turn CamelCaseText into gnu-style-lowercase.
 	 */