puppet 8.3.1 → 8.4.0

data/lib/puppet/functions/hocon_data.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # The `hocon_data` is a hiera 5 `data_hash` data provider function.
 # See [the configuration guide documentation](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html#configuring-a-hierarchy-level-built-in-backends) for
 # how to use this function.

data/lib/puppet/functions/import.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # The import function raises an error when called to inform the user that import is no longer supported.
 #
 Puppet::Functions.create_function(:import) do

data/lib/puppet/functions/include.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Declares one or more classes, causing the resources in them to be
 # evaluated and added to the catalog. Accepts a class name, an array of class
 # names, or a comma-separated list of class names.

data/lib/puppet/functions/index.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the index (or key in a hash) to a first-found value in an `Iterable` value.
 #
 # When called with a  [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
@@ -121,9 +122,8 @@ Puppet::Functions.create_function(:index) do
     param 'Any', :match
   end
 
-
   def index_Hash_1(hash)
-    hash.each_pair { |x, y| return x if yield(y)  }
+    hash.each_pair { |x, y| return x if yield(y) }
     nil
   end
 

data/lib/puppet/functions/info.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Logs a message on the server at level `info`.
 Puppet::Functions.create_function(:info, Puppet::Functions::InternalFunction) do
   # @param values The values to log.

data/lib/puppet/functions/inline_epp.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Evaluates an Embedded Puppet (EPP) template string and returns the rendered
 # text result as a String.
 #
@@ -47,7 +48,6 @@
 # @since 4.0.0
 #
 Puppet::Functions.create_function(:inline_epp, Puppet::Functions::InternalFunction) do
-
   dispatch :inline_epp do
     scope_param()
     param 'String', :template

data/lib/puppet/functions/join.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Joins the values of an Array into a string with elements separated by a delimiter.
 #
 # Supports up to two arguments
@@ -52,6 +53,6 @@ Puppet::Functions.create_function(:join) do
   end
 
   def join(arg, delimiter = '', puppet_formatting = false)
-      arg.join(delimiter)
+    arg.join(delimiter)
   end
 end

data/lib/puppet/functions/json_data.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # The `json_data` is a hiera 5 `data_hash` data provider function.
 # See [the configuration guide documentation](https://puppet.com/docs/puppet/latest/hiera_config_yaml_5.html#configuring-a-hierarchy-level-built-in-backends) for
 # how to use this function.

data/lib/puppet/functions/keys.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the keys of a hash as an Array
 #
 # @example Using `keys`

data/lib/puppet/functions/length.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the length of an Array, Hash, String, or Binary value.
 #
 # The returned value is a positive integer indicating the number
@@ -41,5 +42,4 @@ Puppet::Functions.create_function(:length) do
   def binary_length(bin)
     bin.length
   end
-
 end

data/lib/puppet/functions/lest.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Calls a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # without arguments if the value given to `lest` is `undef`.
 # Returns the result of calling the lambda if the argument is `undef`, otherwise the

data/lib/puppet/functions/lookup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Uses the Puppet lookup system to retrieve a value for a given key. By default,
 # this returns the first value found (and fails compilation if no values are
 # available), but you can configure it to merge multiple values into one, fail
@@ -124,7 +125,6 @@
 #
 # @since 4.0.0
 Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction) do
-
   local_types do
     type 'NameType         = Variant[String, Array[String]]'
     type 'ValueType        = Type'
@@ -146,7 +146,6 @@ Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction)
       default_values_hash => Optional[Hash[String,Any]],\
       merge               => Optional[MergeType]\
     }]"
-
   end
 
   dispatch :lookup_1 do
@@ -209,17 +208,17 @@ Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction)
 
   def do_lookup(scope, name, value_type, default_value, has_default, override, default_values_hash, merge, &block)
     Puppet::Pops::Lookup.lookup(name, value_type, default_value, has_default, merge,
-      Puppet::Pops::Lookup::Invocation.new(scope, override, default_values_hash), &block)
+                                Puppet::Pops::Lookup::Invocation.new(scope, override, default_values_hash), &block)
   end
 
   def hash_args(options_hash)
     [
-        options_hash['value_type'],
-        options_hash['default_value'],
-        options_hash.include?('default_value'),
-        options_hash['override'] || {},
-        options_hash['default_values_hash'] || {},
-        options_hash['merge']
+      options_hash['value_type'],
+      options_hash['default_value'],
+      options_hash.include?('default_value'),
+      options_hash['override'] || {},
+      options_hash['default_values_hash'] || {},
+      options_hash['merge']
     ]
   end
 end

data/lib/puppet/functions/lstrip.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Strips leading spaces from a String
 #
 # This function is compatible with the stdlib function with the same name.
