puppet 8.3.1 → 8.4.0

data/lib/puppet/module_tool/applications/uninstaller.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::ModuleTool
   module Applications
     class Uninstaller < Application
@@ -17,7 +18,7 @@ module Puppet::ModuleTool
 
       def run
         results = {
-          :module_name       => @name,
+          :module_name => @name,
           :requested_version => @version,
         }
 
@@ -31,7 +32,7 @@ module Puppet::ModuleTool
           results[:result] = :success
         rescue ModuleToolError => err
           results[:error] = {
-            :oneline   => err.message,
+            :oneline => err.message,
             :multiline => err.multiline,
           }
         rescue => e
@@ -53,9 +54,9 @@ module Puppet::ModuleTool
           mod_name = (mod.forge_name || mod.name).tr('/', '-')
           if mod_name == @name
             @unfiltered << {
-              :name    => mod_name,
+              :name => mod_name,
               :version => mod.version,
-              :path    => mod.modulepath,
+              :path => mod.modulepath,
             }
             if @options[:version] && mod.version
               next unless Puppet::Module.parse_range(@options[:version]).include?(SemanticPuppet::Version.parse(mod.version))
@@ -68,20 +69,20 @@ module Puppet::ModuleTool
 
         if @installed.length > 1
           raise MultipleInstalledError,
-            :action            => :uninstall,
-            :module_name       => @name,
-            :installed_modules => @installed.sort_by { |mod| @environment.modulepath.index(mod.modulepath) }
+                :action => :uninstall,
+                :module_name => @name,
+                :installed_modules => @installed.sort_by { |mod| @environment.modulepath.index(mod.modulepath) }
         elsif @installed.empty?
           if @unfiltered.empty?
             raise NotInstalledError,
-              :action      => :uninstall,
-              :suggestions => @suggestions,
-              :module_name => @name
+                  :action => :uninstall,
+                  :suggestions => @suggestions,
+                  :module_name => @name
           else
             raise NoVersionMatchesError,
-              :installed_modules => @unfiltered.sort_by { |mod| @environment.modulepath.index(mod[:path]) },
-              :version_range     => @options[:version],
-              :module_name       => @name
+                  :installed_modules => @unfiltered.sort_by { |mod| @environment.modulepath.index(mod[:path]) },
+                  :version_range => @options[:version],
+                  :module_name => @name
           end
         end
       end
@@ -100,19 +101,19 @@ module Puppet::ModuleTool
 
           if mod.has_metadata? && !changes.empty?
             raise LocalChangesError,
-              :action            => :uninstall,
-              :module_name       => (mod.forge_name || mod.name).tr('/', '-'),
-              :requested_version => @options[:version],
-              :installed_version => mod.version
+                  :action => :uninstall,
+                  :module_name => (mod.forge_name || mod.name).tr('/', '-'),
+                  :requested_version => @options[:version],
+                  :installed_version => mod.version
           end
         end
 
         if !@options[:force] && !mod.required_by.empty?
           raise ModuleIsRequiredError,
-            :module_name       => (mod.forge_name || mod.name).tr('/', '-'),
-            :required_by       => mod.required_by,
-            :requested_version => @options[:version],
-            :installed_version => mod.version
+                :module_name => (mod.forge_name || mod.name).tr('/', '-'),
+                :required_by => mod.required_by,
+                :requested_version => @options[:version],
+                :installed_version => mod.version
         end
       end
     end

data/lib/puppet/module_tool/applications/unpacker.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 require 'tmpdir'
 require_relative '../../../puppet/util/json'
@@ -93,9 +94,11 @@ module Puppet::ModuleTool
       #
       # @api private
       # @return [String] path to temporary unpacking location
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def tmpdir
         @dir ||= Dir.mktmpdir('tmp', Puppet::Forge::Cache.base_path)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
     end
   end
 end

data/lib/puppet/module_tool/applications/upgrader.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 
 require_relative '../../../puppet/forge'
@@ -10,7 +11,6 @@ require_relative '../../../puppet/module_tool/installed_modules'
 module Puppet::ModuleTool
   module Applications
     class Upgrader < Application
-
       include Puppet::ModuleTool::Errors
 
       def initialize(name, options)
@@ -79,10 +79,10 @@ module Puppet::ModuleTool
             changes = Checksummer.run(mod.path) rescue []
             if mod.has_metadata? && !changes.empty?
               raise LocalChangesError,
