Add register and select ArbitraryBuilder by name

fixture-monkey/src/main/java/com/navercorp/fixturemonkey/ArbitraryBuilder.java

@@ -112,6 +112,14 @@ public interface ArbitraryBuilder<T> {
 	 */
 	ArbitraryBuilder<T> set(@Nullable Object value);
 
+	/**
+	 * Set the {@link ArbitraryBuilder} sampling given {@code names}.
+	 *
+	 * @param names An array of names to select and register their corresponding ArbitraryBuilders.
+	 * @return an {@link ArbitraryBuilder} with the selected properties.
+	 */
+	ArbitraryBuilder<T> selectName(String... names);
+
 	/**
 	 * Apply one or more manipulations defined in {@link InnerSpec}.
 	 *

fixture-monkey/src/main/java/com/navercorp/fixturemonkey/FixtureMonkey.java

@@ -21,7 +21,9 @@
 import static java.util.stream.Collectors.toList;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Function;
 import java.util.stream.Stream;
 
@@ -53,21 +55,26 @@ public final class FixtureMonkey {
 	private final MonkeyContext monkeyContext;
 	private final List<MatcherOperator<? extends ArbitraryBuilder<?>>> registeredArbitraryBuilders = new ArrayList<>();
 	private final MonkeyManipulatorFactory monkeyManipulatorFactory;
+	private final Map<String, MatcherOperator<? extends ArbitraryBuilder<?>>>
+		namedArbitraryBuilderMap = new HashMap<>();
 
 	public FixtureMonkey(
 		FixtureMonkeyOptions fixtureMonkeyOptions,
 		ArbitraryTraverser traverser,
 		ManipulatorOptimizer manipulatorOptimizer,
 		MonkeyContext monkeyContext,
 		List<MatcherOperator<Function<FixtureMonkey, ? extends ArbitraryBuilder<?>>>> registeredArbitraryBuilders,
-		MonkeyManipulatorFactory monkeyManipulatorFactory
+		MonkeyManipulatorFactory monkeyManipulatorFactory,
+		Map<String, MatcherOperator<Function<FixtureMonkey, ? extends ArbitraryBuilder<?>>>>
+			matcherOperatorMapsByRegisteredName
 	) {
 		this.fixtureMonkeyOptions = fixtureMonkeyOptions;
 		this.traverser = traverser;
 		this.manipulatorOptimizer = manipulatorOptimizer;
 		this.monkeyContext = monkeyContext;
 		this.monkeyManipulatorFactory = monkeyManipulatorFactory;
 		initializeRegisteredArbitraryBuilders(registeredArbitraryBuilders);
+		initializeNamedArbitraryBuilderMap(matcherOperatorMapsByRegisteredName);
 	}
 
 	public static FixtureMonkeyBuilder builder() {
@@ -111,7 +118,8 @@ public <T> ArbitraryBuilder<T> giveMeBuilder(TypeReference<T> type) {
 			builderContext.copy(),
 			registeredArbitraryBuilders,
 			monkeyContext,
-			fixtureMonkeyOptions.getInstantiatorProcessor()
+			fixtureMonkeyOptions.getInstantiatorProcessor(),
+			namedArbitraryBuilderMap
 		);
 	}
 
@@ -138,7 +146,8 @@ public <T> ArbitraryBuilder<T> giveMeBuilder(T value) {
 			context,
 			registeredArbitraryBuilders,
 			monkeyContext,
-			fixtureMonkeyOptions.getInstantiatorProcessor()
+			fixtureMonkeyOptions.getInstantiatorProcessor(),
+			namedArbitraryBuilderMap
 		);
 	}
 
@@ -194,4 +203,15 @@ private void initializeRegisteredArbitraryBuilders(
 			this.registeredArbitraryBuilders.add(generatedRegisteredArbitraryBuilder.get(i));
 		}
 	}
+
+	private void initializeNamedArbitraryBuilderMap(
+		Map<String, MatcherOperator<Function<FixtureMonkey, ? extends ArbitraryBuilder<?>>>>
+			matcherOperatorMapsByRegisteredName
+	) {
+		matcherOperatorMapsByRegisteredName.forEach((name, matcherOperator) -> {
+			MatcherOperator<? extends ArbitraryBuilder<?>> newMatcherOperator =
+				new MatcherOperator<>(matcherOperator.getMatcher(), matcherOperator.getOperator().apply(this));
+			namedArbitraryBuilderMap.put(name, newMatcherOperator);
+		});
+	}
 }

fixture-monkey/src/main/java/com/navercorp/fixturemonkey/FixtureMonkeyBuilder.java

@@ -22,7 +22,9 @@
 import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.function.Function;
 import java.util.function.UnaryOperator;
@@ -76,6 +78,8 @@ public final class FixtureMonkeyBuilder {
 	private ManipulatorOptimizer manipulatorOptimizer = new NoneManipulatorOptimizer();
 	private MonkeyExpressionFactory monkeyExpressionFactory = new ArbitraryExpressionFactory();
 	private final MonkeyContextBuilder monkeyContextBuilder = MonkeyContext.builder();
+	private final Map<String, MatcherOperator<Function<FixtureMonkey, ? extends ArbitraryBuilder<?>>>>
+		registeredArbitraryListByRegisteredName = new HashMap<>();
 	private long seed = System.nanoTime();
 
 	// The default plugins are listed below.
@@ -381,6 +385,21 @@ public FixtureMonkeyBuilder registerGroup(ArbitraryBuilderGroup... arbitraryBuil
 		return this;
 	}
 
+	public FixtureMonkeyBuilder registeredName(
+		String arbitraryName,
+		Class<?> type,
+		Function<FixtureMonkey, ? extends ArbitraryBuilder<?>> arbitraryBuilder
+	) {
+		if (registeredArbitraryListByRegisteredName.containsKey(arbitraryName)) {
+			throw new IllegalArgumentException("Duplicated ArbitraryBuilder name: " + arbitraryName);
+		}
+		MatcherOperator<Function<FixtureMonkey, ? extends ArbitraryBuilder<?>>> matcherOperator =
+			MatcherOperator.assignableTypeMatchOperator(type, arbitraryBuilder);
+
+		this.registeredArbitraryListByRegisteredName.put(arbitraryName, matcherOperator);
+		return this;
+	}
+
 	public FixtureMonkeyBuilder plugin(Plugin plugin) {
 		if (plugin instanceof InterfacePlugin) { // TODO: Added for backward compatibility. It will be removed in 1.1.0
 			this.defaultInterfacePlugin = (InterfacePlugin)plugin;
@@ -552,7 +571,8 @@ public FixtureMonkey build() {
 			manipulatorOptimizer,
 			monkeyContext,
 			registeredArbitraryBuilders,
-			monkeyManipulatorFactory
+			monkeyManipulatorFactory,
+			registeredArbitraryListByRegisteredName
 		);
 	}
 }

fixture-monkey/src/main/java/com/navercorp/fixturemonkey/resolver/ArbitraryResolver.java

@@ -18,6 +18,7 @@
 
 package com.navercorp.fixturemonkey.resolver;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -67,14 +68,19 @@ public ArbitraryResolver(
 
 	public CombinableArbitrary<?> resolve(
 		RootProperty rootProperty,
-		ArbitraryBuilderContext builderContext
+		ArbitraryBuilderContext builderContext,
+		List<MatcherOperator<? extends ArbitraryBuilder<?>>> selectedArbitraryBuilders
 	) {
+		List<MatcherOperator<? extends ArbitraryBuilder<?>>> registeredArbitraryBuildersCopy =
+			new ArrayList<>(registeredArbitraryBuilders);
+		registeredArbitraryBuildersCopy.addAll(selectedArbitraryBuilders);
+
 		List<ArbitraryManipulator> manipulators = builderContext.getManipulators();
 		List<ContainerInfoManipulator> containerInfoManipulators = builderContext.getContainerInfoManipulators();
 		Map<Class<?>, List<Property>> propertyConfigurers = builderContext.getPropertyConfigurers();
 
 		List<MatcherOperator<List<ContainerInfoManipulator>>> registeredContainerInfoManipulators =
-			registeredArbitraryBuilders.stream()
+			registeredArbitraryBuildersCopy.stream()
 				.map(it -> new MatcherOperator<>(
 					it.getMatcher(),
 					((DefaultArbitraryBuilder<?>)it.getOperator()).getContext().getContainerInfoManipulators()
@@ -102,7 +108,7 @@ public CombinableArbitrary<?> resolve(
 			objectTree -> {
 				List<ArbitraryManipulator> registeredManipulators =
 					monkeyManipulatorFactory.newRegisteredArbitraryManipulators(
-						registeredArbitraryBuilders,
+						registeredArbitraryBuildersCopy,
 						objectTree.getMetadata().getNodesByProperty()
 					);
 

fixture-monkey/src/main/java/com/navercorp/fixturemonkey/resolver/DefaultArbitraryBuilder.java

@@ -28,6 +28,7 @@
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 import java.util.function.BiConsumer;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
@@ -85,6 +86,8 @@ public final class DefaultArbitraryBuilder<T> implements ArbitraryBuilder<T>, Ex
 	private final List<MatcherOperator<? extends ArbitraryBuilder<?>>> registeredArbitraryBuilders;
 	private final MonkeyContext monkeyContext;
 	private final InstantiatorProcessor instantiatorProcessor;
+	private final Map<String, MatcherOperator<? extends ArbitraryBuilder<?>>> namedArbitraryBuilderMap;
+	private final List<MatcherOperator<? extends ArbitraryBuilder<?>>> selectedArbitraryBuilders = new ArrayList<>();
 
 	public DefaultArbitraryBuilder(
 		FixtureMonkeyOptions fixtureMonkeyOptions,
@@ -95,7 +98,8 @@ public DefaultArbitraryBuilder(
 		ArbitraryBuilderContext context,
 		List<MatcherOperator<? extends ArbitraryBuilder<?>>> registeredArbitraryBuilders,
 		MonkeyContext monkeyContext,
-		InstantiatorProcessor instantiatorProcessor
+		InstantiatorProcessor instantiatorProcessor,
+		Map<String, MatcherOperator<? extends ArbitraryBuilder<?>>> arbitraryBuilderMapsByRegisteredName
 	) {
 		this.fixtureMonkeyOptions = fixtureMonkeyOptions;
 		this.rootProperty = rootProperty;
@@ -106,6 +110,7 @@ public DefaultArbitraryBuilder(
 		this.registeredArbitraryBuilders = registeredArbitraryBuilders;
 		this.monkeyContext = monkeyContext;
 		this.instantiatorProcessor = instantiatorProcessor;
+		this.namedArbitraryBuilderMap = arbitraryBuilderMapsByRegisteredName;
 	}
 
 	@Override
@@ -178,6 +183,19 @@ public ArbitraryBuilder<T> setLazy(PropertySelector propertySelector, Supplier<?
 		);
 	}
 
+	@Override
+	public ArbitraryBuilder<T> selectName(String... names) {
+		for (String name : names) {
+			MatcherOperator<? extends ArbitraryBuilder<?>> namedArbitraryBuilder = namedArbitraryBuilderMap.get(name);
+
+			if (namedArbitraryBuilder == null) {
+				throw new IllegalArgumentException("Given name is not registered. name: " + name);
+			}
+			selectedArbitraryBuilders.add(namedArbitraryBuilder);
+		}
+		return this;
+	}
+
 	@Override
 	public ArbitraryBuilder<T> setInner(InnerSpec innerSpec) {
 		ManipulatorSet manipulatorSet = innerSpec.getManipulatorSet(monkeyManipulatorFactory);
@@ -510,7 +528,8 @@ public ArbitraryBuilder<T> copy() {
 			context.copy(),
 			registeredArbitraryBuilders,
 			monkeyContext,
-			instantiatorProcessor
+			instantiatorProcessor,
+			namedArbitraryBuilderMap
 		);
 	}
 
@@ -523,7 +542,8 @@ private CombinableArbitrary<?> resolveArbitrary(ArbitraryBuilderContext context)
 			if (context.getFixedCombinableArbitrary() == null || context.fixedExpired()) {
 				Object fixed = resolver.resolve(
 						rootProperty,
-						context
+						context,
+						selectedArbitraryBuilders
 					)
 					.combined();
 				context.addManipulator(monkeyManipulatorFactory.newArbitraryManipulator("$", fixed));
@@ -534,7 +554,8 @@ private CombinableArbitrary<?> resolveArbitrary(ArbitraryBuilderContext context)
 
 		return resolver.resolve(
 			rootProperty,
-			context
+			context,
+			selectedArbitraryBuilders
 		);
 	}
 
@@ -560,7 +581,8 @@ private <R> DefaultArbitraryBuilder<R> generateArbitraryBuilderLazily(LazyArbitr
 			context,
 			registeredArbitraryBuilders,
 			monkeyContext,
-			instantiatorProcessor
+			instantiatorProcessor,
+			namedArbitraryBuilderMap
 		);
 	}
 

fixture-monkey/src/test/java/com/navercorp/fixturemonkey/test/FixtureMonkeyOptionsTest.java

@@ -800,6 +800,121 @@ void registerBuilderGroup() {
 		then(actual3).isEqualTo(ChildBuilderGroup.FIXED_INT_VALUE);
 	}
 
+	@Property
+	void registeredName() {
+		FixtureMonkey sut = FixtureMonkey.builder()
+			.register(Integer.class, monkey -> monkey.giveMeBuilder(1))
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test")
+			)
+			.registeredName(
+				"test2",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test2")
+			)
+			.build();
+
+		SimpleObject actual = sut.giveMeBuilder(SimpleObject.class)
+			.selectName("test")
+			.sample();
+
+		then(actual.getStr()).isEqualTo("test");
+		then(actual.getWrapperInteger()).isEqualTo(Integer.valueOf(1));
+	}
+
+	@Property
+	void registeredNameWithSameNameThrows() {
+		thenThrownBy(() -> FixtureMonkey.builder()
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test")
+			)
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test2")
+			)
+			.build()
+		).isExactlyInstanceOf(IllegalArgumentException.class)
+			.hasMessage("Duplicated ArbitraryBuilder name: test");
+	}
+
+	@Property
+	void registeredNameWithUnregisteredName() {
+		FixtureMonkey sut = FixtureMonkey.builder()
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test")
+			)
+			.registeredName(
+				"test2",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test2")
+			)
+			.build();
+
+		thenThrownBy(() -> sut.giveMeBuilder(SimpleObject.class)
+			.selectName("test3")
+			.sample()
+		).isExactlyInstanceOf(IllegalArgumentException.class)
+			.hasMessage("Given name is not registered. name: test3");
+	}
+
+	@Property
+	void selectedArbitraryBuilderCannotBeReused() {
+		FixtureMonkey sut = FixtureMonkey.builder()
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test")
+			)
+			.registeredName(
+				"test2",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test2")
+			)
+			.build();
+
+		String actual = sut.giveMeBuilder(SimpleObject.class)
+			.selectName("test")
+			.sample()
+			.getStr();
+
+		String actual2 = sut.giveMeBuilder(SimpleObject.class)
+			.selectName("test2")
+			.sample()
+			.getStr();
+
+		then(actual2).isEqualTo("test2");
+	}
+
+	@Property
+	void generateSampleListWithRegisteredNames() {
+		FixtureMonkey sut = FixtureMonkey.builder()
+			.registeredName(
+				"test",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test")
+			)
+			.registeredName(
+				"test2",
+				String.class,
+				monkey -> monkey.giveMeBuilder("test2")
+			)
+			.build();
+
+		List<SimpleObject> actual = sut.giveMeBuilder(SimpleObject.class)
+			.selectName("test")
+			.sampleList(3);
+
+		then(actual).hasSize(3);
+		then(actual).allMatch(it -> it.getStr().equals("test"));
+	}
+
 	@Property
 	void registerSameInstancesTwiceWorksLast() {
 		FixtureMonkey sut = FixtureMonkey.builder()