@@ -26,7 +27,6 @@
 # Would both result in `['hello', 'hi']`
 #
 Puppet::Functions.create_function(:lstrip) do
-
   dispatch :on_numeric do
     param 'Numeric', :arg
   end

data/lib/puppet/functions/map.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Applies a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # to every value in a data structure and returns an array containing the results.
 #

data/lib/puppet/functions/match.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Matches a regular expression against a string and returns an array containing the match
 # and any matched capturing groups.
 #
@@ -54,7 +55,7 @@ Puppet::Functions.create_function(:match) do
     # a puppet runtime (where this function is) without a reboot. If you model a function in a module after
     # this class, use a regular instance variable instead to enable reloading of the module without reboot
     #
-    @@match_visitor   ||= Puppet::Pops::Visitor.new(self, "match", 1, 1)
+    @@match_visitor ||= Puppet::Pops::Visitor.new(self, "match", 1, 1)
   end
 
   # Matches given string against given pattern and returns an Array with matches.
@@ -104,6 +105,7 @@ Puppet::Functions.create_function(:match) do
 
   def match_PRegexpType(regexp_t, s)
     raise ArgumentError, _("Given Regexp Type has no regular expression") unless regexp_t.pattern
+
     do_match(s, regexp_t.regexp)
   end
 

data/lib/puppet/functions/max.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the highest value among a variable number of arguments.
 # Takes at least one argument.
 #
@@ -134,7 +135,6 @@ Puppet::Functions.create_function(:max) do
     repeated_param 'Any', :values
   end
 
-
   # All are Numeric - ok now, will be ok later
   def on_numeric(*args)
     assert_arg_count(args)
