Refactor

Signed-off-by: Piotr Olaszewski <[email protected]>

Author: piotrooo

spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/CommandRegistrationCustomizer.java

@@ -15,20 +15,20 @@
  */
 package org.springframework.shell.boot;
 
-import org.springframework.shell.core.command.CommandRegistration;
+import org.springframework.shell.core.command.Command;
 
 /**
- * Callback interface that can be used to customize a {@link CommandRegistration.Builder}.
+ * Callback interface that can be used to customize a {@link Command.Builder}.
  *
  * @author Janne Valkealahti
  */
 @FunctionalInterface
 public interface CommandRegistrationCustomizer {
 
 	/**
-	 * Callback to customize a {@link CommandRegistration.Builder} instance.
+	 * Callback to customize a {@link Command.Builder} instance.
 	 * @param commandRegistrationBuilder the command registration builder to customize
 	 */
-	void customize(CommandRegistration.Builder commandRegistrationBuilder);
+	void customize(Command.Builder commandRegistrationBuilder);
 
 }

spring-shell-autoconfigure/src/main/java/org/springframework/shell/boot/CommandRegistryAutoConfiguration.java

@@ -27,11 +27,11 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.shell.core.MethodTargetRegistrar;
 import org.springframework.shell.boot.SpringShellProperties.Help;
+import org.springframework.shell.core.command.Command;
 import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.command.CommandRegistryCustomizer;
-import org.springframework.shell.core.command.CommandRegistration;
-import org.springframework.shell.core.command.CommandRegistration.BuilderSupplier;
-import org.springframework.shell.core.command.CommandRegistration.OptionNameModifier;
+import org.springframework.shell.core.command.BuilderSupplier;
+import org.springframework.shell.core.command.OptionNameModifier;
 import org.springframework.shell.core.command.support.OptionNameModifierSupport;
 import org.springframework.shell.core.command.CommandResolver;
 import org.springframework.shell.core.context.ShellContext;
@@ -57,8 +57,7 @@ public CommandRegistry commandRegistry(ObjectProvider<MethodTargetRegistrar> met
 	}
 
 	@Bean
