#
# range.rb
#
-
# TODO(Krzysztof Wilczynski): We probably need to approach numeric values differently ...
-
module Puppet::Parser::Functions
- newfunction(:range, :type => :rvalue, :doc => <<-EOS
-When given range in the form of (start, stop) it will extrapolate a range as
-an array.
+ newfunction(:range, :type => :rvalue, :doc => <<-DOC
+ @summary
+ When given range in the form of (start, stop) it will extrapolate a range as
+ an array.
-*Examples:*
+ @return
+ the range is extrapolated as an array
- range("0", "9")
+ @example **Usage**
+ range("0", "9")
+ Will return: [0,1,2,3,4,5,6,7,8,9]
-Will return: [0,1,2,3,4,5,6,7,8,9]
+ range("00", "09")
+ Will return: [0,1,2,3,4,5,6,7,8,9]
+ (Zero padded strings are converted to integers automatically)
- range("00", "09")
+ range("a", "c")
+ Will return: ["a","b","c"]
-Will return: [0,1,2,3,4,5,6,7,8,9] (Zero padded strings are converted to
-integers automatically)
+ range("host01", "host10")
+ Will return: ["host01", "host02", ..., "host09", "host10"]
- range("a", "c")
+ range("0", "9", "2")
+ Will return: [0,2,4,6,8]
-Will return: ["a","b","c"]
+ NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail.
- range("host01", "host10")
-Will return: ["host01", "host02", ..., "host09", "host10"]
-NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail.
+ > *Note:*
+ Passing a third argument will cause the generated range to step by that
+ interval, e.g.
-Passing a third argument will cause the generated range to step by that
-interval, e.g.
+ The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for
+ iterating a given number of times.
- range("0", "9", "2")
+ @see
+ the step() function in Puppet for skipping values.
-Will return: [0,2,4,6,8]
- EOS
- ) do |arguments|
+ Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9
+ DOC
+ ) do |arguments|
- raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.size == 0
+ raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty?
if arguments.size > 1
start = arguments[0]
else # arguments.size == 1
value = arguments[0]
- if m = value.match(/^(\w+)(\.\.\.?|\-)(\w+)$/)
+ m = value.match(%r{^(\w+)(\.\.\.?|\-)(\w+)$})
+ if m
start = m[1]
stop = m[3]
type = m[2]
step = 1
- elsif value.match(/^.+$/)
+ elsif value =~ %r{^.+$}
raise(Puppet::ParseError, "range(): Unable to compute range from the value: #{value}")
else
raise(Puppet::ParseError, "range(): Unknown range format: #{value}")
end
# If we were given an integer, ensure we work with one
- if start.to_s.match(/^\d+$/)
+ if start.to_s =~ %r{^\d+$}
start = start.to_i
stop = stop.to_i
else
end
range = case type
- when /^(\.\.|\-)$/ then (start .. stop)
- when '...' then (start ... stop) # Exclusive of last element
- end
+ when %r{^(..|-)$} then (start..stop)
+ when '...' then (start...stop) # Exclusive of last element
+ end
- result = range.step(step).to_a
+ result = range.step(step).first(1_000_000).to_a
return result
end