Puppet Function: regexpescape

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/regexpescape.rb
Function type:
Ruby 3.x API

Summary

Regexp escape a string or array of strings. Requires either a single string or an array as an input.

Overview

regexpescape() ⇒ String

Returns:

  • (String) —

    A string of characters with metacharacters converted to their escaped form.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/regexpescape.rb', line 7

newfunction(:regexpescape, type: :rvalue, doc: <<-DOC
  @summary
    Regexp escape a string or array of strings.
    Requires either a single string or an array as an input.
  @return [String]
    A string of characters with metacharacters converted to their escaped form.
  DOC
) do |arguments|
  raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  value = arguments[0]

  unless value.is_a?(Array) || value.is_a?(String)
    raise(Puppet::ParseError, 'regexpescape(): Requires either array or string to work with')
  end

  result = if value.is_a?(Array)
             # Numbers in Puppet are often string-encoded which is troublesome ...
             value.map { |i| i.is_a?(String) ? Regexp.escape(i) : i }
           else
             Regexp.escape(value)
           end

  return result
end