Update release notes wrt #717, minor clean up

Author: cowtowncoder

release-notes/CREDITS-2.x

@@ -310,6 +310,10 @@ Nik Everett (nik9000@github)
   * Contributed  #715: Allow TokenFilters to keep empty arrays and objects
   (2.14.0)
 
+Richard Kwasnicki (Richie94@github)
+  * Contributed #717: Hex capitalization for JsonWriter should be configurable
+  (2.14.0)
+
 Illia Ovchynnikov (wingsofovnia@github)
   * Reported #759: JsonGenerator to provide current value to the context before
    starting objects

release-notes/VERSION-2.x

@@ -26,6 +26,9 @@ JSON library.
  (contributed by Ilya G)
 #715: Allow TokenFilters to keep empty arrays and objects
  (contributed by Nik E)
+#717: Hex capitalization for JsonWriter should be configurable (add
+  `JsonWriteFeature.WRITE_HEX_UPPER_CASE`)
+ (contributed Richard K)
 #733: Add `StreamReadCapability.EXACT_FLOATS` to indicate whether parser reports exact
   floating-point values or not
  (contributed Doug R)

src/main/java/com/fasterxml/jackson/core/io/CharTypes.java

@@ -288,6 +288,10 @@ public static void appendQuoted(StringBuilder sb, String content) {
         }
     }
 
+    /**
+     * @deprecated Since 2.14
+     */
+    @Deprecated // since 2.14
     public static char[] copyHexChars() {
         return copyHexChars(true);
     }
@@ -296,6 +300,10 @@ public static char[] copyHexChars(boolean uppercase) {
         return (uppercase) ? HC.clone() : HClower.clone();
     }
 
+    /**
+     * @deprecated Since 2.14
+     */
+    @Deprecated // since 2.14
     public static byte[] copyHexBytes() {
         return copyHexBytes(true);
     }

src/main/java/com/fasterxml/jackson/core/json/JsonWriteFeature.java

@@ -75,10 +75,11 @@ public enum JsonWriteFeature
     /**
      * Feature that specifies that hex values are encoded with capital letters.
      *<p>
-     * Can be disabled to have a better possibility to compare between other Json
+     * Can be disabled to have a better possibility to compare between other JSON
      * writer libraries, such as JSON.stringify from Javascript.
      *<p>
-     * Feature is enabled by default.
+     * Feature is enabled by default for backwards compatibility with earlier
+     * versions.
      *
      * @since 2.14
      */

src/main/java/com/fasterxml/jackson/core/json/UTF8JsonGenerator.java

@@ -29,17 +29,13 @@ public class UTF8JsonGenerator
     // intermediate copies only made up to certain length...
     private final static int MAX_BYTES_TO_BUFFER = 512;
 
-    private final static byte[] HEX_CHARS_UPPER = CharTypes.copyHexBytes(true);
-    private final static byte[] HEX_CHARS_LOWER = CharTypes.copyHexBytes(false);
+    private final static byte[] HEX_BYTES_UPPER = CharTypes.copyHexBytes(true);
+    private final static byte[] HEX_BYTES_LOWER = CharTypes.copyHexBytes(false);
 
     private final static byte[] NULL_BYTES = { 'n', 'u', 'l', 'l' };
     private final static byte[] TRUE_BYTES = { 't', 'r', 'u', 'e' };
     private final static byte[] FALSE_BYTES = { 'f', 'a', 'l', 's', 'e' };
 
