Start working on #229

cowtowncoder · cowtowncoder · commit dadb47b1789a · 2020-10-02T19:56:03.000-07:00
diff --git a/release-notes/VERSION-2.x b/release-notes/VERSION-2.x
@@ -17,6 +17,7 @@ Modules:
  (reported by wkwkhautbois@github)
 #226: Quote 'y'/'Y'/'n'/'N' as names too (to avoid problems with Boolean keys)
  (requested by pnepywoda@github)
+- SnakeYAML 1.26 -> 1.27
 - Add Gradle Module Metadata (https://blog.gradle.org/alignment-with-gradle-module-metadata)
 
 2.11.3 (02-Oct-2020)
diff --git a/yaml/pom.xml b/yaml/pom.xml
@@ -34,7 +34,7 @@
     <dependency>
       <groupId>org.yaml</groupId>
       <artifactId>snakeyaml</artifactId>
-      <version>1.26</version>
+      <version>1.27</version>
     </dependency>
 
      <!-- and for testing need annotations; but should be available via `jackson-databind` above
diff --git a/yaml/src/main/java/com/fasterxml/jackson/dataformat/yaml/YAMLGenerator.java b/yaml/src/main/java/com/fasterxml/jackson/dataformat/yaml/YAMLGenerator.java
@@ -5,9 +5,7 @@
 import java.math.BigInteger;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashSet;
 import java.util.Map;
-import java.util.Set;
 import java.util.regex.Pattern;
 
 import org.yaml.snakeyaml.DumperOptions;
@@ -20,6 +18,7 @@
 import com.fasterxml.jackson.core.base.GeneratorBase;
 import com.fasterxml.jackson.core.json.JsonWriteContext;
 import com.fasterxml.jackson.core.util.JacksonFeatureSet;
+import com.fasterxml.jackson.dataformat.yaml.util.StringQuotingChecker;
 import com.fasterxml.jackson.core.io.IOContext;
 
 public class YAMLGenerator extends GeneratorBase
@@ -172,33 +171,6 @@ private Feature(boolean defaultState) {
     protected final static Pattern PLAIN_NUMBER_P = Pattern.compile("-?[0-9]*(\\.[0-9]*)?");
     protected final static String TAG_BINARY = Tag.BINARY.toString();
 
-    /* As per <a href="https://yaml.org/type/bool.html">YAML Spec</a> there are a few
-     * aliases for booleans, and we better quote such values as keys; although Jackson
-     * itself has no problems dealing with them, some other tools do have.
-     */
-    // 02-Apr-2019, tatu: Some names will look funny if escaped: let's leave out
-    //    single letter case (esp so 'y' won't get escaped)
-    // 17-Sep-2020, tatu: [dataformats-text#226] No, let's be consistent w/ values
-    private final static Set<String> MUST_QUOTE_NAMES = new HashSet<>(Arrays.asList(
-            "y", "Y", "n", "N",
-            "yes", "Yes", "YES", "no", "No", "NO",
-            "true", "True", "TRUE", "false", "False", "FALSE",
-            "on", "On", "ON", "off", "Off", "OFF"
-    ));
-
-    /**
-     * As per YAML <a href="https://yaml.org/type/null.html">null</a>
-     * and <a href="https://yaml.org/type/bool.html">boolean</a> type specs,
-     * better retain quoting for some values
-     */
-    private final static Set<String> MUST_QUOTE_VALUES = new HashSet<>(Arrays.asList(
-            "y", "Y", "n", "N",
-            "yes", "Yes", "YES", "no", "No", "NO",
-            "true", "True", "TRUE", "false", "False", "FALSE",
-            "on", "On", "ON", "off", "Off", "OFF",
-            "null", "Null", "NULL"
-    ));
-
     /*
     /**********************************************************
     /* Configuration
@@ -258,6 +230,7 @@ private Feature(boolean defaultState) {
 
     protected int _rootValueCount;
 
+    protected final StringQuotingChecker _quotingChecker = StringQuotingChecker.Default.instance();
     /*
     /**********************************************************
     /* Life-cycle
@@ -462,7 +435,7 @@ public void writeFieldId(long id) throws IOException {
     private final void _writeFieldName(String name) throws IOException
     {
         _writeScalar(name, "string",
-                _nameNeedsQuoting(name) ? STYLE_QUOTED : STYLE_UNQUOTED_NAME);
+                _quotingChecker.needToQuoteName(name) ? STYLE_QUOTED : STYLE_UNQUOTED_NAME);
     }
 
     /*
@@ -592,7 +565,7 @@ public void writeString(String text) throws IOException,JsonGenerationException
         DumperOptions.ScalarStyle style;
         if (Feature.MINIMIZE_QUOTES.enabledIn(_formatFeatures)) {
             // If one of reserved values ("true", "null"), or, number, preserve quoting:
-            if (_valueNeedsQuoting(text)
+            if (_quotingChecker.needToQuoteValue(text)
                 || (Feature.ALWAYS_QUOTE_NUMBERS_AS_STRINGS.enabledIn(_formatFeatures)
                         && PLAIN_NUMBER_P.matcher(text).matches())
                 ) {
@@ -944,85 +917,6 @@ private String _base64encode(final Base64Variant b64v, final byte[] input, final
         return sb.toString();
     }
 
-    private boolean _nameNeedsQuoting(String name) {
-        if (name.length() == 0) { // empty String does indeed require quoting
-            return true;
-        }
-        switch (name.charAt(0)) {
-        // First, reserved name starting chars:
-        case 'f': // false
-        case 'o': // on/off
-        case 'n': // no
-        case 't': // true
-        case 'y': // yes
-        case 'F': // False
-        case 'O': // On/Off
-        case 'N': // No
-        case 'T': // True
-        case 'Y': // Yes
-            return MUST_QUOTE_NAMES.contains(name);
-
-            // And then numbers
-        case '0': case '1': case '2': case '3': case '4':
-        case '5': case '6': case '7': case '8': case '9':
-        case '-' : case '+': case '.':
-            return true;
-        }
-        return false;
-    }
-
-    private boolean _valueNeedsQuoting(String name) {
-        switch (name.charAt(0)) { // caller ensures no empty String
-        // First, reserved name starting chars:
-        case 'f': // false
-        case 'o': // on/off
-        case 'n': // null/n/no
-        case 't': // true
-        case 'y': // y/yes
-        case 'F': // False/FALSE
-        case 'O': // On/Off/ON/OFF
-        case 'N': // Null/NULL/N/No/NO
-        case 'T': // True/TRUE
-        case 'Y': // Y/Yes/YES
-            if (MUST_QUOTE_VALUES.contains(name)) {
-                return true;
-            }
-            break;
-        }
-        return _valueHasQuotableChar(name);
-    }
-
-    /**
-     * As per YAML <a href="https://yaml.org/spec/1.2/spec.html#id2788859">Plain Style</a>unquoted
-     * strings are restricted to a reduced charset and must be quoted in case they contain
-     * one of the following characters or character combinations.
-     */
-    private static boolean _valueHasQuotableChar(String inputStr) {
-        for (int i = 0, end = inputStr.length(); i < end; ++i) {
-            switch (inputStr.charAt(i)) {
-            case '[':
-            case ']':
-            case '{':
-            case '}':
-            case ',':
-                return true;
-            case '\t':
-            case ' ':
-                if (i < end - 1 && '#' == inputStr.charAt(i + 1)) {
-                    return true;
-                }
-                break;
-            case ':':
-                if (i < end - 1 && (' ' == inputStr.charAt(i + 1) || '\t' == inputStr.charAt(i + 1))) {
-                    return true;
-                }
-                break;
-            default:
-            }
-        }
-        return false;
-    }
-
     protected String _lf() {
         return _outputOptions.getLineBreak().getString();
     }
diff --git a/yaml/src/main/java/com/fasterxml/jackson/dataformat/yaml/util/StringQuotingChecker.java b/yaml/src/main/java/com/fasterxml/jackson/dataformat/yaml/util/StringQuotingChecker.java
@@ -0,0 +1,175 @@
+package com.fasterxml.jackson.dataformat.yaml.util;
+
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * Helper class that defines API used by
+ * {@link com.fasterxml.jackson.dataformat.yaml.YAMLGenerator}
+ * to check whether property names and String values need to be quoted or not.
+ * Also contains default logic implementation; may be sub-classes to provide
+ * alternate implementation.
+ *
+ * @since 2.12
+ */
+public abstract class StringQuotingChecker
+{
+    /* As per <a href="https://yaml.org/type/bool.html">YAML Spec</a> there are a few
+     * aliases for booleans, and we better quote such values as keys; although Jackson
+     * itself has no problems dealing with them, some other tools do have.
+     */
+    // 02-Apr-2019, tatu: Some names will look funny if escaped: let's leave out
+    //    single letter case (esp so 'y' won't get escaped)
+    // 17-Sep-2020, tatu: [dataformats-text#226] No, let's be consistent w/ values
+    private final static Set<String> DEFAULT_QUOTABLE_NAMES = new HashSet<>(Arrays.asList(
+            "y", "Y", "n", "N",
+            "yes", "Yes", "YES", "no", "No", "NO",
+            "true", "True", "TRUE", "false", "False", "FALSE",
+            "on", "On", "ON", "off", "Off", "OFF",
+            "null", "Null", "NULL"
+    ));
+
+    /**
+     * As per YAML <a href="https://yaml.org/type/null.html">null</a>
+     * and <a href="https://yaml.org/type/bool.html">boolean</a> type specs,
+     * better retain quoting for some values
+     */
+    private final static Set<String> DEFAULT_QUOTABLE_VALUES = new HashSet<>(Arrays.asList(
+            "false", "False", "FALSE",
+            "null", "Null", "NULL",
+            "on", "On", "ON", "off", "Off", "OFF",
+            "true", "True", "TRUE",
+            "y", "Y", "n", "N",
+            "yes", "Yes", "YES", "no", "No", "NO"
+    ));
+
+    /**
+     * Method called by
+     * {@link com.fasterxml.jackson.dataformat.yaml.YAMLGenerator}
+     * to check whether given property name should be quoted: usually
+     * to prevent it from being read as non-String key (boolean or number)
+     */
+    public boolean needToQuoteName(String name)
+    {
+        // empty String does indeed require quoting
+        if (name.length() == 0) {
+            return true;
+        }
+        switch (name.charAt(0)) {
+        // First, reserved name starting chars:
+        case 'f': // false
+        case 'n': // no/n/null
+        case 'o': // on/off
+        case 't': // true
+        case 'y': // yes/y
+        case 'F': // False
+        case 'N': // No/N/Null
+        case 'O': // On/Off
+        case 'T': // True
+        case 'Y': // Yes/Y
+            return isDefaultQuotableName(name);
+
+        // And then numbers
+        case '0': case '1': case '2': case '3': case '4':
+        case '5': case '6': case '7': case '8': case '9':
+        case '-' : case '+': case '.':
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Method called by
+     * {@link com.fasterxml.jackson.dataformat.yaml.YAMLGenerator}
+     * to check whether given String value should be quoted: usually
+     * to prevent it from being value of different type (boolean or number)
+     */
+    public boolean needToQuoteValue(String value)
+    {
+        // empty String does indeed require quoting
+        if (value.length() == 0) {
+            return true;
+        }
+        switch (value.charAt(0)) {
+        // First, reserved name starting chars:
+        case 'f': // false
+        case 'n': // no/n/null
+        case 'o': // on/off
+        case 't': // true
+        case 'y': // yes/y
+        case 'F': // False
+        case 'N': // No/N/Null
+        case 'O': // On/Off
+        case 'T': // True
+        case 'Y': // Yes/Y
+            if (isDefaultQuotableValue(value)) {
+                return true;
+            }
+            break;
+        }
+        return valueHasQuotableChar(value);
+    }
+
+    protected boolean isDefaultQuotableName(String name) {
+        return DEFAULT_QUOTABLE_NAMES.contains(name);
+    }
+
+    protected boolean isDefaultQuotableValue(String name) {
+        return DEFAULT_QUOTABLE_VALUES.contains(name);
+    }
+
+    /**
+     * As per YAML <a href="https://yaml.org/spec/1.2/spec.html#id2788859">Plain Style</a>unquoted
+     * strings are restricted to a reduced charset and must be quoted in case they contain
+     * one of the following characters or character combinations.
+     */
+    protected boolean valueHasQuotableChar(String inputStr)
+    {
+        final int end = inputStr.length();
+        for (int i = 0; i < end; ++i) {
+            switch (inputStr.charAt(i)) {
+            case '[':
+            case ']':
+            case '{':
+            case '}':
+            case ',':
+                return true;
+            case '#':
+                // [dataformats-text#201]: limit quoting with MINIMIZE_QUOTES
+                if (i > 0) {
+                    char d = inputStr.charAt(i-1);
+                    if (' ' == d || '\t' == d) {
+                        return true;
+                    }
+                }
+                break;
+            case ':':
+                // [dataformats-text#201]: limit quoting with MINIMIZE_QUOTES
+                if (i < (end-1)) {
+                    char d = inputStr.charAt(i + 1);
+                    if (' ' == d || '\t' == d) {
+                        return true;
+                    }
+                }
+                break;
+            default:
+            }
+        }
+        return false;
+    }
+    
+    /**
+     * Default {@link StringQuotingChecker} implementation used unless
+     * custom implementation registered.
+     */
+    public final static class Default
+        extends StringQuotingChecker
+    {
+        private final static Default INSTANCE = new Default();
+
+        public Default() { }
+
+        public static Default instance() { return INSTANCE; }
+    }
+}
