puppet 8.5.1 → 8.7.0

data/lib/puppet/module/task.rb

@@ -49,13 +49,13 @@ class Puppet::Module
       end
     end
 
-    FORBIDDEN_EXTENSIONS = %w{.conf .md}
+    FORBIDDEN_EXTENSIONS = %w[.conf .md]
     MOUNTS = %w[files lib scripts tasks]
 
     def self.is_task_name?(name)
       return true if name =~ /^[a-z][a-z0-9_]*$/
 
-      return false
+      false
     end
 
     def self.is_tasks_file?(path)
@@ -65,12 +65,12 @@ class Puppet::Module
     # Determine whether a file has a legal name for either a task's executable or metadata file.
     def self.is_tasks_filename?(path)
       name_less_extension = File.basename(path, '.*')
-      return false if not is_task_name?(name_less_extension)
+      return false unless is_task_name?(name_less_extension)
 
       FORBIDDEN_EXTENSIONS.each do |ext|
         return false if path.end_with?(ext)
       end
-      return true
+      true
     end
 
     def self.get_file_details(path, mod)
@@ -130,7 +130,7 @@ class Puppet::Module
 
         unless File.exist?(path)
           msg = _("Could not find %{path} on disk" % { path: path })
-          raise InvalidFile.new(msg)
+          raise InvalidFile, msg
         end
 
         last_char = file[-1] == '/'
@@ -226,7 +226,7 @@ class Puppet::Module
 
     # file paths must be relative to the modules task directory
     def initialize(pup_module, task_name, module_executables, metadata_file = nil)
-      if !Puppet::Module::Task.is_task_name?(task_name)
+      unless Puppet::Module::Task.is_task_name?(task_name)
         raise InvalidName, _("Task names must start with a lowercase letter and be composed of only lowercase letters, numbers, and underscores")
       end
 
@@ -264,7 +264,7 @@ class Puppet::Module
     end
 
     def ==(other)
-      self.name == other.name &&
+      name == other.name &&
         self.module == other.module
     end
 
@@ -281,7 +281,7 @@ class Puppet::Module
 
     # Abstracted here so we can add support for subdirectories later
     def self.task_name_from_path(path)
-      return File.basename(path, '.*')
+      File.basename(path, '.*')
     end
     private_class_method :task_name_from_path
   end

data/lib/puppet/module.rb

@@ -46,21 +46,21 @@ class Puppet::Module
     fullpath = File.join(path, name)
     return false unless Puppet::FileSystem.directory?(fullpath)
 
-    return is_module_directory_name?(name)
+    is_module_directory_name?(name)
   end
 
   def self.is_module_directory_name?(name)
     # it must match an installed module name according to forge validator
     return true if name =~ /^[a-z][a-z0-9_]*$/
 
-    return false
+    false
   end
 
   def self.is_module_namespaced_name?(name)
     # it must match the full module name according to forge validator
-    return true if name =~ /^[a-zA-Z0-9]+[-][a-z][a-z0-9_]*$/
+    return true if name =~ /^[a-zA-Z0-9]+-[a-z][a-z0-9_]*$/
 
-    return false
+    false
   end
 
   # @api private
@@ -96,16 +96,14 @@ class Puppet::Module
 
   # @deprecated The puppetversion module metadata field is no longer used.
   def validate_puppet_version
-    return
+    nil
   end
 
   def has_metadata?
-    begin
-      load_metadata
-      @metadata.is_a?(Hash) && !@metadata.empty?
-    rescue Puppet::Module::MissingMetadata
-      false
-    end
+    load_metadata
+    @metadata.is_a?(Hash) && !@metadata.empty?
+  rescue Puppet::Module::MissingMetadata
+    false
   end
 
   FILETYPES.each do |type, location|
@@ -118,7 +116,7 @@ class Puppet::Module
         return false
       end
 
-      return true
+      true
     end
 
     # A method for returning a given file of a given type.
@@ -137,7 +135,7 @@ class Puppet::Module
 
       return nil unless Puppet::FileSystem.exist?(full_path)
 
-      return full_path
+      full_path
     end
 
     # Return the base directory for the given type
@@ -173,9 +171,9 @@ class Puppet::Module
     end
 
     if Puppet::FileSystem.exist?(full_path)
-      return full_path
+      full_path
     else
-      return nil
+      nil
     end
   end
 
@@ -206,9 +204,9 @@ class Puppet::Module
     end
 
     if Puppet::FileSystem.exist?(full_path)
-      return full_path
+      full_path
     else
-      return nil
+      nil
     end
   end
 
