Update stdlib and concat to 6.1.0 both

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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/size.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/size.rb
index cc207e3..39b856c 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/size.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/size.rb
@@ -1,20 +1,25 @@
 #
 # size.rb
 #
+module Puppet::Parser::Functions
+  newfunction(:size, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Returns the number of elements in a string, an array or a hash
 
-# TODO(Krzysztof Wilczynski): Support for hashes would be nice too ...
+    @return
+      the number of elements in a string, an array or a hash
 
-module Puppet::Parser::Functions
-  newfunction(:size, :type => :rvalue, :doc => <<-EOS
-Returns the number of elements in a string or array.
-    EOS
-  ) do |arguments|
+    > *Note:* that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions
+    of Puppet < 5.4.0 use the stdlib length() function.
+  DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "size(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+    raise(Puppet::ParseError, "size(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     item = arguments[0]
 
+    function_deprecation([:size, 'This method is going to be deprecated, please use the stdlib length function.'])
+
     if item.is_a?(String)
 
       begin
@@ -28,14 +33,12 @@ Returns the number of elements in a string or array.
         #
         Float(item)
 
-        raise(Puppet::ParseError, 'size(): Requires either ' +
-          'string or array to work with')
-
+        raise(Puppet::ParseError, 'size(): Requires either string, array or hash to work with')
       rescue ArgumentError
         result = item.size
       end
 
-    elsif item.is_a?(Array)
+    elsif item.is_a?(Array) || item.is_a?(Hash)
       result = item.size
     else
       raise(Puppet::ParseError, 'size(): Unknown type given')