openvox 7.37.1 → 8.19.0

data/lib/puppet/module_tool/checksums.rb

@@ -1,8 +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
@@ -18,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.
@@ -35,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

@@ -1,8 +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
 
@@ -22,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? :==
@@ -33,8 +34,8 @@ module Puppet::ModuleTool
 
     def to_data_hash
       result = { :name => @full_module_name }
-      result[:version_requirement] = @version_requirement if @version_requirement && ! @version_requirement.nil?
-      result[:repository] = @repository.to_s if @repository && ! @repository.nil?
+      result[:version_requirement] = @version_requirement if @version_requirement && !@version_requirement.nil?
+      result[:repository] = @repository.to_s if @repository && !@repository.nil?
       result
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet::ModuleTool::Errors
   class ModuleToolError < Puppet::Error
     def v(version)
@@ -8,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/errors/installer.rb

@@ -1,5 +1,6 @@
-module Puppet::ModuleTool::Errors
+# frozen_string_literal: true
 
+module Puppet::ModuleTool::Errors
   class InstallError < ModuleToolError; end
 
   class AlreadyInstalledError < InstallError
@@ -16,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
@@ -53,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
@@ -70,7 +71,7 @@ module Puppet::ModuleTool::Errors
     def multiline
       message = []
       message << _("Could not install module '%{module_name}' (%{version})") % { module_name: @requested_module, version: @requested_version }
-      message << _("  Permission is denied when trying to create directory '%{directory}'.")  % { directory: @directory }
+      message << _("  Permission is denied when trying to create directory '%{directory}'.") % { directory: @directory }
       message << _('  A potential solution is to check the ownership and permissions of parent directories.')
       message.join("\n")
     end

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

@@ -1,5 +1,6 @@
-module Puppet::ModuleTool::Errors
+# frozen_string_literal: true
 
+module Puppet::ModuleTool::Errors
   class NoVersionsSatisfyError < ModuleToolError
     def initialize(options)
       @requested_name    = options[:requested_name]
@@ -30,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
@@ -89,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")
@@ -105,7 +106,7 @@ module Puppet::ModuleTool::Errors
       @requested_module  = options[:requested_module]
       @requested_version = options[:requested_version]
       @conditions        = options[:conditions]
-      @source            = options[:source][1..-1]
+      @source            = options[:source][1..]
 
       super _("'%{module_name}' (%{version}) requested; Invalid dependency cycle") % { module_name: @requested_module, version: v(@requested_version) }
     end
@@ -113,15 +114,15 @@ module Puppet::ModuleTool::Errors
     def multiline
       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"
+      dependency_list += @source[1..].map do |m|
+        # 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
+      message << dependency_list.map { |s| "    #{s}".join(",\n") }
+      # 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
@@ -157,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
@@ -171,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
 
@@ -180,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
@@ -202,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,5 +1,6 @@
-module Puppet::ModuleTool::Errors
+# frozen_string_literal: true
 
+module Puppet::ModuleTool::Errors
   class UninstallError < ModuleToolError; end
 
   class NoVersionMatchesError < UninstallError
@@ -42,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,5 +1,6 @@
-module Puppet::ModuleTool::Errors
+# frozen_string_literal: true
 
+module Puppet::ModuleTool::Errors
   class UpgradeError < ModuleToolError
     def initialize(msg)
       @action = :upgrade
@@ -36,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
@@ -44,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,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 
 module Puppet::ModuleTool

data/lib/puppet/module_tool/install_directory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/module_tool/errors'
 
@@ -8,6 +10,7 @@ module Puppet
       include Puppet::ModuleTool::Errors
 
       attr_reader :target
+
       def initialize(target)
         @target = target
       end
@@ -25,7 +28,7 @@ module Puppet
         end
       end
 
