Added readme and comments on assignment

Bonus.java

@@ -1,22 +1,40 @@
-
-/**
- * Write a description of class Bonus here.
- *
- * @author (your name)
- * @version (a version number or a date)
- */
 public class Bonus
 {
-    public String acronym(String phrase) {
-        return null;
-    }
-    
-    public String encrypt(String word) {
-        return null;
-    }
-   
-    
-    public int factorial(int number){
-        return -1;
-    }
+
+      /**
+       * Given a number, return the factorial of that number.
+       * For example, given 5, the factorial is 5 x 4 x 3 x 2 x 1 which should return 120.
+       * @param number
+       * @return the factorial of the number
+       */
+      public int factorial(int number){
+          return -1;
+      }
+
+      /**
+       * Given a phrase, get the acronym of that phrase. Acronym is the combination of
+       * the first character of each word in upper case.
+       * For example, given "Ruby on Rails", this method will return "ROR"
+       * @param phrase
+       * @return Upper case of the first letter of each word
+       */
+      public String acronym(String phrase) {
+          return null;
+      }
+
+      /**
+       * To prevent anyone from reading our messages, we can encrypt it so it will not be readable by anyone except it
+       * intended audience. This method encrypt the message by shifting the character by 3 characters. If the character is
+       * at the end of the alphabet, it will wraps around.
+       * For example:
+       *  'a' => 'd'
+       *  'w' => 'z'
+       *  'x' => 'a'
+       *  'y' => 'b'
+       * @param word
+       * @return the encrypted string by shifting each character by three character
+       */
+      public String encrypt(String word) {
+          return null;
+      }
 }

MathUtilities.java

@@ -1,19 +1,50 @@
 public class MathUtilities{
-    
-    public int add(int num1, int num2){
-        return -1;
-    }
-    
-    public double add(double num1, double num2){
-        return -1;
-    }
-    
-    public double half(int number) {
-        return -1;
-    }
-    
-    public boolean isOdd(int number){
-        return false;
-    }
+  /**
+   * Add two number together
+   * @param num1 first number
+   * @param num2 second number
+   * @return the sum of the two numbers
+   */
+  public int add(int num1, int num2){
+      return -1;
+  }
+
+  /**
+   * Add two number together
+   * @param num1 first number
+   * @param num2 second number
+   * @return the sum of the two numbers
+   */
+  public double add(double num1, double num2){
+      return -1;
+  }
+
+  /**
+   * Get half the value of the number
+   * @param number the number given
+   * @return the half of the number in double
+   */
+  public double half(int number) {
+      return -1;
+  }
+
+  /**
+   * Determine if the number is odd
+   * @param number the number given
+   * @return true if the number is odd, false if it is even
+   */
+  public boolean isOdd(int number){
+      return false;
+  }
+
+
+  /**
+   * Multiply the number by itself
+   * @param number the number given
+   * @return the result of the number multiply by itself
+   */
+  public int square(int number) {
+      return -1;
+  }
 
 }

MathUtilitiesTest.java

@@ -14,62 +14,98 @@ public class MathUtilitiesTest
     public void setup(){
         utilities = new MathUtilities();
     }
-    
+
     @Test
     public void testAddInteger(){
         //Given
         int expected = 15;
-        
+
         //When
         int actual = utilities.add(7, 8);
-        
+
         //Then
         assertEquals(expected, actual);
     }
-    
+
     @Test
     public void testAddDouble(){
         //Given
         double expected = 11.22;
-        
+
         //When
         double actual = utilities.add(10, 1.22);
-        
+
         //Then
         assertEquals(expected, actual, DELTA);
     }
-    
+
     @Test
     public void testHalfForEven(){
         //Given
         double expected = 2.0;
-        
+
         //When
         double actual = utilities.half(4);
-        
+
         //Then
         assertEquals(expected, actual, DELTA);
     }
-    
+
     @Test
     public void testHalfForOdd(){
         //Given
         double expected = 12.5;
-        
+
         //When
         double actual = utilities.half(25);
-        
+
         //Then
         assertEquals(expected, actual, DELTA);
     }
-    
+
     @Test