-                :action            => :upgrade,
-                :module_name       => name,
-                :requested_version => results[:requested_version],
-                :installed_version => mod.version
+                    :action => :upgrade,
+                    :module_name => name,
+                    :requested_version => results[:requested_version],
+                    :installed_version => mod.version
             end
           end
 
@@ -157,11 +157,11 @@ module Puppet::ModuleTool
               end
 
               raise InstallConflictError,
-                :requested_module  => name,
-                :requested_version => options[:version] || 'latest',
-                :dependency        => dependency,
-                :directory         => mod.path,
-                :metadata          => mod.metadata
+                    :requested_module => name,
+                    :requested_version => options[:version] || 'latest',
+                    :dependency => dependency,
+                    :directory => mod.path,
+                    :metadata => mod.metadata
             end
           end
 
@@ -173,16 +173,16 @@ module Puppet::ModuleTool
               newer_versions = versions.select { |v| v > results[:installed_version] }
 
               raise VersionAlreadyInstalledError,
-                :module_name       => name,
-                :requested_version => results[:requested_version],
-                :installed_version => results[:installed_version],
-                :newer_versions    => newer_versions,
-                :possible_culprits => installed_modules_source.fetched.reject { |x| x == name }
+                    :module_name => name,
+                    :requested_version => results[:requested_version],
+                    :installed_version => results[:installed_version],
+                    :newer_versions => newer_versions,
+                    :possible_culprits => installed_modules_source.fetched.reject { |x| x == name }
             elsif child.version < results[:installed_version]
               raise DowngradingUnsupportedError,
-                :module_name       => name,
-                :requested_version => results[:requested_version],
-                :installed_version => results[:installed_version]
+                    :module_name => name,
+                    :requested_version => results[:requested_version],
+                    :installed_version => results[:installed_version]
             end
           end
 
@@ -203,13 +203,12 @@ module Puppet::ModuleTool
           results[:base_dir] = releases.first.install_dir
           results[:affected_modules] = releases
           results[:graph] = [ build_install_graph(releases.first, releases) ]
-
         rescue VersionAlreadyInstalledError => e
           results[:result] = (e.newer_versions.empty? ? :noop : :failure)
           results[:error] = { :oneline => e.message, :multiline => e.multiline }
         rescue => e
           results[:error] = {
-            :oneline   => e.message,
+            :oneline => e.message,
             :multiline => e.respond_to?(:multiline) ? e.multiline : [e.to_s, e.backtrace].join("\n")
           }
         ensure
@@ -220,6 +219,8 @@ module Puppet::ModuleTool
       end
 
       private
+
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def module_repository
         @repo ||= Puppet::Forge.new(Puppet[:module_repository])
       end
@@ -227,6 +228,7 @@ module Puppet::ModuleTool
       def installed_modules_source
         @installed ||= Puppet::ModuleTool::InstalledModules.new(@environment)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       def installed_modules
         installed_modules_source.modules
@@ -267,13 +269,13 @@ module Puppet::ModuleTool
         end.compact
 
         return {
-          :release          => release,
-          :name             => release.name,
-          :path             => release.install_dir,
-          :dependencies     => dependencies.compact,
-          :version          => release.version,
+          :release => release,
+          :name => release.name,
+          :path => release.install_dir,
+          :dependencies => dependencies.compact,
+          :version => release.version,
           :previous_version => previous,
-          :action           => action,
+          :action => action,
         }
       end
 

data/lib/puppet/module_tool/applications.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 
 module Puppet::ModuleTool

data/lib/puppet/module_tool/checksums.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require 'digest/md5'
 require_relative '../../puppet/network/format_support'
 
 module Puppet::ModuleTool
-
   # = Checksums
   #
   # This class provides methods for generating checksums for data and adding

data/lib/puppet/module_tool/contents_description.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 
 module Puppet::ModuleTool
-
   # = ContentsDescription
   #
   # This class populates +Metadata+'s Puppet type information.
   class ContentsDescription
-
     # Instantiate object for string +module_path+.
     def initialize(module_path)
       @module_path = module_path

data/lib/puppet/module_tool/dependency.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/network/format_support'
 
 module Puppet::ModuleTool
-
   class Dependency
     include Puppet::Network::FormatSupport
 

data/lib/puppet/module_tool/errors/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::ModuleTool::Errors
   class ModuleToolError < Puppet::Error
     def v(version)

data/lib/puppet/module_tool/errors/installer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Puppet::ModuleTool::Errors
 
+module Puppet::ModuleTool::Errors
   class InstallError < ModuleToolError; end
 
   class AlreadyInstalledError < InstallError