@@ -252,11 +250,11 @@ class Puppet::Module
 
     [:source, :author, :version, :license, :dependencies].each do |attr|
       value = data[attr.to_s]
-      raise MissingMetadata, "No #{attr} module metadata provided for #{self.name}" if value.nil?
+      raise MissingMetadata, "No #{attr} module metadata provided for #{name}" if value.nil?
 
       if attr == :dependencies
         unless value.is_a?(Array)
-          raise MissingMetadata, "The value for the key dependencies in the file metadata.json of the module #{self.name} must be an array, not: '#{value}'"
+          raise MissingMetadata, "The value for the key dependencies in the file metadata.json of the module #{name} must be an array, not: '#{value}'"
         end
 
         value.each do |dep|
@@ -338,7 +336,7 @@ class Puppet::Module
   # @return true if the module has a directory for the locale, false
   #         false otherwise
   def has_translations?(locale)
-    return Puppet::FileSystem.exist?(File.join(locale_directory, locale))
+    Puppet::FileSystem.exist?(File.join(locale_directory, locale))
   end
 
   def has_external_facts?
@@ -368,7 +366,7 @@ class Puppet::Module
   end
 
   def required_by
-    environment.module_requirements[self.forge_name] || {}
+    environment.module_requirements[forge_name] || {}
   end
 
   # Identify and mark unmet dependencies.  A dependency will be marked unmet
