3rdparty/modules/stdlib/lib/puppet/parser/functions/delete_at.rb

   1 #
   2 # delete_at.rb
   3 #
   4
   5 module Puppet::Parser::Functions
   6   newfunction(:delete_at, :type => :rvalue, :doc => <<-EOS
   7 Deletes a determined indexed value from an array.
   8
   9 *Examples:*
  10
  11     delete_at(['a','b','c'], 1)
  12
  13 Would return: ['a','c']
  14     EOS
  15   ) do |arguments|
  16
  17     raise(Puppet::ParseError, "delete_at(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2
  18
  19     array = arguments[0]
  20
  21     unless array.is_a?(Array)
  22       raise(Puppet::ParseError, 'delete_at(): Requires array to work with')
  23     end
  24
  25     index = arguments[1]
  26
  27     if index.is_a?(String) and not index.match(/^\d+$/)
  28       raise(Puppet::ParseError, 'delete_at(): You must provide non-negative numeric index')
  29     end
  30
  31     result = array.clone
  32
  33     # Numbers in Puppet are often string-encoded which is troublesome ...
  34     index = index.to_i
  35
  36     if index > result.size - 1 # First element is at index 0 is it not?
  37       raise(Puppet::ParseError, 'delete_at(): Given index exceeds size of array given')
  38     end
  39
  40     result.delete_at(index) # We ignore the element that got deleted ...
  41
  42     return result
  43   end
  44 end
  45
  46 # vim: set ts=2 sw=2 et :