puppet 8.3.1 → 8.4.0

data/lib/puppet/pops/lookup/lookup_adapter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'data_adapter'
 require_relative 'lookup_key'
 
@@ -10,7 +11,6 @@ module Lookup
 #
 # @api private
 class LookupAdapter < DataAdapter
-
   LOOKUP_OPTIONS_PREFIX = LOOKUP_OPTIONS + '.'
   LOOKUP_OPTIONS_PREFIX.freeze
   LOOKUP_OPTIONS_PATTERN_START = '^'
@@ -106,8 +106,8 @@ class LookupAdapter < DataAdapter
         convert_to[0] = Puppet::Pops::Types::TypeParser.singleton.parse(convert_to[0])
       rescue StandardError => e
         raise Puppet::DataBinding::LookupError,
-          _("Invalid data type in lookup_options for key '%{key}' could not parse '%{source}', error: '%{msg}") %
-            { key: key, source: convert_to[0], msg: e.message}
+              _("Invalid data type in lookup_options for key '%{key}' could not parse '%{source}', error: '%{msg}") %
+                { key: key, source: convert_to[0], msg: e.message}
       end
     end
     begin
@@ -117,8 +117,8 @@ class LookupAdapter < DataAdapter
       lookup_invocation.report_text { _("Applying convert_to lookup_option with arguments %{args}") % { args: args_string } }
     rescue StandardError => e
       raise Puppet::DataBinding::LookupError,
-        _("The convert_to lookup_option for key '%{key}' raised error: %{msg}") %
-          { key: key, msg: e.message}
+            _("The convert_to lookup_option for key '%{key}' raised error: %{msg}") %
+              { key: key, msg: e.message}
     end
     result
   end
@@ -139,7 +139,7 @@ class LookupAdapter < DataAdapter
       lookup_invocation.with(:global, terminus) do
         catch(:no_such_key) do
           return lookup_invocation.report_found(key, Puppet::DataBinding.indirection.find(key.root_key,
-            {:environment => environment, :variables => lookup_invocation.scope, :merge => merge_strategy}))
+                                                                                          {:environment => environment, :variables => lookup_invocation.scope, :merge => merge_strategy}))
         end
         lookup_invocation.report_not_found(key)
         throw :no_such_key
@@ -147,6 +147,7 @@ class LookupAdapter < DataAdapter
     end
   rescue Puppet::DataBinding::LookupError => detail
     raise detail unless detail.issue_code.nil?
+
     error = Puppet::Error.new(_("Lookup of key '%{key}' failed: %{detail}") % { key: lookup_invocation.top_key, detail: detail.message })
     error.set_backtrace(detail.backtrace)
     raise error
@@ -195,9 +196,9 @@ class LookupAdapter < DataAdapter
             opts = nil
             lookup_invocation.with(:scope, "Searching for \"#{LookupKey::LOOKUP_OPTIONS}\"") do
               catch(:no_such_key) do
-              opts = compile_patterns(
-                validate_lookup_options(
-                  provider.key_lookup_in_default(LookupKey::LOOKUP_OPTIONS, meta_invocation, MergeStrategy.strategy(HASH)), k))
+                opts = compile_patterns(
+                  validate_lookup_options(
+                    provider.key_lookup_in_default(LookupKey::LOOKUP_OPTIONS, meta_invocation, MergeStrategy.strategy(HASH)), k))
               end
             end
             @module_default_lookup_options[k] = opts
@@ -298,7 +299,7 @@ class LookupAdapter < DataAdapter
     return options if module_name.nil?
 
     pfx = "#{module_name}::"
-    options.each_pair do |key, value|
+    options.each_pair do |key, _value|
       if key.start_with?(LOOKUP_OPTIONS_PATTERN_START)
         unless key[1..pfx.length] == pfx
           raise Puppet::DataBinding::LookupError.new(_("all %{opts} patterns must match a key starting with module name '%{module_name}'") % { opts: LOOKUP_OPTIONS, module_name: module_name })
@@ -313,6 +314,7 @@ class LookupAdapter < DataAdapter
 
   def compile_patterns(options)
     return nil if options.nil?
+
     key_options = {}
     pattern_options = {}
     options.each_pair do |key, value|
@@ -331,7 +333,7 @@ class LookupAdapter < DataAdapter
     else
       merge_strategy = Puppet::Pops::MergeStrategy.strategy(merge)
       key.dig(lookup_invocation,
-        merge_strategy.lookup(PROVIDER_STACK, lookup_invocation) { |m| send(m, key, lookup_invocation, merge_strategy) })
+              merge_strategy.lookup(PROVIDER_STACK, lookup_invocation) { |m| send(m, key, lookup_invocation, merge_strategy) })
     end
   end
 
@@ -353,12 +355,12 @@ class LookupAdapter < DataAdapter
             catch(:no_such_key) do
               module_opts = validate_lookup_options(lookup_in_module(LookupKey::LOOKUP_OPTIONS, meta_invocation, merge_strategy), module_name)
               opts = if opts.nil?
