Puppet Function: delete_at

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

Overview

delete_at() ⇒ Any

Deletes a determined indexed value from an array.

Examples:

delete_at(['a','b','c'], 1)

Would return: ['a','c']

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
43
44
45
46
 
# File 'puppet/modules/stdlib/lib/puppet/parser/functions/delete_at.rb', line 6

newfunction(:delete_at, :type => :rvalue, :doc => <<-EOS
Deletes a determined indexed value from an array.

*Examples:*

  delete_at(['a','b','c'], 1)

Would return: ['a','c']
  EOS
) do |arguments|

  raise(Puppet::ParseError, "delete_at(): Wrong number of arguments " +
    "given (#{arguments.size} for 2)") if arguments.size < 2

  array = arguments[0]

  unless array.is_a?(Array)
    raise(Puppet::ParseError, 'delete_at(): Requires array to work with')
  end

  index = arguments[1]

  if index.is_a?(String) and not index.match(/^\d+$/)
    raise(Puppet::ParseError, 'delete_at(): You must provide ' +
      'non-negative numeric index')
  end

  result = array.clone

  # Numbers in Puppet are often string-encoded which is troublesome ...
  index = index.to_i

  if index > result.size - 1 # First element is at index 0 is it not?
    raise(Puppet::ParseError, 'delete_at(): Given index ' +
      'exceeds size of array given')
  end

  result.delete_at(index) # We ignore the element that got deleted ...

  return result
end