db5010e2aaca47c84dd2c8a50f669f309908cf9a
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / validate_slength.rb
1 #
2 # validate_slength.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:validate_slength, :doc => <<-'DOC') do |args|
6     Validate that the first argument is a string (or an array of strings), and
7     less/equal to than the length of the second argument. An optional third
8     parameter can be given the minimum length. It fails if the first
9     argument is not a string or array of strings, and if arg 2 and arg 3 are
10     not convertable to a number.
11
12     The following values will pass:
13
14       validate_slength("discombobulate",17)
15       validate_slength(["discombobulate","moo"],17)
16       validate_slength(["discombobulate","moo"],17,3)
17
18     The following valueis will not:
19
20       validate_slength("discombobulate",1)
21       validate_slength(["discombobulate","thermometer"],5)
22       validate_slength(["discombobulate","moo"],17,10)
23
24     DOC
25
26     function_deprecation([:validate_slength, 'This method is deprecated, please use the stdlib validate_legacy function,
27                             with String[]. There is further documentation for validate_legacy function in the README.'])
28
29     raise Puppet::ParseError, "validate_slength(): Wrong number of arguments (#{args.length}; must be 2 or 3)" unless args.length == 2 || args.length == 3
30
31     input, max_length, min_length = *args
32
33     begin
34       max_length = Integer(max_length)
35       raise ArgumentError if max_length <= 0
36     rescue ArgumentError, TypeError
37       raise Puppet::ParseError, "validate_slength(): Expected second argument to be a positive Numeric, got #{max_length}:#{max_length.class}"
38     end
39
40     if min_length
41       begin
42         min_length = Integer(min_length)
43         raise ArgumentError if min_length < 0
44       rescue ArgumentError, TypeError
45         raise Puppet::ParseError, "validate_slength(): Expected third argument to be unset or a positive Numeric, got #{min_length}:#{min_length.class}"
46       end
47     else
48       min_length = 0
49     end
50
51     raise Puppet::ParseError, 'validate_slength(): Expected second argument to be equal to or larger than third argument' unless max_length >= min_length
52
53     validator = ->(str) do
54       unless str.length <= max_length && str.length >= min_length
55         raise Puppet::ParseError, "validate_slength(): Expected length of #{input.inspect} to be between #{min_length} and #{max_length}, was #{input.length}"
56       end
57     end
58
59     case input
60     when String
61       validator.call(input)
62     when Array
63       input.each_with_index do |arg, pos|
64         raise Puppet::ParseError, "validate_slength(): Expected element at array position #{pos} to be a String, got #{arg.class}" unless arg.is_a? String
65         validator.call(arg)
66       end
67     else
68       raise Puppet::ParseError, "validate_slength(): Expected first argument to be a String or Array, got #{input.class}"
69     end
70   end
71 end