moved to git.zipcode.rocks

.gitignore

@@ -0,0 +1,115 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Java template
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+### Eclipse template
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# Eclipse Core
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+
+# Scala IDE specific (Scala & Java development for Eclipse)
+.cache-main
+.scala_dependencies
+.worksheet
+### macOS template
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+#Intellij files
+.idea
+*.iml
+
+#maven build target
+target/

.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: java
+
+deploy:
+  provider: script
+  script: "mvn test"
+  skip_cleanup: true
+  on:
+tags: true

README-TDDPatterns.md

@@ -0,0 +1,62 @@
+# Test Driven Development (TDD)
+## What is a unit test?
+* A `unit test` is a practice by which `small units of code` are tested.
+* The purpose of a unit test is to determine if a feature being tested is fit for use in other parts of an application.
+* It is considered best practice to test every method in an application with at least 2 sets of arguments.
+* Tests are typically expressed as a combination of three clauses:
+	* `Given` some context
+	* `When` some action is carried out
+	* `Then` consequences should be observable
+
+### Example
+
+```java
+// Given
+String name = "Leon";
+Integer age = 25;
+Person leon = new Person(name, age);
+
+// When
+String getNameResult = leon.getName();
+Integer getAgeResult = leon.getAge();
+
+// Then
+Assert.assertEquals(name, getNameResult);
+Assert.assertEquals(age, getAgeResult);
+```
+
+
+## What are the three clauses of a test?
+### Given (some context)
+* `Given` is the section of a unit test method that
+	* initializes, instantiates, or sets the value of data to pass to test method.
+
+* **Example**
+
+```java
+// Given
+String name = "Leon";
+Integer age = 25;
+Person leon = new Person(name, age);
+```
+
+### When (some action is carried out)
+* `When` is the section of a unit test method that
+	* invokes the method under test with the arranged parameters
+
+```java
+// When
+String getNameResult = leon.getName();
+Integer getAgeResult = leon.getAge(); 
+```
+
+
+### Then (consequences should be observable)
+* `Then` is the section of a unit test method that
+	* verifies that the method to be tested behaves as expected
+
+```java
+// Then
+Assert.assertEquals(name, getNameResult);
+Assert.assertEquals(age, getAgeResult);
+```

README.md

