3rdparty/modules/stdlib/lib/puppet/parser/functions/range.rb

   1 #
   2 # range.rb
   3 #
   4
   5 # TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ...
   6
   7 module Puppet::Parser::Functions
   8   newfunction(:range, :type => :rvalue, :doc => <<-EOS
   9 When given range in the form of (start, stop) it will extrapolate a range as
  10 an array.
  11
  12 *Examples:*
  13
  14     range("0", "9")
  15
  16 Will return: [0,1,2,3,4,5,6,7,8,9]
  17
  18     range("00", "09")
  19
  20 Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to
  21 integers automatically)
  22
  23     range("a", "c")
  24
  25 Will return: ["a","b","c"]
  26
  27     range("host01", "host10")
  28 Will return: ["host01", "host02", ..., "host09", "host10"]
  29 NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail.
  30
  31 Passing a third argument will cause the generated range to step by that
  32 interval, e.g.
  33
  34     range("0", "9", "2")
  35
  36 Will return: [0,2,4,6,8]
  37     EOS
  38   ) do |arguments|
  39
  40     raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.size == 0
  41
  42     if arguments.size > 1
  43       start = arguments[0]
  44       stop  = arguments[1]
  45       step  = arguments[2].nil? ? 1 : arguments[2].to_i.abs
  46
  47       type = '..' # Use the simplest type of Range available in Ruby
  48
  49     else # arguments.size == 1
  50       value = arguments[0]
  51
  52       if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/)
  53         start = m[1]
  54         stop  = m[3]
  55
  56         type = m[2]
  57         step = 1
  58       elsif value.match(/^.+$/)
  59         raise(Puppet::ParseError, "range(): Unable to compute range from the value: #{value}")
  60       else
  61         raise(Puppet::ParseError, "range(): Unknown range format: #{value}")
  62       end
  63     end
  64
  65     # If we were given an integer, ensure we work with one
  66     if start.to_s.match(/^\d+$/)
  67       start = start.to_i
  68       stop  = stop.to_i
  69     else
  70       start = start.to_s
  71       stop  = stop.to_s
  72     end
  73
  74     range = case type
  75       when /^(\.\.|\-)$/ then (start .. stop)
  76       when '...'         then (start ... stop) # Exclusive of last element
  77     end
  78
  79     result = range.step(step).to_a
  80
  81     return result
  82   end
  83 end
  84
  85 # vim: set ts=2 sw=2 et :