@@ -17,9 +17,9 @@ module Puppet::ModuleTool::Errors
       message << _("Could not install module '%{module_name}' (%{version})") % { module_name: @module_name, version: @requested_version }
       message << _("  Module '%{module_name}' (%{installed_version}) is already installed") % { module_name: @module_name, installed_version: @installed_version }
       message << _("    Installed module has had changes made locally") unless @local_changes.empty?
-      #TRANSLATORS `puppet module upgrade` is a command line and should not be translated
+      # TRANSLATORS `puppet module upgrade` is a command line and should not be translated
       message << _("    Use `puppet module upgrade` to install a different version")
-      #TRANSLATORS `puppet module install --force` is a command line and should not be translated
+      # TRANSLATORS `puppet module install --force` is a command line and should not be translated
       message << _("    Use `puppet module install --force` to re-install only this module")
       message.join("\n")
     end
@@ -54,7 +54,7 @@ module Puppet::ModuleTool::Errors
       message = []
       message << _("Could not install module '%{module_name}' (%{version})") % { module_name: @requested_module, version: @requested_version }
       message << _("  Path '%{directory}' exists but is not a directory.") % { directory: @directory }
-      #TRANSLATORS "mkdir -p '%{directory}'" is a command line example and should not be translated
+      # TRANSLATORS "mkdir -p '%{directory}'" is a command line example and should not be translated
       message << _("  A potential solution is to rename the path and then \"mkdir -p '%{directory}'\"") % { directory: @directory }
       message.join("\n")
     end

data/lib/puppet/module_tool/errors/shared.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Puppet::ModuleTool::Errors
 
+module Puppet::ModuleTool::Errors
   class NoVersionsSatisfyError < ModuleToolError
     def initialize(options)
       @requested_name    = options[:requested_name]
@@ -31,7 +31,7 @@ module Puppet::ModuleTool::Errors
         message << _("  The requested version cannot satisfy all dependencies")
       end
 
-      #TRANSLATORS `puppet module %{action} --ignore-dependencies` is a command line and should not be translated
+      # TRANSLATORS `puppet module %{action} --ignore-dependencies` is a command line and should not be translated
       message << _("  Use `puppet module %{action} '%{module_name}' --ignore-dependencies` to %{action} only this module") % { action: @action, module_name: @requested_name }
       message.join("\n")
     end
@@ -90,10 +90,10 @@ module Puppet::ModuleTool::Errors
       end
 
       if @dependency
-        #TRANSLATORS `puppet module install --ignore-dependencies` is a command line and should not be translated
+        # TRANSLATORS `puppet module install --ignore-dependencies` is a command line and should not be translated
         message << _("    Use `puppet module install --ignore-dependencies` to install only this module")
       else
-        #TRANSLATORS `puppet module install --force` is a command line and should not be translated
+        # TRANSLATORS `puppet module install --force` is a command line and should not be translated
         message << _("    Use `puppet module install --force` to install this module anyway")
       end
       message.join("\n")
@@ -115,14 +115,14 @@ module Puppet::ModuleTool::Errors
       dependency_list = []
       dependency_list << _("You specified '%{name}' (%{version})") % { name: @source.first[:name], version: v(@requested_version) }
       dependency_list += @source[1..-1].map do |m|
-        #TRANSLATORS This message repeats as separate lines as a list under the heading "You specified '%{name}' (%{version})\n"
+        # TRANSLATORS This message repeats as separate lines as a list under the heading "You specified '%{name}' (%{version})\n"
         _("This depends on '%{name}' (%{version})") % { name: m[:name], version: v(m[:version]) }
       end
       message = []
       message << _("Could not install module '%{module_name}' (%{version})") % { module_name: @requested_module, version: v(@requested_version) }
       message << _("  No version of '%{module_name}' will satisfy dependencies") % { module_name: @module_name }
       message << dependency_list.map {|s| "    #{s}".join(",\n")}
-      #TRANSLATORS `puppet module install --force` is a command line and should not be translated
+      # TRANSLATORS `puppet module install --force` is a command line and should not be translated
       message << _("    Use `puppet module install --force` to install this module anyway")
       message.join("\n")
     end
@@ -158,10 +158,10 @@ module Puppet::ModuleTool::Errors
       message << _("Could not %{action} module '%{module_name}'") % { action: @action, module_name: @module_name }
       message << _("  Module '%{module_name}' is not installed") % { module_name: @module_name }
       message += @suggestions.map do |suggestion|