-	public CommandRegistryCustomizer defaultCommandRegistryCustomizer(
-			ObjectProvider<CommandRegistration> commandRegistrations) {
+	public CommandRegistryCustomizer defaultCommandRegistryCustomizer(ObjectProvider<Command> commandRegistrations) {
 		return registry -> {
 			commandRegistrations.orderedStream().forEach(registration -> {
 				registry.register(registration);
@@ -120,7 +119,7 @@ public CommandRegistrationCustomizer defaultOptionNameModifierCommandRegistratio
 	public BuilderSupplier commandRegistrationBuilderSupplier(
 			ObjectProvider<CommandRegistrationCustomizer> customizerProvider) {
 		return () -> {
-			CommandRegistration.Builder builder = CommandRegistration.builder();
+			Command.Builder builder = Command.builder();
 			customizerProvider.orderedStream().forEach((customizer) -> customizer.customize(builder));
 			return builder;
 		};

spring-shell-autoconfigure/src/test/java/org/springframework/shell/boot/CommandRegistryAutoConfigurationTests.java

@@ -25,11 +25,11 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.shell.core.command.CommandRegistry;
-import org.springframework.shell.core.command.CommandRegistration;
+import org.springframework.shell.core.command.Command;
 import org.springframework.shell.core.command.CommandResolver;
-import org.springframework.shell.core.command.CommandRegistration.Builder;
-import org.springframework.shell.core.command.CommandRegistration.BuilderSupplier;
-import org.springframework.shell.core.command.CommandRegistration.OptionNameModifier;
+import org.springframework.shell.core.command.Command.Builder;
+import org.springframework.shell.core.command.BuilderSupplier;
+import org.springframework.shell.core.command.OptionNameModifier;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -162,8 +162,8 @@ CommandRegistry customCommandRegistry() {
 	static class CustomCommandRegistrationConfiguration {
 
 		@Bean
-		CommandRegistration commandRegistration() {
-			return CommandRegistration.builder()
+		Command commandRegistration() {
+			return Command.builder()
 				.command("customcommand")
 				.withTarget(targetSpec -> targetSpec.function(ctx -> null))
 				.build();

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

@@ -20,7 +20,7 @@
 import java.util.List;
 
 import org.springframework.core.ResolvableType;
-import org.springframework.shell.core.command.CommandOption;
+import org.springframework.shell.core.command.metadata.CommandOption;
 import org.springframework.shell.core.completion.CompletionContext;
 import org.springframework.shell.core.completion.CompletionProposal;
 
@@ -37,7 +37,7 @@ public List<CompletionProposal> complete(CompletionContext completionContext) {
 		List<CompletionProposal> result = new ArrayList<>();
 		CommandOption commandOption = completionContext.getCommandOption();
 		if (commandOption != null) {
-			ResolvableType type = commandOption.getType();
+			ResolvableType type = commandOption.type();
 			if (type != null) {
 				Class<?> clazz = type.getRawClass();
 				if (clazz != null) {

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

@@ -42,6 +42,7 @@
 import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.command.CommandExecution.CommandExecutionException;
 import org.springframework.shell.core.command.CommandExecution.CommandExecutionHandlerMethodArgumentResolvers;
+import org.springframework.shell.core.command.metadata.CommandOption;
 import org.springframework.shell.core.completion.CompletionContext;
 import org.springframework.shell.core.completion.CompletionProposal;
 import org.springframework.shell.core.completion.CompletionResolver;
@@ -217,14 +218,14 @@ else if (processExceptionNonInt != null && processExceptionNonInt.exitCode() !=
 		String line = words.stream().collect(Collectors.joining(" ")).trim();
 		String command = findLongestCommand(line, false);
 
-		Map<String, CommandRegistration> registrations = commandRegistry.getRegistrations();
+		Map<String, Command> registrations = commandRegistry.getRegistrations();
 		if (command == null) {
 			return new CommandNotFound(words, new HashMap<>(registrations), input.rawText());
 		}
 
 		log.debug(String.format("Evaluate input with line=[%s], command=[%s]", line, command));
 
-		Optional<CommandRegistration> commandRegistration = registrations.values().stream().filter(r -> {
+		Optional<Command> commandRegistration = registrations.values().stream().filter(r -> {
 			if (r.getCommand().equals(command)) {
 				return true;
 			}
@@ -359,7 +360,7 @@ public List<CompletionProposal> complete(CompletionContext context) {
 		String best = findLongestCommand(prefix, true);
 		if (best != null) {
 			context = context.drop(best.split(" ").length);
-			CommandRegistration registration = commandRegistry.getRegistrations().get(best);
+			Command registration = commandRegistry.getRegistrations().get(best);
 			CompletionContext argsContext = context.commandRegistration(registration);
 
 			for (CompletionResolver resolver : completionResolvers) {
@@ -378,7 +379,7 @@ public List<CompletionProposal> complete(CompletionContext context) {
 			}
 
 			List<CompletionProposal> argProposals = matchedArgOptions.stream().flatMap(o -> {
-				Function<CompletionContext, List<CompletionProposal>> completion = o.getCompletion();
+				Function<CompletionContext, List<CompletionProposal>> completion = o.completion();
 				if (completion != null) {
 					List<CompletionProposal> apply = completion.apply(argsContext.commandOption(o));
 					return apply.stream();
@@ -399,7 +400,7 @@ private List<CommandOption> matchOptions(List<CommandOption> options, String arg
 			if (trimmed.length() == 1) {
 				Character trimmedChar = trimmed.charAt(0);
 				options.stream().filter(o -> {
-					for (Character sn : o.getShortNames()) {
+					for (Character sn : o.shortNames()) {
 						if (trimmedChar.equals(sn)) {
 							return true;
 						}
@@ -410,7 +411,7 @@ private List<CommandOption> matchOptions(List<CommandOption> options, String arg
 			else if (trimmed.length() > 1) {
 				trimmed.chars().mapToObj(i -> (char) i).forEach(c -> {
 					options.stream().forEach(o -> {
-						for (Character sn : o.getShortNames()) {
+						for (Character sn : o.shortNames()) {
 							if (c.equals(sn)) {
 								matched.add(o);
 							}
@@ -421,7 +422,7 @@ else if (trimmed.length() > 1) {
 		}
 		else if (count == 2) {
 			options.stream().filter(o -> {
-				for (String ln : o.getLongNames()) {
+				for (String ln : o.longNames()) {
 					if (trimmed.equals(ln)) {
 						return true;
 					}
@@ -448,7 +449,7 @@ private List<CompletionProposal> commandsStartingWith(String prefix) {
 			.collect(Collectors.toList());
 	}
 
-	private CompletionProposal toCommandProposal(String command, CommandRegistration registration) {
+	private CompletionProposal toCommandProposal(String command, Command registration) {
 		return new CompletionProposal(command).dontQuote(true)
 			.category("Available commands")
 			.description(registration.getDescription());
@@ -460,7 +461,7 @@ private CompletionProposal toCommandProposal(String command, CommandRegistration
 	 * @return a valid command name, or {@literal null} if none matched
 	 */
 	private @Nullable String findLongestCommand(String prefix, boolean filterHidden) {
-		Map<String, CommandRegistration> registrations = commandRegistry.getRegistrations();
+		Map<String, Command> registrations = commandRegistry.getRegistrations();
 		if (filterHidden) {
 			registrations = Utils.removeHiddenCommands(registrations);
 		}

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

@@ -36,7 +36,7 @@
 
 import org.springframework.core.DefaultParameterNameDiscoverer;
 import org.springframework.core.MethodParameter;
-import org.springframework.shell.core.command.CommandRegistration;
+import org.springframework.shell.core.command.Command;
 
 /**
  * Some text utilities.
@@ -177,11 +177,10 @@ public static <T> List<List<T>> split(T[] array, Predicate<T> predicate) {
 	 * @param registrations a command registrations
 	 * @return same map with removed hidden commands
 	 */
-	public static Map<String, CommandRegistration> removeHiddenCommands(
-			Map<String, CommandRegistration> registrations) {
-		Iterator<Map.Entry<String, CommandRegistration>> iter = registrations.entrySet().iterator();
+	public static Map<String, Command> removeHiddenCommands(Map<String, Command> registrations) {
+		Iterator<Map.Entry<String, Command>> iter = registrations.entrySet().iterator();
 		while (iter.hasNext()) {
-			Map.Entry<String, CommandRegistration> entry = iter.next();
+			Map.Entry<String, Command> entry = iter.next();
 			if (entry.getValue().isHidden()) {
 				iter.remove();
 			}

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

@@ -0,0 +1,12 @@
+package org.springframework.shell.core.command;
+
+import java.util.function.Supplier;
+
+/**
+ * Interface used to supply instance of a {@link Command.Builder}. Meant to be a single
+ * point access to centrally configured builder in an application context.
+ */
+@FunctionalInterface
+public interface BuilderSupplier extends Supplier<Command.Builder> {
+
+}