Merge pull request stleary#35 from stleary/more-todo-cleanup

clean up a few more todos

Author: stleary

JSONStringerTest.java

@@ -11,8 +11,7 @@
 
 
 /**
- * Tests for JSON-Java JSONStringer. 
- * TODO: Could use a lot more testing. For example, cascade-style productions.
+ * Tests for JSON-Java JSONStringer and JSONWriter.
  */
 public class JSONStringerTest {
 
@@ -234,43 +233,44 @@ public void simpleArrayString() {
     }
 
     /**
-     * Build a nested JSON doc using JSONString API calls,
-     * then convert to JSONObject
+     * Build a nested JSON doc using JSONString API calls, then convert to
+     * JSONObject. Will create a long cascade of output by reusing the
+     * returned values..
      */
     @Test
     public void complexObjectString() {
         JSONStringer jsonStringer = new JSONStringer();
-        jsonStringer.object();
-        jsonStringer.key("trueValue").value(true);
-        jsonStringer.key("falseValue").value(false);
-        jsonStringer.key("nullValue").value(null);
-        jsonStringer.key("stringValue").value("hello world!");
-        jsonStringer.key("object2").object();
-        jsonStringer.key("k1").value("v1");
-        jsonStringer.key("k2").value("v2");
-        jsonStringer.key("k3").value("v3");
-        jsonStringer.key("array1").array();
-        jsonStringer.value(1);
-        jsonStringer.value(2);
-        jsonStringer.object();
-        jsonStringer.key("k4").value("v4");
-        jsonStringer.key("k5").value("v5");
-        jsonStringer.key("k6").value("v6");
-        jsonStringer.key("array2").array();
-        jsonStringer.value(5);
-        jsonStringer.value(6);
-        jsonStringer.value(7);
-        jsonStringer.value(8);
-        jsonStringer.endArray();
-        jsonStringer.endObject();
-        jsonStringer.value(3);
-        jsonStringer.value(4);
-        jsonStringer.endArray();
-        jsonStringer.endObject();
-        jsonStringer.key("complexStringValue").value("h\be\tllo w\u1234orld!");
-        jsonStringer.key("intValue").value(42);
-        jsonStringer.key("doubleValue").value(-23.45e67);
-        jsonStringer.endObject();
+        jsonStringer.object().
+            key("trueValue").value(true).
+            key("falseValue").value(false).
+            key("nullValue").value(null).
+            key("stringValue").value("hello world!").
+            key("object2").object().
+            key("k1").value("v1").
+            key("k2").value("v2").
+            key("k3").value("v3").
+            key("array1").array().
+            value(1).
+            value(2).
+            object().
+            key("k4").value("v4").
+            key("k5").value("v5").
+            key("k6").value("v6").
+            key("array2").array().
+            value(5).
+            value(6).
+            value(7).
+            value(8).
+            endArray().
+            endObject().
+            value(3).
+            value(4).
+            endArray().
+            endObject().
+            key("complexStringValue").value("h\be\tllo w\u1234orld!").
+            key("intValue").value(42).
+            key("doubleValue").value(-23.45e67).
+            endObject();
         String str = jsonStringer.toString();
         JSONObject jsonObject = new JSONObject(str);
 

Util.java

@@ -59,24 +59,26 @@ public static void compareActualVsExpectedJsonObjects(
     private static void compareActualVsExpectedObjects(Object value,
             Object expectedValue) {
         if (value instanceof JSONObject && expectedValue instanceof JSONObject) {
+            // Compare JSONObjects
             JSONObject jsonObject = (JSONObject)value;
             JSONObject expectedJsonObject = (JSONObject)expectedValue;
             compareActualVsExpectedJsonObjects(
                     jsonObject, expectedJsonObject);
         } else if (value instanceof JSONArray && expectedValue instanceof JSONArray) {
+            // Compare JSONArrays
             JSONArray jsonArray = (JSONArray)value;
             JSONArray expectedJsonArray = (JSONArray)expectedValue;
             compareActualVsExpectedJsonArrays(
                     jsonArray, expectedJsonArray);
         } else {
             /**
-             * Certain helper classes (e.g. XML) may create Long instead of
-             * Integer for small int values. As long as both are Numbers,
-             * just compare the toString() values.
-             * TODO: this may not work in the case where the underlying types
-             * do not have the same precision.
+             * Compare all other types using toString(). First, the types must
+             * also be equal, unless both are Number type. Certain helper
+             * classes (e.g. XML) may create Long instead of Integer for small
+             * int values.
              */
             if (!(value instanceof Number && expectedValue instanceof Number)) {
+                // Non-Number and non-matching types
                 assertTrue("object types should be equal for actual: "+
                     value.toString()+" ("+
                     value.getClass().toString()+") expected: "+
@@ -86,8 +88,7 @@ private static void compareActualVsExpectedObjects(Object value,
                             expectedValue.getClass().toString()));
             }
             /**
-             * When in doubt, compare by string
-             * TODO: should not this be an else to the previous condition?
+             * Same types or both Numbers, compare by toString()
              */
             assertTrue("string values should be equal for actual: "+
                 value.toString()+" expected: "+expectedValue.toString(),