-        #TRANSLATORS `puppet module %{action} %{suggestion}` is a command line and should not be translated
+        # TRANSLATORS `puppet module %{action} %{suggestion}` is a command line and should not be translated
         _("    You may have meant `puppet module %{action} %{suggestion}`") % { action: @action, suggestion: suggestion }
       end
-      #TRANSLATORS `puppet module install` is a command line and should not be translated
+      # TRANSLATORS `puppet module install` is a command line and should not be translated
       message << _("    Use `puppet module install` to install this module") if @action == :upgrade
       message.join("\n")
     end
@@ -172,7 +172,7 @@ module Puppet::ModuleTool::Errors
       @module_name = options[:module_name]
       @modules     = options[:installed_modules]
       @action      = options[:action]
-      #TRANSLATORS "module path" refers to a set of directories where modules may be installed
+      # TRANSLATORS "module path" refers to a set of directories where modules may be installed
       super _("Could not %{action} '%{module_name}'; module appears in multiple places in the module path") % { action: @action, module_name: @module_name }
     end
 
@@ -181,10 +181,10 @@ module Puppet::ModuleTool::Errors
       message << _("Could not %{action} module '%{module_name}'") % { action: @action, module_name: @module_name }
       message << _("  Module '%{module_name}' appears multiple places in the module path") % { module_name: @module_name }
       message += @modules.map do |mod|
-        #TRANSLATORS This is repeats as separate lines as a list under "Module '%{module_name}' appears multiple places in the module path"
+        # TRANSLATORS This is repeats as separate lines as a list under "Module '%{module_name}' appears multiple places in the module path"
         _("    '%{module_name}' (%{version}) was found in %{path}") % { module_name: @module_name, version: v(mod.version), path: mod.modulepath }
       end
-      #TRANSLATORS `--modulepath` is command line option and should not be translated
+      # TRANSLATORS `--modulepath` is command line option and should not be translated
       message << _("    Use the `--modulepath` option to limit the search to specific directories")
       message.join("\n")
     end
@@ -203,7 +203,7 @@ module Puppet::ModuleTool::Errors
       message = []
       message << _("Could not %{action} module '%{module_name}' (%{version})") % { action: @action, module_name: @module_name, version: vstring }
       message << _("  Installed module has had changes made locally")
-      #TRANSLATORS `puppet module %{action} --ignore-changes` is a command line and should not be translated
+      # TRANSLATORS `puppet module %{action} --ignore-changes` is a command line and should not be translated
       message << _("    Use `puppet module %{action} --ignore-changes` to %{action} this module anyway") % { action: @action }
       message.join("\n")
     end

data/lib/puppet/module_tool/errors/uninstaller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Puppet::ModuleTool::Errors
 
+module Puppet::ModuleTool::Errors
   class UninstallError < ModuleToolError; end
 
   class NoVersionMatchesError < UninstallError
@@ -43,7 +43,7 @@ module Puppet::ModuleTool::Errors
       message += @required_by.map do |mod|
         _("    '%{module_name}' (%{version}) requires '%{module_dep}' (%{dep_version})") % { module_name: mod['name'], version: v(mod['version']), module_dep: @module_name, dep_version: v(mod['version_requirement']) }
       end
-      #TRANSLATORS `puppet module uninstall --force` is a command line option that should not be translated
+      # TRANSLATORS `puppet module uninstall --force` is a command line option that should not be translated
       message << _("    Use `puppet module uninstall --force` to uninstall this module anyway")
       message.join("\n")
     end

data/lib/puppet/module_tool/errors/upgrader.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-module Puppet::ModuleTool::Errors
 
+module Puppet::ModuleTool::Errors
   class UpgradeError < ModuleToolError
     def initialize(msg)
       @action = :upgrade
@@ -37,7 +37,7 @@ module Puppet::ModuleTool::Errors
           end
         end
       end
-      #TRANSLATORS `puppet module upgrade --force` is a command line option that should not be translated
+      # TRANSLATORS `puppet module upgrade --force` is a command line option that should not be translated
       message << _("    Use `puppet module upgrade --force` to upgrade only this module")
       message.join("\n")
     end
@@ -45,7 +45,7 @@ module Puppet::ModuleTool::Errors
 
   class DowngradingUnsupportedError < UpgradeError
     def initialize(options)
-      @module_name    = options[:module_name]
+      @module_name = options[:module_name]
       @requested_version = options[:requested_version]
       @installed_version = options[:installed_version]
       @conditions        = options[:conditions]

data/lib/puppet/module_tool/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 
 module Puppet::ModuleTool

data/lib/puppet/module_tool/install_directory.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/module_tool/errors'
 
