#
# suffix.rb
#
-
module Puppet::Parser::Functions
- newfunction(:suffix, :type => :rvalue, :doc => <<-EOS
-This function applies a suffix to all elements in an array, or to the keys
-in a hash.
+ newfunction(:suffix, :type => :rvalue, :doc => <<-DOC
+ @summary
+ This function applies a suffix to all elements in an array, or to the keys
+ in a hash.
+
+ @return
+ Array or Hash with updated elements containing the passed suffix
+
+ @example **Usage**
-*Examples:*
+ suffix(['a','b','c'], 'p')
+ Will return: ['ap','bp','cp']
- suffix(['a','b','c'], 'p')
+ > *Note:* that since Puppet 4.0.0 the general way to modify values is in array is by using the map
+ function in Puppet. This example does the same as the example above:
-Will return: ['ap','bp','cp']
- EOS
- ) do |arguments|
+ ```['a', 'b', 'c'].map |$x| { "${x}p" }```
+
+ DOC
+ ) do |arguments|
# Technically we support two arguments but only first is mandatory ...
- raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+ raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
enumerable = arguments[0]
- unless enumerable.is_a?(Array) or enumerable.is_a?(Hash)
+ unless enumerable.is_a?(Array) || enumerable.is_a?(Hash)
raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}"
end
end
end
- if enumerable.is_a?(Array)
- # Turn everything into string same as join would do ...
- result = enumerable.collect do |i|
- i = i.to_s
- suffix ? i + suffix : i
- end
- else
- result = Hash[enumerable.map do |k,v|
- k = k.to_s
- [ suffix ? k + suffix : k, v ]
- end]
- end
+ result = if enumerable.is_a?(Array)
+ # Turn everything into string same as join would do ...
+ enumerable.map do |i|
+ i = i.to_s
+ suffix ? i + suffix : i
+ end
+ else
+ Hash[enumerable.map do |k, v|
+ k = k.to_s
+ [suffix ? k + suffix : k, v]
+ end]
+ end
return result
end