-    private byte[] getHexChars() {
-        return _cfgWriteHexUppercase ? HEX_CHARS_UPPER : HEX_CHARS_LOWER;
-    }
-
     /*
     /**********************************************************
     /* Configuration
@@ -2141,7 +2137,7 @@ protected final void _outputSurrogates(int surr1, int surr2) throws IOException
      */
     private final int _outputMultiByteChar(int ch, int outputPtr) throws IOException
     {
-        byte[] HEX_CHARS = getHexChars();
+        byte[] HEX_CHARS = getHexBytes();
         byte[] bbuf = _outputBuffer;
         if (ch >= SURR1_FIRST && ch <= SURR2_LAST) { // yes, outside of BMP; add an escape
             // 23-Nov-2015, tatu: As per [core#223], may or may not want escapes;
@@ -2181,7 +2177,7 @@ private final void _writeNull() throws IOException
     private int _writeGenericEscape(int charToEscape, int outputPtr) throws IOException
     {
         final byte[] bbuf = _outputBuffer;
-        byte[] HEX_CHARS = getHexChars();
+        byte[] HEX_CHARS = getHexBytes();
         bbuf[outputPtr++] = BYTE_BACKSLASH;
         bbuf[outputPtr++] = BYTE_u;
         if (charToEscape > 0xFF) {
@@ -2207,4 +2203,9 @@ protected final void _flushBuffer() throws IOException
             _outputStream.write(_outputBuffer, 0, len);
         }
     }
+
+    private byte[] getHexBytes() {
+        return _cfgWriteHexUppercase ? HEX_BYTES_UPPER : HEX_BYTES_LOWER;
+    }
 }
+

src/test/java/com/fasterxml/jackson/core/BaseTest.java

@@ -575,6 +575,10 @@ protected static byte[] utf8Bytes(String str) {
         return str.getBytes(StandardCharsets.UTF_8);
     }
 
+    protected static String fromUTF8(ByteArrayOutputStream bytes) {
+        return new String(bytes.toByteArray(), StandardCharsets.UTF_8);
+    }
+
     protected void fieldNameFor(StringBuilder sb, int index)
     {
         /* let's do something like "f1.1" to exercise different

src/test/java/com/fasterxml/jackson/core/json/GeneratorFeaturesTest.java

@@ -354,4 +354,45 @@ private void _testNonNumericQuoting(JsonFactory f, boolean quoted)
             assertEquals("{\"double\":NaN} {\"float\":NaN}", result);
         }
     }
+
+    // [core#717]: configurable hex digits; lower-case
+    public void testHexLowercase() throws Exception {
+        JsonFactory f = JsonFactory.builder()
+                .disable(JsonWriteFeature.WRITE_HEX_UPPER_CASE)
+                .build();
+        _testHexOutput(f, false, "\u001b", q("\\u001b"));
+        _testHexOutput(f, true, "\u001b", q("\\u001b"));
+    }
+
+    // [core#717]: configurable hex digits; upper-case (default)
+    public void testHexUppercase() throws Exception
+    {
+        JsonFactory f = JsonFactory.builder()
+                .enable(JsonWriteFeature.WRITE_HEX_UPPER_CASE)
+                .build();
+        _testHexOutput(f, false, "\u001b", q("\\u001B"));
+        _testHexOutput(f, true, "\u001b", q("\\u001B"));
+    }
+
+    private void _testHexOutput(JsonFactory f, boolean useBytes,
+            String input, String exp) throws Exception
+    {
+        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+        StringWriter sw = new StringWriter();
+        JsonGenerator g;
+        if (useBytes) {
+            g = f.createGenerator(bytes);
+        } else {
+            g = f.createGenerator(sw);
+        }
+
+        g.writeString(input);
+        g.flush();
+        g.close();
+
+        String result = useBytes ? fromUTF8(bytes) : sw.toString();
+        assertEquals(exp, result);
+
+        g.close();
+    }
 }

src/test/java/com/fasterxml/jackson/core/write/UTF8GeneratorTest.java

@@ -1,5 +1,7 @@
 package com.fasterxml.jackson.core.write;
 
+import java.io.ByteArrayOutputStream;
+
 import com.fasterxml.jackson.core.*;
 import com.fasterxml.jackson.core.filter.FilteringGeneratorDelegate;
 import com.fasterxml.jackson.core.filter.JsonPointerBasedFilter;
@@ -9,10 +11,6 @@
 import com.fasterxml.jackson.core.json.UTF8JsonGenerator;
 import com.fasterxml.jackson.core.util.BufferRecycler;
 
-import java.io.ByteArrayOutputStream;
-
-import static com.fasterxml.jackson.core.json.JsonWriteFeature.WRITE_HEX_UPPER_CASE;
-
 public class UTF8GeneratorTest extends BaseTest
 {
     private final JsonFactory JSON_F = new JsonFactory();
@@ -116,33 +114,4 @@ public void testFilteringWithEscapedChars() throws Exception
         assertNull(p.nextToken());
         p.close();
     }
-
-    public void testHexLowercase() throws Exception
-    {
-        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
-        JsonFactory factory = JsonFactory.builder().disable(WRITE_HEX_UPPER_CASE).build();
-        JsonGenerator gen = factory.createGenerator(bytes);
-        String str = "\u001b";
-        gen.writeString(str);
-        gen.flush();
-        gen.close();
-
-        String result = bytes.toString();
-        assertEquals("\"\\u001b\"", result);
-    }
-
-    public void testHexUppercase() throws Exception
-    {
-        ByteArrayOutputStream bytes = new ByteArrayOutputStream();
-        JsonFactory factory = JsonFactory.builder().enable(WRITE_HEX_UPPER_CASE).build();
-        JsonGenerator gen = factory.createGenerator(bytes);
-        String str = "\u001b";
-        gen.writeString(str);
-        gen.flush();
-        gen.close();
-
-        String result = bytes.toString();
-        assertEquals("\"\\u001B\"", result);
-    }
-
 }