Puppet Function: join

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

Overview

join()Any

This function joins an array into a string using a separator.

Examples:

join(['a','b','c'], ",")

Would result in: “a,b,c”

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
35
36
# File 'modules/stdlib/lib/puppet/parser/functions/join.rb', line 5

newfunction(:join, :type => :rvalue, :doc => <<-DOC
  This function joins an array into a string using a separator.

  *Examples:*

      join(['a','b','c'], ",")

  Would result in: "a,b,c"
  DOC
           ) do |arguments|

  # Technically we support two arguments but only first is mandatory ...
  raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  array = arguments[0]

  unless array.is_a?(Array)
    raise(Puppet::ParseError, 'join(): Requires array to work with')
  end

  suffix = arguments[1] if arguments[1]

  if suffix
    unless suffix.is_a?(String)
      raise(Puppet::ParseError, 'join(): Requires string to work with')
    end
  end

  result = suffix ? array.join(suffix) : array.join

  return result
end