Puppet Function: delete

Defined in:
puppet/modules/stdlib/lib/puppet/parser/functions/delete.rb
Function type:
Ruby 3.x API

Overview

delete() ⇒ Any

Deletes all instances of a given element from an array, substring from a string, or key from a hash.

Examples:

delete(['a','b','c','b'], 'b')
Would return: ['a','c']

delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
Would return: {'a'=>1,'c'=>3}

delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
Would return: {'a'=>1}

delete('abracadabra', 'bra')
Would return: 'acada'

Returns:

  • (Any) 


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
32
33
34
35
36
37
38
39
40
41
42
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/delete.rb', line 6

newfunction(:delete, :type => :rvalue, :doc => <<-EOS
Deletes all instances of a given element from an array, substring from a
string, or key from a hash.

*Examples:*

  delete(['a','b','c','b'], 'b')
  Would return: ['a','c']

  delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
  Would return: {'a'=>1,'c'=>3}

  delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
  Would return: {'a'=>1}

  delete('abracadabra', 'bra')
  Would return: 'acada'
EOS
) do |arguments|

  raise(Puppet::ParseError, "delete(): Wrong number of arguments "+
                            "given #{arguments.size} for 2") unless arguments.size == 2

  collection = arguments[0].dup
  Array(arguments[1]).each do |item|
    case collection
      when Array, Hash
        collection.delete item
      when String
        collection.gsub! item, ''
      else
        raise(TypeError, "delete(): First argument must be an Array, " +
                           "String, or Hash. Given an argument of class #{collection.class}.")
    end
  end
  collection
end