@@ -415,8 +413,8 @@ class Puppet::Module
         :name => name,
         :version_constraint => version_string.gsub(/^(?=\d)/, "v"),
         :parent => {
-          :name => self.forge_name,
-          :version => self.version.gsub(/^(?=\d)/, "v")
+          :name => forge_name,
+          :version => version.gsub(/^(?=\d)/, "v")
         },
         :mod_details => {
           :installed_version => dep_mod.nil? ? nil : dep_mod.version
@@ -429,32 +427,32 @@ class Puppet::Module
         next
       end
 
-      if version_string
-        begin
-          required_version_semver_range = self.class.parse_range(version_string)
-          actual_version_semver = SemanticPuppet::Version.parse(dep_mod.version)
-        rescue ArgumentError
-          error_details[:reason] = :non_semantic_version
-          unmet_dependencies << error_details
-          next
-        end
+      next unless version_string
 
-        unless required_version_semver_range.include? actual_version_semver
-          error_details[:reason] = :version_mismatch
-          unmet_dependencies << error_details
-          next
-        end
+      begin
+        required_version_semver_range = self.class.parse_range(version_string)
+        actual_version_semver = SemanticPuppet::Version.parse(dep_mod.version)
+      rescue ArgumentError
+        error_details[:reason] = :non_semantic_version
+        unmet_dependencies << error_details
+        next
       end
+
+      next if required_version_semver_range.include? actual_version_semver
+
+      error_details[:reason] = :version_mismatch
+      unmet_dependencies << error_details
+      next
     end
 
     unmet_dependencies
   end
 
   def ==(other)
-    self.name == other.name &&
-      self.version == other.version &&
-      self.path == other.path &&
-      self.environment == other.environment
+    name == other.name &&
+      version == other.version &&
+      path == other.path &&
+      environment == other.environment
   end
 
   private

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

@@ -28,7 +28,11 @@ module Puppet::ModuleTool
         when Net::HTTPOK, Net::HTTPCreated
           Puppet.notice success
         else
-          errors = Puppet::Util::Json.load(response.body)['error'] rescue "HTTP #{response.code}, #{response.body}"
+          errors = begin
+            Puppet::Util::Json.load(response.body)['error']
+          rescue
+            "HTTP #{response.code}, #{response.body}"
+          end
           Puppet.warning "#{failure} (#{errors})"
         end
       end
@@ -50,11 +54,9 @@ module Puppet::ModuleTool
 
         if File.file?(metadata_path)
           File.open(metadata_path) do |f|
-            begin
-              @metadata.update(Puppet::Util::Json.load(f))
-            rescue Puppet::Util::Json::ParseError => ex
-              raise ArgumentError, _("Could not parse JSON %{metadata_path}") % { metadata_path: metadata_path }, ex.backtrace
-            end
+            @metadata.update(Puppet::Util::Json.load(f))
+          rescue Puppet::Util::Json::ParseError => ex
+            raise ArgumentError, _("Could not parse JSON %{metadata_path}") % { metadata_path: metadata_path }, ex.backtrace
           end
         end
 
@@ -62,7 +64,7 @@ module Puppet::ModuleTool
           Puppet.warning _("A Modulefile was found in the root directory of the module. This file will be ignored and can safely be removed.")
         end
 
-        return @metadata
+        @metadata
       end
 
       def load_metadata!
@@ -82,7 +84,7 @@ module Puppet::ModuleTool
           raise ArgumentError, _("Invalid version format: %{version} (Semantic Versions are acceptable: http://semver.org)") % { version: version }
         end
 
-        return {
+        {
           :module_name => module_name,
           :author => author,
           :dir_name => shortname,

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

@@ -72,7 +72,11 @@ module Puppet::ModuleTool
                 results[:version] = installed_module.version
                 return results
               else
-                changes = Checksummer.run(installed_modules[name].mod.path) rescue []
+                changes = begin
+                  Checksummer.run(installed_modules[name].mod.path)
+                rescue
+                  []
+                end
                 raise AlreadyInstalledError,
                       :module_name => name,
                       :installed_version => installed_modules[name].version,
@@ -107,22 +111,22 @@ module Puppet::ModuleTool
 
             version = release.version
 
-            unless forced?
-              # Since upgrading already installed modules can be troublesome,
-              # we'll place constraints on the graph for each installed module,
-              # locking it to upgrades within the same major version.
-              installed_range = ">=#{version} #{version.major}.x"
-              graph.add_constraint('installed', mod, installed_range) do |node|
-                Puppet::Module.parse_range(installed_range).include? node.version
-              end
+            next if forced?
+
+            # Since upgrading already installed modules can be troublesome,
+            # we'll place constraints on the graph for each installed module,
+            # locking it to upgrades within the same major version.
+            installed_range = ">=#{version} #{version.major}.x"
+            graph.add_constraint('installed', mod, installed_range) do |node|
+              Puppet::Module.parse_range(installed_range).include? node.version
+            end
 
-              release.mod.dependencies.each do |dep|
-                dep_name = dep['name'].tr('/', '-')
+            release.mod.dependencies.each do |dep|
+              dep_name = dep['name'].tr('/', '-')
 
-                range = dep['version_requirement']
-                graph.add_constraint("#{mod} constraint", dep_name, range) do |node|
-                  Puppet::Module.parse_range(range).include? node.version
-                end
+              range = dep['version_requirement']
+              graph.add_constraint("#{mod} constraint", dep_name, range) do |node|
+                Puppet::Module.parse_range(range).include? node.version
               end
             end
           end
@@ -194,28 +198,27 @@ module Puppet::ModuleTool
             # Check for module name conflicts.
             releases.each do |rel|
               installed_module = installed_modules_source.by_name[rel.name.split('-').last]
-              if installed_module
-                next if installed_module.has_metadata? && installed_module.forge_name.tr('/', '-') == rel.name
-
-                if rel.name != name
-                  dependency = {
-                    :name => rel.name,
-                    :version => rel.version
-                  }
-                end
-
-                raise InstallConflictError,
-                      :requested_module => name,
-                      :requested_version => options[:version] || 'latest',
-                      :dependency => dependency,
-                      :directory => installed_module.path,
-                      :metadata => installed_module.metadata
+              next unless installed_module
+              next if installed_module.has_metadata? && installed_module.forge_name.tr('/', '-') == rel.name
+
+              if rel.name != name
+                dependency = {
+                  :name => rel.name,
+                  :version => rel.version
+                }
               end
+
+              raise InstallConflictError,
+                    :requested_module => name,
+                    :requested_version => options[:version] || 'latest',
+                    :dependency => dependency,
+                    :directory => installed_module.path,
+                    :metadata => installed_module.metadata
             end
           end
 
           Puppet.info _("Preparing to install ...")
-          releases.each { |release| release.prepare }
+          releases.each(&:prepare)
 
           Puppet.notice _('Installing -- do not interrupt ...')
           releases.each do |release|
@@ -287,7 +290,7 @@ module Puppet::ModuleTool
 
         previous = installed_modules[release.name]
         previous = previous.version if previous
-        return {
+        {
           :release => release,
           :name => release.name,
           :path => release.install_dir.to_s,
@@ -368,24 +371,24 @@ module Puppet::ModuleTool
               metadata = nil
             end
 
-            if release[:module] =~ /-#{mod.name}$/
-              dependency_info = {
-                :name => release[:module],
-                :version => release[:version][:vstring]
-              }
-              dependency = is_dependency ? dependency_info : nil
-              all_versions = @versions["#{@module_name}"].sort_by { |h| h[:semver] }
-              versions = all_versions.select { |x| x[:semver].special == '' }
-              versions = all_versions if versions.empty?
-              latest_version = versions.last[:vstring]
+            next unless release[:module] =~ /-#{mod.name}$/
 
-              raise InstallConflictError,
-                    :requested_module => @module_name,
-                    :requested_version => @version || "latest: v#{latest_version}",
-                    :dependency => dependency,
-                    :directory => mod.path,
-                    :metadata => metadata
-            end
+            dependency_info = {
+              :name => release[:module],
+              :version => release[:version][:vstring]
+            }
+            dependency = is_dependency ? dependency_info : nil
+            all_versions = @versions[@module_name.to_s].sort_by { |h| h[:semver] }
+            versions = all_versions.select { |x| x[:semver].special == '' }
+            versions = all_versions if versions.empty?
+            latest_version = versions.last[:vstring]
+
+            raise InstallConflictError,
+                  :requested_module => @module_name,
+                  :requested_version => @version || "latest: v#{latest_version}",
+                  :dependency => dependency,
+                  :directory => mod.path,
+                  :metadata => metadata
           end
 
           deps = release[:dependencies]

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

@@ -9,7 +9,7 @@ module Puppet::ModuleTool
   module Applications
     class Unpacker < Application
       def self.unpack(filename, target)
-        app = self.new(filename, :target_dir => target)
+        app = new(filename, :target_dir => target)
         app.unpack
         app.sanity_check
         app.move_into(target)
@@ -38,7 +38,7 @@ module Puppet::ModuleTool
 
         # Return the Pathname object representing the directory where the
         # module release archive was unpacked the to.
-        return module_dir
+        module_dir
       end
 
       # @api private
@@ -54,11 +54,9 @@ module Puppet::ModuleTool
 
       # @api private
       def unpack
-        begin
-          Puppet::ModuleTool::Tar.instance.unpack(@filename.to_s, tmpdir, [@module_path.stat.uid, @module_path.stat.gid].join(':'))
-        rescue Puppet::ExecutionFailure => e
-          raise RuntimeError, _("Could not extract contents of module archive: %{message}") % { message: e.message }
-        end
+        Puppet::ModuleTool::Tar.instance.unpack(@filename.to_s, tmpdir, [@module_path.stat.uid, @module_path.stat.gid].join(':'))
+      rescue Puppet::ExecutionFailure => e
+        raise RuntimeError, _("Could not extract contents of module archive: %{message}") % { message: e.message }
       end
 
       # @api private
@@ -66,7 +64,7 @@ module Puppet::ModuleTool
         return @root_dir if @root_dir
 
         # Grab the first directory containing a metadata.json file
-        metadata_file = Dir["#{tmpdir}/**/metadata.json"].sort_by(&:length)[0]
+        metadata_file = Dir["#{tmpdir}/**/metadata.json"].min_by(&:length)
 
         if metadata_file
           @root_dir = Pathname.new(metadata_file).dirname

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

@@ -76,7 +76,11 @@ module Puppet::ModuleTool
           vstring = mod.version ? "v#{mod.version}" : '???'
           Puppet.notice _("Found '%{name}' (%{version}) in %{dir} ...") % { name: name, version: colorize(:cyan, vstring), dir: dir }
           unless @ignore_changes
-            changes = Checksummer.run(mod.path) rescue []
+            changes = begin
+              Checksummer.run(mod.path)
+            rescue
+              []
+            end
             if mod.has_metadata? && !changes.empty?
               raise LocalChangesError,
                     :action => :upgrade,
@@ -117,22 +121,22 @@ module Puppet::ModuleTool
 
             version = release.version
 
-            unless forced?
-              # Since upgrading already installed modules can be troublesome,
-              # we'll place constraints on the graph for each installed
-              # module, locking it to upgrades within the same major version.
-              installed_range = ">=#{version} #{version.major}.x"
-              graph.add_constraint('installed', installed_module, installed_range) do |node|
-                Puppet::Module.parse_range(installed_range).include? node.version
-              end
+            next if forced?
+
+            # Since upgrading already installed modules can be troublesome,
+            # we'll place constraints on the graph for each installed
+            # module, locking it to upgrades within the same major version.
+            installed_range = ">=#{version} #{version.major}.x"
+            graph.add_constraint('installed', installed_module, installed_range) do |node|
+              Puppet::Module.parse_range(installed_range).include? node.version
+            end
 
-              release.mod.dependencies.each do |dep|
-                dep_name = dep['name'].tr('/', '-')
+            release.mod.dependencies.each do |dep|
+              dep_name = dep['name'].tr('/', '-')
 
-                range = dep['version_requirement']
-                graph.add_constraint("#{installed_module} constraint", dep_name, range) do |node|
-                  Puppet::Module.parse_range(range).include? node.version
-                end
+              range = dep['version_requirement']
+              graph.add_constraint("#{installed_module} constraint", dep_name, range) do |node|
+                Puppet::Module.parse_range(range).include? node.version
               end
             end
           end
@@ -146,30 +150,29 @@ module Puppet::ModuleTool
 
           releases.each do |rel|
             mod = installed_modules_source.by_name[rel.name.split('-').last]
-            if mod
-              next if mod.has_metadata? && mod.forge_name.tr('/', '-') == rel.name
-
-              if rel.name != name
-                dependency = {
-                  :name => rel.name,
-                  :version => rel.version
-                }
-              end
-
-              raise InstallConflictError,
-                    :requested_module => name,
-                    :requested_version => options[:version] || 'latest',
-                    :dependency => dependency,
-                    :directory => mod.path,
-                    :metadata => mod.metadata
+            next unless mod
+            next if mod.has_metadata? && mod.forge_name.tr('/', '-') == rel.name
+
+            if rel.name != name
+              dependency = {
+                :name => rel.name,
+                :version => rel.version
+              }
             end
+
+            raise InstallConflictError,
+                  :requested_module => name,
+                  :requested_version => options[:version] || 'latest',
+                  :dependency => dependency,
+                  :directory => mod.path,
+                  :metadata => mod.metadata
           end
 
           child = releases.find { |x| x.name == name }
 
           unless forced?
             if child.version == results[:installed_version]
-              versions = graph.dependencies[name].map { |r| r.version }
+              versions = graph.dependencies[name].map(&:version)
               newer_versions = versions.select { |v| v > results[:installed_version] }
 
               raise VersionAlreadyInstalledError,
@@ -187,7 +190,7 @@ module Puppet::ModuleTool
           end
 
           Puppet.info _("Preparing to upgrade ...")
-          releases.each { |release| release.prepare }
+          releases.each(&:prepare)
 
           Puppet.notice _('Upgrading -- do not interrupt ...')
           releases.each do |release|
@@ -268,7 +271,7 @@ module Puppet::ModuleTool
           end
         end
 
-        return {
+        {
           :release => release,
           :name => release.name,
           :path => release.install_dir,

data/lib/puppet/module_tool/checksums.rb

@@ -19,7 +19,7 @@ module Puppet::ModuleTool
 
     # Return checksum for the +Pathname+.
     def checksum(pathname)
-      return Digest::MD5.hexdigest(Puppet::FileSystem.binread(pathname))
+      Digest::MD5.hexdigest(Puppet::FileSystem.binread(pathname))
     end
 
     # Return checksums for object's +Pathname+, generate if it's needed.
@@ -36,7 +36,7 @@ module Puppet::ModuleTool
           end
         end
       end
-      return @data
+      @data
     end
 
     alias :to_data_hash :data

data/lib/puppet/module_tool/dependency.rb

@@ -23,7 +23,7 @@ module Puppet::ModuleTool
     # We override Object's ==, eql, and hash so we can more easily find identical
     # dependencies.
     def ==(o)
-      self.hash == o.hash
+      hash == o.hash
     end
 
     alias :eql? :==

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

@@ -10,7 +10,7 @@ module Puppet::ModuleTool::Errors
       if @action == :upgrade
         "#{v(@installed_version)} -> #{v(@requested_version)}"
       else
-        "#{v(@installed_version || @requested_version)}"
+        v(@installed_version || @requested_version).to_s
       end
     end
   end

data/lib/puppet/module_tool/install_directory.rb

@@ -36,7 +36,7 @@ module Puppet
       }
 
       def converted_to_friendly_error(module_name, version, orig_error)
-        return orig_error if not ERROR_MAPPINGS.include?(orig_error.class)
+        return orig_error unless ERROR_MAPPINGS.include?(orig_error.class)
 
         ERROR_MAPPINGS[orig_error.class].new(orig_error,
                                              :requested_module => module_name,

data/lib/puppet/module_tool/local_tarball.rb

@@ -84,11 +84,9 @@ module Puppet::ModuleTool
     # rubocop:enable Naming/MemoizedInstanceVariableName
 
     def unpack(file, destination)
-      begin
-        Puppet::ModuleTool::Applications::Unpacker.unpack(file, destination)
-      rescue Puppet::ExecutionFailure => e
-        raise RuntimeError, _("Could not extract contents of module archive: %{message}") % { message: e.message }
-      end
+      Puppet::ModuleTool::Applications::Unpacker.unpack(file, destination)
+    rescue Puppet::ExecutionFailure => e
+      raise RuntimeError, _("Could not extract contents of module archive: %{message}") % { message: e.message }
     end
   end
 end