Fix for GRAILS-10980: make encodeAsJSON() and encodeAsXML() work as in older grails versions for other than CharSequence/String and primitive objects

Author: lhotari

grails-plugin-codecs/build.gradle

@@ -1,4 +1,4 @@
 dependencies {
     compile 'commons-codec:commons-codec:1.6'
-    compile project(":grails-web")
-}
+    compile project(":grails-web"), project(":grails-plugin-converters")
+}

grails-plugin-codecs/src/main/groovy/org/codehaus/groovy/grails/plugins/codecs/AbstractCharReplacementEncoder.java

@@ -54,6 +54,10 @@ public AbstractCharReplacementEncoder(CodecIdentifier codecIdentifier) {
      * @see org.codehaus.groovy.grails.support.encoding.Encoder#encode(java.lang.Object)
      */
     public Object encode(Object o) {
+        return doCharReplacementEncoding(o);
+    }
+
+    protected final Object doCharReplacementEncoding(Object o) {
         if (o == null) {
             return null;
         }
@@ -72,9 +76,17 @@ else if (o instanceof Character) {
             }
         }
         else {
-            str = String.valueOf(o);
+            str = convertToString(o);
         }
 
+        return escapeCharSequence(str);
+    }
+
+    protected String convertToString(Object o) {
+        return String.valueOf(o);
+    }
+
+    protected Object escapeCharSequence(CharSequence str) {
         if (str == null || str.length() == 0) {
             return str;
         }

grails-plugin-codecs/src/main/groovy/org/codehaus/groovy/grails/plugins/codecs/HTMLEncoder.java

@@ -32,4 +32,8 @@ public class HTMLEncoder extends XMLEncoder {
     public HTMLEncoder() {
         super(HTML_CODEC_IDENTIFIER);
     }
+    
+    protected Object doEncode(Object o) {
+        return doCharReplacementEncoding(o);
+    }    
 }

grails-plugin-codecs/src/main/groovy/org/codehaus/groovy/grails/plugins/codecs/JSONEncoder.java

@@ -15,9 +15,12 @@
  */
 package org.codehaus.groovy.grails.plugins.codecs;
 
+import grails.converters.JSON;
+
 import org.apache.commons.lang.StringUtils;
 import org.codehaus.groovy.grails.support.encoding.CodecIdentifier;
 import org.codehaus.groovy.grails.support.encoding.DefaultCodecIdentifier;
+import org.springframework.util.ClassUtils;
 
 /**
  * Escapes characters in JSON output
@@ -37,6 +40,8 @@ public JSONEncoder() {
         super(JSON_CODEC_IDENTIFIER);
     }
 
+    
+    
     /* (non-Javadoc)
      * @see org.codehaus.groovy.grails.plugins.codecs.AbstractCharReplacementEncoder#escapeCharacter(char, char)
      */
@@ -82,4 +87,24 @@ protected String escapeCharacter(char ch, char previousChar) {
     public boolean isApplyToSafelyEncoded() {
         return true;
     }
+
+    @Override
+    public final Object encode(Object o) {
+        return doEncode(o);
+    }
+
+    protected Object doEncode(Object o) {
+        if(o == null) {
+            return null;
+        }        
+        if(o instanceof CharSequence || (o != null && ClassUtils.isPrimitiveOrWrapper(o.getClass())) ) {
+            return super.encode(o);
+        } else {
+            return encodeToJsonString(o);            
+        }
+    }
+
+    protected Object encodeToJsonString(Object o) {
+        return new JSON(o).toString();
+    }
 }

grails-plugin-codecs/src/main/groovy/org/codehaus/groovy/grails/plugins/codecs/XMLEncoder.java

@@ -15,8 +15,11 @@
  */
 package org.codehaus.groovy.grails.plugins.codecs;
 
+import grails.converters.XML;
+
 import org.codehaus.groovy.grails.support.encoding.CodecIdentifier;
 import org.codehaus.groovy.grails.support.encoding.DefaultCodecIdentifier;
+import org.springframework.util.ClassUtils;
 
 /**
  * Encoder implementation that escapes some characters for inclusion in XML documents
@@ -81,4 +84,24 @@ protected String escapeCharacter(char ch, char previousChar) {
       }
       return null;
     }
+    
+    @Override
+    public final Object encode(Object o) {
+        return doEncode(o);
+    }
+
+    protected Object doEncode(Object o) {
+        if(o == null) {
+            return null;
+        }
+        if(o instanceof CharSequence || (o != null && ClassUtils.isPrimitiveOrWrapper(o.getClass()))) {
+            return doCharReplacementEncoding(o);
+        } else {
+            return encodeToXmlString(o);            
+        }
+    }
+
+    protected Object encodeToXmlString(Object o) {
+        return new XML(o).toString();
+    }    
 }

grails-test-suite-web/src/test/groovy/org/codehaus/groovy/grails/web/codecs/CodecSpec.groovy

@@ -2,6 +2,7 @@ package org.codehaus.groovy.grails.web.codecs
 
 import grails.test.mixin.TestMixin
 import grails.test.mixin.web.GroovyPageUnitTestMixin
+import spock.lang.Issue
 import spock.lang.Specification
 
 /**
@@ -29,6 +30,28 @@ class CodecSpec extends Specification {
             '"<script>"'.encodeAsJavaScript() == '\\u0022\\u003cscript\\u003e\\u0022'
             '"<script>"'.encodeAsJavaScript().encodeAsHTML() == '"<script>"'.encodeAsJavaScript()
     }
+    
+    @Issue("GRAILS-10980")
+    void "JSON codec behaviour like in Grails versions pre 2.3.x"() {
+        when:
+            String x=null
+        then:
+            [a: 1, b: 2, c: 3].encodeAsJSON() == '{"a":1,"b":2,"c":3}'
+            x.encodeAsJSON() == null
+            1.encodeAsJSON() == '1' // convert primitives to string
+            true.encodeAsJSON() == 'true'
+    }
+
+    @Issue("GRAILS-10980")
+    void "XML codec behaviour like in Grails versions pre 2.3.x"() {
+        when:
+            String x=null
+        then:
+            [a: 1, b: 2, c: 3].encodeAsXML() == '<?xml version="1.0" encoding="UTF-8"?><map><entry key="a">1</entry><entry key="b">2</entry><entry key="c">3</entry></map>'
+            x.encodeAsXML() == null
+            1.encodeAsXML() == '1' // convert primitives to string
+            true.encodeAsXML() == 'true'
+    }
 
     void "Test that the raw method works in GSP"() {
         when:"The raw method is called for a GSP expression"