e799aef0ee6d56e49b998b6e86ef9ec717d9ef85
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / delete_values.rb
1 module Puppet::Parser::Functions
2   newfunction(:delete_values, :type => :rvalue, :doc => <<-EOS
3 Deletes all instances of a given value from a hash.
4
5 *Examples:*
6
7     delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
8
9 Would return: {'a'=>'A','c'=>'C','B'=>'D'}
10
11       EOS
12     ) do |arguments|
13
14     raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2
15
16     hash, item = arguments
17
18     if not hash.is_a?(Hash)
19       raise(TypeError, "delete_values(): First argument must be a Hash. Given an argument of class #{hash.class}.")
20     end
21     hash.dup.delete_if { |key, val| item == val }
22   end
23 end