X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fsuffix.rb;h=643d7223abca10bd8a3c9a31c90e6ac1bf369cbf;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=7c5057dcba5b10c0b6caf9d9982b2c4095d3bd1b;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/suffix.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/suffix.rb index 7c5057dcb..643d7223a 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/suffix.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/suffix.rb @@ -1,26 +1,34 @@ # # 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 @@ -32,18 +40,18 @@ Will return: ['ap','bp','cp'] 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