Merge branch 'master' of https://github.com/themoffster/java-design-patterns into themoffster-master

Conflicts:
	dao/pom.xml

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

@@ -7,7 +7,7 @@ import org.junit.Test;
 
 public class AppTest {
 
-	private App app = new App();;
+	private App app = new App();
 	private KingdomFactory elfFactory;
 	private KingdomFactory orcFactory;
 	

dao/pom.xml

@@ -1,18 +1,28 @@
 <?xml version="1.0"?>
-<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
+<project
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
-  <modelVersion>4.0.0</modelVersion>
+	xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <parent>
+	<modelVersion>4.0.0</modelVersion>
-    <groupId>com.iluwatar</groupId>
+	<parent>
-    <artifactId>java-design-patterns</artifactId>
+		<groupId>com.iluwatar</groupId>
-    <version>1.7.0</version>
+		<artifactId>java-design-patterns</artifactId>
-  </parent>
+		<version>1.7.0</version>
-  <artifactId>dao</artifactId>
+	</parent>
-  <dependencies>
+	<artifactId>dao</artifactId>
-    <dependency>
+	
-      <groupId>junit</groupId>
+	<properties>
-      <artifactId>junit</artifactId>
+		
-      <scope>test</scope>
+	</properties>
-    </dependency>
+	
-  </dependencies>
+	<dependencies>
+		<dependency>
+			<groupId>junit</groupId>
+			<artifactId>junit</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>log4j</groupId>
+			<artifactId>log4j</artifactId>
+		</dependency>
+	</dependencies>
 </project>

dao/src/main/java/com/iluwatar/dao/App.java

@@ -3,6 +3,8 @@ package com.iluwatar.dao;
 import java.util.ArrayList;
 import java.util.List;
 
+import org.apache.log4j.Logger;
+
 /**
  * 
  * Data Access Object (DAO) is an object that provides an abstract interface to some type of database or other 
@@ -17,43 +19,38 @@ import java.util.List;
  */
 public class App {
 
+	private static Logger LOGGER = Logger.getLogger(App.class);
+
 	/**
-	 * Program entry point
+	 * Program entry point.
-	 * @param args command line args
+	 * 
+	 * @param args command line args.
 	 */
-	public static void main(String[] args) {
+	public static void main(final String[] args) {
-
+		final CustomerDaoImpl customerDao = new CustomerDaoImpl(generateSampleCustomers());
-		CustomerDaoImpl customerDao = new CustomerDaoImpl(generateSampleCustomers());
+		LOGGER.info("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-
+		LOGGER.info("customerDao.getCusterById(2): " + customerDao.getCustomerById(2));
-		System.out.println("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
+		final Customer customer = new Customer(4, "Dan", "Danson");
-		System.out.println("customerDao.getCusterById(2): " + customerDao.getCusterById(2));
-
-		Customer customer = new Customer(4, "Dan", "Danson");
 		customerDao.addCustomer(customer);
-
+		LOGGER.info("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-		System.out.println("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-
 		customer.setFirstName("Daniel");
 		customer.setLastName("Danielson");
 		customerDao.updateCustomer(customer);
-
+		LOGGER.info("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-		System.out.println("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-
 		customerDao.deleteCustomer(customer);
-
+		LOGGER.info("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
-		System.out.println("customerDao.getAllCustomers(): " + customerDao.getAllCustomers());
 	}
 
 	/**
-	 * Generate customers
+	 * Generate customers.
-	 * @return list of customers
+	 * 
+	 * @return list of customers.
 	 */
 	public static List<Customer> generateSampleCustomers() {
-		Customer customer1 = new Customer(1, "Adam", "Adamson");
+		final Customer customer1 = new Customer(1, "Adam", "Adamson");
-		Customer customer2 = new Customer(2, "Bob", "Bobson");
+		final Customer customer2 = new Customer(2, "Bob", "Bobson");
-		Customer customer3 = new Customer(3, "Carl", "Carlson");
+		final Customer customer3 = new Customer(3, "Carl", "Carlson");
-
+		final List<Customer> customers = new ArrayList<Customer>();
-		List<Customer> customers = new ArrayList<Customer>();
 		customers.add(customer1);
 		customers.add(customer2);
 		customers.add(customer3);

dao/src/main/java/com/iluwatar/dao/Customer.java

@@ -6,65 +6,63 @@ package com.iluwatar.dao;
  *
  */
 public class Customer {
-	
-    private int id;
-    private String firstName;
-    private String lastName;
 
-    public Customer(int id, String firstName, String lastName) {
+  private int id;
-        this.id = id;
+  private String firstName;
-        this.firstName = firstName;
+  private String lastName;
-        this.lastName = lastName;
+
+  public Customer(final int id, final String firstName, final String lastName) {
+    this.id = id;
+    this.firstName = firstName;
+    this.lastName = lastName;
+  }
+
+  public int getId() {
+    return id;
+  }
+
+  public void setId(final int id) {
+    this.id = id;
+  }
+
+  public String getFirstName() {
+    return firstName;
+  }
+
+  public void setFirstName(final String firstName) {
+    this.firstName = firstName;
+  }
+
+  public String getLastName() {
+    return lastName;
+  }
+
+  public void setLastName(final String lastName) {
+    this.lastName = lastName;
+  }
+
+  @Override
+  public String toString() {
+    return "Customer{" + "id=" + getId() + ", firstName='" + getFirstName() + '\'' + ", lastName='"
+        + getLastName() + '\'' + '}';
+  }
+
+  @Override
+  public boolean equals(final Object o) {
+    boolean isEqual = false;
+    if (this == o) {
+      isEqual = true;
+    } else if (o != null && (getClass() == o.getClass())) {
+      final Customer customer = (Customer) o;
+      if (getId() == customer.getId())
+        isEqual = true;
     }
+    return isEqual;
+  }
 
-    public int getId() {
+  @Override
-        return id;
+  public int hashCode() {
-    }
+    int result = getId();
-
+    return result;
-    public void setId(int id) {
+  }
-        this.id = id;
+}
-    }
-
-    public String getFirstName() {
-        return firstName;
-    }
-
-    public void setFirstName(String firstName) {
-        this.firstName = firstName;
-    }
-
-    public String getLastName() {
-        return lastName;
-    }
-
-    public void setLastName(String lastName) {
-        this.lastName = lastName;
-    }
-
-    @Override
-    public String toString() {
-        return "Customer{" +
-                "id=" + id +
-                ", firstName='" + firstName + '\'' +
-                ", lastName='" + lastName + '\'' +
-                '}';
-    }
-
-    @Override
-    public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
-
-        Customer customer = (Customer) o;
-
-        if (id != customer.id) return false;
-
-        return true;
-    }
-
-    @Override
-    public int hashCode() {
-        int result = id;
-        return result;
-    }
-}

dao/src/main/java/com/iluwatar/dao/CustomerDao.java

@@ -8,10 +8,14 @@ import java.util.List;
  *
  */
 public interface CustomerDao {
-	
+
-    public List<Customer> getAllCustomers();
+  List<Customer> getAllCustomers();
-    public Customer getCusterById(int id);
+
-    public void addCustomer(Customer customer);
+  Customer getCustomerById(int id);
-    public void updateCustomer(Customer customer);
+
-    public void deleteCustomer(Customer customer);
+  void addCustomer(Customer customer);
-}
+
+  void updateCustomer(Customer customer);
+
+  void deleteCustomer(Customer customer);
+}

dao/src/main/java/com/iluwatar/dao/CustomerDaoImpl.java

@@ -4,54 +4,59 @@ import java.util.List;
 
 /**
  * 
- * The data access object (DAO) is an object that provides an abstract interface to some type of database or other persistence mechanism.
+ * The data access object (DAO) is an object that provides an abstract interface to some type of
- * By mapping application calls to the persistence layer, DAO provide some specific data operations without exposing details of the database.
+ * database or other persistence mechanism. By mapping application calls to the persistence layer,
- * This isolation supports the Single responsibility principle. It separates what data accesses the application needs, in terms of
+ * DAO provide some specific data operations without exposing details of the database. This
- * domain-specific objects and data types (the public interface of the DAO), from how these needs can be satisfied with a specific DBMS,
+ * isolation supports the Single responsibility principle. It separates what data accesses the
- * database schema, etc.
+ * application needs, in terms of domain-specific objects and data types (the public interface of
+ * the DAO), from how these needs can be satisfied with a specific DBMS, database schema, etc.
  * 
  */
 public class CustomerDaoImpl implements CustomerDao {
 
-    // Represents the DB structure for our example so we don't have to managed it ourselves
+  // Represents the DB structure for our example so we don't have to managed it ourselves
-    // Note: Normally this would be in the form of an actual database and not part of the Dao Impl.
+  // Note: Normally this would be in the form of an actual database and not part of the Dao Impl.
-    private List<Customer> customers;
+  private List<Customer> customers;
 
-    public CustomerDaoImpl(List<Customer> customers) {
+  public CustomerDaoImpl(final List<Customer> customers) {
-        this.customers = customers;
+    this.customers = customers;
+  }
+
+  @Override
+  public List<Customer> getAllCustomers() {
+    return customers;
+  }
+
+  @Override
+  public Customer getCustomerById(final int id) {
+    Customer customer = null;
+    for (final Customer cus : getAllCustomers()) {
+      if (cus.getId() == id) {
+        customer = cus;
+        break;
+      }
     }
+    return customer;
+  }
 
-    @Override
+  @Override
-    public List<Customer> getAllCustomers() {
+  public void addCustomer(final Customer customer) {
-        return customers;
+    if (getCustomerById(customer.getId()) == null) {
+      customers.add(customer);
     }
+  }
 
-    @Override
+
-    public Customer getCusterById(int id) {
+  @Override
-        for (int i = 0; i < customers.size(); i++) {
+  public void updateCustomer(final Customer customer) {
-            if (customers.get(i).getId() == id) {
+    if (getAllCustomers().contains(customer)) {
-                return customers.get(i);
+      final int index = getAllCustomers().indexOf(customer);
-            }
+      getAllCustomers().set(index, customer);
-        }
-        // No customer found
-        return null;
     }
+  }
 
-    @Override
+  @Override
-    public void addCustomer(Customer customer) {
+  public void deleteCustomer(final Customer customer) {
-        customers.add(customer);
+    getAllCustomers().remove(customer);
-    }
+  }
-
+}
-
-    @Override
-    public void updateCustomer(Customer customer) {
-        if (customers.contains(customer)) {
-            customers.set(customers.indexOf(customer), customer);
-        }
-    }
-
-    @Override
-    public void deleteCustomer(Customer customer) {
-        customers.remove(customer);
-    }
-}

dao/src/test/java/com/iluwatar/dao/AppTest.java

@@ -1,19 +0,0 @@
-package com.iluwatar.dao;
-
-import org.junit.Test;
-
-import com.iluwatar.dao.App;
-
-/**
- * 
- * Application test
- *
- */
-public class AppTest {
-
-	@Test
-	public void test() {
-		String[] args = {};
-		App.main(args);
-	}
-}

dao/src/test/java/com/iluwatar/dao/CustomerDaoImplTest.java

@@ -0,0 +1,99 @@
+package com.iluwatar.dao;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.Before;
+import org.junit.Test;
+
+public class CustomerDaoImplTest {
+
+  private CustomerDaoImpl impl;
+  private List<Customer> customers;
+  private static final Customer CUSTOMER = new Customer(1, "Freddy", "Kruger");
+
+  @Before
+  public void setUp() {
+    customers = new ArrayList<Customer>();
+    customers.add(CUSTOMER);
+    impl = new CustomerDaoImpl(customers);
+  }
+
+  @Test
+  public void deleteExistingCustomer() {
+    assertEquals(1, impl.getAllCustomers().size());
+    impl.deleteCustomer(CUSTOMER);
+    assertTrue(impl.getAllCustomers().isEmpty());
+  }
+
+  @Test
+  public void deleteNonExistingCustomer() {
+    final Customer nonExistingCustomer = new Customer(2, "Robert", "Englund");
+    impl.deleteCustomer(nonExistingCustomer);
+    assertEquals(1, impl.getAllCustomers().size());
+  }
+
+  @Test
+  public void updateExistingCustomer() {
+    final String newFirstname = "Bernard";
+    final String newLastname = "Montgomery";
+    final Customer customer = new Customer(CUSTOMER.getId(), newFirstname, newLastname);
+    impl.updateCustomer(customer);
+    final Customer cust = impl.getCustomerById(CUSTOMER.getId());
+    assertEquals(newFirstname, cust.getFirstName());
+    assertEquals(newLastname, cust.getLastName());
+  }
+
+  @Test
+  public void updateNonExistingCustomer() {
+    final int nonExistingId = getNonExistingCustomerId();
+    final String newFirstname = "Douglas";
+    final String newLastname = "MacArthur";
+    final Customer customer = new Customer(nonExistingId, newFirstname, newLastname);
+    impl.updateCustomer(customer);
+    assertNull(impl.getCustomerById(nonExistingId));
+    final Customer existingCustomer = impl.getCustomerById(CUSTOMER.getId());
+    assertEquals(CUSTOMER.getFirstName(), existingCustomer.getFirstName());
+    assertEquals(CUSTOMER.getLastName(), existingCustomer.getLastName());
+  }
+
+  @Test
+  public void addCustomer() {
+    final Customer newCustomer = new Customer(3, "George", "Patton");
+    impl.addCustomer(newCustomer);
+    assertEquals(2, impl.getAllCustomers().size());
+  }
+
+  @Test
+  public void addAlreadyAddedCustomer() {
+    final Customer newCustomer = new Customer(3, "George", "Patton");
+    impl.addCustomer(newCustomer);
+    assertEquals(2, impl.getAllCustomers().size());
+    impl.addCustomer(newCustomer);
+    assertEquals(2, impl.getAllCustomers().size());
+  }
+
+  @Test
+  public void getExistinCustomerById() {
+    assertEquals(CUSTOMER, impl.getCustomerById(CUSTOMER.getId()));
+  }
+
+  @Test
+  public void getNonExistinCustomerById() {
+    final int nonExistingId = getNonExistingCustomerId();
+    assertNull(impl.getCustomerById(nonExistingId));
+  }
+
+  /**
+   * An arbitrary number which does not correspond to an active Customer id.
+   * 
+   * @return an int of a customer id which doesn't exist
+   */
+  private int getNonExistingCustomerId() {
+    return 999;
+  }
+}

dao/src/test/java/com/iluwatar/dao/CustomerTest.java

@@ -0,0 +1,74 @@
+package com.iluwatar.dao;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+
+import org.junit.Before;
+import org.junit.Test;
+
+public class CustomerTest {
+
+  private Customer customer;
+  private static final int ID = 1;
+  private static final String FIRSTNAME = "Winston";
+  private static final String LASTNAME = "Churchill";
+
+  @Before
+  public void setUp() {
+    customer = new Customer(ID, FIRSTNAME, LASTNAME);
+  }
+
+  @Test
+  public void getAndSetId() {
+    final int newId = 2;
+    customer.setId(newId);
+    assertEquals(newId, customer.getId());
+  }
+
+  @Test
+  public void getAndSetFirstname() {
+    final String newFirstname = "Bill";
+    customer.setFirstName(newFirstname);
+    assertEquals(newFirstname, customer.getFirstName());
+  }
+
+  @Test
+  public void getAndSetLastname() {
+    final String newLastname = "Clinton";
+    customer.setLastName(newLastname);
+    assertEquals(newLastname, customer.getLastName());
+  }
+
+  @Test
+  public void notEqualWithDifferentId() {
+    final int newId = 2;
+    final Customer otherCustomer = new Customer(newId, FIRSTNAME, LASTNAME);
+    assertNotEquals(customer, otherCustomer);
+    assertNotEquals(customer.hashCode(), otherCustomer.hashCode());
+  }
+
+  @Test
+  public void equalsWithSameObjectValues() {
+    final Customer otherCustomer = new Customer(ID, FIRSTNAME, LASTNAME);
+    assertEquals(customer, otherCustomer);
+    assertEquals(customer.hashCode(), otherCustomer.hashCode());
+  }
+
+  @Test
+  public void equalsWithSameObjects() {
+    assertEquals(customer, customer);
+    assertEquals(customer.hashCode(), customer.hashCode());
+  }
+
+  @Test
+  public void testToString() {
+    final StringBuffer buffer = new StringBuffer();
+    buffer.append("Customer{id=");
+    buffer.append("" + customer.getId());
+    buffer.append(", firstName='");
+    buffer.append(customer.getFirstName());
+    buffer.append("\', lastName='");
+    buffer.append(customer.getLastName() + "\'}");
+    assertEquals(buffer.toString(), customer.toString());
+  }
+}

dao/src/test/resources/log4j.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+<log4j:configuration debug="true"
+	xmlns:log4j='http://jakarta.apache.org/log4j/'>
+
+	<appender name="console" class="org.apache.log4j.ConsoleAppender">
+		<layout class="org.apache.log4j.PatternLayout">
+			<param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n" />
+		</layout>
+	</appender>
+
+	<root>
+		<level value="INFO" />
+		<appender-ref ref="console" />
+	</root>
+
+</log4j:configuration>

pom.xml

@@ -19,6 +19,7 @@
 		<jacoco.version>0.7.2.201409121644</jacoco.version>
 		<commons-dbcp.version>1.4</commons-dbcp.version>
 		<camel.version>2.15.3</camel.version>
+		<log4j.version>1.2.17</log4j.version>
 	</properties>
 	<modules>
 		<module>abstract-factory</module>
@@ -126,6 +127,11 @@
 				<version>${junit.version}</version>
 				<scope>test</scope>
 			</dependency>
+			<dependency>
+				<groupId>log4j</groupId>
+				<artifactId>log4j</artifactId>
+				<version>${log4j.version}</version>
+			</dependency>
 		</dependencies>
 	</dependencyManagement>