Puppet Function: regexpescape

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

Overview

regexpescape() ⇒ Any

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

Returns:

  • (Any) 


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

newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS
  Regexp escape a string or array of strings.
  Requires either a single string or an array as an input.
  EOS
) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation
  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.collect { |i| i.is_a?(String) ? Regexp.escape(i) : i }
           else
             Regexp.escape(value)
           end

  return result
end