Update stdlib
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / values_at.rb
1 #
2 # values_at.rb
3 #
4
5 module Puppet::Parser::Functions
6   newfunction(:values_at, :type => :rvalue, :doc => <<-EOS
7 Finds value inside an array based on location.
8
9 The first argument is the array you want to analyze, and the second element can
10 be a combination of:
11
12 * A single numeric index
13 * A range in the form of 'start-stop' (eg. 4-9)
14 * An array combining the above
15
16 *Examples*:
17
18     values_at(['a','b','c'], 2)
19
20 Would return ['c'].
21
22     values_at(['a','b','c'], ["0-1"])
23
24 Would return ['a','b'].
25
26     values_at(['a','b','c','d','e'], [0, "2-3"])
27
28 Would return ['a','c','d'].
29     EOS
30   ) do |arguments|
31
32     raise(Puppet::ParseError, "values_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2
33
34     array = arguments.shift
35
36     unless array.is_a?(Array)
37       raise(Puppet::ParseError, 'values_at(): Requires array to work with')
38     end
39
40     indices = [arguments.shift].flatten() # Get them all ... Pokemon ...
41
42     if not indices or indices.empty?
43       raise(Puppet::ParseError, 'values_at(): You must provide at least one positive index to collect')
44     end
45
46     result       = []
47     indices_list = []
48
49     indices.each do |i|
50       i = i.to_s
51       if m = i.match(/^(\d+)(\.\.\.?|\-)(\d+)$/)
52         start = m[1].to_i
53         stop  = m[3].to_i
54
55         type = m[2]
56
57         if start > stop
58           raise(Puppet::ParseError, 'values_at(): Stop index in given indices range is smaller than the start index')
59         elsif stop > array.size - 1 # First element is at index 0 is it not?
60           raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size')
61         end
62
63         range = case type
64           when /^(\.\.|\-)$/ then (start .. stop)
65           when /^(\.\.\.)$/  then (start ... stop) # Exclusive of last element ...
66         end
67
68         range.each { |i| indices_list << i.to_i }
69       else
70         # Only positive numbers allowed in this case ...
71         if not i.match(/^\d+$/)
72           raise(Puppet::ParseError, 'values_at(): Unknown format of given index')
73         end
74
75         # In Puppet numbers are often string-encoded ...
76         i = i.to_i
77
78         if i > array.size - 1 # Same story.  First element is at index 0 ...
79           raise(Puppet::ParseError, 'values_at(): Given index exceeds array size')
80         end
81
82         indices_list << i
83       end
84     end
85
86     # We remove nil values as they make no sense in Puppet DSL ...
87     result = indices_list.collect { |i| array[i] }.compact
88
89     return result
90   end
91 end
92
93 # vim: set ts=2 sw=2 et :