3rdparty/modules/stdlib/lib/puppet/functions/validate_array.rb

   1 # @summary
   2 #   Validate the passed value represents an array.
   3 Puppet::Functions.create_function(:validate_array) do
   4   # @param scope
   5   #   The main value that will be passed to the method
   6   #
   7   # @param args
   8   #   Any additional values that are to be passed to the method
   9   #
  10   # @return
  11   #   A boolean value (`true` or `false`) returned from the called function.
  12   dispatch :deprecation_gen do
  13     param 'Any', :scope
  14     repeated_param 'Any', :args
  15   end
  16   # Workaround PUP-4438 (fixed: https://github.com/puppetlabs/puppet/commit/e01c4dc924cd963ff6630008a5200fc6a2023b08#diff
  17   #   -c937cc584953271bb3d3b3c2cb141790R221) to support puppet < 4.1.0 and puppet < 3.8.1.
  18   def call(scope, *args)
  19     manipulated_args = [scope] + args
  20     self.class.dispatcher.dispatch(self, scope, manipulated_args)
  21   end
  22
  23   def deprecation_gen(scope, *args)
  24     call_function('deprecation', 'validate_array', 'This method is deprecated, please use the stdlib validate_legacy function,
  25                     with Stdlib::Compat::Array. There is further documentation for validate_legacy function in the README.')
  26     scope.send('function_validate_array', args)
  27   end
  28 end