From b423fd30d4b0d1fd6db2681c35f7c49ce447b1e5 Mon Sep 17 00:00:00 2001
From: Samil Ayoub <ssamil.ayoub@gmail.com>
Date: Wed, 2 Sep 2020 18:12:42 +0100
Subject: [PATCH] Fix bugs, clean the code and add unit tests.

---
 simple-factory/etc/simple-factory.urm.puml    | 35 +++++++++++++++
 simple-factory/pom.xml                        | 13 +++++-
 .../java/com/iluwatar/simplefactory/App.java  | 44 +++++++++++++++----
 .../java/com/iluwatar/simplefactory/Car.java  |  8 ++--
 .../simplefactory/CarSimpleFactory.java       | 42 ++++++++----------
 .../com/iluwatar/simplefactory/Ferrari.java   | 16 +++----
 .../java/com/iluwatar/simplefactory/Ford.java | 12 ++---
 .../com/iluwatar/simplefactory/AppTest.java   | 14 ++++++
 .../simplefactory/CarSimpleFactoryTest.java   | 15 +++++++
 9 files changed, 148 insertions(+), 51 deletions(-)
 create mode 100644 simple-factory/etc/simple-factory.urm.puml
 create mode 100644 simple-factory/src/test/java/com/iluwatar/simplefactory/AppTest.java
 create mode 100644 simple-factory/src/test/java/com/iluwatar/simplefactory/CarSimpleFactoryTest.java

diff --git a/simple-factory/etc/simple-factory.urm.puml b/simple-factory/etc/simple-factory.urm.puml
new file mode 100644
index 000000000..77fee4b5b
--- /dev/null
+++ b/simple-factory/etc/simple-factory.urm.puml
@@ -0,0 +1,35 @@
+@startuml
+package com.iluwatar.simplefactory {
+  class App {
+    - LOGGER : Logger {static}
+    + App()
+    + main(args : String[]) {static}
+  }
+  interface Car {
+    + getDescription() : String {abstract}
+  }
+  class CarSimpleFactory {
+    + CarSimpleFactory()
+    + getCar(type : CarType) : Car {static}
+  }
+  ~enum CarType {
+    + FERRARI {static}
+    + FORD {static}
+    + valueOf(name : String) : CarType {static}
+    + values() : CarType[] {static}
+  }
+  class Ferrari {
+    ~ DESCRIPTION : String {static}
+    + Ferrari()
+    + getDescription() : String
+  }
+  class Ford {
+    ~ DESCRIPTION : String {static}
+    + Ford()
+    + getDescription() : String
+  }
+}
+CarType ..+ CarSimpleFactory
+Ferrari ..|> Car 
+Ford ..|> Car 
+@enduml
\ No newline at end of file
diff --git a/simple-factory/pom.xml b/simple-factory/pom.xml
index e7d28511f..ca7c0547d 100644
--- a/simple-factory/pom.xml
+++ b/simple-factory/pom.xml
@@ -6,6 +6,17 @@
     <version>1.24.0-SNAPSHOT</version>
   </parent>
   <artifactId>simple-factory</artifactId>
+  <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+    </dependency>
+  </dependencies>
   <build>
 		<plugins>
 			<!-- Maven assembly plugin is invoked with default setting which we have 
@@ -18,7 +29,7 @@
 						<configuration>
 							<archive>
 								<manifest>
-									<mainClass>com.iluwatar.abstractfactory.App</mainClass>
+									<mainClass>com.iluwatar.simplefactory.App</mainClass>
 								</manifest>
 							</archive>
 						</configuration>
diff --git a/simple-factory/src/main/java/com/iluwatar/simplefactory/App.java b/simple-factory/src/main/java/com/iluwatar/simplefactory/App.java
index 898efe6d3..f13566ba6 100644
--- a/simple-factory/src/main/java/com/iluwatar/simplefactory/App.java
+++ b/simple-factory/src/main/java/com/iluwatar/simplefactory/App.java
@@ -1,16 +1,42 @@
+/*
+ * The MIT License
+ * Copyright © 2014-2019 Ilkka Seppälä
+ *
+ * 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:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * 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.simplefactory;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class App {
-	
-	private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
-
-	public static void main(String[] args) {
-		Car car1 = CarSimpleFactory.getCar(CarSimpleFactory.carTypes.FORD);
-		Car car2 = CarSimpleFactory.getCar(CarSimpleFactory.carTypes.FERRARI);
-		LOGGER.info(car1.getDescription());
-		LOGGER.info(car2.getDescription());
-	}
+  
+  private static final Logger LOGGER = LoggerFactory.getLogger(App.class);
+  
+  /**
+   * Program main entry point.
+   */
+  public static void main(String[] args) {
+    Car car1 = CarSimpleFactory.getCar(CarSimpleFactory.CarType.FORD);
+    Car car2 = CarSimpleFactory.getCar(CarSimpleFactory.CarType.FERRARI);
+    LOGGER.info(car1.getDescription());
+    LOGGER.info(car2.getDescription());
+  }
 }
