add helpers 'asUrlPath' and 'asUrlQuery'

Author: siordache

build.gradle

@@ -5,13 +5,13 @@ plugins {
     id 'idea'
     id 'maven-publish'
     id "com.github.ethankhall.semantic-versioning" version "1.1.0"
-    id "com.github.ben-manes.versions" version "0.13.0"
-    id "com.jfrog.bintray" version "1.7.1"
-    id "org.asciidoctor.convert" version "1.5.3"
-    id 'org.ajoberstar.github-pages' version '1.6.0-rc.1'
-    id "com.github.hierynomus.license" version "0.13.1"
-    id "net.saliman.properties" version "1.4.5"
-    id 'com.github.jk1.dependency-license-report' version '0.3.5'
+    id "com.github.ben-manes.versions" version "0.17.0"
+    id "com.jfrog.bintray" version "1.8.0"
+    id "org.asciidoctor.convert" version "1.5.7"
+    id 'org.ajoberstar.github-pages' version '1.7.2'
+    id "com.github.hierynomus.license" version "0.14.0"
+    id "net.saliman.properties" version "1.4.6"
+    id 'com.github.jk1.dependency-license-report' version '0.4.1'
 }
 
 project.version.with {
@@ -45,7 +45,7 @@ def pomConfig = {
     }
 }
 
