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     @summary
   7       Returns a copy of input hash or array with all undefs deleted.
   8
   9     @example Example usage
  10
  11       $hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
  12       Would return: {a => 'A', b => '', d => false}
  13
  14       While:
  15       $array = delete_undef_values(['A','',undef,false])
  16       Would return: ['A','',false]
  17
  18     > *Note:*
  19     Since Puppet 4.0.0 the equivalent can be performed with the built-in
  20     [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:
  21     $array.filter |$val| { $val =~ NotUndef }
  22     $hash.filter |$key, $val| { $val =~ NotUndef }
  23
  24     @return [Array] The given array now issing of undefined values.
  25     DOC
  26              ) do |args|
  27
  28     raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty?
  29
  30     unless args[0].is_a?(Array) || args[0].is_a?(Hash)
  31       raise(Puppet::ParseError, "delete_undef_values(): expected an array or hash, got #{args[0]} type  #{args[0].class} ")
  32     end
  33     result = args[0].dup
  34     if result.is_a?(Hash)
  35       result.delete_if { |_, val| val.equal?(:undef) || val.nil? }
  36     elsif result.is_a?(Array)
  37       result.delete :undef
  38       result.delete nil
  39     end
  40     result
  41   end
  42 end