Merge pull request iluwatar#569 from kapinuss/master

iluwatar · web-flow · commit 4d6467e435f3 · 2017-05-21T09:02:18.000+03:00
Adding Setter Dependency Injection as a second subtype of DI
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/AdvancedSorceress.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/AdvancedSorceress.java
@@ -0,0 +1,43 @@
+package com.iluwatar.dependency.injection;
+
+/**
+ * The MIT License
+ * Copyright (c) 2014-2017 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+
+/**
+ * AdvancedSorceress implements inversion of control. It depends on abstraction that can be injected
+ * through its setter.
+ */
+public class AdvancedSorceress implements Wizard {
+
+  private Tobacco tobacco;
+
+  public void setTobacco(Tobacco tobacco) {
+    this.tobacco = tobacco;
+  }
+
+  @Override
+  public void smoke() {
+    tobacco.smoke(this);
+  }
+}
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/App.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/App.java
@@ -1,17 +1,17 @@
 /**
  * The MIT License
  * Copyright (c) 2014-2016 Ilkka Seppälä
- *
+ * <p>
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- *
+ * <p>
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- *
+ * <p>
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -26,7 +26,6 @@
 import com.google.inject.Injector;
 
 /**
- * 
  * Dependency Injection pattern deals with how objects handle their dependencies. The pattern
  * implements so called inversion of control principle. Inversion of control has two specific rules:
  * - High-level modules should not depend on low-level modules. Both should depend on abstractions.
@@ -36,21 +35,21 @@
  * naive implementation violating the inversion of control principle. It depends directly on a
  * concrete implementation which cannot be changed.
  * <p>
- * The second wizard ({@link AdvancedWizard}) is more flexible. It does not depend on any concrete
- * implementation but abstraction. It utilizes Dependency Injection pattern allowing its
- * {@link Tobacco} dependency to be injected through its constructor. This way, handling the
- * dependency is no longer the wizard's responsibility. It is resolved outside the wizard class.
+ * The second and third wizards({@link AdvancedWizard} and {@link AdvancedSorceress}) are more flexible.
+ * They do not depend on any concrete implementation but abstraction. They utilizes Dependency Injection
+ * pattern allowing their {@link Tobacco} dependency to be injected through constructor ({@link AdvancedWizard})
+ * or setter ({@link AdvancedSorceress}). This way, handling the dependency is no longer the wizard's
+ * responsibility. It is resolved outside the wizard class.
  * <p>
- * The third example takes the pattern a step further. It uses Guice framework for Dependency
+ * The fourth example takes the pattern a step further. It uses Guice framework for Dependency
  * Injection. {@link TobaccoModule} binds a concrete implementation to abstraction. Injector is then
  * used to create {@link GuiceWizard} object with correct dependencies.
- *
  */
 public class App {
 
   /**
    * Program entry point
-   * 
+   *
    * @param args command line args
    */
   public static void main(String[] args) {
@@ -60,6 +59,10 @@ public static void main(String[] args) {
     AdvancedWizard advancedWizard = new AdvancedWizard(new SecondBreakfastTobacco());
     advancedWizard.smoke();
 
+    AdvancedSorceress advancedSorceress = new AdvancedSorceress();
+    advancedSorceress.setTobacco(new SecondBreakfastTobacco());
+    advancedSorceress.smoke();
+
     Injector injector = Guice.createInjector(new TobaccoModule());
     GuiceWizard guiceWizard = injector.getInstance(GuiceWizard.class);
     guiceWizard.smoke();
diff --git a/dependency-injection/src/test/java/com/iluwatar/dependency/injection/AdvancedSorceressTest.java b/dependency-injection/src/test/java/com/iluwatar/dependency/injection/AdvancedSorceressTest.java
@@ -0,0 +1,76 @@
+/**
+ * The MIT License
+ * Copyright (c) 2014-2016 Ilkka Seppälä
+ * <p>
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * <p>
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ * <p>
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.iluwatar.dependency.injection;
+
+import com.iluwatar.dependency.injection.utils.InMemoryAppender;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Date: 28/04/17 - 7:40 AM
+ *
+ * @author Stanislav Kapinus
+ */
+
+public class AdvancedSorceressTest {
+
+  private InMemoryAppender appender;
+
+  @Before
+  public void setUp() {
+    appender = new InMemoryAppender(Tobacco.class);
+  }
+
+  @After
+  public void tearDown() {
+    appender.stop();
+  }
+
+  /**
+   * Test if the {@link AdvancedSorceress} smokes whatever instance of {@link Tobacco} is passed to her
+   * through the setter's parameter
+   */
+  @Test
+  public void testSmokeEveryThing() throws Exception {
+
+    final Tobacco[] tobaccos = {
+        new OldTobyTobacco(), new RivendellTobacco(), new SecondBreakfastTobacco()
+    };
+
+    for (final Tobacco tobacco : tobaccos) {
+      final AdvancedSorceress advancedSorceress = new AdvancedSorceress();
+      advancedSorceress.setTobacco(tobacco);
+      advancedSorceress.smoke();
+      // Verify if the sorceress is smoking the correct tobacco ...
+      assertEquals("AdvancedSorceress smoking " + tobacco.getClass().getSimpleName(), appender.getLastMessage());
+
+    }
+
+    // ... and nothing else is happening.
+    assertEquals(tobaccos.length, appender.getLogSize());
+
+  }
+}
