Update puppetlabs/stdlib module
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / delete_undef_values.rb
1 #
2 # delete_undef_values.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:delete_undef_values, :type => :rvalue, :doc => <<-DOC
6     Returns a copy of input hash or array with all undefs deleted.
7
8     *Examples:*
9
10         $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
11
12     Would return: {a => 'A', b => '', d => false}
13
14         $array = delete_undef_values(['A','',undef,false])
15
16     Would return: ['A','',false]
17
18     Note that since Puppet 4.0.0 the equivalent can be performed with the filter() function in Puppet:
19
20         $array.filter |$val| { $val =~ NotUndef }
21         $hash.filter |$key, $val| { $val =~ NotUndef }
22
23       DOC
24              ) do |args|
25
26     raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty?
27
28     unless args[0].is_a?(Array) || args[0].is_a?(Hash)
29       raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type  #{args[0].class} ")
30     end
31     result = args[0].dup
32     if result.is_a?(Hash)
33       result.delete_if { |_, val| val.equal?(:undef) || val.nil? }
34     elsif result.is_a?(Array)
35       result.delete :undef
36       result.delete nil
37     end
38     result
39   end
40 end