Refine #1329

Extract method profile checking utility in Utils class

Author: fmbenhassine

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

@@ -26,18 +26,17 @@
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Profile;
 import org.springframework.core.MethodIntrospector;
 import org.springframework.core.annotation.AnnotatedElementUtils;
-import org.springframework.core.env.Environment;
-import org.springframework.core.env.Profiles;
 import org.springframework.shell.core.command.Command;
 import org.springframework.shell.core.command.CommandRegistry;
 import org.springframework.shell.core.command.annotation.support.CommandFactoryBean;
 import org.springframework.shell.core.utils.Utils;
 import org.springframework.stereotype.Component;
 import org.springframework.util.ReflectionUtils;
 
+import static org.springframework.shell.core.utils.Utils.isProfileActive;
+
 @AutoConfiguration
 public class CommandRegistryAutoConfiguration {
 
@@ -79,9 +78,4 @@ private void registerAnnotatedCommands(ApplicationContext applicationContext, Co
 		}
 	}
 
-	private boolean isProfileActive(Method method, Environment environment) {
-		Profile profile = AnnotatedElementUtils.findMergedAnnotation(method, Profile.class);
-		return profile == null || environment.acceptsProfiles(Profiles.of(profile.value()));
-	}
-
 }

spring-shell-core/src/main/java/org/springframework/shell/core/command/annotation/support/EnableCommandRegistrar.java

@@ -24,11 +24,9 @@
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
-import org.springframework.context.annotation.Profile;
 import org.springframework.core.MethodIntrospector;
 import org.springframework.core.annotation.AnnotatedElementUtils;
 import org.springframework.core.env.Environment;
-import org.springframework.core.env.Profiles;
 import org.springframework.core.type.AnnotationMetadata;
 import org.springframework.shell.core.ConsoleInputProvider;
 import org.springframework.shell.core.SystemShellRunner;
@@ -37,6 +35,8 @@
 import org.springframework.shell.core.command.annotation.EnableCommand;
 import org.springframework.util.ReflectionUtils;
 
+import static org.springframework.shell.core.utils.Utils.isProfileActive;
+
 /**
  * {@link ImportBeanDefinitionRegistrar} for {@link EnableCommand @EnableCommands}.
  *
@@ -108,7 +108,7 @@ private void registerCommands(Class<?> candidateClass, BeanDefinitionRegistry re
 
 	private void registerAnnotatedMethods(Class<?> candidateClass, BeanDefinitionRegistry registry) {
 		ReflectionUtils.MethodFilter filter = method -> AnnotatedElementUtils.hasAnnotation(method, Command.class)
-				&& isProfileActive(method);
+				&& isProfileActive(method, this.environment);
 		Set<Method> methods = MethodIntrospector.selectMethods(candidateClass, filter);
 		for (Method method : methods) {
 			BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder
@@ -118,9 +118,4 @@ private void registerAnnotatedMethods(Class<?> candidateClass, BeanDefinitionReg
 		}
 	}
 
-	private boolean isProfileActive(Method method) {
-		Profile profile = AnnotatedElementUtils.findMergedAnnotation(method, Profile.class);
-		return profile == null || environment.acceptsProfiles(Profiles.of(profile.value()));
-	}
-
 }

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

@@ -16,6 +16,7 @@
 
 package org.springframework.shell.core.utils;
 
+import java.lang.reflect.Method;
 import java.util.Comparator;
 import java.util.HashSet;
 import java.util.List;
@@ -25,6 +26,10 @@
 import jakarta.validation.Validator;
 import jakarta.validation.ValidatorFactory;
 
+import org.springframework.context.annotation.Profile;
+import org.springframework.core.annotation.AnnotatedElementUtils;
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.Profiles;
 import org.springframework.shell.core.command.AbstractCommand;
 import org.springframework.shell.core.command.Command;
 import org.springframework.shell.core.command.CommandContext;
@@ -41,6 +46,19 @@
  */
 public class Utils {
 
+	/**
+	 * Check if a method is annotated with an active {@link Profile} in the given
+	 * environment.
+	 * @param method the method to check
+	 * @param environment the environment
+	 * @return true if the method has an active profile, false otherwise
+	 * @since 4.0.2
+	 */
+	public static boolean isProfileActive(Method method, Environment environment) {
+		Profile profile = AnnotatedElementUtils.findMergedAnnotation(method, Profile.class);
+		return profile == null || environment.acceptsProfiles(Profiles.of(profile.value()));
+	}
+
 	/**
 	 * Split a CamelCase class name into separate words. Used to derive command group
 	 * names. For example, "MyCommands" becomes "My Commands".