Puppet Function: zip

Defined in:
modules/stdlib/lib/puppet/parser/functions/zip.rb
Function type:
Ruby 3.x API

Overview

zip()Any

Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments.

Example:

zip(['1','2','3'],['4','5','6'])

Would result in:

["1", "4"], ["2", "5"], ["3", "6"]

Returns:

  • (Any)


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'modules/stdlib/lib/puppet/parser/functions/zip.rb', line 5

newfunction(:zip, :type => :rvalue, :doc => <<-DOC
  Takes one element from first array and merges corresponding elements from second array. This generates a sequence of n-element arrays, where n is one more than the count of arguments.

  *Example:*

      zip(['1','2','3'],['4','5','6'])

  Would result in:

      ["1", "4"], ["2", "5"], ["3", "6"]
  DOC
           ) do |arguments|

  # Technically we support three arguments but only first is mandatory ...
  raise(Puppet::ParseError, "zip(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2

  a = arguments[0]
  b = arguments[1]

  unless a.is_a?(Array) && b.is_a?(Array)
    raise(Puppet::ParseError, 'zip(): Requires array to work with')
  end

  flatten = function_str2bool([arguments[2]]) if arguments[2]

  result = a.zip(b)
  result = flatten ? result.flatten : result

  return result
end