#
# concat.rb
#
-
module Puppet::Parser::Functions
- newfunction(:concat, :type => :rvalue, :doc => <<-EOS
-Appends the contents of multiple arrays into array 1.
+ newfunction(:concat, :type => :rvalue, :doc => <<-DOC
+ @summary
+ Appends the contents of multiple arrays into array 1.
+
+ @example Example usage
-*Example:*
+ concat(['1','2','3'],'4') returns ['1','2','3','4']
+ concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7']
- concat(['1','2','3'],['4','5','6'],['7','8','9'])
+ > *Note:*
+ Since Puppet 4.0, you can use the `+`` operator for concatenation of arrays and
+ merge of hashes, and the `<<`` operator for appending:
-Would result in:
+ `['1','2','3'] + ['4','5','6'] + ['7','8','9']` returns `['1','2','3','4','5','6','7','8','9']`
+ `[1, 2, 3] << 4` returns `[1, 2, 3, 4]`
+ `[1, 2, 3] << [4, 5]` returns `[1, 2, 3, [4, 5]]`
- ['1','2','3','4','5','6','7','8','9']
- EOS
- ) do |arguments|
+ @return [Array] The single concatenated array
+ DOC
+ ) do |arguments|
# Check that more than 2 arguments have been given ...
- raise(Puppet::ParseError, "concat(): Wrong number of arguments " +
- "given (#{arguments.size} for < 2)") if arguments.size < 2
+ raise(Puppet::ParseError, "concat(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2
a = arguments[0]
arguments.shift
arguments.each do |x|
- result = result + Array(x)
+ result += (x.is_a?(Array) ? x : [x])
end
return result