ca25a702c58a9881a695882bb1bec3e85f8f15c3
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / validate_re.rb
1 module Puppet::Parser::Functions
2   newfunction(:validate_re, :doc => <<-'ENDHEREDOC') do |args|
3     Perform simple validation of a string against one or more regular
4     expressions. The first argument of this function should be a string to
5     test, and the second argument should be a stringified regular expression
6     (without the // delimiters) or an array of regular expressions.  If none
7     of the regular expressions match the string passed in, compilation will
8     abort with a parse error.
9
10     If a third argument is specified, this will be the error message raised and
11     seen by the user.
12
13     The following strings will validate against the regular expressions:
14
15         validate_re('one', '^one$')
16         validate_re('one', [ '^one', '^two' ])
17
18     The following strings will fail to validate, causing compilation to abort:
19
20         validate_re('one', [ '^two', '^three' ])
21
22     A helpful error message can be returned like this:
23
24         validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
25
26     ENDHEREDOC
27     if (args.length < 2) or (args.length > 3) then
28       raise Puppet::ParseError, ("validate_re(): wrong number of arguments (#{args.length}; must be 2 or 3)")
29     end
30
31     msg = args[2] || "validate_re(): #{args[0].inspect} does not match #{args[1].inspect}"
32
33     # We're using a flattened array here because we can't call String#any? in
34     # Ruby 1.9 like we can in Ruby 1.8
35     raise Puppet::ParseError, (msg) unless [args[1]].flatten.any? do |re_str|
36       args[0] =~ Regexp.compile(re_str)
37     end
38
39   end
40 end