Puppet Function: grep

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

Overview

grep()Any

> *Note:* that since Puppet 4.0.0, the built-in [`filter`](puppet.com/docs/puppet/latest/function.html#filter) function does the “same” - as any logic can be used to filter, as opposed to just regular expressions: “`['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }“`

Examples:

Example Usage:

grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']

Returns:

  • (Any)

    array of elements that match the provided regular expression.



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

newfunction(:grep, :type => :rvalue, :doc => <<-DOC
  @summary
    This function searches through an array and returns any elements that match
    the provided regular expression.

  @return
    array of elements that match the provided regular expression.
  @example Example Usage:
    grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']

  > **Note:** that since Puppet 4.0.0, the built-in
  [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does
  the "same" - as any logic can be used to filter, as opposed to just regular expressions:
  ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }```
  DOC
           ) do |arguments|

  if arguments.size != 2
    raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2")
  end

  a = arguments[0]
  pattern = Regexp.new(arguments[1])

  a.grep(pattern)
end