Working on #9365

Refactoring codecs to use Groovy extension methods

Author: jeffscottbrown

grails-codecs/build.gradle

@@ -1,2 +1,3 @@
 dependencies {
+    compile 'commons-codec:commons-codec:1.6'
 }

grails-plugin-codecs/src/main/groovy/org/grails/plugins/codecs/Base64Codec.groovy renamed to grails-codecs/src/main/groovy/org/grails/plugins/codecs/Base64CodecExtensionMethods.groovy

@@ -15,18 +15,18 @@
  */
 package org.grails.plugins.codecs
 
-import org.codehaus.groovy.runtime.DefaultGroovyMethods
 import org.apache.commons.codec.binary.Base64
+import org.codehaus.groovy.runtime.NullObject
 
 /**
  * A codec that encodes and decodes Objects using Base64 encoding.
  *
  * @author Drew Varner
  */
-class Base64Codec {
+class Base64CodecExtensionMethods {
 
-    static encode = { theTarget ->
-        if (theTarget == null) {
+    static encodeAsBase64(theTarget) {
+        if (theTarget == null || theTarget instanceof NullObject) {
             return null
         }
 
@@ -37,8 +37,8 @@ class Base64Codec {
         return new String(Base64.encodeBase64(theTarget.toString().getBytes("UTF-8")))
     }
 
-    static decode = { theTarget ->
-        if (theTarget == null) {
+    static decodeBase64(theTarget) {
+        if (theTarget == null || theTarget instanceof NullObject) {
             return null
         }
 

grails-codecs/src/main/resources/META-INF/services/org.codehaus.groovy.runtime.ExtensionModule

@@ -1,6 +1,7 @@
 moduleName=grails-codecs
 moduleVersion=3.0
-extensionClasses=org.grails.plugins.codecs.HexCodecExtensionMethods,\
+extensionClasses=org.grails.plugins.codecs.Base64CodecExtensionMethods,\
+  org.grails.plugins.codecs.HexCodecExtensionMethods,\
   org.grails.plugins.codecs.MD5BytesCodecExtensionMethods,\
   org.grails.plugins.codecs.MD5CodecExtensionMethods,\
   org.grails.plugins.codecs.SHA1BytesCodecExtensionMethods,\

grails-plugin-codecs/src/test/groovy/org/grails/web/codecs/Base64CodecTests.groovy renamed to grails-codecs/src/test/groovy/org/grails/web/codecs/Base64CodecTests.groovy

@@ -1,13 +1,7 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.Base64Codec
-import org.springframework.core.io.*
-
 class Base64CodecTests extends GroovyTestCase {
 
-    def codec = new Base64Codec()
-    def resourceLoader = new DefaultResourceLoader()
-
     byte[] dataPrimitive = new byte[256]
     Byte[] dataWrapper = new Byte[256]
 
@@ -23,31 +17,31 @@ class Base64CodecTests extends GroovyTestCase {
         def expectedResult = 'AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8gISIjJCUmJygpKissLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZHSElKS0xNTk9QUVJTVFVWV1hZWltcXV5fYGFiY2RlZmdoaWprbG1ub3BxcnN0dXZ3eHl6e3x9fn+AgYKDhIWGh4iJiouMjY6PkJGSk5SVlpeYmZqbnJ2en6ChoqOkpaanqKmqq6ytrq+wsbKztLW2t7i5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+/w=='
 
         // we want to verify that both Byte[] and byte[] inputs work
-        String primitiveResult = codec.encode(dataPrimitive)
-        String wrapperResult = codec.encode(dataWrapper)
+        String primitiveResult = dataPrimitive.encodeAsBase64()
+        String wrapperResult = dataWrapper.encodeAsBase64()
 
         assertEquals(expectedResult,primitiveResult)
         assertEquals(expectedResult,wrapperResult)
 
         //make sure encoding null returns null
-        assertNull codec.encode(null)
+        assertNull null.encodeAsBase64()
     }
 
     void testDecode() {
         String data = 'd2hhdA=='
-        byte[] result = codec.decode(data)
+        byte[] result = data.decodeBase64()
 
         assertEquals(119, result[0])
         assertEquals(104, result[1])
         assertEquals(97, result[2])
         assertEquals(116, result[3])
 
         //make sure decoding null returns null
-        assertNull codec.decode(null)
+        assertNull null.decodeBase64()
     }
 
     void testRountrip() {
-        assertEquals(dataPrimitive, codec.decode(codec.encode(dataPrimitive)))
-        assertEquals(dataWrapper, codec.decode(codec.encode(dataWrapper)))
+        assertEquals(dataPrimitive, dataPrimitive.encodeAsBase64().decodeBase64())
+        assertEquals(dataWrapper, dataWrapper.encodeBase64().decodeBase64())
     }
 }

grails-plugin-codecs/build.gradle

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

grails-plugin-codecs/src/main/groovy/org/grails/plugins/CodecsGrailsPlugin.groovy

@@ -19,7 +19,6 @@ import grails.plugins.Plugin
 import grails.util.GrailsUtil
 import org.grails.plugins.codecs.DefaultCodecLookup
 import org.grails.commons.CodecArtefactHandler
-import org.grails.plugins.codecs.Base64Codec
 import org.grails.encoder.impl.HTML4Codec
 import org.grails.plugins.codecs.HTMLCodec
 import org.grails.encoder.impl.HTMLJSCodec
@@ -47,7 +46,6 @@ class CodecsGrailsPlugin extends Plugin {
             JavaScriptCodec,
             HTMLJSCodec,
             URLCodec,
-            Base64Codec,
             RawCodec
     ]