@@ -0,0 +1,79 @@
+# TDD-AnimalFactory
+* **Objective:**
+    * To create tests that ensure expected behavior of each class:
+        * Cat
+        * Dog
+        * AnimalFactory
+        * CatHouse
+        * DogHouse
+* **Purpose:**
+    * To establish familiarity with Test-Driven-Development (TDD) practices.
+* **Getting context:**
+	* Click [here](./README-TDDPatterns.md) to gain more familiarity with TDD-structured programming.
+
+## Getting Started
+* Begin by opening the `test.java.rocks.zipcodewilmington` package and completing each of the `TODO`s.
+
+### CatTest
+* Create tests for `void setName(String name)`
+    * ensure that when `.setName` is invoked on an instance of `Cat`, the `name` field is being set to the respective value.
+* Create tests for `String speak()`
+    * ensure that when `.speak` is invoked on an instance of `Cat`, the value `"meow!"` is returned.
+* Create tests for `setBirthDate(Date birthDate)`
+    * ensure that when `.setBirthDate` is invoked on an instance of `Cat`, the `name` field is being set to the respective value.
+* Create tests for `void eat(Food food)`
+    * ensure that when `.eat` is invoked on an instance of `Cat`, the `numberOfMealsEaten` is increased by 1.
+* Create tests for `Integer getId()`
+    * ensure that when `.getId` is invoked on an instance of `Cat`, the respective `id` value is returned.
+* Create test to check Animal inheritance; google search `java instanceof keyword`
+    * ensure that a `Cat` is an `instanceof` an Animal 
+* Create test to check Mammal inheritance; google search `java instanceof keyword`
+    * ensure that a `Cat` is an `instanceof` a Mammal
+
+### DogTest
+* Create tests for `void setName(String name)`
+    * ensure that when `.setName` is invoked on an instance of `Dog`, the `name` field is being set to the respective value.
+* Create tests for `String speak()`
+    * ensure that when `.speak` is invoked on an instance of `Dog`, the value `"bark!"` is returned.
+* Create tests for `setBirthDate(Date birthDate)`
+    * ensure that when `.setBirthDate` is invoked on an instance of `Dog`, the `name` field is being set to the respective value.
+* Create tests for `void eat(Food food)`
+    * ensure that when `.eat` is invoked on an instance of `Dog`, the `numberOfMealsEaten` is increased by 1.
+* Create tests for `Integer getId()`
+    * ensure that when `.getId` is invoked on an instance of `Dog`, the respective `id` value is returned.
+* Create test to check Animal inheritance; google search `java instanceof keyword`
+    * ensure that a `Dog` is an `instanceof` an Animal 
+* Create test to check Mammal inheritance; google search `java instanceof keyword`
+    * ensure that a `Dog` is an `instanceof` an Mammal
+ 
+
+### AnimalFactoryTest
+* Create Test for `Animal createDog(String name, Date birthDate)`
+    * ensure that when `.createDog` is invoked on `AnimalFactoryTest` a `Dog` is created with the respective `name` and `birthDate` value.
+* Create Test for `Animal createCat(String name, Date birthDate)`
+    * ensure that when `.createCat` is invoked on `AnimalFactoryTest` a `Dog` is created with the respective `name` and `birthDate` value.
+
+### CatHouseTest
+* Create tests for `void add(Cat cat)`
+    * ensure that when `.add` is invoked on the `CatHouse`, a respective `Cat` object can be retrieved from the house.  
+* Create tests for `void remove(Cat cat)`
+    * ensure that when `.remove` is invoked on the `CatHouse`, a respective `Cat` object can no longer be retrieved from the house.
+* Create tests for `void remove(Integer id)`
+    * ensure that when `.remove` is invoked on the `CatHouse`, a `Cat` object with the respective `id` can no longer be retrieved from the house.
+* Create tests for `Cat getCatById(Integer id)`
+    * ensure that when `.getCatById` is invoked on the `CatHouse`, a `Cat` with the respective `id` is returned.
+* Create tests for `Integer getNumberOfCats()`
+    * ensure that when `.getNumberOfCats()` is invoked on the `CatHouse`, the respective number of `Cat` objects is returned.
+ 
+### DogHouseTest
+* Create tests for `void add(Dog dog)`
+    * ensure that when `.add` is invoked on the `DogHouse`, a respective `Dog` object can be retrieved from the house.  
+* Create tests for `void remove(Integer id)`
+    * ensure that when `.remove` is invoked on the `DogHouse`, a respective `Dog` object can no longer be retrieved from the house.
+* Create tests for `void remove(Dog dog)`
+    * ensure that when `.remove` is invoked on the `DogHouse`, a `Dog` object with the respective `id` can no longer be retrieved from the house.
+* Create tests for `Dog getDogById(Integer id)`
+    * ensure that when `.getCatById` is invoked on the `DogHouse`, a `Dog` with the respective `id` is returned.
+* Create tests for `Integer getNumberOfDogs()`
+    * ensure that when `.getNumberOfDogs()` is invoked on the `DogHouse`, the respective number of `Dog` objects is returned.
+

pom.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         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>
+
+    <groupId>rocks.zipcodewilmington</groupId>
+    <artifactId>tdd-animals</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.7.0</version>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+        </dependency>
+    </dependencies>
+
+</project>

src/main/java/rocks/zipcodewilmington/Food.java

@@ -0,0 +1,7 @@
+package rocks.zipcodewilmington;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class Food {
+}

src/main/java/rocks/zipcodewilmington/MainApplication.java

@@ -0,0 +1,7 @@
+package rocks.zipcodewilmington;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class MainApplication {
+}

src/main/java/rocks/zipcodewilmington/animals/Animal.java

@@ -0,0 +1,14 @@
+package rocks.zipcodewilmington.animals;
+
+import rocks.zipcodewilmington.Food;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public interface Animal {
+    String speak();
+    Integer getNumberOfMealsEaten();
+    Integer getId();
+    void eat(Food food);
+
+}

src/main/java/rocks/zipcodewilmington/animals/Cat.java