@@ -148,7 +148,7 @@ Puppet::Functions.create_function(:max) do
     args.max do|a,b|
       if a.to_s =~ %r{\A^-?\d+([._eE]\d+)?\z} && b.to_s =~ %r{\A-?\d+([._eE]\d+)?\z}
         Puppet.warn_once('deprecations', 'max_function_numeric_coerce_string',
-          _("The max() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+                         _("The max() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
         a.to_f <=> b.to_f
       else
         # case sensitive as in the stdlib function
@@ -234,11 +234,11 @@ Puppet::Functions.create_function(:max) do
       bs = b.to_s
       if as =~ %r{\A^-?\d+([._eE]\d+)?\z} && bs =~ %r{\A-?\d+([._eE]\d+)?\z}
         Puppet.warn_once('deprecations', 'max_function_numeric_coerce_string',
-          _("The max() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+                         _("The max() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
         a.to_f <=> b.to_f
       else
         Puppet.warn_once('deprecations', 'max_function_string_coerce_any',
-          _("The max() function's auto conversion of Any to String is deprecated - change to convert input before calling, or use lambda"))
+                         _("The max() function's auto conversion of Any to String is deprecated - change to convert input before calling, or use lambda"))
         as <=> bs
       end
     end

data/lib/puppet/functions/min.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the lowest value among a variable number of arguments.
 # Takes at least one argument.
 #
@@ -133,7 +134,6 @@ Puppet::Functions.create_function(:min) do
     repeated_param 'Any', :values
   end
 
-
   # All are Numeric - ok now, will be ok later
   def on_numeric(*args)
     assert_arg_count(args)
@@ -147,7 +147,7 @@ Puppet::Functions.create_function(:min) do
     args.min do|a,b|
       if a.to_s =~ %r{\A^-?\d+([._eE]\d+)?\z} && b.to_s =~ %r{\A-?\d+([._eE]\d+)?\z}
         Puppet.warn_once('deprecations', 'min_function_numeric_coerce_string',
-          _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+                         _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
         a.to_f <=> b.to_f
       else
         # case sensitive as in the stdlib function
@@ -233,11 +233,11 @@ Puppet::Functions.create_function(:min) do
       bs = b.to_s
       if as =~ %r{\A^-?\d+([._eE]\d+)?\z} && bs =~ %r{\A-?\d+([._eE]\d+)?\z}
         Puppet.warn_once('deprecations', 'min_function_numeric_coerce_string',
-          _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+                         _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
         a.to_f <=> b.to_f
       else
         Puppet.warn_once('deprecations', 'min_function_string_coerce_any',
-          _("The min() function's auto conversion of Any to String is deprecated - change to convert input before calling, or use lambda"))
+                         _("The min() function's auto conversion of Any to String is deprecated - change to convert input before calling, or use lambda"))
         as <=> bs
       end
     end

data/lib/puppet/functions/module_directory.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Finds an existing module and returns the path to its root directory.
 #
 # The argument to this function should be a module name String

data/lib/puppet/functions/new.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Creates a new instance/object of a given data type.
 #
 # This function makes it possible to create new instances of
@@ -982,7 +983,6 @@
 # @since 4.5.0
 #
 Puppet::Functions.create_function(:new, Puppet::Functions::InternalFunction) do
-
   dispatch :new_instance do
     scope_param
     param          'Type', :type
@@ -992,6 +992,7 @@ Puppet::Functions.create_function(:new, Puppet::Functions::InternalFunction) do
 
   def new_instance(scope, t, *args)
     return args[0] if args.size == 1 && !t.is_a?(Puppet::Pops::Types::PInitType) && t.instance?(args[0])
+
     result = assert_type(t, new_function_for_type(t).call(scope, *args))
     return block_given? ? yield(result) : result
   end

data/lib/puppet/functions/next.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Makes iteration continue with the next value, optionally with a given value for this iteration.
 # If a value is not given it defaults to `undef`
 # 

data/lib/puppet/functions/notice.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Logs a message on the server at level `notice`.
 Puppet::Functions.create_function(:notice, Puppet::Functions::InternalFunction) do
   # @param values The values to log.

data/lib/puppet/functions/reduce.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Applies a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # to every value in a data structure from the first argument, carrying over the returned
 # value of each iteration, and returns the result of the lambda's final iteration. This
@@ -127,7 +128,6 @@
 # @since 4.0.0
 #
 Puppet::Functions.create_function(:reduce) do
-
   dispatch :reduce_without_memo do
     param 'Iterable', :enumerable
     block_param 'Callable[2,2]', :block

data/lib/puppet/functions/regsubst.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Performs regexp replacement on a string or array of strings.
 Puppet::Functions.create_function(:regsubst) do
   # @param target [String]

data/lib/puppet/functions/require.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Requires the specified classes.
 # Evaluate one or more classes, adding the required class as a dependency.
 #
@@ -69,6 +70,7 @@ Puppet::Functions.create_function(:require, Puppet::Functions::InternalFunction)
       # lookup the class in the scopes
       klass = (classobj = krt.find_hostclass(klass)) ? classobj.name : nil
       raise Puppet::ParseError.new(_("Could not find class %{klass}") % { klass: klass }) unless klass
+
       ref = Puppet::Resource.new(:class, klass)
       resource = scope.resource
       resource.set_parameter(:require, [resource[:require]].flatten.compact << ref)

data/lib/puppet/functions/return.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Makes iteration continue with the next value, optionally with a given value for this iteration.
 # If a value is not given it defaults to `undef`
 #

data/lib/puppet/functions/reverse_each.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Reverses the order of the elements of something that is iterable and optionally runs a
 # [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html) for each
 # element.

data/lib/puppet/functions/round.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns an `Integer` value rounded to the nearest value.
 # Takes a single `Numeric` value as an argument.
 #

data/lib/puppet/functions/rstrip.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Strips trailing spaces from a String
 #
 # This function is compatible with the stdlib function with the same name.
@@ -26,7 +27,6 @@
 # Would both result in `['hello', 'hi']`
 #
 Puppet::Functions.create_function(:rstrip) do
-
   dispatch :on_numeric do
     param 'Numeric', :arg
   end

data/lib/puppet/functions/scanf.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Scans a string and returns an array of one or more converted values based on the given format string.
 # See the documentation of Ruby's String#scanf method for details about the supported formats (which
 # are similar but not identical to the formats used in Puppet's `sprintf` function.)

data/lib/puppet/functions/size.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # The same as length() - returns the size of an Array, Hash, String, or Binary value.
 #
 # @since 6.0.0 - also supporting Binary
@@ -8,9 +9,7 @@ Puppet::Functions.create_function(:size) do
     param 'Variant[Collection, String, Binary]', :arg
   end
 
-
   def generic_size(arg)
     call_function('length', arg)
   end
-
 end

data/lib/puppet/functions/slice.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Slices an array or hash into pieces of a given size.
 #
 # This function takes two mandatory arguments: the first should be an array or hash, and the second specifies
@@ -116,6 +117,7 @@ Puppet::Functions.create_function(:slice) do
     if serving_size == 0
       raise ArgumentError, _("slice(): block must define at least one parameter. Block has 0.")
     end
+
     unless serving_size == 1 || serving_size == slice_size
       raise ArgumentError, _("slice(): block must define one parameter, or the same number of parameters as the given size of the slice (%{slice_size}). Block has %{serving_size}; %{parameter_names}") %
           { slice_size: slice_size, serving_size: serving_size, parameter_names: pblock.parameter_names.join(', ') }

data/lib/puppet/functions/sort.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Sorts an Array numerically or lexicographically or the characters of a String lexicographically.
 # Please note: This function is based on Ruby String comparison 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.

data/lib/puppet/functions/split.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Splits a string into an array using a given pattern.
 # The pattern can be a string, regexp or regexp type.
 #

data/lib/puppet/functions/step.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Provides stepping with given interval over elements in an iterable and optionally runs a
 # [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html) for each
 # element.

data/lib/puppet/functions/strftime.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Formats timestamp or timespan according to the directives in the given format string. The directives begins with a percent (%) character.
 # Any text not listed as a directive will be passed through to the output string.
 #
@@ -206,8 +207,8 @@ Puppet::Functions.create_function(:strftime) do
   def legacy_strftime(format, timezone = nil)
     file, line = Puppet::Pops::PuppetStack.top_of_stack
     Puppet.warn_once('deprecations', 'legacy#strftime',
-      _('The argument signature (String format, [String timezone]) is deprecated for #strftime. See #strftime documentation and Timespan type for more info'),
-      file, line)
+                     _('The argument signature (String format, [String timezone]) is deprecated for #strftime. See #strftime documentation and Timespan type for more info'),
+                     file, line)
     Puppet::Pops::Time::Timestamp.format_time(format, Time.now.utc, timezone)
   end
 end

data/lib/puppet/functions/strip.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Strips leading and trailing spaces from a String
 #
 # This function is compatible with the stdlib function with the same name.
@@ -26,7 +27,6 @@
 # Would both result in `['hello', 'hi']`
 #
 Puppet::Functions.create_function(:strip) do
-
   dispatch :on_numeric do
     param 'Numeric', :arg
   end

data/lib/puppet/functions/then.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Calls a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # with the given argument unless the argument is `undef`.
 # Returns `undef` if the argument is `undef`, and otherwise the result of giving the
@@ -73,6 +74,7 @@ Puppet::Functions.create_function(:then) do
 
   def then(arg)
     return nil if arg.nil?
+
     yield(arg)
   end
 end

data/lib/puppet/functions/tree_each.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Runs a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # recursively and repeatedly using values from a data structure, then returns the unchanged data structure, or if
 # a lambda is not given, returns an `Iterator` for the tree.
@@ -141,7 +142,6 @@
 # @since 5.0.0
 #
 Puppet::Functions.create_function(:tree_each) do
-
   local_types do
     type "OptionsType  = Struct[{\
       container_type => Optional[Type],\

data/lib/puppet/functions/type.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the data type of a given value with a given degree of generality.
 #
 # ```puppet

data/lib/puppet/functions/unique.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Produces a unique set of values from an `Iterable` argument.
 #
 # * If the argument is a `String`, the unique set of characters are returned as a new `String`.
@@ -119,7 +120,7 @@ Puppet::Functions.create_function(:unique) do
     end
     # reduce the set of possibly duplicated value entries
     inverted = {}
-    result.each_pair {|k,v| inverted[v[:keys]] = v[:values].uniq }
+    result.each_pair {|_k,v| inverted[v[:keys]] = v[:values].uniq }
     inverted
   end
 

data/lib/puppet/functions/unwrap.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Unwraps a Sensitive value and returns the wrapped object.
 # Returns the Value itself, if it is not Sensitive.
 #

data/lib/puppet/functions/upcase.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Converts a String, Array or Hash (recursively) into upper case.
 #
 # This function is compatible with the stdlib function with the same name.

data/lib/puppet/functions/values.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Returns the values of a hash as an Array
 #
 # @example Using `values`

data/lib/puppet/functions/versioncmp.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/package'
 
 # Compares two version numbers.
 #
 # Prototype:
 #
-#     \$result = versioncmp(a, b)
+#     $result = versioncmp(a, b)
 #
 # Where a and b are arbitrary version strings.
 #
@@ -28,7 +29,6 @@ require_relative '../../puppet/util/package'
 # `package` type.
 #
 Puppet::Functions.create_function(:versioncmp) do
-
   dispatch :versioncmp do
     param 'String', :a
     param 'String', :b

data/lib/puppet/functions/warning.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Logs a message on the server at level `warning`.
 Puppet::Functions.create_function(:warning, Puppet::Functions::InternalFunction) do
   # @param values The values to log.

data/lib/puppet/functions/with.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Calls a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # with the given arguments and returns the result.
 #

data/lib/puppet/functions/yaml_data.rb

@@ -29,6 +29,7 @@ Puppet::Functions.create_function(:yaml_data) do
         else
           msg = _("%{path}: file does not contain a valid yaml hash" % { path: path })
           raise Puppet::DataBinding::LookupError, msg if Puppet[:strict] == :error && data != false
+
           Puppet.warning(msg)
           {}
         end