Puppet Function: shell_join

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

Overview

shell_join()Any

Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function

Returns:

  • (Any)

    a command line string



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

newfunction(:shell_join, :type => :rvalue, :doc => <<-DOC
  @summary
  Builds a command line string from the given array of strings.
  Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between.
  This function behaves the same as ruby's Shellwords.shelljoin() function

  @return
    a command line string
DOC
           ) do |arguments|

  raise(Puppet::ParseError, "shell_join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1

  array = arguments[0]

  raise Puppet::ParseError, "First argument is not an Array: #{array.inspect}" unless array.is_a?(Array)

  # explicit conversion to string is required for ruby 1.9
  array = array.map { |item| item.to_s }
  result = Shellwords.shelljoin(array)

  return result
end