-    private
+      private
 
       ERROR_MAPPINGS = {
         Errno::EACCES => PermissionDeniedCreateInstallDirectoryError,
@@ -33,12 +36,12 @@ 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,
-          :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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 require_relative '../../puppet/forge'
@@ -22,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
@@ -41,9 +44,9 @@ module Puppet::ModuleTool
 
       if @modules.key? name
         @fetched << name
-        [ @modules[name] ]
+        [@modules[name]]
       else
-        [ ]
+        []
       end
     end
 

data/lib/puppet/module_tool/local_tarball.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'tmpdir'
 
@@ -18,9 +20,9 @@ module Puppet::ModuleTool
 
     def fetch(name)
       if @release.name == name
-        [ @release ]
+        [@release]
       else
-        [ ]
+        []
       end
     end
 
@@ -54,7 +56,7 @@ module Puppet::ModuleTool
           dependencies = mod.dependencies.map do |dep|
             Puppet::ModuleTool.parse_module_dependency(release, dep)[0..1]
           end
-          dependencies = Hash[dependencies]
+          dependencies = dependencies.to_h
         end
 
         super(source, name, version, dependencies || {})
@@ -75,16 +77,16 @@ 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
-        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

data/lib/puppet/module_tool/metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/module_tool'
 require_relative '../../puppet/network/format_support'
 require 'uri'
@@ -5,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
@@ -14,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,
     }
 
@@ -39,7 +40,8 @@ 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('-')
+
+      [dashed_name, @data['version']].join('-')
     end
 
     alias :name :module_name
@@ -56,13 +58,13 @@ module Puppet::ModuleTool
       merge_dependencies(data) if data['dependencies']
 
       @data.merge!(data)
-      return self
+      self
     end
 
     # Validates the name and version_requirement for a dependency, then creates
     # the Dependency and adds it.
     # Returns the Dependency that was added.
-    def add_dependency(name, version_requirement=nil, repository=nil)
+    def add_dependency(name, version_requirement = nil, repository = nil)
       validate_name(name)
       validate_version_range(version_requirement) if version_requirement
 
@@ -100,7 +102,11 @@ module Puppet::ModuleTool
       data = @data.dup.merge('dependencies' => dependencies)
 
       contents = data.keys.map do |k|
-        value = (Puppet::Util::Json.dump(data[k], :pretty => true) rescue data[k].to_json)
+        value = begin
+          Puppet::Util::Json.dump(data[k], :pretty => true)
+        rescue
+          data[k].to_json
+        end
         %Q("#{k}": #{value})
       end
 
@@ -110,6 +116,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
 
@@ -118,7 +125,7 @@ module Puppet::ModuleTool
     # Do basic validation and parsing of the name parameter.
     def process_name(data)
       validate_name(data['name'])
-      author, @module_name = data['name'].split(/[-\/]/, 2)
+      author, @module_name = data['name'].split(%r{[-/]}, 2)
 
       data['author'] ||= author if @data['author'] == DEFAULTS['author']
     end
@@ -136,7 +143,7 @@ module Puppet::ModuleTool
     # GitHub, we can predict sensible defaults for both project_page and
     # issues_url.
     def process_source(data)
-      if data['source'] =~ %r[://]
+      if data['source'] =~ %r{://}
         source_uri = URI.parse(data['source'])
       else
         source_uri = URI.parse("http://#{data['source']}")
@@ -146,11 +153,10 @@ module Puppet::ModuleTool
         source_uri.scheme = 'https'
         source_uri.path.sub!(/\.git$/, '')
         data['project_page'] ||= @data['project_page'] || source_uri.to_s
-        data['issues_url'] ||= @data['issues_url'] || source_uri.to_s.sub(/\/*$/, '') + '/issues'
+        data['issues_url'] ||= @data['issues_url'] || source_uri.to_s.sub(%r{/*$}, '') + '/issues'
       end
-
     rescue URI::Error
-      return
+      nil
     end
 
     # Validates and parses the dependencies.
@@ -165,21 +171,21 @@ module Puppet::ModuleTool
 
     # Validates that the given module name is both namespaced and well-formed.
     def validate_name(name)
-      return if name =~ /\A[a-z0-9]+[-\/][a-z][a-z0-9_]*\Z/i
+      return if name =~ %r{\A[a-z0-9]+[-/][a-z][a-z0-9_]*\Z}i
 
-      namespace, modname = name.split(/[-\/]/, 2)
+      namespace, modname = name.split(%r{[-/]}, 2)
       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