Rename CommandCatalog to CommandRegistry

Based on method names, CommandRegistry is more representative
and more explicit about the concept than CommandCatalog.

Author: fmbenhassine

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2023 the original author or authors.
+ * Copyright 2021-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.
@@ -27,8 +27,8 @@
 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.CommandCatalog;
-import org.springframework.shell.core.command.CommandCatalogCustomizer;
+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;
@@ -38,30 +38,30 @@
 
 @AutoConfiguration
 @EnableConfigurationProperties(SpringShellProperties.class)
-public class CommandCatalogAutoConfiguration {
+public class CommandRegistryAutoConfiguration {
 
 	@Bean
-	@ConditionalOnMissingBean(CommandCatalog.class)
-	public CommandCatalog commandCatalog(ObjectProvider<MethodTargetRegistrar> methodTargetRegistrars,
-			ObjectProvider<CommandResolver> commandResolvers,
-			ObjectProvider<CommandCatalogCustomizer> commandCatalogCustomizers,
-			ShellContext shellContext) {
+	@ConditionalOnMissingBean(CommandRegistry.class)
+	public CommandRegistry commandRegistry(ObjectProvider<MethodTargetRegistrar> methodTargetRegistrars,
+										  ObjectProvider<CommandResolver> commandResolvers,
+										  ObjectProvider<CommandRegistryCustomizer> commandRegistryCustomizers,
+										  ShellContext shellContext) {
 		List<CommandResolver> resolvers = commandResolvers.orderedStream().collect(Collectors.toList());
-		CommandCatalog catalog = CommandCatalog.of(resolvers, shellContext);
+		CommandRegistry registry = CommandRegistry.of(resolvers, shellContext);
 		methodTargetRegistrars.orderedStream().forEach(resolver -> {
-			resolver.register(catalog);
+			resolver.register(registry);
 		});
-		commandCatalogCustomizers.orderedStream().forEach(customizer -> {
-			customizer.customize(catalog);
+		commandRegistryCustomizers.orderedStream().forEach(customizer -> {
+			customizer.customize(registry);
 		});
-		return catalog;
+		return registry;
 	}
 
 	@Bean
-	public CommandCatalogCustomizer defaultCommandCatalogCustomizer(ObjectProvider<CommandRegistration> commandRegistrations) {
-		return catalog -> {
+	public CommandRegistryCustomizer defaultCommandRegistryCustomizer(ObjectProvider<CommandRegistration> commandRegistrations) {
+		return registry -> {
 			commandRegistrations.orderedStream().forEach(registration -> {
-				catalog.register(registration);
+				registry.register(registration);
 			});
 		};
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2021-2022 the original author or authors.
+ * Copyright 2021-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.
@@ -38,12 +38,13 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.event.ContextClosedEvent;
 import org.springframework.context.event.EventListener;
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.config.UserConfigPathProvider;
 import org.springframework.util.StringUtils;
 
 /**
  * @author Piotr Olaszewski
+ * @author Mahmoud Ben Hassine
  */
 @AutoConfiguration
 @EnableConfigurationProperties(SpringShellProperties.class)
@@ -57,7 +58,7 @@ public class LineReaderAutoConfiguration {
 
 	private Parser parser;
 
-	private CommandCatalog commandRegistry;
+	private CommandRegistry commandRegistry;
 
 	private org.jline.reader.History jLineHistory;
 
@@ -68,8 +69,8 @@ public class LineReaderAutoConfiguration {
 	private UserConfigPathProvider userConfigPathProvider;
 
 	public LineReaderAutoConfiguration(Terminal terminal, Completer completer, Parser parser,
-			CommandCatalog commandRegistry, org.jline.reader.History jLineHistory,
-			SpringShellProperties springShellProperties, UserConfigPathProvider userConfigPathProvider) {
+									   CommandRegistry commandRegistry, org.jline.reader.History jLineHistory,
+									   SpringShellProperties springShellProperties, UserConfigPathProvider userConfigPathProvider) {
 		this.terminal = terminal;
 		this.completer = completer;
 		this.parser = parser;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2024 the original author or authors.
+ * Copyright 2017-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.
@@ -30,7 +30,7 @@
 import org.springframework.shell.core.ResultHandler;
 import org.springframework.shell.core.ResultHandlerService;
 import org.springframework.shell.core.Shell;
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.config.ShellConversionServiceSupplier;
 import org.springframework.shell.core.context.ShellContext;
 import org.springframework.shell.core.exit.ExitCodeMappings;
@@ -64,9 +64,9 @@ public ResultHandlerService resultHandlerService(Set<ResultHandler<?>> resultHan
 	}
 
 	@Bean
-	public Shell shell(ResultHandlerService resultHandlerService, CommandCatalog commandRegistry, Terminal terminal,
-			ShellConversionServiceSupplier shellConversionServiceSupplier, ShellContext shellContext,
-			ExitCodeMappings exitCodeMappings) {
+	public Shell shell(ResultHandlerService resultHandlerService, CommandRegistry commandRegistry, Terminal terminal,
+					   ShellConversionServiceSupplier shellConversionServiceSupplier, ShellContext shellContext,
+					   ExitCodeMappings exitCodeMappings) {
 		Shell shell = new Shell(resultHandlerService, commandRegistry, terminal, shellContext, exitCodeMappings);
 		shell.setConversionService(shellConversionServiceSupplier.get());
 		return shell;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2023 the original author or authors.
+ * Copyright 2017-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.
@@ -19,7 +19,7 @@
 import org.springframework.boot.LazyInitializationExcludeFilter;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.context.annotation.Bean;
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.standard.CommandValueProvider;
 import org.springframework.shell.standard.EnumValueProvider;
 import org.springframework.shell.standard.FileValueProvider;
@@ -29,12 +29,13 @@
  * Sets up all required beans for supporting the standard Shell API.
  *
  * @author Eric Bottard
+ * @author Mahmoud Ben Hassine
  */
 @AutoConfiguration
 public class StandardAPIAutoConfiguration {
 
 	@Bean
-	public ValueProvider commandValueProvider(CommandCatalog commandRegistry) {
+	public ValueProvider commandValueProvider(CommandRegistry commandRegistry) {
 		return new CommandValueProvider(commandRegistry);
 	}
 

spring-shell-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -3,7 +3,7 @@ org.springframework.shell.boot.ShellContextAutoConfiguration
 org.springframework.shell.boot.SpringShellAutoConfiguration
 org.springframework.shell.boot.ShellRunnerAutoConfiguration
 org.springframework.shell.boot.ApplicationRunnerAutoConfiguration
-org.springframework.shell.boot.CommandCatalogAutoConfiguration
+org.springframework.shell.boot.CommandRegistryAutoConfiguration
 org.springframework.shell.boot.LineReaderAutoConfiguration
 org.springframework.shell.boot.CompleterAutoConfiguration
 org.springframework.shell.boot.UserConfigAutoConfiguration

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

@@ -24,7 +24,7 @@
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.command.CommandRegistration;
 import org.springframework.shell.core.command.CommandResolver;
 import org.springframework.shell.core.command.CommandRegistration.Builder;
@@ -33,42 +33,42 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-class CommandCatalogAutoConfigurationTests {
+class CommandRegistryAutoConfigurationTests {
 
 	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
-			.withConfiguration(AutoConfigurations.of(CommandCatalogAutoConfiguration.class,
+			.withConfiguration(AutoConfigurations.of(CommandRegistryAutoConfiguration.class,
 					JLineShellAutoConfiguration.class, ShellContextAutoConfiguration.class));
 
 	@Test
-	void defaultCommandCatalog() {
-		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(CommandCatalog.class));
+	void defaultCommandRegistry() {
+		this.contextRunner.run((context) -> assertThat(context).hasSingleBean(CommandRegistry.class));
 	}
 
 	@Test
 	void testCommandResolvers() {
 		this.contextRunner.withUserConfiguration(CustomCommandResolverConfiguration.class)
 				.run((context) -> {
-					CommandCatalog commandCatalog = context.getBean(CommandCatalog.class);
-					assertThat(commandCatalog).extracting("resolvers").asInstanceOf(InstanceOfAssertFactories.LIST)
+					CommandRegistry commandRegistry = context.getBean(CommandRegistry.class);
+					assertThat(commandRegistry).extracting("resolvers").asInstanceOf(InstanceOfAssertFactories.LIST)
 							.hasSize(1);
 				});
 	}
 
 	@Test
-	void customCommandCatalog() {
-		this.contextRunner.withUserConfiguration(CustomCommandCatalogConfiguration.class)
+	void customCommandRegistry() {
+		this.contextRunner.withUserConfiguration(CustomCommandRegistryConfiguration.class)
 				.run((context) -> {
-					CommandCatalog commandCatalog = context.getBean(CommandCatalog.class);
-					assertThat(commandCatalog).isSameAs(CustomCommandCatalogConfiguration.testCommandCatalog);
+					CommandRegistry commandRegistry = context.getBean(CommandRegistry.class);
+					assertThat(commandRegistry).isSameAs(CustomCommandRegistryConfiguration.TEST_COMMAND_REGISTRY);
 				});
 	}
 
 	@Test
 	void registerCommandRegistration() {
 		this.contextRunner.withUserConfiguration(CustomCommandRegistrationConfiguration.class)
 				.run(context -> {
-					CommandCatalog commandCatalog = context.getBean(CommandCatalog.class);
-					assertThat(commandCatalog.getRegistrations().get("customcommand")).isNotNull();
+					CommandRegistry commandRegistry = context.getBean(CommandRegistry.class);
+					assertThat(commandRegistry.getRegistrations().get("customcommand")).isNotNull();
 				});
 	}
 
@@ -158,13 +158,13 @@ CommandResolver customCommandResolver() {
 	}
 
 	@Configuration
-	static class CustomCommandCatalogConfiguration {
+	static class CustomCommandRegistryConfiguration {
 
-		static final CommandCatalog testCommandCatalog = CommandCatalog.of();
+		static final CommandRegistry TEST_COMMAND_REGISTRY = CommandRegistry.of();
 
 		@Bean
-		CommandCatalog customCommandCatalog() {
-			return testCommandCatalog;
+		CommandRegistry customCommandRegistry() {
+			return TEST_COMMAND_REGISTRY;
 		}
 	}
 

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

@@ -29,7 +29,7 @@
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.config.UserConfigPathProvider;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -97,8 +97,8 @@ Parser mockParser() {
 		}
 
 		@Bean
-		CommandCatalog mockCommandCatalog() {
-			return mock(CommandCatalog.class);
+		CommandRegistry mockCommandRegistry() {
+			return mock(CommandRegistry.class);
 		}
 
 		@Bean

spring-shell-core/src/main/java/org/springframework/shell/core/MethodTargetRegistrar.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.
@@ -16,19 +16,20 @@
 
 package org.springframework.shell.core;
 
-import org.springframework.shell.core.command.CommandCatalog;
+import org.springframework.shell.core.command.CommandRegistry;
 
 /**
  * Strategy interface for registering commands.
  *
  * @author Eric Bottard
  * @author Camilo Gonzalez
+ * @author Mahmoud Ben Hassine
  */
 public interface MethodTargetRegistrar {
 
 	/**
 	 * Register mappings from {@literal <command keyword(s)>} to actual behavior.
 	 */
-	void register(CommandCatalog registry);
+	void register(CommandRegistry registry);
 
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2024 the original author or authors.
+ * Copyright 2017-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.
@@ -38,15 +38,10 @@
 import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.support.DefaultConversionService;
-import org.springframework.shell.core.command.CommandAlias;
-import org.springframework.shell.core.command.CommandCatalog;
-import org.springframework.shell.core.command.CommandExceptionResolver;
-import org.springframework.shell.core.command.CommandExecution;
+import org.springframework.shell.core.command.*;
+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.CommandHandlingResult;
-import org.springframework.shell.core.command.CommandOption;
-import org.springframework.shell.core.command.CommandRegistration;
 import org.springframework.shell.core.completion.CompletionResolver;
 import org.springframework.shell.core.context.InteractionMode;
 import org.springframework.shell.core.context.ShellContext;
@@ -60,6 +55,7 @@
  * @author Eric Bottard
  * @author Janne Valkealahti
  * @author Piotr Olaszewski
+ * @author Mahmoud Ben Hassine
  */
 public class Shell {
 
@@ -73,7 +69,7 @@ public class Shell {
 	public static final Object NO_INPUT = new Object();
 
 	private final Terminal terminal;
-	private final CommandCatalog commandRegistry;
+	private final CommandRegistry commandRegistry;
 	protected List<CompletionResolver> completionResolvers = new ArrayList<>();
 	private @Nullable CommandExecutionHandlerMethodArgumentResolvers argumentResolvers;
 	private ConversionService conversionService = new DefaultConversionService();
@@ -91,8 +87,8 @@ public class Shell {
 	private Validator validator = Utils.defaultValidator();
 	private List<CommandExceptionResolver> exceptionResolvers = new ArrayList<>();
 
-	public Shell(ResultHandlerService resultHandlerService, CommandCatalog commandRegistry, Terminal terminal,
-			ShellContext shellContext, ExitCodeMappings exitCodeMappings) {
+	public Shell(ResultHandlerService resultHandlerService, CommandRegistry commandRegistry, Terminal terminal,
+				 ShellContext shellContext, ExitCodeMappings exitCodeMappings) {
 		this.resultHandlerService = resultHandlerService;
 		this.commandRegistry = commandRegistry;
 		this.terminal = terminal;