first commit

.gitignore

@@ -0,0 +1,3 @@
+.idea/*
+*.iml
+target/*

README.md

@@ -0,0 +1,65 @@
+-
+-
+#ZCW-MicroLabs-ExceptionsAndLogging
+
+-
+#PhoneNumberFactory
+* **Purpose** - to demonstrate basic exception handling and logging.
+* **Objective** - to implement a `PhoneNumberFactory` class that generates `PhoneNumber` objects.
+* The `PhoneNumber` class is a container for a `String` representation of a respective phone number.
+* Note: Phone numbers are a composite of 3 affixes; `Area Code`, `Central Office Code`, and `Phone Line Code`.
+	* `Area Code`  - the first 3 numeric values
+	* `Central Office Code` - the 4th, 5th, and 6th numeric values.
+	* `Phone Line Code` - the last 3 numeric values. 
+
+* Below is a sample *instantation of* and *invokation on* `PhoneNumber`.
+	
+```Java
+String stringRepresentation = "(302)-312-5555)";
+PhoneNumber phoneNumber = new PhoneNumber(stringRepresentation);
+String areaCode = phoneNumber.getAreaCode();
+String centralOfficeCode = phoneNumber.getCentralOfficeCode();
+String phoneLineCode = phoneNumber.getPhoneLineCode();
+```
+
+
+-
+#Part 1; Modify `createPhoneNumber`
+* Upon instantiating a new `PhoneNumber` object, it is possible to receive a `InvalidPhoneNumberFormatException` if the `String` passed into the `PhoneNumber` constructor does not fit the format `(###)-###-####`.<br>
+* `InvalidPhoneNumberFormatException` extends `IOException`, which is a `checked exception`.<br>
+* Modify the `createPhoneNumber` method so that it throws any resulting `InvalidPhoneNumberFormatException`.
+	* This will ensure that any method calling `createPhoneNumber` will have to handle the exception.
+
+
+
+-
+#Part 2; Implement `createPhoneNumberSafely`
+* Using the `createPhoneNumber` method from `Part 1`, define the `createPhoneNumberSafely` method such that the input parameters, `areaCode`, `centralOfficeCode`, `phoneLineCode` are concatenated to create a `String` representation of the respective phone number.
+* Use this `String` object to construct a new instance of `PhoneNumber` and return it.
+* If the concatentation of the input parameters yields a `String` whose value does not match the format `(###)-###-####`, then our `PhoneNumber` will throw a `InvalidPhoneNumberFormatException`.
+* If a `InvalidPhoneNumberFormatException` is thrown within this method, catch it and return `null`.
+
+
+-
+#Part 3; Implement `createRandomPhoneNumber`
+* Using the `RandomNumberFactory`, generate a random `Area Code`, `Central Office Code`, and `Phone Line Code`. Pass these values as arguments of the `createPhoneNumberSafely` method from `Part 2` and return the resulting `PhoneNumber` object.
+
+-
+#Part 4; Implement `createRandomPhoneNumberArray`
+* Using the `createRandomPhoneNumber` from `Part 3`, generate an array of `PhoneNumber` objects, whose length reflects the input argument.
+	* For example `createRandomPhoneNumber(5)` should return an array of 5 `PhoneNumber` objects.
+
+
+-
+#Part 5; Add logging
+* Add logging to the `createPhoneNumber` method from `Part 1`, which logs the message
+	* `"Attempting to create a new PhoneNumber object with a value of (###)-###-####`
+	* where `(###)-###-####` will be replaced with the respective input parameter.
+
+* Add logging to the `createPhoneNumberSafely` method from `Part 2`, which logs the message
+	* `(###)-###-#### is not a valid phone number`
+	* Where `(###)-###-####` will be replaced with the respective input parameter.
+
+	
+#Part 6; Ensure all test cases pass
+* Yeah this header says all that is needed...

pom.xml

@@ -0,0 +1,43 @@
+<?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>zcw</groupId>
+    <artifactId>exceptions-assertions-logging</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>1.7</source>
+                    <target>1.7</target>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.5</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+            <version>1.7.5</version>
+        </dependency>
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>RELEASE</version>
+        </dependency>
+    </dependencies>
+
+</project>

src/main/java/com/zipcodewilmington/exceptions/InvalidPhoneNumberFormatException.java

@@ -0,0 +1,9 @@
+package com.zipcodewilmington.exceptions;
+
+import java.io.IOException;
+
+/**
+ * Created by leon on 5/10/17.
+ */ // Checked Exception
+public final class InvalidPhoneNumberFormatException extends IOException {
+}