@@ -9,6 +10,7 @@ module Puppet
       include Puppet::ModuleTool::Errors
 
       attr_reader :target
+
       def initialize(target)
         @target = target
       end
@@ -26,7 +28,7 @@ module Puppet
         end
       end
 
-    private
+      private
 
       ERROR_MAPPINGS = {
         Errno::EACCES => PermissionDeniedCreateInstallDirectoryError,
@@ -37,9 +39,9 @@ module Puppet
         return orig_error if not ERROR_MAPPINGS.include?(orig_error.class)
 
         ERROR_MAPPINGS[orig_error.class].new(orig_error,
-          :requested_module  => module_name,
-          :requested_version => version,
-          :directory         => @target.to_s)
+                                             :requested_module => module_name,
+                                             :requested_version => version,
+                                             :directory => @target.to_s)
       end
     end
   end

data/lib/puppet/module_tool/installed_modules.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 
 require_relative '../../puppet/forge'
@@ -23,6 +24,7 @@ module Puppet::ModuleTool
         modules[path].each do |mod|
           @by_name[mod.name] = mod
           next unless mod.has_metadata?
+
           release = ModuleRelease.new(self, mod)
           @modules[release.name] ||= release
         end

data/lib/puppet/module_tool/local_tarball.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'pathname'
 require 'tmpdir'
 
@@ -76,9 +77,11 @@ module Puppet::ModuleTool
     # Obtain a suitable temporary path for unpacking tarballs
     #
     # @return [String] path to temporary unpacking location
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def tmpdir
       @dir ||= Dir.mktmpdir('local-tarball', Puppet::Forge::Cache.base_path)
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     def unpack(file, destination)
       begin

data/lib/puppet/module_tool/metadata.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/network/format_support'
 require 'uri'
@@ -6,7 +7,6 @@ require_relative '../../puppet/util/json'
 require 'set'
 
 module Puppet::ModuleTool
-
   # This class provides a data structure representing a module's metadata.
   # @api private
   class Metadata
@@ -15,15 +15,15 @@ module Puppet::ModuleTool
     attr_accessor :module_name
 
     DEFAULTS = {
-      'name'          => nil,
-      'version'       => nil,
-      'author'        => nil,
-      'summary'       => nil,
-      'license'       => 'Apache-2.0',
-      'source'        => '',
-      'project_page'  => nil,
-      'issues_url'    => nil,
-      'dependencies'  => Set.new.freeze,
+      'name' => nil,
+      'version' => nil,
+      'author' => nil,
+      'summary' => nil,
+      'license' => 'Apache-2.0',
+      'source' => '',
+      'project_page' => nil,
+      'issues_url' => nil,
+      'dependencies' => Set.new.freeze,
       'data_provider' => nil,
     }
 
@@ -40,6 +40,7 @@ module Puppet::ModuleTool
     # Returns a string that uniquely represents this version of this module.
     def release_name
       return nil unless @data['name'] && @data['version']
+
       [ dashed_name, @data['version'] ].join('-')
     end
 
@@ -111,6 +112,7 @@ module Puppet::ModuleTool
     # Expose any metadata keys as callable reader methods.
     def method_missing(name, *args)
       return @data[name.to_s] if @data.key? name.to_s
+
       super
     end
 
@@ -149,7 +151,6 @@ module Puppet::ModuleTool
         data['project_page'] ||= @data['project_page'] || source_uri.to_s
         data['issues_url'] ||= @data['issues_url'] || source_uri.to_s.sub(/\/*$/, '') + '/issues'
       end
-
     rescue URI::Error
       return
     end
@@ -172,15 +173,15 @@ module Puppet::ModuleTool
       modname = :namespace_missing if namespace == ''
 
       err = case modname
-      when nil, '', :namespace_missing
-        _("the field must be a namespaced module name")
-      when /[^a-z0-9_]/i
-        _("the module name contains non-alphanumeric (or underscore) characters")
-      when /^[^a-z]/i
-        _("the module name must begin with a letter")
-      else
-        _("the namespace contains non-alphanumeric characters")
-      end
+            when nil, '', :namespace_missing
+              _("the field must be a namespaced module name")
+            when /[^a-z0-9_]/i
+              _("the module name contains non-alphanumeric (or underscore) characters")
+            when /^[^a-z]/i
+              _("the module name must begin with a letter")
+            else
+              _("the namespace contains non-alphanumeric characters")
+            end
 
       raise ArgumentError, _("Invalid 'name' field in metadata.json: %{err}") % { err: err }
     end