summaryrefslogtreecommitdiff
path: root/lib/puppet/parser/functions/shell_join.rb
blob: 05aeb952651b8a66752e6ee5ff6ba9bc8b2554d1 (plain)
1
2
3
4
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
#
# shell_join.rb
#

require 'shellwords'

module Puppet::Parser::Functions
  newfunction(:shell_join, :type => :rvalue, :doc => <<-EOS
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
  EOS
  ) 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
end

# vim: set ts=2 sw=2 et :