Update stdlib
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / difference.rb
1 #
2 # difference.rb
3 #
4
5 module Puppet::Parser::Functions
6   newfunction(:difference, :type => :rvalue, :doc => <<-EOS
7 This function returns the difference between two arrays.
8 The returned array is a copy of the original array, removing any items that
9 also appear in the second array.
10
11 *Examples:*
12
13     difference(["a","b","c"],["b","c","d"])
14
15 Would return: ["a"]
16     EOS
17   ) do |arguments|
18
19     # Two arguments are required
20     raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2
21
22     first = arguments[0]
23     second = arguments[1]
24
25     unless first.is_a?(Array) && second.is_a?(Array)
26       raise(Puppet::ParseError, 'difference(): Requires 2 arrays')
27     end
28
29     result = first - second
30
31     return result
32   end
33 end
34
35 # vim: set ts=2 sw=2 et :