summaryrefslogtreecommitdiffstats
path: root/lib/puppet/parser/functions/split.rb
blob: 36dba7e683a195b660a11079ba135a12f61e840b (plain)
1
2
3
4
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
module Puppet::Parser::Functions
    newfunction(:split, :type => :rvalue,
      :doc => "\
Split a string variable into an array using the specified split regexp.

  Usage::

    $string     = 'v1.v2:v3.v4'
    $array_var1 = split($string, ':')
    $array_var2 = split($string, '[.]')
    $array_var3 = split($string, '[.:]')

$array_var1 now holds the result ['v1.v2', 'v3.v4'],
while $array_var2 holds ['v1', 'v2:v3', 'v4'], and
$array_var3 holds ['v1', 'v2', 'v3', 'v4'].

Note that in the second example, we split on a string that contains
a regexp meta-character (.), and that needs protection.  A simple
way to do that for a single character is to enclose it in square
brackets.") do |args|

     if args.length != 2
         raise Puppet::ParseError, ("split(): wrong number of arguments" +
				   " (#{args.length}; must be 2)")
     end

     return args[0].split(Regexp.compile(args[1]))
    end
end