Merge pull request skyscreamer#76 from picimako/feature/various-updates

carterpage · web-flow · commit 8af86e361dc1 · 2017-03-19T10:17:22.000-04:00
Feature/various updates
diff --git a/src/main/java/org/json/JSONString.java b/src/main/java/org/json/JSONString.java
@@ -5,7 +5,7 @@
 * the behavior of JSONObject.toString(), JSONArray.toString(), and JSONWriter.value(Object). 
 * The toJSONString method will be used instead of the default behavior of using the 
 * Object's toString() method and quoting the result.
- * 
+ *
 * @author sasdjb
 *
 */
@@ -15,6 +15,6 @@ public interface JSONString{
 * The toJSONString method allows a class to produce its own JSON 
 * serialization.
 * */
- public String toJSONString();
+ String toJSONString();
 
 }
diff --git a/src/main/java/org/skyscreamer/jsonassert/ArrayValueMatcher.java b/src/main/java/org/skyscreamer/jsonassert/ArrayValueMatcher.java
@@ -147,8 +147,8 @@ public ArrayValueMatcher(JSONComparator comparator, int index){
 	 * 
 	 * @param comparator
 	 * comparator to use to compare elements
-	 * @from first element in actual array to compared
-	 * @to last element in actual array to compared
+	 * @param from first element in actual array to compared
+	 * @param to last element in actual array to compared
 	 */
 	public ArrayValueMatcher(JSONComparator comparator, int from, int to){
 		assert comparator != null : "comparator null";
diff --git a/src/main/java/org/skyscreamer/jsonassert/Customization.java b/src/main/java/org/skyscreamer/jsonassert/Customization.java
@@ -24,18 +24,7 @@ private String buildPatternLevel1(String path){
 		String regex = "\\*\\*\\.";
 		String replacement = "(?:.+\\.)?";
 
-		StringBuilder sb = new StringBuilder();
-		String[] parts = path.split(regex);
-		for (int i = 0; i < parts.length; i++){
-			String part = parts[i];
-
-			sb.append(buildPatternLevel2(part));
-			if (i < parts.length - 1){
-				sb.append(replacement);
-			}
-		}
-
-		return sb.toString();
+		return buildPattern(path, regex, replacement, 1);
 	}
 
 	private String buildPatternLevel2(String s){
@@ -45,17 +34,7 @@ private String buildPatternLevel2(String s){
 		String regex = "\\*\\*";
 		String replacement = ".+";
 
-		StringBuilder sb = new StringBuilder();
-		String[] parts = s.split(regex);
-		for (int i = 0; i < parts.length; i++){
-			String part = parts[i];
-
-			sb.append(buildPatternLevel3(part));
-			if (i < parts.length - 1){
-				sb.append(replacement);
- }
- }
-		return sb.toString();
+		return buildPattern(s, regex, replacement, 2);
 	}
 
 	private String buildPatternLevel3(String s){
@@ -66,19 +45,41 @@ private String buildPatternLevel3(String s){
 		String regex = "\\*";
 		String replacement = "[^\\.]+";
 
+		return buildPattern(s, regex, replacement, 3);
+	}
+
+	private String buildPattern(String path, String regex, String replacement, int level){
 		StringBuilder sb = new StringBuilder();
-		String[] parts = s.split(regex);
+		String[] parts = path.split(regex);
 		for (int i = 0; i < parts.length; i++){
-			String part = parts[i];
-
-			sb.append(Pattern.quote(part));
+			sb.append(buildPatternForLevel(level, parts[i]));
 			if (i < parts.length - 1){
 				sb.append(replacement);
- }
- }
+			}
+		}
 		return sb.toString();
 	}
 
+	private String buildPatternForLevel(int level, String part){
+		switch (level){
+			case 1:
+				return buildPatternLevel2(part);
+			case 2:
+				return buildPatternLevel3(part);
+			case 3:
+				return Pattern.quote(part);
+			default:
+				return "Incorrect level.";
+		}
+	}
+
+	/**
+	 * Creates a new{@link Customization} instance for{@code path} and{@code comparator}.
+	 *
+	 * @param path the json path
+	 * @param comparator the comparator
+	 * @return a new Customization
+	 */
 	public static Customization customization(String path, ValueMatcher<Object> comparator){
 		return new Customization(path, comparator);
 	}
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONAssert.java b/src/main/java/org/skyscreamer/jsonassert/JSONAssert.java
@@ -71,7 +71,7 @@ public static void assertEquals(String message, String expectedStr, JSONObject a
 * Asserts that the JSONObject provided does not match the expected string. If it is it throws an
 *{@link AssertionError}.
 * 
- * @see #assertEquals(String JSONObject, boolean)
+ * @see #assertEquals(String, JSONObject, boolean)
 * 
 * @param expectedStr Expected JSON string
 * @param actual JSONObject to compare
diff --git a/src/main/java/org/skyscreamer/jsonassert/JSONCompareMode.java b/src/main/java/org/skyscreamer/jsonassert/JSONCompareMode.java
@@ -52,7 +52,7 @@ public enum JSONCompareMode{
 private final boolean _extensible;
 private final boolean _strictOrder;
 
- private JSONCompareMode(boolean extensible, boolean strictOrder){
+ JSONCompareMode(boolean extensible, boolean strictOrder){
 _extensible = extensible;
 _strictOrder = strictOrder;
 }
diff --git a/src/main/java/org/skyscreamer/jsonassert/ValueMatcher.java b/src/main/java/org/skyscreamer/jsonassert/ValueMatcher.java
@@ -1,7 +1,19 @@
 package org.skyscreamer.jsonassert;
 
+/**
+ * Represents a value matcher that can compare two objects for equality.
+ *
+ * @param <T> the object type to compare
+ */
 public interface ValueMatcher<T>{
 
+ /**
+ * Compares the two provided objects whether they are equal.
+ *
+ * @param o1 the first object to check
+ * @param o2 the object to check the first against
+ * @return true if the objects are equal, false otherwise
+ */
 boolean equal(T o1, T o2);
 
 }
diff --git a/src/main/java/org/skyscreamer/jsonassert/comparator/DefaultComparator.java b/src/main/java/org/skyscreamer/jsonassert/comparator/DefaultComparator.java
@@ -11,7 +11,7 @@
 
 /**
 * This class is the default json comparator implementation. <p/>
- * Comparison is performed according to{@link JSONCompareMode} that is passed as constructor's argument.
+ * Comparison is performed according to{@link JSONCompareMode} that is passed as constructor's argument.
 */
 public class DefaultComparator extends AbstractComparator{
 
@@ -36,8 +36,8 @@ public void compareJSON(String prefix, JSONObject expected, JSONObject actual, J
 @Override
 public void compareValues(String prefix, Object expectedValue, Object actualValue, JSONCompareResult result)
 throws JSONException{
- if (expectedValue instanceof Number && actualValue instanceof Number){
- if (((Number)expectedValue).doubleValue() != ((Number)actualValue).doubleValue()){
+ if (areNumbers(expectedValue, actualValue)){
+ if (areNotSameDoubles(expectedValue, actualValue)){
 result.fail(prefix, expectedValue, actualValue);
 }
 } else if (expectedValue.getClass().isAssignableFrom(actualValue.getClass())){
@@ -74,4 +74,12 @@ public void compareJSONArray(String prefix, JSONArray expected, JSONArray actual
 recursivelyCompareJSONArray(prefix, expected, actual, result);
 }
 }
+
+ protected boolean areNumbers(Object expectedValue, Object actualValue){
+ return expectedValue instanceof Number && actualValue instanceof Number;
+ }
+
+ protected boolean areNotSameDoubles(Object expectedValue, Object actualValue){
+ return ((Number) expectedValue).doubleValue() != ((Number) actualValue).doubleValue();
+ }
 }
diff --git a/src/main/java/org/skyscreamer/jsonassert/comparator/JSONComparator.java b/src/main/java/org/skyscreamer/jsonassert/comparator/JSONComparator.java
@@ -13,13 +13,59 @@
 */
 public interface JSONComparator{
 
+ /**
+ * Compares two{@link JSONObject}s and returns the result of the comparison in a{@link JSONCompareResult} object.
+ *
+ * @param expected the expected JSON object
+ * @param actual the actual JSON object
+ * @return the result of the comparison
+ * @throws JSONException
+ */
 JSONCompareResult compareJSON(JSONObject expected, JSONObject actual) throws JSONException;
 
+ /**
+ * Compares two{@link JSONArray}s and returns the result of the comparison in a{@link JSONCompareResult} object.
+ *
+ * @param expected the expected JSON array
+ * @param actual the actual JSON array
+ * @return the result of the comparison
+ * @throws JSONException
+ */
 JSONCompareResult compareJSON(JSONArray expected, JSONArray actual) throws JSONException;
 
+ /**
+ * Compares two{@link JSONObject}s on the provided path represented by{@code prefix} and
+ * updates the result of the comparison in the{@code result}{@link JSONCompareResult} object.
+ *
+ * @param prefix the path in the json where the comparison happens
+ * @param expected the expected JSON object
+ * @param actual the actual JSON object
+ * @param result stores the actual state of the comparison result
+ * @throws JSONException
+ */
 void compareJSON(String prefix, JSONObject expected, JSONObject actual, JSONCompareResult result) throws JSONException;
 
+ /**
+ * Compares two{@link Object}s on the provided path represented by{@code prefix} and
+ * updates the result of the comparison in the{@code result}{@link JSONCompareResult} object.
+ *
+ * @param prefix the path in the json where the comparison happens
+ * @param expectedValue the expected value
+ * @param actualValue the actual value
+ * @param result stores the actual state of the comparison result
+ * @throws JSONException
+ */
 void compareValues(String prefix, Object expectedValue, Object actualValue, JSONCompareResult result) throws JSONException;
 
+ /**
+ * Compares two{@link JSONArray}s on the provided path represented by{@code prefix} and
+ * updates the result of the comparison in the{@code result}{@link JSONCompareResult} object.
+ *
+ * @param prefix the path in the json where the comparison happens
+ * @param expected the expected JSON array
+ * @param actual the actual JSON array
+ * @param result stores the actual state of the comparison result
+ * @throws JSONException
+ */
 void compareJSONArray(String prefix, JSONArray expected, JSONArray actual, JSONCompareResult result) throws JSONException;
 }
diff --git a/src/main/java/org/skyscreamer/jsonassert/comparator/JSONCompareUtil.java b/src/main/java/org/skyscreamer/jsonassert/comparator/JSONCompareUtil.java
diff --git a/src/site/resources/cookbook.html b/src/site/resources/cookbook.html
diff --git a/src/site/resources/quickstart.html b/src/site/resources/quickstart.html

-Original file line number
+Diff line change
 Stringregex = "\\*\\*\\.";
 Stringreplacement = "(?:.+\\.)?";
 -StringBuildersb = newStringBuilder();
 -String[] parts = path.split(regex);
 -for (inti = 0; i < parts.length; i++){
 -Stringpart = parts[i];
+-
 -sb.append(buildPatternLevel2(part));
 -if (i < parts.length - 1){
 -sb.append(replacement);
 - }
 - }
+-
 -returnsb.toString();
 +returnbuildPattern(path, regex, replacement, 1);
+ }
 privateStringbuildPatternLevel2(Strings){
 Stringregex = "\\*\\*";
 Stringreplacement = ".+";
 -StringBuildersb = newStringBuilder();
 -String[] parts = s.split(regex);
 -for (inti = 0; i < parts.length; i++){
 -Stringpart = parts[i];
+-
 -sb.append(buildPatternLevel3(part));
 -if (i < parts.length - 1){
 -sb.append(replacement);
 - }
 - }
 -returnsb.toString();
 +returnbuildPattern(s, regex, replacement, 2);
+ }
 privateStringbuildPatternLevel3(Strings){
 Stringregex = "\\*";
 Stringreplacement = "[^\\.]+";
 +returnbuildPattern(s, regex, replacement, 3);
 + }
++
 +privateStringbuildPattern(Stringpath, Stringregex, Stringreplacement, intlevel){
 StringBuildersb = newStringBuilder();
 -String[] parts = s.split(regex);
 +String[] parts = path.split(regex);
 for (inti = 0; i < parts.length; i++){
 -Stringpart = parts[i];
+-
 -sb.append(Pattern.quote(part));
 +sb.append(buildPatternForLevel(level, parts[i]));
 if (i < parts.length - 1){
 sb.append(replacement);
 -}
 -}
 +}
 +}
 returnsb.toString();
+ }
 +privateStringbuildPatternForLevel(intlevel, Stringpart){
 +switch (level){
 +case1:
 +returnbuildPatternLevel2(part);
 +case2:
 +returnbuildPatternLevel3(part);
 +case3:
 +returnPattern.quote(part);
 +default:
 +return"Incorrect level.";
 + }
 + }
++
 +/**
 + * Creates a new{@link Customization} instance for{@code path} and{@code comparator}.
 + *
 + * @param path the json path
 + * @param comparator the comparator
 + * @return a new Customization
 + */
 publicstaticCustomizationcustomization(Stringpath, ValueMatcher<Object> comparator){
 returnnewCustomization(path, comparator);
+ }
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public static void assertEquals(String message, String expectedStr, JSONObject a`
`71`	`71`	`* Asserts that the JSONObject provided does not match the expected string. If it is it throws an`
`72`	`72`	`*{@link AssertionError}.`
`73`	`73`	`*`
`74`		`- * @see #assertEquals(String JSONObject, boolean)`
	`74`	`+ * @see #assertEquals(String, JSONObject, boolean)`
`75`	`75`	`*`
`76`	`76`	`* @param expectedStr Expected JSON string`
`77`	`77`	`* @param actual JSONObject to compare`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public enum JSONCompareMode{`
`52`	`52`	`privatefinalboolean_extensible;`
`53`	`53`	`privatefinalboolean_strictOrder;`
`54`	`54`
`55`		`-privateJSONCompareMode(booleanextensible, booleanstrictOrder){`
	`55`	`+JSONCompareMode(booleanextensible, booleanstrictOrder){`
`56`	`56`	`_extensible = extensible;`
`57`	`57`	`_strictOrder = strictOrder;`
`58`	`58`	`}`