Working on #9365

jeffscottbrown · jeffscottbrown · commit 01df8c6424f9 · 2015-12-14T06:39:09.000Z
Refactoring codecs to use Groovy extension methods
diff --git a/grails-codecs/build.gradle b/grails-codecs/build.gradle
@@ -0,0 +1,2 @@
+dependencies {
+}
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/DigestUtils.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/DigestUtils.groovy
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/HexCodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/HexCodecExtensionMethods.groovy
@@ -15,13 +15,15 @@
  */
 package org.grails.plugins.codecs
 
-class HexCodec {
+import org.codehaus.groovy.runtime.NullObject
+
+class HexCodecExtensionMethods {
 
     static HEXDIGITS = '0123456789abcdef'
 
     // Expects an array/list of numbers
-    static encode = { theTarget ->
-        if (theTarget == null) {
+    static encodeAsHex(theTarget) {
+        if (theTarget == null || theTarget instanceof NullObject) {
             return null
         }
 
@@ -30,13 +32,13 @@ class HexCodec {
             theTarget = theTarget.getBytes("UTF-8")
         }
         theTarget.each() {
-            result << HexCodec.HEXDIGITS[(it & 0xF0) >> 4]
-            result << HexCodec.HEXDIGITS[it & 0x0F]
+            result << HexCodecExtensionMethods.HEXDIGITS[(it & 0xF0) >> 4]
+            result << HexCodecExtensionMethods.HEXDIGITS[it & 0x0F]
         }
         return result.toString()
     }
 
-    static decode = { theTarget ->
+    static decodeHex(theTarget) {
         if (!theTarget) return null
 
         def output = []
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/MD5BytesCodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/MD5BytesCodecExtensionMethods.groovy
@@ -15,14 +15,19 @@
  */
 package org.grails.plugins.codecs
 
-class MD5Codec {
+import org.codehaus.groovy.runtime.NullObject
+
+class MD5BytesCodecExtensionMethods {
     // Returns the byte[] of the digest, taken from UTF-8 of the string representation
     // or the raw data coerced to bytes
-    static encode = { theTarget ->
-        HexCodec.encode(MD5BytesCodec.encode(theTarget))
+    static encodeAsMD5Bytes(theTarget) {
+        if(theTarget == null || theTarget instanceof NullObject) {
+            return null
+        }
+        DigestUtils.digest("MD5", theTarget)
     }
 
-    static decode = { theTarget ->
+    static decodeMD5Bytes(theTarget) {
         throw new UnsupportedOperationException("Cannot decode MD5 hashes")
     }
 }
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/MD5CodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/MD5CodecExtensionMethods.groovy
@@ -15,14 +15,14 @@
  */
 package org.grails.plugins.codecs
 
-class MD5BytesCodec {
+class MD5CodecExtensionMethods {
     // Returns the byte[] of the digest, taken from UTF-8 of the string representation
     // or the raw data coerced to bytes
-    static encode = { theTarget ->
-        DigestUtils.digest("MD5", theTarget)
+    static encodeAsMD5(theTarget) {
+        theTarget.encodeAsMD5Bytes()?.encodeAsHex()
     }
 
-    static decode = { theTarget ->
+    static decodeMD5(theTarget) {
         throw new UnsupportedOperationException("Cannot decode MD5 hashes")
     }
 }
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA1BytesCodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA1BytesCodecExtensionMethods.groovy
@@ -15,13 +15,18 @@
  */
 package org.grails.plugins.codecs
 
-class SHA1BytesCodec {
+import org.codehaus.groovy.runtime.NullObject
+
+class SHA1BytesCodecExtensionMethods {
     // Returns the byte[] of the digest
-    static encode = { theTarget ->
+    static encodeAsSHA1Bytes(theTarget) {
+        if(theTarget == null || theTarget instanceof NullObject) {
+            return null
+        }
         DigestUtils.digest("SHA-1", theTarget)
     }
 
-    static decode = { theTarget ->
+    static decodeSHA1Bytes(theTarget) {
         throw new UnsupportedOperationException("Cannot decode SHA-1 hashes")
     }
 }
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA1CodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA1CodecExtensionMethods.groovy
@@ -15,13 +15,18 @@
  */
 package org.grails.plugins.codecs
 
-class SHA1Codec{
+import org.codehaus.groovy.runtime.NullObject
+
+class SHA1CodecExtensionMethods {
     // Returns the byte[] of the digest
-    static encode = { theTarget ->
-        HexCodec.encode(SHA1BytesCodec.encode(theTarget))
+    static encodeAsSHA1(theTarget) {
+        if(theTarget == null || theTarget instanceof NullObject) {
+            return null
+        }
+        theTarget.encodeAsSHA1Bytes().encodeAsHex()
     }
 
-    static decode = { theTarget ->
+    static decodeSHA1(theTarget) {
         throw new UnsupportedOperationException("Cannot decode SHA-1 hashes")
     }
 }
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA256BytesCodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA256BytesCodecExtensionMethods.groovy
@@ -15,13 +15,18 @@
  */
 package org.grails.plugins.codecs
 
-class SHA256BytesCodec {
+import org.codehaus.groovy.runtime.NullObject
+
+class SHA256BytesCodecExtensionMethods {
     // Returns the byte[] of the digest
-    static encode = { theTarget ->
+    static encodeAsSHA256Bytes(theTarget) {
+        if(theTarget == null || theTarget instanceof NullObject) {
+            return null
+        }
         DigestUtils.digest("SHA-256", theTarget)
     }
 
-    static decode = { theTarget ->
+    static decodeSHA256Bytes(theTarget) {
         throw new UnsupportedOperationException("Cannot decode SHA-256 hashes")
     }
 }
diff --git a/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA256CodecExtensionMethods.groovy b/grails-codecs/src/main/groovy/org/grails/plugins/codecs/SHA256CodecExtensionMethods.groovy
@@ -15,13 +15,18 @@
  */
 package org.grails.plugins.codecs
 
-class SHA256Codec extends DigestUtils {
+import org.codehaus.groovy.runtime.NullObject
+
+class SHA256CodecExtensionMethods extends DigestUtils {
     // Returns the byte[] of the digest
-    static encode = { theTarget ->
-        HexCodec.encode(SHA256BytesCodec.encode(theTarget))
+    static encodeAsSHA256(theTarget) {
+        if(theTarget == null || theTarget instanceof NullObject) {
+            return null
+        }
+        theTarget.encodeAsSHA256Bytes()?.encodeAsHex()
     }
 
-    static decode = { theTarget ->
+    static decodeSHA256(theTarget) {
         throw new UnsupportedOperationException("Cannot decode SHA-256 hashes")
     }
 }
diff --git a/grails-codecs/src/main/resources/META-INF/services/org.codehaus.groovy.runtime.ExtensionModule b/grails-codecs/src/main/resources/META-INF/services/org.codehaus.groovy.runtime.ExtensionModule
@@ -0,0 +1,9 @@
+moduleName=grails-codecs
+moduleVersion=3.0
+extensionClasses=org.grails.plugins.codecs.HexCodecExtensionMethods,\
+  org.grails.plugins.codecs.MD5BytesCodecExtensionMethods,\
+  org.grails.plugins.codecs.MD5CodecExtensionMethods,\
+  org.grails.plugins.codecs.SHA1BytesCodecExtensionMethods,\
+  org.grails.plugins.codecs.SHA1CodecExtensionMethods,\
+  org.grails.plugins.codecs.SHA256BytesCodecExtensionMethods,\
+  org.grails.plugins.codecs.SHA256CodecExtensionMethods
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/HexCodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/HexCodecTests.groovy
@@ -1,37 +1,33 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.HexCodec
-
 class HexCodecTests extends GroovyTestCase {
 
-    private codec = new HexCodec()
-
     void testEncode() {
 
         def expectedResult = '412042204320442045'
 
         // we want to verify that both Byte[] and byte[] inputs work
-        String primitiveResult = codec.encode([65, 32, 66, 32, 67, 32, 68, 32, 69])
-        String toStringResult = codec.encode('A B C D E')
+        String primitiveResult = [65, 32, 66, 32, 67, 32, 68, 32, 69].encodeAsHex()
+        String toStringResult = 'A B C D E'.encodeAsHex()
 
         assertEquals(expectedResult,primitiveResult)
         assertEquals(expectedResult,toStringResult)
 
         //make sure encoding null returns null
-        assertEquals(codec.encode(null), null)
+        assertEquals(null.encodeAsHex(), null)
     }
 
     void testDecode() {
         String data = '412042204320442045'
-        byte[] result = codec.decode(data)
+        byte[] result = data.decodeHex()
 
         assertEquals([65, 32, 66, 32, 67, 32, 68, 32, 69], result.toList())
         //make sure decoding null returns null
-        assertEquals(codec.decode(null), null)
+        assertEquals(null.decodeHex(), null)
     }
 
     void testRoundtrip() {
-        assertEquals([65, 32, 66, 32, 67, 32, 68, 32, 69], codec.decode(codec.encode([65, 32, 66, 32, 67, 32, 68, 32, 69])).toList())
-        assertEquals([65, 32, 66, 32, 67, 32, 68, 32, 69], codec.decode(codec.encode('A B C D E')).toList())
+        assertEquals([65, 32, 66, 32, 67, 32, 68, 32, 69], [65, 32, 66, 32, 67, 32, 68, 32, 69].encodeAsHex().decodeHex().toList())
+        assertEquals([65, 32, 66, 32, 67, 32, 68, 32, 69], 'A B C D E'.encodeAsHex().decodeHex().toList())
     }
 }
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/MD5BytesCodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/MD5BytesCodecTests.groovy
@@ -0,0 +1,25 @@
+package org.grails.web.codecs
+
+class MD5BytesCodecTests extends GroovyTestCase{
+
+    void testEncode() {
+
+        def expectedResult = [-19, 7, 98, -121, 83, 46, -122, 54, 94, -124, 30, -110, -65, -59, 13, -116]
+
+        // we want to verify that both array/list and String inputs work
+        def primitiveResult = [72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33].encodeAsMD5Bytes()
+        def toStringResult = 'Hello World!'.encodeAsMD5Bytes()
+
+        assertEquals(expectedResult,primitiveResult.toList())
+        assertEquals(expectedResult,toStringResult.toList())
+
+        //make sure encoding null returns null
+        assertNull null.encodeAsMD5Bytes()
+    }
+
+    void testDecode() {
+        shouldFail(UnsupportedOperationException) {
+            [1,2,3,4,5].decodeMD5Bytes()
+        }
+    }
+}
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/MD5CodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/MD5CodecTests.groovy
@@ -1,29 +1,25 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.MD5Codec
-
 class MD5CodecTests extends GroovyTestCase {
 
-    def codec = new MD5Codec()
-
     void testEncode() {
 
         def expectedResult = 'ed076287532e86365e841e92bfc50d8c'
 
         // we want to verify that both array/list and String inputs work
-        def primitiveResult = codec.encode([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
-        def toStringResult = codec.encode('Hello World!')
+        def primitiveResult = [72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33].encodeAsMD5()
+        def toStringResult = 'Hello World!'.encodeAsMD5()
 
         assertEquals(expectedResult,primitiveResult)
         assertEquals(expectedResult,toStringResult)
 
         //make sure encoding null returns null
-        assertNull codec.encode(null)
+        assertNull null.encodeAsMD5()
     }
 
     void testDecode() {
-        shouldFail {
-            codec.decode [1,2,3,4,5]
+        shouldFail(UnsupportedOperationException) {
+            [1,2,3,4,5].decodeMD5()
         }
     }
 }
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA1BytesCodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA1BytesCodecTests.groovy
@@ -1,29 +1,27 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.SHA1BytesCodec
+import org.grails.plugins.codecs.SHA1BytesCodecExtensionMethods
 
 class SHA1BytesCodecTests extends GroovyTestCase{
 
-    def codec = new SHA1BytesCodec()
-
     void testEncode() {
 
         def expectedResult = [46, -9, -67, -26, 8, -50, 84, 4, -23, 125, 95, 4, 47, -107, -8, -97, 28, 35, 40, 113]
 
         // we want to verify that both array/list and String inputs work
-        def primitiveResult = codec.encode([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
-        def toStringResult = codec.encode('Hello World!')
+        def primitiveResult = [72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33].encodeAsSHA1Bytes()
+        def toStringResult = 'Hello World!'.encodeAsSHA1Bytes()
 
         assertEquals(expectedResult,primitiveResult.toList())
         assertEquals(expectedResult,toStringResult.toList())
 
         //make sure encoding null returns null
-        assertNull codec.encode(null)
+        assertNull null.encodeAsSHA1Bytes()
     }
 
     void testDecode() {
-        shouldFail {
-            codec.decode [1,2,3,4,5]
+        shouldFail(UnsupportedOperationException) {
+            [1,2,3,4,5].decodeSHA1Bytes()
         }
     }
 }
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA1CodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA1CodecTests.groovy
@@ -1,29 +1,25 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.SHA1Codec
-
 class SHA1CodecTests extends GroovyTestCase {
 
-    def codec = new SHA1Codec()
-
     void testEncode() {
 
         def expectedResult = '2ef7bde608ce5404e97d5f042f95f89f1c232871'
 
         // we want to verify that both array/list and String inputs work
-        def primitiveResult = codec.encode([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
-        def toStringResult = codec.encode('Hello World!')
+        def primitiveResult = [72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33].encodeAsSHA1()
+        def toStringResult = 'Hello World!'.encodeAsSHA1()
 
         assertEquals(expectedResult,primitiveResult)
         assertEquals(expectedResult,toStringResult)
 
         //make sure encoding null returns null
-        assertNull codec.encode(null)
+        assertNull null.encodeAsSHA1()
     }
 
     void testDecode() {
-        shouldFail {
-            codec.decode [1,2,3,4,5]
+        shouldFail(UnsupportedOperationException) {
+            [1,2,3,4,5].decodeSHA1()
         }
     }
 }
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA256BytesCodec.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA256BytesCodec.groovy
@@ -1,30 +1,28 @@
 package org.grails.web.codecs
 
-import org.grails.plugins.codecs.SHA256BytesCodec
+import org.grails.plugins.codecs.SHA256BytesCodecExtensionMethods
 
 class SHA256BytesCodecTests extends GroovyTestCase{
 
-    def codec = new SHA256BytesCodec()
-
     void testEncode() {
 
         def expectedResult = [127, -125, -79, 101, 127, -15, -4, 83, -71, 45, -63, -127, 72, -95,
             -42, 93, -4, 45, 75, 31, -93, -42, 119, 40, 74, -35, -46, 0, 18, 109, -112, 105]
 
         // we want to verify that both array/list and String inputs work
-        def primitiveResult = codec.encode([72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33])
-        def toStringResult = codec.encode('Hello World!')
+        def primitiveResult = [72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33].encodeAsSHA256Bytes()
+        def toStringResult = 'Hello World!'.encodeAsSHA256Bytes()
 
         assertEquals(expectedResult,primitiveResult.toList())
         assertEquals(expectedResult,toStringResult.toList())
 
         //make sure encoding null returns null
-        assertNull codec.encode(null)
+        assertNull null.encodeAsSHA256Bytes()
     }
 
     void testDecode() {
-        shouldFail {
-            codec.decode [1,2,3,4,5]
+        shouldFail(UnsupportedOperationException) {
+            [1,2,3,4,5].decodeSHA256Bytes()
         }
     }
 }
diff --git a/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA256CodecTests.groovy b/grails-codecs/src/test/groovy/org/grails/web/codecs/SHA256CodecTests.groovy
diff --git a/grails-plugin-codecs/src/main/groovy/org/grails/plugins/CodecsGrailsPlugin.groovy b/grails-plugin-codecs/src/main/groovy/org/grails/plugins/CodecsGrailsPlugin.groovy
diff --git a/grails-plugin-codecs/src/test/groovy/org/grails/web/codecs/MD5BytesCodecTests.groovy b/grails-plugin-codecs/src/test/groovy/org/grails/web/codecs/MD5BytesCodecTests.groovy
diff --git a/settings.gradle b/settings.gradle

Original file line number	Diff line number	Diff line change
`@@ -15,14 +15,14 @@`
`15`	`15`	`*/`
`16`	`16`	`package org.grails.plugins.codecs`
`17`	`17`
`18`		`-class MD5BytesCodec {`
	`18`	`+class MD5CodecExtensionMethods {`
`19`	`19`	`// Returns the byte[] of the digest, taken from UTF-8 of the string representation`
`20`	`20`	`// or the raw data coerced to bytes`
`21`		`- static encode = { theTarget ->`
`22`		`- DigestUtils.digest("MD5", theTarget)`
	`21`	`+ static encodeAsMD5(theTarget) {`
	`22`	`+ theTarget.encodeAsMD5Bytes()?.encodeAsHex()`
`23`	`23`	`}`
`24`	`24`
`25`		`- static decode = { theTarget ->`
	`25`	`+ static decodeMD5(theTarget) {`
`26`	`26`	`throw new UnsupportedOperationException("Cannot decode MD5 hashes")`
`27`	`27`	`}`
`28`	`28`	`}`