Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / delete.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete.rb
index f548b44..bf614f7 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/delete.rb
@@ -1,45 +1,63 @@
 #
 # delete.rb
 #
+module Puppet::Parser::Functions
+  newfunction(:delete, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Deletes all instances of a given element from an array, substring from a
+      string, or key from a hash.
 
-# TODO(Krzysztof Wilczynski): We need to add support for regular expression ...
+    @example Example usage
 
-module Puppet::Parser::Functions
-  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.
+      delete(['a','b','c','b'], 'b')
+      Would return: ['a','c']
 
-*Examples:*
+      delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
+      Would return: {'a'=>1,'c'=>3}
 
-    delete(['a','b','c','b'], 'b')
-    Would return: ['a','c']
+      delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
+      Would return: {'a'=>1}
 
-    delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
-    Would return: {'a'=>1,'c'=>3}
+      delete('abracadabra', 'bra')
+      Would return: 'acada'
 
-    delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
-    Would return: {'a'=>1}
+      ['a', 'b', 'c', 'b'] - 'b'
+      Would return: ['a', 'c']
 
-    delete('abracadabra', 'bra')
-    Would return: 'acada'
-  EOS
-  ) do |arguments|
+      {'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
+      Would return: {'a' => '1'}
 
-    if (arguments.size != 2) then
-      raise(Puppet::ParseError, "delete(): Wrong number of arguments "+
-                                  "given #{arguments.size} for 2.")
-    end
+      'abracadabra'.regsubst(/bra/, '', 'G')
+      Would return: 'acada'
+
+    > *Note:*
+    From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash
+    `{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])`
+    >
+    A global delete from a string can be performed with the
+    [`regsubst`](https://puppet.com/docs/puppet/latest/function.html#regsubst) function:
+    `'abracadabra'.regsubst(/bra/, '', 'G')`
+
+    In general, the built-in [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter)
+    function can filter out entries from arrays and hashes based on keys and/or values.
+
+    @return [String] The filtered String, if one was given.
+    @return [Hash] The filtered Hash, if one was given.
+    @return [Array] The filtered Array, if one was given.
+  DOC
+             ) 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}.")
+      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