Refactor

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

Author: piotrooo

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

@@ -1,8 +1,22 @@
 package org.springframework.shell.core.command;
 
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Function;
+import java.util.function.Supplier;
+
 import org.jspecify.annotations.Nullable;
+
 import org.springframework.core.ResolvableType;
 import org.springframework.shell.core.command.availability.Availability;
+import org.springframework.shell.core.command.metadata.CommandAlias;
+import org.springframework.shell.core.command.metadata.CommandExitCode;
+import org.springframework.shell.core.command.metadata.CommandHelpOptionInfo;
 import org.springframework.shell.core.command.metadata.CommandOption;
 import org.springframework.shell.core.command.metadata.CommandTarget;
 import org.springframework.shell.core.command.metadata.CommandTarget.TargetType;
@@ -12,45 +26,34 @@
 import org.springframework.util.Assert;
 import org.springframework.util.ObjectUtils;
 import org.springframework.util.ReflectionUtils;
-
-import java.lang.reflect.Method;
-import java.lang.reflect.Type;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-import java.util.function.Consumer;
-import java.util.function.Function;
-import java.util.function.Supplier;
-import java.util.stream.Collectors;
+import org.springframework.util.StringUtils;
+import static java.util.stream.Collectors.*;
 
 class DefaultCommand implements Command {
 
-	private String command;
-
-	private InteractionMode interactionMode;
+	private final String command;
 
-	private @Nullable String group;
+	private final InteractionMode interactionMode;
 
-	private boolean hidden;
+	private final @Nullable String group;
 
-	private @Nullable String description;
+	private final boolean hidden;
 
-	private Supplier<Availability> availability;
+	private final @Nullable String description;
 
-	private @Nullable List<CommandOption> options;
+	private final Supplier<Availability> availability;
 
-	private List<DefaultOptionSpec> optionSpecs;
+	private final List<CommandOption> options;
 
-	private DefaultTargetSpec targetSpec;
+	private final DefaultTargetSpec targetSpec;
 
-	private List<DefaultAliasSpec> aliasSpecs;
+	private final List<DefaultAliasSpec> aliasSpecs;
 
-	private @Nullable DefaultExitCodeSpec exitCodeSpec;
+	private final @Nullable DefaultExitCodeSpec exitCodeSpec;
 
-	private @Nullable DefaultErrorHandlingSpec errorHandlingSpec;
+	private final @Nullable DefaultErrorHandlingSpec errorHandlingSpec;
 
-	private @Nullable DefaultHelpOptionsSpec helpOptionsSpec;
+	private final @Nullable DefaultHelpOptionsSpec helpOptionsSpec;
 
 	private final @Nullable Function<String, String> defaultOptionNameModifier;
 
@@ -65,7 +68,7 @@ public DefaultCommand(String command, InteractionMode interactionMode, @Nullable
 		this.hidden = hidden;
 		this.description = description;
 		this.availability = availability;
-		this.optionSpecs = optionSpecs;
+		this.options = initOptions(optionSpecs);
 		this.targetSpec = targetSpec;
 		this.aliasSpecs = aliasSpecs;
 		this.exitCodeSpec = exitCodeSpec;
@@ -101,35 +104,11 @@ public boolean isHidden() {
 
 	@Override
 	public Availability getAvailability() {
-		return availability != null ? availability.get() : Availability.available();
+		return availability.get();
 	}
 
 	@Override
 	public List<CommandOption> getOptions() {
-		if (options != null) {
-			return options;
-		}
-		options = optionSpecs.stream().map(o -> {
-			String[] longNames = o.longNames;
-			String[] longNamesModified = new String[0];
-			Function<String, String> modifier = o.nameModifier != null ? o.nameModifier : defaultOptionNameModifier;
-			if (modifier != null) {
-				longNamesModified = Arrays.copyOf(longNames, longNames.length);
-				longNames = Arrays.stream(longNames).map(modifier).toArray(String[]::new);
-			}
-			return new CommandOption(longNames, longNamesModified, o.shortNames, o.description, o.type, o.required,
-					o.defaultValue, o.position, o.arityMin, o.arityMax, o.label, o.completion);
-		}).collect(Collectors.toList());
-
-		if (helpOptionsSpec != null) {
-			String[] longNames = helpOptionsSpec.longNames != null ? helpOptionsSpec.longNames : new String[0];
-			Character[] shortNames = helpOptionsSpec.shortNames != null ? helpOptionsSpec.shortNames : new Character[0];
-			String desc = "help for %s".formatted(command);
-			CommandOption commandOption = CommandOption.of(longNames, shortNames, desc,
-					ResolvableType.forType(void.class));
-			options.add(commandOption);
-		}
-
 		return options;
 	}
 
@@ -156,16 +135,19 @@ public CommandTarget getTarget() {
 
 	@Override
 	public List<CommandAlias> getAliases() {
-		return aliasSpecs.stream().map(spec -> CommandAlias.of(spec.commands, spec.group)).toList();
+		return aliasSpecs.stream()
+			.filter(spec -> StringUtils.hasText(spec.commands))
+			.map(spec -> new CommandAlias(spec.commands, spec.group))
+			.toList();
 	}
 
 	@Override
 	public CommandExitCode getExitCode() {
 		if (this.exitCodeSpec == null) {
-			return CommandExitCode.of();
+			return CommandExitCode.empty();
 		}
 		else {
-			return CommandExitCode.of(exitCodeSpec.functions);
+			return new CommandExitCode(exitCodeSpec.functions);
 		}
 	}
 
@@ -180,14 +162,39 @@ public List<CommandExceptionResolver> getExceptionResolvers() {
 	}
 
 	@Override
-	public HelpOptionInfo getHelpOption() {
+	public CommandHelpOptionInfo getHelpOption() {
 		if (this.helpOptionsSpec == null) {
-			return HelpOptionInfo.of();
+			return CommandHelpOptionInfo.empty();
 		}
 		else {
-			return HelpOptionInfo.of(helpOptionsSpec.enabled, helpOptionsSpec.longNames, helpOptionsSpec.shortNames,
-					helpOptionsSpec.command);
+			return new CommandHelpOptionInfo(helpOptionsSpec.enabled, helpOptionsSpec.longNames,
+					helpOptionsSpec.shortNames, helpOptionsSpec.command);
+		}
+	}
+
+	private List<CommandOption> initOptions(List<DefaultOptionSpec> optionSpecs) {
+		List<CommandOption> commandOptions = optionSpecs.stream().map(o -> {
+			String[] longNames = o.longNames;
+			String[] longNamesModified = new String[0];
+			Function<String, String> modifier = o.nameModifier != null ? o.nameModifier : defaultOptionNameModifier;
+			if (modifier != null) {
+				longNamesModified = Arrays.copyOf(longNames, longNames.length);
+				longNames = Arrays.stream(longNames).map(modifier).toArray(String[]::new);
+			}
+			return new CommandOption(longNames, longNamesModified, o.shortNames, o.description, o.type, o.required,
+					o.defaultValue, o.position, o.arityMin, o.arityMax, o.label, o.completion);
+		}).collect(toList());
+
+		if (helpOptionsSpec != null) {
+			String[] longNames = helpOptionsSpec.longNames != null ? helpOptionsSpec.longNames : new String[0];
+			Character[] shortNames = helpOptionsSpec.shortNames != null ? helpOptionsSpec.shortNames : new Character[0];
+			String desc = "help for %s".formatted(command);
+			CommandOption commandOption = CommandOption.of(longNames, shortNames, desc,
+					ResolvableType.forType(void.class));
+			commandOptions.add(commandOption);
 		}
+
+		return commandOptions;
 	}
 
 	static class DefaultOptionSpec implements OptionSpec {

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

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2022-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.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.shell.core.command.metadata;
+
+import org.jspecify.annotations.Nullable;
+
+/**
+ * Represents a command alias.
+ *
+ * @author Janne Valkealahti
+ * @author Piotr Olaszewski
+ */
+public record CommandAlias(String command, @Nullable String group) {
+}