-                module_opts
-              elsif module_opts
-                merge_strategy.lookup([GLOBAL_ENV_MERGE, "Module #{lookup_invocation.module_name}"], meta_invocation) do |n|
-                  meta_invocation.with(:scope, n) { meta_invocation.report_found(LOOKUP_OPTIONS,  n == GLOBAL_ENV_MERGE ? opts : module_opts) }
-                end
-              end
+                       module_opts
+                     elsif module_opts
+                       merge_strategy.lookup([GLOBAL_ENV_MERGE, "Module #{lookup_invocation.module_name}"], meta_invocation) do |n|
+                         meta_invocation.with(:scope, n) { meta_invocation.report_found(LOOKUP_OPTIONS, n == GLOBAL_ENV_MERGE ? opts : module_opts) }
+                       end
+                     end
             end
           end
           compile_patterns(opts)
@@ -430,7 +432,7 @@ class LookupAdapter < DataAdapter
       elsif mp_config.version >= 5
         unless provider_name.nil? || Puppet[:strict] == :off
           Puppet.warn_once('deprecations', "metadata.json#data_provider-#{module_name}",
-            _("Defining \"data_provider\": \"%{name}\" in metadata.json is deprecated. It is ignored since a '%{config}' with version >= 5 is present") % { name: provider_name, config: HieraConfig::CONFIG_FILE_NAME }, mod.metadata_file)
+                           _("Defining \"data_provider\": \"%{name}\" in metadata.json is deprecated. It is ignored since a '%{config}' with version >= 5 is present") % { name: provider_name, config: HieraConfig::CONFIG_FILE_NAME }, mod.metadata_file)
         end
         provider_name = nil
       end
@@ -479,11 +481,11 @@ class LookupAdapter < DataAdapter
       elsif ep_config.version >= 5
         unless provider_name.nil? || Puppet[:strict] == :off
           Puppet.warn_once('deprecations', 'environment.conf#data_provider',
-            _("Defining environment_data_provider='%{provider_name}' in environment.conf is deprecated") % { provider_name: provider_name }, env_path + 'environment.conf')
+                           _("Defining environment_data_provider='%{provider_name}' in environment.conf is deprecated") % { provider_name: provider_name }, env_path + 'environment.conf')
 
           unless provider_name == 'hiera'
             Puppet.warn_once('deprecations', 'environment.conf#data_provider_overridden',
-              _("The environment_data_provider='%{provider_name}' setting is ignored since '%{config_path}' version >= 5") % { provider_name: provider_name, config_path: config_path }, env_path + 'environment.conf')
+                             _("The environment_data_provider='%{provider_name}' setting is ignored since '%{config_path}' version >= 5") % { provider_name: provider_name, config_path: config_path }, env_path + 'environment.conf')
           end
         end
         provider_name = nil

data/lib/puppet/pops/lookup/lookup_key.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'sub_lookup'
 
 module Puppet::Pops

data/lib/puppet/pops/lookup/lookup_key_function_provider.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'function_provider'
 
 module Puppet::Pops

data/lib/puppet/pops/lookup/module_data_provider.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require_relative 'configured_data_provider'
 
 module Puppet::Pops
 module Lookup
 # @api private
 class ModuleDataProvider < ConfiguredDataProvider
-
   attr_reader :module_name
 
   def initialize(module_name, config = nil)
@@ -49,6 +49,7 @@ class ModuleDataProvider < ConfiguredDataProvider
     module_prefix = "#{module_name}::"
     data_hash.each_key.reduce(data_hash) do |memo, k|
       next memo if k == LOOKUP_OPTIONS || k.start_with?(module_prefix)
+
       msg = "#{yield} must use keys qualified with the name of the module"
       memo = memo.clone if memo.equal?(data_hash)
       memo.delete(k)
@@ -83,6 +84,7 @@ class ModuleDataProvider < ConfiguredDataProvider
     env = lookup_invocation.scope.environment
     mod = env.module(module_name)
     raise Puppet::DataBinding::LookupError, _("Environment '%{env}', cannot find module '%{module_name}'") % { env: env.name, module_name: module_name } unless mod
+
     Pathname.new(mod.path)
   end
 end

data/lib/puppet/pops/lookup/sub_lookup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Pops
 module Lookup
 module SubLookup
@@ -19,6 +20,7 @@ module SubLookup
   # @api public
   def split_key(key)
     return [key] if key.match(SPECIAL).nil?
+
     segments = key.split(/(\s*"[^"]+"\s*|\s*'[^']+'\s*|[^'".]+)/)
     if segments.empty?
       # Only happens if the original key was an empty string
@@ -29,6 +31,7 @@ module SubLookup
 
       segments.keep_if { |seg| seg != '.' }
       raise yield('Syntax error') unless segments.size * 2 == count + 1
+
       segments.map! do |segment|
         segment.strip!
         if segment.start_with?('"', "'")
@@ -73,8 +76,8 @@ module SubLookup
           else
             unless value.respond_to?(:'[]') && !(value.is_a?(Array) || value.instance_of?(String))
               raise Puppet::DataBinding::LookupError,
