Puppet Function: grep

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

Overview

grep()Any

This function searches through an array and returns any elements that match the provided regular expression.

Examples:

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

Would return:

['aaa','aaaddd']

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
# File 'lib/puppet/parser/functions/grep.rb', line 5

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

  *Examples:*

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

  Would return:

      ['aaa','aaaddd']
  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