-    public void testIsOdd_forOddNumber(){
+    public void testIsOddForOddNumber(){
         assertTrue(utilities.isOdd(7));
     }
-    
+
     @Test
-    public void testIsOdd_forEvenNumber(){
+    public void testIsOddForEvenNumber(){
         assertFalse(utilities.isOdd(12));
     }
+
+    @Test
+    public void testSquareForBaseCase() {
+      //Given
+      int expected = 1;
+
+      //When
+      int actual = utilities.square(1);
+
+      //Then
+      assertEquals(expected, actual);
+    }
+
+    @Test
+    public void testSquareForOneDigit() {
+      //Given
+      int expected = 9;
+
+      //When
+      int actual = utilities.square(3);
+
+      //Then
+      assertEquals(expected, actual);
+    }
+
+    @Test
+    public void testSquareForTwoDigit() {
+      //Given
+      int expected = 121;
+
+      //When
+      int actual = utilities.square(11);
+
+      //Then
+      assertEquals(expected, actual);
+    }
 }

README.MD

@@ -0,0 +1,32 @@
+# Quiz 1
+You have one hour to complete this quiz. You are required to do section 1 & 2. Section 3 is a bonus section, which means do it if you finish the other two sections before the hour is up.
+
+### **Instructions:**
+
+1. Fork this Repository
+    * [fork](https://help.github.com/articles/fork-a-repo/) this repository to your personal github account
+    * [clone](https://help.github.com/articles/cloning-a-repository/) **your** `forked` repository to your local machine
+    * Write the code to make all the tests pass. See below for instructions.
+      * MAKE SURE YOUR CODE COMPILES
+      * Run the test to verify your code
+    * `git add .` to add files you want to commit
+    * `git commit -m "commit message"` to commit your changes
+    * `git push` your staged files to your remote repository
+    * submit a `pull request` which compares Zipcoder `master` to your `master`
+
+## Section 1 - MathUtilities
+Make all the tests in the `MathUtilitiesTest` class pass. All the methods have been stubbed out for you in the `MathUtilities` class. Each of the method has a comment above it to describe the expected behavior. Look at the test case to see example of input and expected output.
+  - `int add(int num1, int num2)`
+  - `double add(double num1, double num2)`
+  - `double half(int number)`
+  - `boolean isOdd(int number)`
+  - `int square(int number)`
+
+## Section 2 - StringUtilities
+Make all the tests in the `StringUtilitiesTest` class pass. All the methods have been stubbed out for you in the `StringUtilities` class. Each of the method has a comment above it to describe the expected behavior. Look at the test case to see example of input and expected output.
+
+  - `Character getMiddleCharacter(String word)`
+  - `String removeCharacter(String value, char charToRemove)`
+  - `String getLastWord(String value)`
+
+## Section 3 - Bonus

README.TXT

@@ -1,12 +0,0 @@
-------------------------------------------------------------------------
-This is the project README file. Here, you should describe your project.
-Tell the reader (someone who does not know anything about this project)
-all he/she needs to know. The comments should usually include at least:
-------------------------------------------------------------------------
-
-PROJECT TITLE:
-PURPOSE OF PROJECT:
-VERSION or DATE:
-HOW TO START THIS PROJECT:
-AUTHORS:
-USER INSTRUCTIONS:

package.bluej

@@ -2,22 +2,28 @@
 dependency1.from=StringUtilitiesTest
 dependency1.to=StringUtilities
 dependency1.type=UsesDependency
+dependency2.from=BonusTest
+dependency2.to=Bonus
+dependency2.type=UsesDependency
+dependency3.from=MathUtilitiesTest
+dependency3.to=MathUtilities
+dependency3.type=UsesDependency
 editor.fx.0.height=722
-editor.fx.0.width=800
-editor.fx.0.x=166
-editor.fx.0.y=127
+editor.fx.0.width=876
+editor.fx.0.x=158
+editor.fx.0.y=216
 objectbench.height=164
-objectbench.width=776
+objectbench.width=669
 package.divider.horizontal=0.6
-package.divider.vertical=0.6845018450184502
-package.editor.height=364
-package.editor.width=674
+package.divider.vertical=0.7628294036061026
+package.editor.height=543
+package.editor.width=567
 package.editor.x=557
 package.editor.y=43
-package.frame.height=600
-package.frame.width=800
-package.numDependencies=1
-package.numTargets=2
+package.frame.height=779
+package.frame.width=693
+package.numDependencies=3
+package.numTargets=6
 package.showExtends=true
 package.showUses=true
 project.charset=UTF-8
@@ -31,13 +37,43 @@ target1.name=StringUtilitiesTest
 target1.showInterface=false
 target1.type=UnitTestTargetJunit4
 target1.width=110
-target1.x=100
-target1.y=-20
-target2.association=StringUtilitiesTest
+target1.x=110
+target1.y=150
 target2.height=50
-target2.name=StringUtilities
+target2.name=BonusTest
 target2.showInterface=false
-target2.type=ClassTarget
-target2.width=110
-target2.x=70
-target2.y=10
+target2.type=UnitTestTargetJunit4
+target2.width=80
+target2.x=120
+target2.y=270
+target3.association=BonusTest
+target3.height=50
+target3.name=Bonus
+target3.showInterface=false
+target3.type=ClassTarget
+target3.width=80
+target3.x=90
+target3.y=300
+target4.association=MathUtilitiesTest
+target4.height=50
+target4.name=MathUtilities
+target4.showInterface=false
+target4.type=ClassTarget
+target4.width=100
+target4.x=80
+target4.y=70
+target5.association=StringUtilitiesTest
+target5.height=50
+target5.name=StringUtilities
+target5.showInterface=false
+target5.type=ClassTarget
+target5.width=110
+target5.x=80
+target5.y=180
+target6.height=50
+target6.name=MathUtilitiesTest
+target6.showInterface=false
+target6.type=UnitTestTargetJunit4
+target6.width=100
+target6.x=110
+target6.y=40