Merge pull request #834 from hairyhenderson/regexp-quotemeta-751

Add function regexp.QuoteMeta

docs-src/content/functions/regexp.yml

@@ -72,6 +72,21 @@ funcs:
       - |
         $ gomplate -i '{{ if (.Env.USER | regexp.Match `^h`) }}username ({{.Env.USER}}) starts with h!{{end}}'
         username (hairyhenderson) starts with h!
+  - name: regexp.QuoteMeta
+    description: |
+      Escapes all regular expression metacharacters in the input. The returned string is a regular expression matching the literal text.
+
+      This function provides the same behaviour as Go's
+      [`regexp.QuoteMeta`](https://golang.org/pkg/regexp/#Regexp.QuoteMeta) function.
+    pipeline: true
+    arguments:
+      - name: input
+        required: true
+        description: The input to escape
+    examples:
+      - |
+        $ gomplate -i '{{ `{hello}` | regexp.QuoteMeta }}'
+        \{hello\}
   - name: regexp.Replace
     description: |
       Replaces matches of a regular expression with the replacement string.

docs/content/functions/regexp.md

@@ -59,18 +59,18 @@ This function provides the same behaviour as Go's
 ### Usage
 
 ```go
-regexp.FindAll expression [false] input
+regexp.FindAll expression [n] input
 ```
 ```go
-input | regexp.FindAll expression [false]
+input | regexp.FindAll expression [n]
 ```
 
 ### Arguments
 
 | name | description |
 |------|-------------|
 | `expression` | _(required)_ The regular expression |
-| `false` | _(optional)_ The number of matches to return |
+| `n` | _(optional)_ The number of matches to return |
 | `input` | _(required)_ The input to search |
 
 ### Examples
@@ -113,6 +113,35 @@ $ gomplate -i '{{ if (.Env.USER | regexp.Match `^h`) }}username ({{.Env.USER}})
 username (hairyhenderson) starts with h!
 ```
 
+## `regexp.QuoteMeta`
+
+Escapes all regular expression metacharacters in the input. The returned string is a regular expression matching the literal text.
+
+This function provides the same behaviour as Go's
+[`regexp.QuoteMeta`](https://golang.org/pkg/regexp/#Regexp.QuoteMeta) function.
+
+### Usage
+
+```go
+regexp.QuoteMeta input
+```
+```go
+input | regexp.QuoteMeta
+```
+
+### Arguments
+
+| name | description |
+|------|-------------|
+| `input` | _(required)_ The input to escape |
+
+### Examples
+
+```console
+$ gomplate -i '{{ `{hello}` | regexp.QuoteMeta }}'
+\{hello\}
+```
+
 ## `regexp.Replace`
 
 Replaces matches of a regular expression with the replacement string.
@@ -205,18 +234,18 @@ This function provides the same behaviour as Go's
 ### Usage
 
 ```go
-regexp.Split expression [false] input
+regexp.Split expression [n] input
 ```
 ```go
-input | regexp.Split expression [false]
+input | regexp.Split expression [n]
 ```
 
 ### Arguments
 
 | name | description |
 |------|-------------|
 | `expression` | _(required)_ The regular expression |
-| `false` | _(optional)_ The number of matches to return |
+| `n` | _(optional)_ The number of matches to return |
 | `input` | _(required)_ The input to search |
 
 ### Examples

funcs/regexp.go

@@ -58,6 +58,11 @@ func (f *ReFuncs) Match(re, input interface{}) bool {
 	return regexp.Match(conv.ToString(re), conv.ToString(input))
 }
 
+// QuoteMeta -
+func (f *ReFuncs) QuoteMeta(in interface{}) string {
+	return regexp.QuoteMeta(conv.ToString(in))
+}
+
 // Replace -
 func (f *ReFuncs) Replace(re, replacement, input interface{}) string {
 	return regexp.Replace(conv.ToString(re),

regexp/regexp.go

@@ -27,6 +27,11 @@ func Match(expression, input string) bool {
 	return re.MatchString(input)
 }
 
+// QuoteMeta -
+func QuoteMeta(input string) string {
+	return stdre.QuoteMeta(input)
+}
+
 // Replace -
 func Replace(expression, replacement, input string) string {
 	re := stdre.MustCompile(expression)

regexp/regexp_test.go

@@ -107,3 +107,7 @@ func TestSplit(t *testing.T) {
 		assert.EqualValues(t, d.expected, f)
 	}
 }
+
+func TestQuoteMeta(t *testing.T) {
+	assert.Equal(t, `foo\{\(\\`, QuoteMeta(`foo{(\`))
+}

tests/integration/regexp_test.go

@@ -17,3 +17,9 @@ func (s *RegexpSuite) TestReplace(c *C) {
 		`{{ "1.2.3-59" | regexp.Replace "-([0-9]*)" ".$1" }}`)
 	result.Assert(c, icmd.Expected{ExitCode: 0, Out: "1.2.3.59"})
 }
+
+func (s *RegexpSuite) TestQuoteMeta(c *C) {
+	result := icmd.RunCommand(GomplateBin, "-i",
+		"{{ regexp.QuoteMeta `foo{(\\` }}")
+	result.Assert(c, icmd.Expected{ExitCode: 0, Out: `foo\{\(\\`})
+}