Puppet Function: delete_at

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

Summary

Deletes a determined indexed value from an array.

Overview

delete_at() ⇒ Array

For example

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

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

> Note:

Since Puppet 4 this can be done in general with the built-in
[`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:

```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }```

Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]:

```
$array[0, -1] # the same as all the values
$array[2, -1] # all but the first 2 elements
$array[0, -3] # all but the last 2 elements
$array[1, -2] # all but the first and last element
```

Returns:

  • (Array) —

    The given array, now missing the tar



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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/delete_at.rb', line 7

newfunction(:delete_at, type: :rvalue, doc: <<-DOC) do |arguments|
  @summary
    Deletes a determined indexed value from an array.

  For example
      ```delete_at(['a','b','c'], 1)```

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

  > *Note:*
    Since Puppet 4 this can be done in general with the built-in
    [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function:

    ```['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }```

  Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]:
    ```
    $array[0, -1] # the same as all the values
    $array[2, -1] # all but the first 2 elements
    $array[0, -3] # all but the last 2 elements
    $array[1, -2] # all but the first and last element
    ```

  @return [Array] The given array, now missing the target value

DOC

  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) && !index.match(%r{^\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