src/main/java/com/zipcodewilmington/phone/PhoneNumber.java

@@ -0,0 +1,41 @@
+package com.zipcodewilmington.phone;
+
+import com.zipcodewilmington.exceptions.InvalidPhoneNumberFormatException;
+
+/**
+ * Created by leon on 5/10/17.
+ */
+public final class PhoneNumber {
+    private final String phoneNumberString;
+
+    // default constructor is uncallable
+    private PhoneNumber() throws InvalidPhoneNumberFormatException {
+        this(null);
+    }
+
+    // non-default constructor is package-protected
+    protected PhoneNumber(String phoneNumber) throws InvalidPhoneNumberFormatException {
+        //validate phone number with format `(###)-###-####`
+        if (!phoneNumber.matches("\\(\\d{3}\\)-\\d{3}-\\d{4}")) {
+            throw new InvalidPhoneNumberFormatException();
+        }
+        this.phoneNumberString = phoneNumber;
+    }
+
+    public String getAreaCode() {
+        return toString().substring(1, 4);
+    }
+
+    public String getCentralOfficeCode() {
+        return toString().substring(6, 9);
+    }
+
+    public String getPhoneLineCode() {
+        return toString().substring(10, 14);
+}
+
+    @Override
+    public String toString() {
+        return phoneNumberString;
+    }
+}

src/main/java/com/zipcodewilmington/phone/PhoneNumberFactory.java

@@ -0,0 +1,53 @@
+package com.zipcodewilmington.phone;
+
+import com.zipcodewilmington.exceptions.InvalidPhoneNumberFormatException;
+import com.zipcodewilmington.tools.RandomNumberFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Created by leon on 5/1/17.
+ */
+public final class PhoneNumberFactory {
+    private static final Logger logger = LoggerFactory.getLogger(PhoneNumberFactory.class);
+
+    private PhoneNumberFactory() {
+        /** This constructor is private
+         *  This class is uninstantiable */
+    }
+
+    /**
+     * @param phoneNumberCount - number of PhoneNumber objects to instantiate
+     * @return array of randomly generated PhoneNumber objects
+     */ //TODO - Implement logic
+    public static PhoneNumber[] createRandomPhoneNumberArray(int phoneNumberCount) {
+        return null;
+    }
+
+    /**
+     * @return an instance of PhoneNumber with randomly generated phone number value
+     */ //TODO - Implement logic
+    private static PhoneNumber createRandomPhoneNumber() {
+        return createPhoneNumberSafely(-1, -1, -1);
+    }
+
+
+    /**
+     * @param areaCode          - 3 digit code
+     * @param centralOfficeCode - 3 digit code
+     * @param phoneLineCode     - 4 digit code
+     * @return a new phone number object
+     */ //TODO - if input is valid, return respective PhoneNumber object, else return null
+    public static PhoneNumber createPhoneNumberSafely(int areaCode, int centralOfficeCode, int phoneLineCode) {
+        return createPhoneNumber(null);
+    }
+
+    /**
+     * @param phoneNumberString - some String corresponding to a phone number whose format is `(###)-###-####`
+     * @return a new phone number object
+     * @throws InvalidPhoneNumberFormatException - thrown if phoneNumberString does not match acceptable format
+     */ // TODO - Add throws statement to method signature
+    public static PhoneNumber createPhoneNumber(String phoneNumberString) {
+        return null;
+    }
+}

src/main/java/com/zipcodewilmington/tools/RandomNumberFactory.java

