docs: update .all-contributorsrc [skip ci]

847

.all-contributorsrc

@@ -1195,6 +1195,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "vdlald",
+      "name": "Vladislav Golubinov",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/29997701?v=4",
+      "profile": "https://github.com/vdlald",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 4,

README.md

@@ -10,7 +10,7 @@
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=iluwatar_java-design-patterns&metric=coverage)](https://sonarcloud.io/dashboard?id=iluwatar_java-design-patterns)
 [![Join the chat at https://gitter.im/iluwatar/java-design-patterns](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/iluwatar/java-design-patterns?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-131-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-132-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 # Introduction
@@ -246,7 +246,7 @@ This project is licensed under the terms of the MIT license.
   <tr>
     <td align="center"><a href="https://github.com/nishant"><img src="https://avatars2.githubusercontent.com/u/15331971?v=4" width="100px;" alt=""/><br /><sub><b>Nishant Arora</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=nishant" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/raja-peeyush-kumar-singh"><img src="https://avatars0.githubusercontent.com/u/5496024?v=4" width="100px;" alt=""/><br /><sub><b>Peeyush</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=raja-peeyush-kumar-singh" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/ravening"><img src="https://avatars1.githubusercontent.com/u/10645273?v=4" width="100px;" alt=""/><br /><sub><b>Rakesh</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=ravening" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/ravening"><img src="https://avatars1.githubusercontent.com/u/10645273?v=4" width="100px;" alt=""/><br /><sub><b>Rakesh</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=ravening" title="Code">💻</a> <a href="https://github.com/iluwatar/java-design-patterns/pulls?q=is%3Apr+reviewed-by%3Aravening" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/vINCENT8888801"><img src="https://avatars0.githubusercontent.com/u/8037883?v=4" width="100px;" alt=""/><br /><sub><b>Wei Seng</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=vINCENT8888801" title="Code">💻</a></td>
   </tr>
   <tr>
@@ -262,10 +262,10 @@ This project is licensed under the terms of the MIT license.
     <td align="center"><a href="https://github.com/mkrzywanski"><img src="https://avatars0.githubusercontent.com/u/15279585?v=4" width="100px;" alt=""/><br /><sub><b>Michał Krzywański</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=mkrzywanski" title="Code">💻</a></td>
   </tr>
   <tr>
-    <td align="center"><a href="https://github.com/ravening"><img src="https://avatars1.githubusercontent.com/u/10645273?v=4" width="100px;" alt=""/><br /><sub><b>Rakesh</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=ravening" title="Code">💻</a> <a href="https://github.com/iluwatar/java-design-patterns/pulls?q=is%3Apr+reviewed-by%3Aravening" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://www.stefan-birkner.de"><img src="https://avatars1.githubusercontent.com/u/711349?v=4" width="100px;" alt=""/><br /><sub><b>Stefan Birkner</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=stefanbirkner" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/fedorskvorcov"><img src="https://avatars3.githubusercontent.com/u/43882212?v=4" width="100px;" alt=""/><br /><sub><b>Fedor Skvorcov</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=fedorskvorcov" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/samilAyoub"><img src="https://avatars0.githubusercontent.com/u/61546990?v=4" width="100px;" alt=""/><br /><sub><b>samilAyoub</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=samilAyoub" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/vdlald"><img src="https://avatars0.githubusercontent.com/u/29997701?v=4" width="100px;" alt=""/><br /><sub><b>Vladislav Golubinov</b></sub></a><br /><a href="https://github.com/iluwatar/java-design-patterns/commits?author=vdlald" title="Code">💻</a></td>
   </tr>
 </table>
 

abstract-factory/src/main/java/com/iluwatar/abstractfactory/App.java

@@ -23,7 +23,6 @@
 
 package com.iluwatar.abstractfactory;
 
-import com.iluwatar.abstractfactory.App.FactoryMaker.KingdomType;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -41,84 +40,14 @@ import org.slf4j.LoggerFactory;
  * and its implementations ( {@link ElfKingdomFactory}, {@link OrcKingdomFactory}). The example uses
  * both concrete implementations to create a king, a castle and an army.
  */
-public class App {
+public class App implements Runnable {
 
-  private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
+  private static Logger log = LoggerFactory.getLogger(App.class);
 
-  private King king;
-  private Castle castle;
-  private Army army;
+  private final Kingdom kingdom = new Kingdom();
 
-  /**
-   * Creates kingdom.
-   */
-  public void createKingdom(final KingdomFactory factory) {
-    setKing(factory.createKing());
-    setCastle(factory.createCastle());
-    setArmy(factory.createArmy());
-  }
-
-  King getKing(final KingdomFactory factory) {
-    return factory.createKing();
-  }
-
-  public King getKing() {
-    return king;
-  }
-
-  private void setKing(final King king) {
-    this.king = king;
-  }
-
-  Castle getCastle(final KingdomFactory factory) {
-    return factory.createCastle();
-  }
-
-  public Castle getCastle() {
-    return castle;
-  }
-
-  private void setCastle(final Castle castle) {
-    this.castle = castle;
-  }
-
-  Army getArmy(final KingdomFactory factory) {
-    return factory.createArmy();
-  }
-
-  public Army getArmy() {
-    return army;
-  }
-
-  private void setArmy(final Army army) {
-    this.army = army;
-  }
-
-  /**
-   * The factory of kingdom factories.
-   */
-  public static class FactoryMaker {
-
-    /**
-     * Enumeration for the different types of Kingdoms.
-     */
-    public enum KingdomType {
-      ELF, ORC
-    }
-
-    /**
-     * The factory method to create KingdomFactory concrete objects.
-     */
-    public static KingdomFactory makeFactory(KingdomType type) {
-      switch (type) {
-        case ELF:
-          return new ElfKingdomFactory();
-        case ORC:
-          return new OrcKingdomFactory();
-        default:
-          throw new IllegalArgumentException("KingdomType not supported.");
-      }
-    }
+  public Kingdom getKingdom() {
+    return kingdom;
   }
 
   /**
@@ -127,19 +56,33 @@ public class App {
    * @param args command line args
    */
   public static void main(String[] args) {
-
     var app = new App();
+    app.run();
+  }
 
-    LOGGER.info("Elf Kingdom");
-    app.createKingdom(FactoryMaker.makeFactory(KingdomType.ELF));
-    LOGGER.info(app.getArmy().getDescription());
-    LOGGER.info(app.getCastle().getDescription());
-    LOGGER.info(app.getKing().getDescription());
+  @Override
+  public void run() {
+    log.info("Elf Kingdom");
+    createKingdom(Kingdom.FactoryMaker.KingdomType.ELF);
+    log.info(kingdom.getArmy().getDescription());
+    log.info(kingdom.getCastle().getDescription());
+    log.info(kingdom.getKing().getDescription());
 
-    LOGGER.info("Orc Kingdom");
-    app.createKingdom(FactoryMaker.makeFactory(KingdomType.ORC));
-    LOGGER.info(app.getArmy().getDescription());
-    LOGGER.info(app.getCastle().getDescription());
-    LOGGER.info(app.getKing().getDescription());
+    log.info("Orc Kingdom");
+    createKingdom(Kingdom.FactoryMaker.KingdomType.ORC);
+    log.info(kingdom.getArmy().getDescription());
+    log.info(kingdom.getCastle().getDescription());
+    log.info(kingdom.getKing().getDescription());
+  }
+
+  /**
+   * Creates kingdom.
+   * @param kingdomType type of Kingdom
+   */
+  public void createKingdom(final Kingdom.FactoryMaker.KingdomType kingdomType) {
+    final KingdomFactory kingdomFactory = Kingdom.FactoryMaker.makeFactory(kingdomType);
+    kingdom.setKing(kingdomFactory.createKing());
+    kingdom.setCastle(kingdomFactory.createCastle());
+    kingdom.setArmy(kingdomFactory.createArmy());
   }
 }

abstract-factory/src/main/java/com/iluwatar/abstractfactory/Kingdom.java

@@ -0,0 +1,59 @@
+package com.iluwatar.abstractfactory;
+
+public class Kingdom {
+
+  private King king;
+  private Castle castle;
+  private Army army;
+
+  public King getKing() {
+    return king;
+  }
+
+  public Castle getCastle() {
+    return castle;
+  }
+
+  public Army getArmy() {
+    return army;
+  }
+
+  public void setKing(King king) {
+    this.king = king;
+  }
+
+  public void setCastle(Castle castle) {
+    this.castle = castle;
+  }
+
+  public void setArmy(Army army) {
+    this.army = army;
+  }
+
+  /**
+   * The factory of kingdom factories.
+   */
+  public static class FactoryMaker {
+
+    /**
+     * Enumeration for the different types of Kingdoms.
+     */
+    public enum KingdomType {
+      ELF, ORC
+    }
+
+    /**
+     * The factory method to create KingdomFactory concrete objects.
+     */
+    public static KingdomFactory makeFactory(KingdomType type) {
+      switch (type) {
+        case ELF:
+          return new ElfKingdomFactory();
+        case ORC:
+          return new OrcKingdomFactory();
+        default:
+          throw new IllegalArgumentException("KingdomType not supported.");
+      }
+    }
+  }
+}

abstract-factory/src/test/java/com/iluwatar/abstractfactory/AbstractFactoryTest.java

@@ -23,65 +23,71 @@
 
 package com.iluwatar.abstractfactory;
 
+import org.junit.jupiter.api.Test;
+
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
-import com.iluwatar.abstractfactory.App.FactoryMaker;
-import com.iluwatar.abstractfactory.App.FactoryMaker.KingdomType;
-import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
-
 /**
  * Test for abstract factory.
  */
 public class AbstractFactoryTest {
 
   private final App app = new App();
-  private KingdomFactory elfFactory;
-  private KingdomFactory orcFactory;
-
-  @BeforeEach
-  public void setUp() {
-    elfFactory = FactoryMaker.makeFactory(KingdomType.ELF);
-    orcFactory = FactoryMaker.makeFactory(KingdomType.ORC);
-  }
 
   @Test
   public void king() {
-    final var elfKing = app.getKing(elfFactory);
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ELF);
+    final var kingdom = app.getKingdom();
+
+    final var elfKing = kingdom.getKing();
     assertTrue(elfKing instanceof ElfKing);
     assertEquals(ElfKing.DESCRIPTION, elfKing.getDescription());
-    final var orcKing = app.getKing(orcFactory);
+
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ORC);
+    final var orcKing = kingdom.getKing();
     assertTrue(orcKing instanceof OrcKing);
     assertEquals(OrcKing.DESCRIPTION, orcKing.getDescription());
   }
 
   @Test
   public void castle() {
-    final var elfCastle = app.getCastle(elfFactory);
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ELF);
+    final var kingdom = app.getKingdom();
+
+    final var elfCastle = kingdom.getCastle();
     assertTrue(elfCastle instanceof ElfCastle);
     assertEquals(ElfCastle.DESCRIPTION, elfCastle.getDescription());
-    final var orcCastle = app.getCastle(orcFactory);
+
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ORC);
+    final var orcCastle = kingdom.getCastle();
     assertTrue(orcCastle instanceof OrcCastle);
     assertEquals(OrcCastle.DESCRIPTION, orcCastle.getDescription());
   }
 
   @Test
   public void army() {
-    final var elfArmy = app.getArmy(elfFactory);
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ELF);
+    final var kingdom = app.getKingdom();
+
+    final var elfArmy = kingdom.getArmy();
     assertTrue(elfArmy instanceof ElfArmy);
     assertEquals(ElfArmy.DESCRIPTION, elfArmy.getDescription());
-    final var orcArmy = app.getArmy(orcFactory);
+
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ORC);
+    final var orcArmy = kingdom.getArmy();
     assertTrue(orcArmy instanceof OrcArmy);
     assertEquals(OrcArmy.DESCRIPTION, orcArmy.getDescription());
   }
 
   @Test
   public void createElfKingdom() {
-    app.createKingdom(elfFactory);
-    final var king = app.getKing();
-    final var castle = app.getCastle();
-    final var army = app.getArmy();
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ELF);
+    final var kingdom = app.getKingdom();
+
+    final var king = kingdom.getKing();
+    final var castle = kingdom.getCastle();
+    final var army = kingdom.getArmy();
     assertTrue(king instanceof ElfKing);
     assertEquals(ElfKing.DESCRIPTION, king.getDescription());
     assertTrue(castle instanceof ElfCastle);