@@ -0,0 +1,16 @@
+package rocks.zipcodewilmington.animals;
+
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class Cat extends Mammal {
+    public Cat(String name, Date birthDate, Integer id) {
+        super(name, birthDate, id);
+    }
+
+    public String speak() {
+        return "meow!";
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/Dog.java

@@ -0,0 +1,16 @@
+package rocks.zipcodewilmington.animals;
+
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class Dog extends Mammal {
+    public Dog(String name, Date birthDate, Integer id) {
+        super(name, birthDate, id);
+    }
+
+    public String speak() {
+        return "bark!";
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/Mammal.java

@@ -0,0 +1,53 @@
+package rocks.zipcodewilmington.animals;
+
+import rocks.zipcodewilmington.Food;
+
+import java.util.ArrayList;
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public abstract class Mammal implements Animal {
+    private final Integer id;
+    private ArrayList<Food> eatenMeals;
+    private String name;
+    private Date birthDate;
+
+    public Mammal(String name, Date birthDate, Integer id) {
+        this.name = name;
+        this.birthDate = birthDate;
+        this.eatenMeals = new ArrayList<>();
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public Date getBirthDate() {
+        return birthDate;
+    }
+
+    public void setBirthDate(Date birthDate) {
+        this.birthDate = birthDate;
+    }
+
+
+    public Integer getNumberOfMealsEaten() {
+        return eatenMeals.size();
+    }
+
+    public void eat(Food food) {
+        eatenMeals.add(food);
+    }
+
+    @Override
+    public Integer getId() {
+        return id;
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/animal_creation/AnimalFactory.java

@@ -0,0 +1,25 @@
+package rocks.zipcodewilmington.animals.animal_creation;
+
+import rocks.zipcodewilmington.animals.Animal;
+import rocks.zipcodewilmington.animals.Cat;
+import rocks.zipcodewilmington.animals.Dog;
+import rocks.zipcodewilmington.animals.animal_storage.CatHouse;
+import rocks.zipcodewilmington.animals.animal_storage.DogHouse;
+
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ * This class is responsible for creating animals and automatically assigning them an id
+ */
+public class AnimalFactory {
+    public static Dog createDog(String name, Date birthDate) {
+        Integer newId = DogHouse.getNumberOfDogs();
+        return new Dog(name, birthDate, newId);
+    }
+
+    public static Cat createCat(String name, Date birthDate) {
+        Integer newId = CatHouse.getNumberOfCats();
+        return new Cat(name, birthDate, newId);
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/animal_storage/AnimalWarehouse.java

@@ -0,0 +1,42 @@
+package rocks.zipcodewilmington.animals.animal_storage;
+
+import rocks.zipcodewilmington.animals.Animal;
+
+import java.util.ArrayList;
+
+/**
+ * @author leon on 4/19/18.
+ * this class is an abstraction of how Animals are stored and retrieved
+ */
+class AnimalWarehouse<AnimalType extends Animal> {
+    private volatile ArrayList<AnimalType> list = new ArrayList<>();
+
+    public void add(AnimalType animal) {
+        list.add(animal);
+    }
+
+    public AnimalType getAnimalById(int id) {
+        for(AnimalType animal : list) {
+            if(animal.getId() == id) {
+                return animal;
+            }
+        }
+        return null;
+    }
+
+    public void removeAnimal(Animal animal) {
+        list.remove(animal);
+    }
+
+    public void removeAnimalById(int id) {
+        removeAnimal(getAnimalById(id));
+    }
+
+    public Integer getNumberOfAnimals() {
+        return list.size();
+    }
+
+    public void clear() {
+        list.clear();
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/animal_storage/CatHouse.java

@@ -0,0 +1,35 @@
+package rocks.zipcodewilmington.animals.animal_storage;
+
+
+import rocks.zipcodewilmington.animals.Cat;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class CatHouse {
+    private static AnimalWarehouse<Cat> catHouse = new AnimalWarehouse<>();
+
+    public static void add(Cat cat) {
+        catHouse.add(cat);
+    }
+
+    public static void remove(Integer id) {
+        catHouse.removeAnimalById(id);
+    }
+
+    public static void remove(Cat cat) {
+        catHouse.removeAnimal(cat);
+    }
+
+    public static Cat getCatById(Integer id) {
+        return catHouse.getAnimalById(id);
+    }
+
+    public static Integer getNumberOfCats() {
+        return catHouse.getNumberOfAnimals();
+    }
+
+    public static void clear() {
+        catHouse.clear();
+    }
+}

src/main/java/rocks/zipcodewilmington/animals/animal_storage/DogHouse.java

@@ -0,0 +1,34 @@
+package rocks.zipcodewilmington.animals.animal_storage;
+
+import rocks.zipcodewilmington.animals.Dog;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class DogHouse {
+    private static AnimalWarehouse<Dog> dogHouse = new AnimalWarehouse<>();
+
+    public static void add(Dog dog) {
+        dogHouse.add(dog);
+    }
+
+    public static void remove(Integer id) {
+        dogHouse.removeAnimalById(id);
+    }
+
+    public static void remove(Dog dog) {
+        dogHouse.removeAnimal(dog);
+    }
+
+    public static Dog getDogById(Integer id) {
+        return dogHouse.getAnimalById(id);
+    }
+
+    public static Integer getNumberOfDogs() {
+        return dogHouse.getNumberOfAnimals();
+    }
+
+    public static void clear() {
+        dogHouse.clear();
+    }
+}

src/test/java/rocks/zipcodewilmington/AnimalFactoryTest.java

@@ -0,0 +1,9 @@
+package rocks.zipcodewilmington;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class AnimalFactoryTest {
+    //TODO - Create Test for `Animal createDog(String name, Date birthDate)`
+    //TODO - Create Test for `Animal createCat(String name, Date birthDate)`
+}

src/test/java/rocks/zipcodewilmington/CatHouseTest.java

@@ -0,0 +1,12 @@
+package rocks.zipcodewilmington;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class CatHouseTest {
+    // TODO - Create tests for `void add(Cat cat)`
+    // TODO - Create tests for `void remove(Integer id)`
+    // TODO - Create tests for `void remove(Cat cat)`
+    // TODO - Create tests for `Cat getCatById(Integer id)`
+    // TODO - Create tests for `Integer getNumberOfCats()`
+}

src/test/java/rocks/zipcodewilmington/CatTest.java

@@ -0,0 +1,43 @@
+package rocks.zipcodewilmington;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcodewilmington.animals.Cat;
+
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class CatTest {
+    // TODO - Create tests for `void setName(String name)`
+    // TODO - Create tests for `speak`
+    // TODO - Create tests for `setBirthDate(Date birthDate)`
+    // TODO - Create tests for `void eat(Food food)`
+    // TODO - Create tests for `Integer getId()`
+    // TODO - Create test to check Animal inheritance; google search `java instanceof keyword`
+    // TODO - Create test to check Mammal inheritance; google search `java instanceof keyword`
+
+
+    @Test
+    public void constructorTest() {
+        // Given (cat data)
+        String givenName = "Zula";
+        Date givenBirthDate = new Date();
+        Integer givenId = 0;
+
+        // When (a cat is constructed)
+        Cat cat = new Cat(givenName, givenBirthDate, givenId);
+
+        // When (we retrieve data from the cat)
+        String retrievedName = cat.getName();
+        Date retrievedBirthDate = cat.getBirthDate();
+        Integer retrievedId = cat.getId();
+
+        // Then (we expect the given data, to match the retrieved data)
+        Assert.assertEquals(givenName, retrievedName);
+        Assert.assertEquals(givenBirthDate, retrievedBirthDate);
+        Assert.assertEquals(givenId, retrievedId);
+    }
+
+}

src/test/java/rocks/zipcodewilmington/DogHouseTest.java

@@ -0,0 +1,34 @@
+package rocks.zipcodewilmington;
+
+import org.junit.Test;
+import rocks.zipcodewilmington.animals.Dog;
+import rocks.zipcodewilmington.animals.animal_creation.AnimalFactory;
+import rocks.zipcodewilmington.animals.animal_storage.DogHouse;
+
+import java.util.Date;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class DogHouseTest {
+    // TODO - Create tests for `void add(Dog dog)`
+    // TODO - Create tests for `void remove(Integer id)`
+    // TODO - Create tests for `void remove(Dog dog)`
+    // TODO - Create tests for `Dog getDogById(Integer id)`
+    // TODO - Create tests for `Integer getNumberOfDogs()`
+
+    @Test
+    public void testGetNumberOfDogs() {
+        // Given (some
+        String name = "Milo";
+        Date birthDate = new Date();
+        Dog animal = AnimalFactory.createDog(name, birthDate);
+        DogHouse.clear();
+
+        // When
+        DogHouse.add(animal);
+
+        // Then
+        DogHouse.getNumberOfDogs();
+    }
+}

src/test/java/rocks/zipcodewilmington/DogTest.java

@@ -0,0 +1,31 @@
+package rocks.zipcodewilmington;
+
+import org.junit.Assert;
+import org.junit.Test;
+import rocks.zipcodewilmington.animals.Dog;
+
+/**
+ * @author leon on 4/19/18.
+ */
+public class DogTest {
+    // TODO - Create tests for `new Dog(String name, Date birthDate, Integer id)`
+    // TODO - Create tests for `speak`
+    // TODO - Create tests for `setBirthDate(Date birthDate)`
+    // TODO - Create tests for `void eat(Food food)`
+    // TODO - Create tests for `Integer getId()`
+    // TODO - Create test to check Animal inheritance; google search `java instanceof keyword`
+    // TODO - Create test to check Mammal inheritance; google search `java instanceof keyword`
+    @Test
+    public void setNameTest() {
+        // Given (a name exists and a dog exists)
+        Dog dog = new Dog(null, null, null);
+        String givenName = "Milo";
+
+        // When (a dog's name is set to the given name)
+        dog.setName(givenName);
+
+        // Then (we expect to get the given name from the dog)
+        String dogName = dog.getName();
+        Assert.assertEquals(dogName, givenName);
+    }
+}