diff --git a/simple-factory/src/main/java/com/iluwatar/simplefactory/Car.java b/simple-factory/src/main/java/com/iluwatar/simplefactory/Car.java
index 82ff4ebe0..b87070040 100644
--- a/simple-factory/src/main/java/com/iluwatar/simplefactory/Car.java
+++ b/simple-factory/src/main/java/com/iluwatar/simplefactory/Car.java
@@ -1,10 +1,10 @@
 package com.iluwatar.simplefactory;
 
 /**
- * Car interface
+ * Car interface.
  */
 public interface Car {
-
-	public String getDescription();
-
+  
+  public String getDescription();
+  
 }
diff --git a/simple-factory/src/main/java/com/iluwatar/simplefactory/CarSimpleFactory.java b/simple-factory/src/main/java/com/iluwatar/simplefactory/CarSimpleFactory.java
index 33dbe7b88..911fe610f 100644
--- a/simple-factory/src/main/java/com/iluwatar/simplefactory/CarSimpleFactory.java
+++ b/simple-factory/src/main/java/com/iluwatar/simplefactory/CarSimpleFactory.java
@@ -1,29 +1,25 @@
 package com.iluwatar.simplefactory;
 
-
 /**
- * Factory of cars
+ * Factory of cars.
  */
 public class CarSimpleFactory {
-	
-	/*
-	 * Enumeration for different types of cars
-	 */
-	static enum carTypes {
-		FORD, FERRARI
-	};
-	
-	/*
-	 * Factory method takes as parameter a car type and initiate the appropriate class
-	 */
-	public static Car getCar(carTypes type) {
-		switch (type) {
-		case FORD:
-			return new Ford();
-		case FERRARI:
-			return new Ferrari();
-		default:
-			throw new IllegalArgumentException("Model not supported.");
-		}
-	}
+  
+  /**
+   * Enumeration for different types of cars.
+   */
+  static enum CarType {
+    FORD, FERRARI
+  }
+  
+  /**
+   * Factory method takes as parameter a car type and initiate the appropriate class.
+   */
+  public static Car getCar(CarType type) {
+    switch (type) {
+      case FORD: return new Ford();
+      case FERRARI: return new Ferrari();
+      default: throw new IllegalArgumentException("Model not supported.");
+    }
+  }
 }
diff --git a/simple-factory/src/main/java/com/iluwatar/simplefactory/Ferrari.java b/simple-factory/src/main/java/com/iluwatar/simplefactory/Ferrari.java
index f9f1d8492..d6e865182 100644
--- a/simple-factory/src/main/java/com/iluwatar/simplefactory/Ferrari.java
+++ b/simple-factory/src/main/java/com/iluwatar/simplefactory/Ferrari.java
@@ -1,14 +1,14 @@
 package com.iluwatar.simplefactory;
 
 /**
- * Ferrari implementation
+ * Ferrari implementation.
  */
 public class Ferrari implements Car {
-	
-	static final String DESCRIPTION = "This is Ferrari.";
-	
-	@Override
-	public String getDescription() {
-		return DESCRIPTION;
-	}
+   
+  static final String DESCRIPTION = "This is Ferrari.";
+
+  @Override
+  public String getDescription() {
+    return DESCRIPTION;
+  }
 }
diff --git a/simple-factory/src/main/java/com/iluwatar/simplefactory/Ford.java b/simple-factory/src/main/java/com/iluwatar/simplefactory/Ford.java
index 0adf4b66b..19cbea2ae 100644
--- a/simple-factory/src/main/java/com/iluwatar/simplefactory/Ford.java
+++ b/simple-factory/src/main/java/com/iluwatar/simplefactory/Ford.java
@@ -1,14 +1,14 @@
 package com.iluwatar.simplefactory;
 
 /**
- * Ford implementation
+ * Ford implementation.
  */
 public class Ford implements Car {
 
-	static final String DESCRIPTION = "This is Ford.";
+  static final String DESCRIPTION = "This is Ford.";
 
-	@Override
-	public String getDescription() {
-		return DESCRIPTION;
-	}
+  @Override
+  public String getDescription() {
+    return DESCRIPTION;
+  }
 }
diff --git a/simple-factory/src/test/java/com/iluwatar/simplefactory/AppTest.java b/simple-factory/src/test/java/com/iluwatar/simplefactory/AppTest.java
new file mode 100644
index 000000000..4465b3b8c
--- /dev/null
+++ b/simple-factory/src/test/java/com/iluwatar/simplefactory/AppTest.java
@@ -0,0 +1,14 @@
+package com.iluwatar.simplefactory;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import org.junit.jupiter.api.Test;
+
+class AppTest {
+
+	@Test
+	void shouldExecuteWithoutExceptions() {
+		assertDoesNotThrow(() -> App.main(new String[]{}));
+	}
+
+}
diff --git a/simple-factory/src/test/java/com/iluwatar/simplefactory/CarSimpleFactoryTest.java b/simple-factory/src/test/java/com/iluwatar/simplefactory/CarSimpleFactoryTest.java
new file mode 100644
index 000000000..394b652b6
--- /dev/null
+++ b/simple-factory/src/test/java/com/iluwatar/simplefactory/CarSimpleFactoryTest.java
@@ -0,0 +1,15 @@
+package com.iluwatar.simplefactory;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import org.junit.jupiter.api.Test;
+
+class CarSimpleFactoryTest {
+
+	@Test
+	void shouldReturnFerrariInstance() {
+		final var ferrari = CarSimpleFactory.getCar(CarSimpleFactory.CarType.FERRARI);
+		assertTrue(ferrari instanceof Ferrari);
+	}
+
+}