-                _("Data Provider type mismatch: Got %{klass} when a hash-like object was expected to access value using '%{segment}' from key '%{key}'") %
-                  { klass: value.class.name, segment: segment, key: key }
+                    _("Data Provider type mismatch: Got %{klass} when a hash-like object was expected to access value using '%{segment}' from key '%{key}'") %
+                      { klass: value.class.name, segment: segment, key: key }
             end
             unless value.include?(segment)
               lookup_invocation.report_not_found(segment)

data/lib/puppet/pops/lookup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This class is the backing implementation of the Puppet function 'lookup'.
 # See puppet/functions/lookup.rb for documentation.
 #
@@ -27,22 +28,26 @@ module Lookup
     # with name and value.
     not_found = MergeStrategy::NOT_FOUND
     override_values = lookup_invocation.override_values
-    result_with_name = names.reduce([nil, not_found]) do |memo, key|
+    result_with_name = [nil, not_found]
+    names.each do |key|
       value = override_values.include?(key) ? assert_type(["Value found for key '%s' in override hash", key], value_type, override_values[key]) : not_found
       catch(:no_such_key) { value = search_and_merge(key, lookup_invocation, merge, false) } if value.equal?(not_found)
-      break [key, assert_type('Found value', value_type, value)] unless value.equal?(not_found)
-      memo
+      next if value.equal?(not_found)
+
+      result_with_name = [key, assert_type('Found value', value_type, value)]
+      break
     end
 
     # Use the 'default_values' hash as a last resort if nothing is found
     if result_with_name[1].equal?(not_found)
       default_values = lookup_invocation.default_values
       unless default_values.empty?
-        result_with_name = names.reduce(result_with_name) do |memo, key|
+        names.each do |key|
           value = default_values.include?(key) ? assert_type(["Value found for key '%s' in default values hash", key], value_type, default_values[key]) : not_found
-          memo = [key, value]
-          break memo unless value.equal?(not_found)
-          memo
+          next if value.equal?(not_found)
+
+          result_with_name = [key, value]
+          break
         end
       end
     end
@@ -88,7 +93,7 @@ module Lookup
     raise Puppet::DataBinding::LookupError,
           n_("Function lookup() did not find a value for the name '%{name}'",
              "Function lookup() did not find a value for any of the names [%{name_list}]", names.size
-            ) % { name: names[0], name_list: names.map { |n| "'#{n}'" }.join(', ') }
+          ) % { name: names[0], name_list: names.map { |n| "'#{n}'" }.join(', ') }
   end
   private_class_method :fail_lookup
 end

data/lib/puppet/pops/merge_strategy.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'deep_merge/core'
 
 module Puppet::Pops
@@ -25,9 +26,10 @@ module Puppet::Pops
       if merge.is_a?(Hash)
         merge_strategy = merge['strategy']
         if merge_strategy.nil?
-          #TRANSLATORS 'merge' is a variable name and 'strategy' is a key and should not be translated
+          # TRANSLATORS 'merge' is a variable name and 'strategy' is a key and should not be translated
           raise ArgumentError, _("The hash given as 'merge' must contain the name of a strategy in string form for the key 'strategy'")
         end
+
         merge_options  = merge.size == 1 ? EMPTY_HASH : merge
       else
         merge_strategy = merge
@@ -36,6 +38,7 @@ module Puppet::Pops
       merge_strategy = merge_strategy.to_sym if merge_strategy.is_a?(String)
       strategy_class = strategies[merge_strategy]
       raise ArgumentError, _("Unknown merge strategy: '%{strategy}'") % { strategy: merge_strategy } if strategy_class.nil?
+
       merge_options == EMPTY_HASH ? strategy_class::INSTANCE : strategy_class.new(merge_options)
     end
 
@@ -53,7 +56,7 @@ module Puppet::Pops
     #
     def self.add_strategy(strategy_class)
       unless MergeStrategy > strategy_class
-        #TRANSLATORS 'MergeStrategies.add_strategy' is a method, 'stratgey_class' is a variable and 'MergeStrategy' is a class name and should not be translated
+        # TRANSLATORS 'MergeStrategies.add_strategy' is a method, 'stratgey_class' is a variable and 'MergeStrategy' is a class name and should not be translated
         raise ArgumentError, _("MergeStrategies.add_strategy 'strategy_class' must be a 'MergeStrategy' class. Got %{strategy_class}") %
             { strategy_class: strategy_class }
       end

data/lib/puppet/pops/migration/migration_checker.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
+
 # This class defines the private API of the MigrationChecker support.
 # @api private
 #
 class Puppet::Pops::Migration::MigrationChecker
-
   def initialize()
   end
 
+  # rubocop:disable Naming/MemoizedInstanceVariableName
   def self.singleton
     @null_checker ||= self.new
   end
+  # rubocop:enable Naming/MemoizedInstanceVariableName
 
   # Produces a hash of available migrations; a map from a symbolic name in string form to a brief description.
   # This version has no such supported migrations.