Update stdlib
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / delete_regex.rb
1 #
2 #  delete_regex.rb
3 #  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
4 #
5
6 module Puppet::Parser::Functions
7   newfunction(:delete_regex, :type => :rvalue, :doc => <<-EOS
8 deletes all instances of a given element that match a regular expression
9 from an array or key from a hash. Multiple regular expressions are assumed
10 to be matched as an OR.
11
12 *Examples:*
13
14     delete_regex(['a','b','c','b'], 'b')
15     Would return: ['a','c']
16
17     delete_regex(['a','b','c','b'], ['b', 'c'])
18     Would return: ['a']
19
20     delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b')
21     Would return: {'a'=>1,'c'=>3}
22
23     delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$')
24     Would return: {'b'=>2,'c'=>3}
25
26   EOS
27   ) do |arguments|
28
29     raise(Puppet::ParseError, "delete_regex(): Wrong number of arguments given #{arguments.size} for 2") unless arguments.size == 2
30
31     collection = arguments[0].dup
32     Array(arguments[1]).each do |item|
33       case collection
34         when Array, Hash, String
35           collection.reject! { |coll_item| (coll_item =~ %r{\b#{item}\b}) }
36         else
37           raise(TypeError, "delete_regex(): First argument must be an Array, Hash, or String. Given an argument of class #{collection.class}.")
38       end
39     end
40     collection
41   end
42 end
43
44 # vim: set ts=2 sw=2 et :