@@ -0,0 +1,21 @@
+package com.zipcodewilmington.tools;
+import java.awt.*;
+import java.util.*;
+
+/**
+ * Created by Leon on 2/4/2017.
+ */
+
+public abstract class RandomNumberFactory {
+    private static final Random random = new Random();
+
+    /** @return a random float between the specified min and max numeric range */
+    public static Float createFloat(float min, float max) {
+        return random.nextFloat() * (max - min) + min;
+    }
+
+    /** @return a random integer between the specified min and max numeric range */
+    public static Integer createInteger(Integer min, Integer max) {
+        return createFloat(min, max).intValue();
+    }
+}

src/main/resources/log4j.properties

@@ -0,0 +1,16 @@
+# Root logger option
+log4j.rootLogger=DEBUG, stdout, file
+
+# Redirect log messages to console
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+log4j.appender.stdout.Target=System.out
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n
+
+# Redirect log messages to a log file, support file rolling.
+log4j.appender.file=org.apache.log4j.RollingFileAppender
+log4j.appender.file.File=log4j-application.log
+log4j.appender.file.MaxFileSize=5MB
+log4j.appender.file.MaxBackupIndex=10
+log4j.appender.file.layout=org.apache.log4j.PatternLayout
+log4j.appender.file.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n

src/test/java/com/zipcodewilmington/PhoneNumberFactoryTest.java

@@ -0,0 +1,93 @@
+package com.zipcodewilmington;
+
+import com.zipcodewilmington.exceptions.InvalidPhoneNumberFormatException;
+import com.zipcodewilmington.phone.PhoneNumber;
+import com.zipcodewilmington.phone.PhoneNumberFactory;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Created by leon on 5/9/17.
+ */
+public class PhoneNumberFactoryTest {
+
+    @Test(expected = InvalidPhoneNumberFormatException.class)
+    public void testInvalidPhoneNumberFormatException() throws InvalidPhoneNumberFormatException {
+        PhoneNumberFactory.createPhoneNumber("-1");
+    }
+
+    @Test
+    public void testCreatePhoneNumberSafely() {
+        // : Given
+        int areaCode = 0;
+        int centralOfficeCode = 0;
+        int phoneLineCode = 0;
+
+        // : When
+        PhoneNumber phoneNumber = PhoneNumberFactory.createPhoneNumberSafely(areaCode, centralOfficeCode, phoneLineCode);
+
+        // : Then
+        Assert.assertEquals(null, phoneNumber);
+    }
+
+    @Test
+    public void testGetAreaCode() {
+        // : Given
+        Integer areaCode = 302;
+        int centralOfficeCode = 312;
+        int phoneLineCode = 5555;
+
+        // : When
+        PhoneNumber phoneNumber = PhoneNumberFactory.createPhoneNumberSafely(areaCode, centralOfficeCode, phoneLineCode);
+
+        // : Then
+        Assert.assertEquals(phoneNumber.getAreaCode(), areaCode.toString());
+    }
+
+    @Test
+    public void testGetCentralOfficeCode() {
+        // : Given
+        int areaCode = 302;
+        Integer centralOfficeCode = 312;
+        int phoneLineCode = 5555;
+
+        // : When
+        PhoneNumber phoneNumber = PhoneNumberFactory.createPhoneNumberSafely(areaCode, centralOfficeCode, phoneLineCode);
+
+        // : Then
+        Assert.assertEquals(phoneNumber.getCentralOfficeCode(), centralOfficeCode.toString());
+    }
+
+
+    @Test
+    public void testPhoneLineCode() {
+        // : Given
+        int areaCode = 302;
+        int centralOfficeCode = 312;
+        Integer phoneLineCode = 5555;
+
+        // : When
+        PhoneNumber phoneNumber = PhoneNumberFactory.createPhoneNumberSafely(areaCode, centralOfficeCode, phoneLineCode);
+
+        // : Then
+        Assert.assertEquals(phoneNumber.getPhoneLineCode(), phoneLineCode.toString());
+    }
+
+    @Test
+    public void testCreateRandomPhoneNumber() {
+        Logger.getGlobal().setLevel(Level.OFF);
+        // : Given
+        PhoneNumber[] phoneNumbers = PhoneNumberFactory.createRandomPhoneNumberArray(999);
+
+        // : When
+        for (PhoneNumber phoneNumber : phoneNumbers) {
+
+            // : Then
+            Assert.assertTrue(phoneNumber != null);
+        }
+    }
+}