-ext.groovyVersion = '2.4.7'
+ext.groovyVersion = '2.4.13'
 
 
 tasks.withType(Javadoc) {
@@ -107,19 +107,19 @@ signArchives {
 
 dependencies {
   compile "org.codehaus.groovy:groovy-all:$groovyVersion"
-  compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.21'
+  compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'
   compile 'com.github.jknack:handlebars:4.0.6'
 
   provided 'com.google.code.findbugs:findbugs-annotations:3.0.1'
 
-  testCompile group: 'ch.qos.logback', name: 'logback-classic', version: '1.1.7'
-  testCompile 'org.yaml:snakeyaml:1.17'
-  testCompile('org.spockframework:spock-core:1.1-groovy-2.4-rc-2') {
+  testCompile group: 'ch.qos.logback', name: 'logback-classic', version: '1.2.3'
+  testCompile 'org.yaml:snakeyaml:1.19'
+  testCompile('org.spockframework:spock-core:1.1-groovy-2.4') {
       exclude module: 'groovy-all'
   }
-  testCompile 'cglib:cglib-nodep:3.2.4'
-  testCompile 'org.objenesis:objenesis:2.4'
-  testCompile('com.athaydes:spock-reports:1.2.12') { transitive = false}
+  testCompile 'cglib:cglib-nodep:3.2.5'
+  testCompile 'org.objenesis:objenesis:2.6'
+  testCompile('com.athaydes:spock-reports:1.4.0') { transitive = false}
 
 }
 

doc/helpers.adoc

@@ -122,7 +122,7 @@ Team size: 3 developers
 == math
 Computes the result of an arithmetic operation.
 
-*Syntax*: {{[purple]##math## _operand1_ _'operator'_ _operand2_  {startsb}[purple]##decimals##: _dec_ {startsb}[purple]##locale##: _loc_{endsb}{endsb}}}
+*Syntax*: {{[purple]##math## _operand1_ _'operator'_ _operand2_  {startsb}[purple]##decimals##=_dec_ {startsb}[purple]##locale##=_loc_{endsb}{endsb}}}
 
 Supported operators: `+`, `-`, `\*`, `/`, `%`, `**`.
 
@@ -170,7 +170,7 @@ interest: 37,50 EUR
 == compare
 Compares two operands using the specified relational operator.
 
-*Syntax*: {{[purple]##compare## _operand1_ _'operator'_ _operand2_}}
+*Syntax*: {{[purple]##compare## _operand1_ _'operator'_ _operand2_ {startsb}[purple]##asString##=_strBool_{endsb}}}
 
 Supported relational operators: `==`, `!=`, `<`, `\<=`, `>`, `>=`.
 
@@ -199,6 +199,7 @@ Exceeded allowed penalty: false
 You won!
 ----
 
+If the operands are numeric you can enforce comparing them as strings by specifying `asString=true`.
 
 == asBoolean
 Returns the boolean value of the operand.
@@ -323,7 +324,7 @@ Click here to download the logs.
 == asJavaId
 Converts a value to a valid Java identifier.
 
-*Syntax*: {{[purple]##asJavaId## _value_ {startsb}[purple]##camelCase##: _ccBool_{endsb} {startsb}[purple]##underscore##: _usBool_{endsb}}}
+*Syntax*: {{[purple]##asJavaId## _value_ {startsb}[purple]##camelCase##=_ccBool_{endsb} {startsb}[purple]##underscore##=_usBool_{endsb}}}
 
 You can control the format of the generated Java identifier by specifying the values of the boolean flags [purple]##camelCase## and [purple]##underscore##.
 The default values are: [purple]##camelCase## = true and [purple]##underscore## = false.
@@ -348,6 +349,59 @@ package: byte_as_an_octet
 ----
 
 
+== asUrlPath
+Encodes a string as the path part of a URL.
+
+*Syntax*: {{[purple]##asUrlPath## _value_ {startsb}[purple]##ascii##=_aBool_{endsb}}}
+
+If the [purple]##ascii## flag is `true`, the string will be encoded so that it only contains characters in the US-ASCII charset.
+The default value of the [purple]##ascii## flag is `false`.
+
+*Example:*
+
+.YAML Model
+----
+name: Mötley Crüe
+----
+
+.Template
+----
+Click <a href="http://videos.example.org/{{asUrlPath name}}.mp4">here</a> to download.
+
+Click <a href="http://videos.example.org/{{asUrlPath name ascii=true}}.mp4">here</a> to download.
+----
+
+.Result
+----
+Click <a href="http://videos.example.org/Mötley%20Crüe.mp4">here</a> to download.
+
+Click <a href="http://videos.example.org/M%C3%B6tley%20Cr%C3%BCe.mp4">here</a> to download.
+----
+
+
+== asUrlQuery
+Encodes a string as the query part of a URL.
+
+*Syntax*: {{[purple]##asUrlQuery## _value_}}
+
+*Example:*
+
+.YAML Model
+----
+url: http://www.example.org/news?id=101
+----
+
+.Template
+----
+Click <a href="http://translate.example.org?url={{asUrlQuery url}}">here</a> to translate the page.
+----
+
+.Result
+----
+Click <a href="http://translate.example.org?url=http%3A%2F%2Fwww.example.org%2Fnews%3Fid%3D101">here</a> to translate the page.
+----
+
+
 == javaComment
 Inserts the content of a file as a Java comment.
 

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip

src/main/groovy/org/beryx/hbs/Helpers.groovy

@@ -24,11 +24,13 @@ import groovy.transform.stc.FromAbstractTypeMethods
 import groovy.util.logging.Slf4j
 import org.apache.commons.lang3.LocaleUtils
 
+import java.nio.charset.StandardCharsets
+
 @Slf4j
 enum Helpers implements Helper {
     DEF ("def", { varName, options ->
         Context ctx = options.context
-        def val = (options.params.size() > 0) ? options.prm(0) : options.fn()
+        def val = (options.params.length > 0) ? options.prm(0) : options.fn()
         varName = from(varName)
         ctx.combine(varName, val)
         options.buffer()
@@ -64,7 +66,6 @@ enum Helpers implements Helper {
         operand1 = from(operand1)
         def op = options.prm(0)
         def operand2 = options.prm(1)
-
         boolean asString = options.hash("asString", false)
         if(!asString && isNumber(operand1) && isNumber(operand2)) {
             operand1 = operand1 as double
@@ -195,7 +196,29 @@ enum Helpers implements Helper {
             buffer.append(' */\n')
         }
         buffer
-    })
+    }),
+
+    AS_URL_PATH("asUrlPath", { path, options ->
+        Options.Buffer buffer = options.buffer()
+        path = from(path)
+        if(path) {
+            def uri = new URI(null, null, path, null, null)
+            boolean ascii = options.hash("ascii", false)
+            def encoded = ascii ? uri.toASCIIString() : uri.toString()
+            buffer.append(encoded)
+        }
+        buffer
+    }),
+
+    AS_URL_QUERY("asUrlQuery", { query, options ->
+        Options.Buffer buffer = options.buffer()
+        query = from(query)
+        if(query) {
+            def encoded = URLEncoder.encode(query, StandardCharsets.UTF_8.name())
+            buffer.append(encoded)
+        }
+        buffer
+    }),
 
 
     static {

src/test/groovy/org/beryx/hbs/DocExamplesSpec.groovy

@@ -304,6 +304,46 @@ class DocExamplesSpec extends Specification implements TestUtil {
     }
 
 
+    def "doc example: asUrlPath"() {
+        given:
+        def ctx = '''
+            name: Mötley Crüe
+        '''
+        def template = '''
+            Click <a href="http://videos.example.org/{{asUrlPath name}}.mp4">here</a> to download.
+            Click <a href="http://videos.example.org/{{asUrlPath name ascii=true}}.mp4">here</a> to download.
+        '''
+
+        when:
+        def merged = merge(template, ctx)
+
+        then:
+        merged == '''
+            Click <a href="http://videos.example.org/Mötley%20Crüe.mp4">here</a> to download.
+            Click <a href="http://videos.example.org/M%C3%B6tley%20Cr%C3%BCe.mp4">here</a> to download.
+        '''.stripAll()
+    }
+
+
+    def "doc example: asUrlQuery"() {
+        given:
+        def ctx = '''
+            url: http://www.example.org/news?id=101
+        '''
+        def template = '''
+            Click <a href="http://translate.example.org?url={{asUrlQuery url}}">here</a> to translate the page.
+        '''
+
+        when:
+        def merged = merge(template, ctx)
+
+        then:
+        merged == '''
+            Click <a href="http://translate.example.org?url=http%3A%2F%2Fwww.example.org%2Fnews%3Fid%3D101">here</a> to translate the page.
+        '''.stripAll()
+    }
+
+
     def "README example: the fifteenth anniversary of a person born in #year was in a #res year"() {
         given:
         def ctx = "birthYear: $year"

src/test/groovy/org/beryx/hbs/HelpersSpec.groovy

@@ -414,4 +414,46 @@ class HelpersSpec extends Specification implements TestUtil {
         '''.stripAll()
 
     }
+
+    def "asUrlPath should convert'#path' to '#encoded'"() {
+        given:
+        def template = "{{asUrlPath $path}}"
+
+        when:
+        def merged = merge(template, context)
+
+        then:
+        merged == "$encoded"
+
+        where:
+        path                     | encoded
+        "''"                  | ''
+        "' '"                 | '%20'
+        "'/'"                 | '/'
+        "'/abc/def'"          | '/abc/def'
+        "'a and b'"           | 'a%20and%20b'
+        "'göögle'"            | 'göögle'
+        "'göögle' ascii=true" | 'g%C3%B6%C3%B6gle'
+    }
+
+    def "asUrlQuery should convert'#query' to '#encoded'"() {
+        given:
+        def template = "{{asUrlQuery $query}}"
+
+        when:
+        def merged = merge(template, context)
+
+        then:
+        merged == "$encoded"
+
+        where:
+        query                                                      | encoded
+        "''"                                                       | ''
+        "' '"                                                      | '+'
+        "'/'"                                                      | '%2F'
+        "'key1=val1&key2=val2'"                                    | 'key1%3Dval1%26key2%3Dval2'
+        "'url=http://www.example.org/doc?name=guide&page=3#intro'" | 'url%3Dhttp%3A%2F%2Fwww.example.org%2Fdoc%3Fname%3Dguide%26page%3D3%23intro'
+        "'göögle'"                                                 | 'g%C3%B6%C3%B6gle'
+    }
+
 }