4 module Puppet::Parser::Functions
5 newfunction(:validate_numeric, :doc => <<-DOC
7 Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail.
9 The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max.
10 The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min.
11 If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check
12 if (all elements of) the first argument are greater or equal to the given minimum.
13 It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric.
16 Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail.
18 For passing and failing usage, see `validate_integer()`. It is all the same for validate_numeric, yet now floating point values are allowed, too.
22 function_deprecation([:validate_numeric, 'This method is deprecated, please use the stdlib validate_legacy function,
23 with Stdlib::Compat::Numeric. There is further documentation for validate_legacy function in the README.'])
25 # tell the user we need at least one, and optionally up to two other parameters
26 raise Puppet::ParseError, "validate_numeric(): Wrong number of arguments; must be 1, 2 or 3, got #{args.length}" unless !args.empty? && args.length < 4
28 input, max, min = *args
30 # check maximum parameter
33 # allow max to be empty (or undefined) if we have a minimum set
34 if args.length > 2 && max == ''
39 rescue TypeError, ArgumentError
40 raise Puppet::ParseError, "validate_numeric(): Expected second argument to be unset or a Numeric, got #{max}:#{max.class}"
47 # check minimum parameter
51 rescue TypeError, ArgumentError
52 raise Puppet::ParseError, "validate_numeric(): Expected third argument to be unset or a Numeric, got #{min}:#{min.class}"
58 # ensure that min < max
59 if min && max && min > max
60 raise Puppet::ParseError, "validate_numeric(): Expected second argument to be larger than third argument, got #{max} < #{min}"
63 # create lamba validator function
64 validator = ->(num) do
67 raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be smaller or equal to #{max}, got #{input.inspect}."
69 # check input > min (this will only be checked if no exception has been raised before)
71 raise Puppet::ParseError, "validate_numeric(): Expected #{input.inspect} to be greater or equal to #{min}, got #{input.inspect}."
75 # if this is an array, handle it.
78 # check every element of the array
79 input.each_with_index do |arg, pos|
81 raise TypeError if arg.is_a?(Hash)
84 rescue TypeError, ArgumentError
85 raise Puppet::ParseError, "validate_numeric(): Expected element at array position #{pos} to be a Numeric, got #{arg.class}"
88 # for the sake of compatibility with ruby 1.8, we need extra handling of hashes
90 raise Puppet::ParseError, "validate_integer(): Expected first argument to be a Numeric or Array, got #{input.class}"
91 # check the input. this will also fail any stuff other than pure, shiny integers
94 input = Float(input.to_s)
96 rescue TypeError, ArgumentError
97 raise Puppet::ParseError, "validate_numeric(): Expected first argument to be a Numeric or Array, got #{input.class}"