#95 - Add support for supplying qualifer name bean via withBean() - withBean(name, type, suppliedImplementation)

Author: rbygrave

inject-generator/src/main/java/io/avaje/inject/generator/BeanReader.java

@@ -358,6 +358,9 @@ boolean isExtraInjectionRequired() {
 
   void buildAddFor(Append writer) {
     writer.append("    if (builder.isAddBeanFor(");
+    if (name != null) {
+      writer.append("\"%s\", ", name);
+    }
     if (addForType != null) {
       writer.append(addForType).append(".class, ");
     }

inject-generator/src/main/java/io/avaje/inject/generator/MethodReader.java

@@ -177,8 +177,10 @@ void addImports(Set<String> importTypes) {
   }
 
   void buildAddFor(Append writer) {
-
     writer.append("    if (builder.isAddBeanFor(");
+    if (name != null) {
+      writer.append("\"%s\", ", name);
+    }
     if (addForType != null) {
       writer.append(addForType).append(".class, ");
     }

inject-test/src/test/java/org/example/coffee/qualifier/StoreManagerWithSetterQualifierTest.java

@@ -15,4 +15,31 @@ void redStore() {
       assertThat(manager.greenStore()).isEqualTo("green");
     }
   }
+
+  @Test
+  void namedTestDouble() {
+    try (BeanContext context = BeanContext.newBuilder()
+      .withBean("Blue", SomeStore.class, () -> "TD Blue")
+      .withBean("Green", SomeStore.class, () -> "TD Green")
+      .build()) {
+
+      StoreManagerWithSetterQualifier manager = context.getBean(StoreManagerWithSetterQualifier.class);
+      assertThat(manager.blueStore()).isEqualTo("TD Blue");
+      assertThat(manager.greenStore()).isEqualTo("TD Green");
+    }
+  }
+
+  @Test
+  void namedTestDouble_expect_otherNamedStillWired() {
+    try (BeanContext context = BeanContext.newBuilder()
+      .withBean("Blue", SomeStore.class, () -> "TD Blue Only")
+      // with GreenStore still wired
+      .build()) {
+
+      StoreManagerWithSetterQualifier manager = context.getBean(StoreManagerWithSetterQualifier.class);
+      assertThat(manager.blueStore()).isEqualTo("TD Blue Only");
+      assertThat(manager.greenStore()).isEqualTo("green");
+    }
+  }
+
 }

inject/src/main/java/io/avaje/inject/BeanContextBuilder.java

@@ -168,6 +168,15 @@ public interface BeanContextBuilder {
    */
   <D> BeanContextBuilder withBean(Class<D> type, D bean);
 
+  /**
+   * Add a supplied bean instance with the given name and injection type.
+   *
+   * @param name The name qualifier
+   * @param type The dependency injection type this bean is target for
+   * @param bean The supplied bean instance to use (typically a test mock)
+   */
+  <D> BeanContextBuilder withBean(String name, Class<D> type, D bean);
+
   /**
    * Use a mockito mock when injecting this bean type.
    *

inject/src/main/java/io/avaje/inject/DBeanContextBuilder.java

@@ -67,14 +67,19 @@ public BeanContextBuilder withIgnoreMissingModuleDependencies() {
   @SuppressWarnings({"unchecked", "rawtypes"})
   public BeanContextBuilder withBeans(Object... beans) {
     for (Object bean : beans) {
-      suppliedBeans.add(new SuppliedBean(suppliedType(bean.getClass()), bean));
+      suppliedBeans.add(new SuppliedBean(null, suppliedType(bean.getClass()), bean));
     }
     return this;
   }
 
   @Override
-  public <D> DBeanContextBuilder withBean(Class<D> type, D bean) {
-    suppliedBeans.add(new SuppliedBean<>(type, bean));
+  public <D> BeanContextBuilder withBean(Class<D> type, D bean) {
+    return withBean(null, type, bean);
+  }
+
+  @Override
+  public <D> BeanContextBuilder withBean(String name, Class<D> type, D bean) {
+    suppliedBeans.add(new SuppliedBean<>(name, type, bean));
     return this;
   }
 
@@ -85,7 +90,7 @@ public BeanContextBuilder withMock(Class<?> type) {
 
   @Override
   public <D> DBeanContextBuilder withMock(Class<D> type, Consumer<D> consumer) {
-    suppliedBeans.add(new SuppliedBean<>(type, null, consumer));
+    suppliedBeans.add(new SuppliedBean<>(null, type, null, consumer));
     return this;
   }
 

inject/src/main/java/io/avaje/inject/spi/Builder.java

@@ -63,7 +63,7 @@ static Builder newBuilder(String name, String[] provides, String[] dependsOn) {
   /**
    * Return true if the bean should be created and registered with the context.
    * <p/>
-   * Returning false means there has been a (test double) bean already registered and
+   * Returning false means there has been a supplied bean already registered and
    * that we should skip the creation and registration for this bean.
    *
    * @param addForType   The interface that the bean implements and provides
@@ -74,13 +74,36 @@ static Builder newBuilder(String name, String[] provides, String[] dependsOn) {
   /**
    * Return true if the bean should be created and registered with the context.
    * <p/>
-   * Returning false means there has been a (test double) bean already registered and
+   * Returning false means there has been a supplied bean already registered and
+   * that we should skip the creation and registration for this bean.
+   *
+   * @param name         The qualifier name
+   * @param addForType   The interface that the bean implements and provides
+   * @param injectTarget The actual bean type we are looking to create and register
+   */
+  boolean isAddBeanFor(String name, Class<?> addForType, Class<?> injectTarget);
+
+  /**
+   * Return true if the bean should be created and registered with the context.
+   * <p/>
+   * Returning false means there has been a supplied bean already registered and
    * that we should skip the creation and registration for this bean.
    *
    * @param injectTarget The actual bean type we are looking to create and register
    */
   boolean isAddBeanFor(Class<?> injectTarget);
 
+  /**
+   * Return true if the bean should be created and registered with the context.
+   * <p/>
+   * Returning false means there has been a supplied bean already registered and
+   * that we should skip the creation and registration for this bean.
+   *
+   * @param name         The qualifier name
+   * @param injectTarget The actual bean type we are looking to create and register
+   */
+  boolean isAddBeanFor(String name, Class<?> injectTarget);
+
   /**
    * Register the bean instance into the context.
    * <p>

inject/src/main/java/io/avaje/inject/spi/DBeanMap.java

@@ -39,10 +39,7 @@ void add(List<SuppliedBean> suppliedBeans) {
   @SuppressWarnings("rawtypes")
   private void addSuppliedBean(SuppliedBean supplied) {
     Class<?> suppliedType = supplied.getType();
-    Named annotation = suppliedType.getAnnotation(Named.class);
-    String name = (annotation == null) ? null : annotation.value();
-
-    DContextEntryBean entryBean = DContextEntryBean.of(supplied.getBean(), name, SUPPLIED);
+    DContextEntryBean entryBean = DContextEntryBean.of(supplied.getBean(), supplied.name(), SUPPLIED);
     beans.computeIfAbsent(suppliedType.getCanonicalName(), s -> new DContextEntry()).add(entryBean);
     for (Class<?> anInterface : suppliedType.getInterfaces()) {
       beans.computeIfAbsent(anInterface.getCanonicalName(), s -> new DContextEntry()).add(entryBean);
@@ -93,8 +90,8 @@ void addAll(Class type, List list) {
   /**
    * Return true if there is a supplied bean for this type.
    */
-  boolean isSupplied(String canonicalName) {
+  boolean isSupplied(String canonicalName, String qualifierName) {
     DContextEntry entry = beans.get(canonicalName);
-    return entry != null && entry.isSupplied();
+    return entry != null && entry.isSupplied(qualifierName);
   }
 }

inject/src/main/java/io/avaje/inject/spi/DBuilder.java

@@ -103,18 +103,28 @@ public void setParent(Builder parent) {
 
   @Override
   public boolean isAddBeanFor(Class<?> addForType, Class<?> injectTarget) {
+    return isAddBeanFor(null, addForType, injectTarget);
+  }
+
+  @Override
+  public boolean isAddBeanFor(String name, Class<?> addForType, Class<?> injectTarget) {
     if (parent == null) {
       return true;
     }
     this.injectTarget = injectTarget;
-    return parent.isAddBeanFor(addForType);
+    return parent.isAddBeanFor(name, addForType, injectTarget);
   }
 
   @Override
   public boolean isAddBeanFor(Class<?> injectTarget) {
     return isAddBeanFor(injectTarget, injectTarget);
   }
 
+  @Override
+  public boolean isAddBeanFor(String name, Class<?> injectTarget) {
+    return isAddBeanFor(name, injectTarget, injectTarget);
+  }
+
   @Override
   public <T> Set<T> getSet(Class<T> interfaceType) {
     return new LinkedHashSet<>(getList(interfaceType));

inject/src/main/java/io/avaje/inject/spi/DBuilderExtn.java

@@ -28,13 +28,18 @@ class DBuilderExtn extends DBuilder {
     }
   }
 
+  @Override
+  public boolean isAddBeanFor(Class<?> addForType, Class<?> injectTarget) {
+    return isAddBeanFor(null, addForType, injectTarget);
+  }
+
   /**
    * Checking for supplied beans (mocks).
    */
   @Override
-  public boolean isAddBeanFor(Class<?> addForType, Class<?> injectTarget) {
+  public boolean isAddBeanFor(String qualifierName, Class<?> addForType, Class<?> injectTarget) {
     if (hasSuppliedBeans) {
-      return !beanMap.isSupplied(addForType.getCanonicalName());
+      return !beanMap.isSupplied(addForType.getCanonicalName(), qualifierName);
     }
     return true;
   }

inject/src/main/java/io/avaje/inject/spi/DContextEntry.java

@@ -45,9 +45,9 @@ void add(DContextEntryBean entryBean) {
   /**
    * Return true if a supplied bean is one of the entries.
    */
-  boolean isSupplied() {
+  boolean isSupplied(String qualifierName) {
     for (DContextEntryBean entry : entries) {
-      if (entry.isSupplied()) {
+      if (entry.isSupplied(qualifierName)) {
         return true;
       }
     }

inject/src/main/java/io/avaje/inject/spi/DContextEntryBean.java

@@ -58,8 +58,8 @@ boolean isSecondary() {
     return flag == BeanEntry.SECONDARY;
   }
 
-  boolean isSupplied() {
-    return flag == BeanEntry.SUPPLIED;
+  boolean isSupplied(String qualifierName) {
+    return flag == BeanEntry.SUPPLIED && (qualifierName == null || qualifierName.equals(this.name));
   }
 
   @SuppressWarnings({"unchecked", "rawtypes"})

inject/src/main/java/io/avaje/inject/spi/SuppliedBean.java

@@ -2,6 +2,7 @@
 
 import org.mockito.Mockito;
 
+import javax.inject.Named;
 import java.util.function.Consumer;
 
 /**
@@ -14,6 +15,8 @@
  */
 public class SuppliedBean<B> {
 
+  private final String name;
+
   private final Class<B> type;
 
   private final Consumer<B> consumer;
@@ -23,14 +26,15 @@ public class SuppliedBean<B> {
   /**
    * Create with a given target type and bean instance.
    */
-  public SuppliedBean(Class<B> type, B bean) {
-    this(type, bean, null);
+  public SuppliedBean(String name, Class<B> type, B bean) {
+    this(name, type, bean, null);
   }
 
   /**
    * Create with a consumer to setup the mock.
    */
-  public SuppliedBean(Class<B> type, B bean, Consumer<B> consumer) {
+  public SuppliedBean(String name, Class<B> type, B bean, Consumer<B> consumer) {
+    this.name = name;
     this.type = type;
     this.bean = bean;
     this.consumer = consumer;
@@ -56,4 +60,15 @@ public B getBean() {
     }
     return bean;
   }
+
+  /**
+   * Return the qualifier name of the supplied bean.
+   */
+  public String name() {
+    if (name != null) {
+      return name;
+    }
+    Named annotation = type.getAnnotation(Named.class);
+    return (annotation == null) ? null : annotation.value();
+  }
 }