@@ -92,10 +98,12 @@ public class AbstractFactoryTest {
 
   @Test
   public void createOrcKingdom() {
-    app.createKingdom(orcFactory);
-    final var king = app.getKing();
-    final var castle = app.getCastle();
-    final var army = app.getArmy();
+    app.createKingdom(Kingdom.FactoryMaker.KingdomType.ORC);
+    final var kingdom = app.getKingdom();
+
+    final var king = kingdom.getKing();
+    final var castle = kingdom.getCastle();
+    final var army = kingdom.getArmy();
     assertTrue(king instanceof OrcKing);
     assertEquals(OrcKing.DESCRIPTION, king.getDescription());
     assertTrue(castle instanceof OrcCastle);

factory/README.md

@@ -15,35 +15,31 @@ tags:
 
 ## Intent
 
-Providing a static method encapsulated in a class called factory, in order to hide the implementation logic and makes client code focus on usage rather then initialization new objects.
+Providing a static method encapsulated in a class called factory, in order to hide the 
+implementation logic and makes client code focus on usage rather then initialization new objects.
 
 ## Explanation
 
 Real world example
 
-> Lets say we have a web application connected to SQLServer, but now we want to switch to Oracle. To do so without modifying existing source code, we need to implements Simple Factory pattern, in which a static method can be invoked to create connection to a given database.
+> Lets say we have a web application connected to SQLServer, but now we want to switch to Oracle. To 
+> do so without modifying existing source code, we need to implements Simple Factory pattern, in 
+> which a static method can be invoked to create connection to a given database.
 
 Wikipedia says
 
-> Factory is an object for creating other objects – formally a factory is a function or method that returns objects of a varying prototype or class.
+> Factory is an object for creating other objects – formally a factory is a function or method that 
+> returns objects of a varying prototype or class.
 
 **Programmatic Example**
 
-We have an interface 'Car' and tow implementations 'Ford' and 'Ferrari'.
+We have an interface `Car` and two implementations `Ford` and `Ferrari`.
 
 ```java
-/**
- * Car interface.
- */
 public interface Car {
-  
-  public String getDescription();
-  
+  String getDescription();
 }
 
-/**
- * Ford implementation.
- */
 public class Ford implements Car {
 
   static final String DESCRIPTION = "This is Ford.";
@@ -54,9 +50,6 @@ public class Ford implements Car {
   }
 }
 
-/**
- * Ferrari implementation.
- */
 public class Ferrari implements Car {
    
   static final String DESCRIPTION = "This is Ferrari.";
@@ -68,14 +61,11 @@ public class Ferrari implements Car {
 }
 ```
 
-Enumeration above represents types of cars that we support (Ford and Ferrari).
+Enumeration above represents types of cars that we support (`Ford` and `Ferrari`).
 
 ```java
 public enum CarType {
   
-  /**
-   * Enumeration for different types of cars.
-   */
   FORD(Ford::new), 
   FERRARI(Ferrari::new);
   
@@ -90,17 +80,12 @@ public enum CarType {
   }
 }
 ```
-Then we have the static method 'getCar' to create car objects encapsulated in the factory class 'CarSimpleFactory'.
+Then we have the static method `getCar` to create car objects encapsulated in the factory class 
+`CarSimpleFactory`.
 
 ```java
-/**
- * Factory of cars.
- */
 public class CarsFactory {
   
-  /**
-   * Factory method takes as parameter a car type and initiate the appropriate class.
-   */
   public static Car getCar(CarType type) {
     return type.getConstructor().get();
   }
@@ -122,23 +107,27 @@ Program output:
 This is Ford.
 This Ferrari.
 ```
+
 ## Class Diagram
+
 ![alt text](./etc/factory.urm.png "Factory pattern class diagram")
 
 ## Applicability
-Use the Simple Factory pattern when you only care about the creation of a object, not how to create and manage it.
 
-## Pros
+Use the Simple Factory pattern when you only care about the creation of a object, not how to create 
+and manage it.
+
+Pros
+
 * Allows keeping all objects creation in one place and avoid of spreading 'new' key value across codebase.
 * Allows to writs loosely coupled code. Some of its main advantages include better testability, easy-to-understand code, swappable components, scalability and isolated features.
 
-## Cons
+Cons
+
 * The code becomes more complicated than it should be. 
 
 ## Related patterns
 
-[Factory Method](https://java-design-patterns.com/patterns/factory-method/)
-[Factory Kit](https://java-design-patterns.com/patterns/factory-kit/)
-[Abstract Factory](https://java-design-patterns.com/patterns/abstract-factory/)
-
-
+* [Factory Method](https://java-design-patterns.com/patterns/factory-method/)
+* [Factory Kit](https://java-design-patterns.com/patterns/factory-kit/)
+* [Abstract Factory](https://java-design-patterns.com/patterns/abstract-factory/)

factory/src/main/java/com/iluwatar/factory/Car.java

@@ -5,6 +5,6 @@ package com.iluwatar.factory;
  */
 public interface Car {
   
-  public String getDescription();
+  String getDescription();
   
 }