rubygems-update 2.6.1 → 3.5.0

data/lib/rubygems/deprecate.rb

@@ -1,33 +1,80 @@
 # frozen_string_literal: true
+
 ##
-# Provides a single method +deprecate+ to be used to declare when
-# something is going away.
+# Provides 3 methods for declaring when something is going away.
+#
+# +deprecate(name, repl, year, month)+:
+#     Indicate something may be removed on/after a certain date.
+#
+# +rubygems_deprecate(name, replacement=:none)+:
+#     Indicate something will be removed in the next major RubyGems version,
+#     and (optionally) a replacement for it.
+#
+# +rubygems_deprecate_command+:
+#     Indicate a RubyGems command (in +lib/rubygems/commands/*.rb+) will be
+#     removed in the next RubyGems version.
+#
+# Also provides +skip_during+ for temporarily turning off deprecation warnings.
+# This is intended to be used in the test suite, so deprecation warnings
+# don't cause test failures if you need to make sure stderr is otherwise empty.
+#
+#
+# Example usage of +deprecate+ and +rubygems_deprecate+:
 #
 #     class Legacy
-#       def self.klass_method
+#       def self.some_class_method
+#         # ...
+#       end
+#
+#       def some_instance_method
 #         # ...
 #       end
 #
-#       def instance_method
+#       def some_old_method
 #         # ...
 #       end
 #
 #       extend Gem::Deprecate
-#       deprecate :instance_method, "X.z", 2011, 4
+#       deprecate :some_instance_method, "X.z", 2011, 4
+#       rubygems_deprecate :some_old_method, "Modern#some_new_method"
 #
 #       class << self
 #         extend Gem::Deprecate
-#         deprecate :klass_method, :none, 2011, 4
+#         deprecate :some_class_method, :none, 2011, 4
+#       end
+#     end
+#
+#
+# Example usage of +rubygems_deprecate_command+:
+#
+#     class Gem::Commands::QueryCommand < Gem::Command
+#       extend Gem::Deprecate
+#       rubygems_deprecate_command
+#
+#       # ...
+#     end
+#
+#
+# Example usage of +skip_during+:
+#
+#     class TestSomething < Gem::Testcase
+#       def test_some_thing_with_deprecations
+#         Gem::Deprecate.skip_during do
+#           actual_stdout, actual_stderr = capture_output do
+#             Gem.something_deprecated
+#           end
+#           assert_empty actual_stdout
+#           assert_equal(expected, actual_stderr)
+#         end
 #       end
 #     end
 
 module Gem::Deprecate
-
   def self.skip # :nodoc:
     @skip ||= false
   end
 
-  def self.skip= v # :nodoc:
+  def self.skip=(v) # :nodoc:
     @skip = v
   end
 
@@ -35,37 +82,86 @@ module Gem::Deprecate
   # Temporarily turn off warnings. Intended for tests only.
 
   def skip_during
-    Gem::Deprecate.skip, original = true, Gem::Deprecate.skip
+    original = Gem::Deprecate.skip
+    Gem::Deprecate.skip = true
     yield
   ensure
     Gem::Deprecate.skip = original
   end
 
+  def self.next_rubygems_major_version # :nodoc:
+    Gem::Version.new(Gem.rubygems_version.segments.first).bump
+  end
+
   ##
   # Simple deprecation method that deprecates +name+ by wrapping it up
   # in a dummy method. It warns on each call to the dummy method
   # telling the user of +repl+ (unless +repl+ is :none) and the
   # year/month that it is planned to go away.
 
-  def deprecate name, repl, year, month
-    class_eval {
+  def deprecate(name, repl, year, month)
+    class_eval do
       old = "_deprecated_#{name}"
       alias_method old, name
       define_method name do |*args, &block|
-        klass = self.kind_of? Module
+        klass = is_a? Module
         target = klass ? "#{self}." : "#{self.class}#"
-        msg = [ "NOTE: #{target}#{name} is deprecated",
+        msg = [
+          "NOTE: #{target}#{name} is deprecated",
           repl == :none ? " with no replacement" : "; use #{repl} instead",
-          ". It will be removed on or after %4d-%02d-01." % [year, month],
+          format(". It will be removed on or after %4d-%02d.", year, month),
           "\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}",
         ]
         warn "#{msg.join}." unless Gem::Deprecate.skip
         send old, *args, &block
       end
-    }
+      ruby2_keywords name if respond_to?(:ruby2_keywords, true)
+    end
   end
 
-  module_function :deprecate, :skip_during
+  ##
+  # Simple deprecation method that deprecates +name+ by wrapping it up
+  # in a dummy method. It warns on each call to the dummy method
+  # telling the user of +repl+ (unless +repl+ is :none) and the
+  # Rubygems version that it is planned to go away.
 
-end
+  def rubygems_deprecate(name, replacement=:none)
+    class_eval do
+      old = "_deprecated_#{name}"
+      alias_method old, name
+      define_method name do |*args, &block|
+        klass = is_a? Module
+        target = klass ? "#{self}." : "#{self.class}#"
+        msg = [
+          "NOTE: #{target}#{name} is deprecated",
+          replacement == :none ? " with no replacement" : "; use #{replacement} instead",
+          ". It will be removed in Rubygems #{Gem::Deprecate.next_rubygems_major_version}",
+          "\n#{target}#{name} called from #{Gem.location_of_caller.join(":")}",
+        ]
+        warn "#{msg.join}." unless Gem::Deprecate.skip
+        send old, *args, &block
+      end
+      ruby2_keywords name if respond_to?(:ruby2_keywords, true)
+    end
+  end
 
+  # Deprecation method to deprecate Rubygems commands
+  def rubygems_deprecate_command(version = Gem::Deprecate.next_rubygems_major_version)
+    class_eval do
+      define_method "deprecated?" do
+        true
+      end
+
+      define_method "deprecation_warning" do
+        msg = [
+          "#{command} command is deprecated",
+          ". It will be removed in Rubygems #{version}.\n",
+        ]
+
+        alert_warning msg.join.to_s unless Gem::Deprecate.skip
+      end
+    end
+  end
+
+  module_function :rubygems_deprecate, :rubygems_deprecate_command, :skip_during
+end

data/lib/rubygems/doctor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'rubygems'
-require 'rubygems/user_interaction'
+
+require_relative "../rubygems"
+require_relative "user_interaction"
 
 ##
 # Cleans up after a partially-failed uninstall or for an invalid
@@ -12,7 +13,6 @@ require 'rubygems/user_interaction'
 # removing the bogus specification.
 
 class Gem::Doctor
-
   include Gem::UserInteraction
 
   ##
@@ -20,19 +20,20 @@ class Gem::Doctor
   # subdirectory.
 
   REPOSITORY_EXTENSION_MAP = [ # :nodoc:
-    ['specifications', '.gemspec'],
-    ['build_info',     '.info'],
-    ['cache',          '.gem'],
-    ['doc',            ''],
-    ['extensions',     ''],
-    ['gems',           ''],
-  ]
+    ["specifications", ".gemspec"],
+    ["build_info",     ".info"],
+    ["cache",          ".gem"],
+    ["doc",            ""],
+    ["extensions",     ""],
+    ["gems",           ""],
+    ["plugins",        ""],
+  ].freeze
 
   missing =
     Gem::REPOSITORY_SUBDIRECTORIES.sort -
-      REPOSITORY_EXTENSION_MAP.map { |(k,_)| k }.sort
+    REPOSITORY_EXTENSION_MAP.map {|(k,_)| k }.sort
 
-  raise "Update REPOSITORY_EXTENSION_MAP, missing: #{missing.join ', '}" unless
+  raise "Update REPOSITORY_EXTENSION_MAP, missing: #{missing.join ", "}" unless
     missing.empty?
 
   ##
@@ -41,7 +42,7 @@ class Gem::Doctor
   #
   # If +dry_run+ is true no files or directories will be removed.
 
-  def initialize gem_repository, dry_run = false
+  def initialize(gem_repository, dry_run = false)
     @gem_repository = gem_repository
     @dry_run        = dry_run
 
@@ -52,14 +53,14 @@ class Gem::Doctor
   # Specs installed in this gem repository
 
   def installed_specs # :nodoc:
-    @installed_specs ||= Gem::Specification.map { |s| s.full_name }
+    @installed_specs ||= Gem::Specification.map(&:full_name)
   end
 
   ##
   # Are we doctoring a gem repository?
 
   def gem_repository?
-    not installed_specs.empty?
+    !installed_specs.empty?
   end
 
   ##
@@ -73,9 +74,9 @@ class Gem::Doctor
 
     Gem.use_paths @gem_repository.to_s
 
-    unless gem_repository? then
-      say 'This directory does not appear to be a RubyGems repository, ' +
-          'skipping'
+    unless gem_repository?
+      say "This directory does not appear to be a RubyGems repository, " \
+          "skipping"
       say
       return
     end
@@ -99,34 +100,33 @@ class Gem::Doctor
   ##
   # Removes files in +sub_directory+ with +extension+
 
-  def doctor_child sub_directory, extension # :nodoc:
+  def doctor_child(sub_directory, extension) # :nodoc:
     directory = File.join(@gem_repository, sub_directory)
 
     Dir.entries(directory).sort.each do |ent|
-      next if ent == "." || ent == ".."
+      next if [".", ".."].include?(ent)
 
       child = File.join(directory, ent)
       next unless File.exist?(child)
 
       basename = File.basename(child, extension)
       next if installed_specs.include? basename
-      next if /^rubygems-\d/ =~ basename
-      next if 'specifications' == sub_directory and 'default' == basename
+      next if /^rubygems-\d/.match?(basename)
+      next if sub_directory == "specifications" && basename == "default"
+      next if sub_directory == "plugins" && Gem.plugin_suffix_regexp =~ (basename)
 
-      type = File.directory?(child) ? 'directory' : 'file'
+      type = File.directory?(child) ? "directory" : "file"
 
-      action = if @dry_run then
-                 'Extra'
-               else
-                 FileUtils.rm_r(child)
-                 'Removed'
-               end
+      action = if @dry_run
+        "Extra"
+      else
+        FileUtils.rm_r(child)
+        "Removed"
+      end
 
       say "#{action} #{type} #{sub_directory}/#{File.basename(child)}"
     end
   rescue Errno::ENOENT
     # ignore
   end
-
 end
-

data/lib/rubygems/errors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #--
 # This file contains all the various exceptions and other errors that are used
 # inside of RubyGems.
@@ -20,10 +21,53 @@ module Gem
     attr_accessor :requirement
   end
 
+  ##
+  # Raised when trying to activate a gem, and that gem does not exist on the
+  # system.  Instead of rescuing from this class, make sure to rescue from the
+  # superclass Gem::LoadError to catch all types of load errors.
+  class MissingSpecError < Gem::LoadError
+    def initialize(name, requirement, extra_message=nil)
+      @name        = name
+      @requirement = requirement
+      @extra_message = extra_message
+    end
+
+    def message # :nodoc:
+      build_message +
+        "Checked in 'GEM_PATH=#{Gem.path.join(File::PATH_SEPARATOR)}' #{@extra_message}, execute `gem env` for more information"
+    end
+
+    private
+
+    def build_message
+      total = Gem::Specification.stubs.size
+      "Could not find '#{name}' (#{requirement}) among #{total} total gem(s)\n"
+    end
+  end
+
+  ##
+  # Raised when trying to activate a gem, and the gem exists on the system, but
+  # not the requested version. Instead of rescuing from this class, make sure to
+  # rescue from the superclass Gem::LoadError to catch all types of load errors.
+  class MissingSpecVersionError < MissingSpecError
+    attr_reader :specs
+
+    def initialize(name, requirement, specs)
+      super(name, requirement)
+      @specs = specs
+    end
+
+    private
+
+    def build_message
+      names = specs.map(&:full_name)
+      "Could not find '#{name}' (#{requirement}) - did find: [#{names.join ","}]\n"
+    end
+  end
+
   # Raised when there are conflicting gem specs loaded
 
   class ConflictError < LoadError
-
     ##
     # A Hash mapping conflicting specifications to the dependencies that
     # caused the conflict
@@ -35,14 +79,14 @@ module Gem
 
     attr_reader :target
 
-    def initialize target, conflicts
+    def initialize(target, conflicts)
       @target    = target
       @conflicts = conflicts
       @name      = target.name
 
-      reason = conflicts.map { |act, dependencies|
+      reason = conflicts.map do |act, dependencies|
         "#{act.full_name} conflicts with #{dependencies.join(", ")}"
-      }.join ", "
+      end.join ", "
 
       # TODO: improve message by saying who activated `con`
 
@@ -59,7 +103,6 @@ module Gem
   # in figuring out why a gem couldn't be installed.
   #
   class PlatformMismatch < ErrorReason
-
     ##
     # the name of the gem
     attr_reader :name
@@ -91,11 +134,7 @@ module Gem
     ##
     # A wordy description of the error.
     def wordy
-      "Found %s (%s), but was for platform%s %s" %
-        [@name,
-         @version,
-         @platforms.size == 1 ? '' : 's',
-         @platforms.join(' ,')]
+      format("Found %s (%s), but was for platform%s %s", @name, @version, @platforms.size == 1 ? "" : "s", @platforms.join(" ,"))
     end
   end
 
@@ -104,7 +143,6 @@ module Gem
   # data from a source
 
   class SourceFetchProblem < ErrorReason
-
     ##
     # Creates a new SourceFetchProblem for the given +source+ and +error+.
 
@@ -127,12 +165,12 @@ module Gem
     # An English description of the error.
 
     def wordy
-      "Unable to download data from #{@source.uri} - #{@error.message}"
+      "Unable to download data from #{Gem::Uri.redact(@source.uri)} - #{@error.message}"
     end
 
     ##
     # The "exception" alias allows you to call raise on a SourceFetchProblem.
 
-    alias exception error
+    alias_method :exception, :error
   end
 end

data/lib/rubygems/exceptions.rb

@@ -1,23 +1,42 @@
 # frozen_string_literal: true
-# TODO: the documentation in here is terrible.
-#
-# Each exception needs a brief description and the scenarios where it is
-# likely to be raised
+
+require_relative "deprecate"
+require_relative "unknown_command_spell_checker"
 
 ##
 # Base exception class for RubyGems.  All exception raised by RubyGems are a
 # subclass of this one.
-class Gem::Exception < RuntimeError
+class Gem::Exception < RuntimeError; end
 
-  ##
-  #--
-  # TODO: remove in RubyGems 3, nobody sets this
+class Gem::CommandLineError < Gem::Exception; end
 
-  attr_accessor :source_exception # :nodoc:
+class Gem::UnknownCommandError < Gem::Exception
+  attr_reader :unknown_command
 
-end
+  def initialize(unknown_command)
+    self.class.attach_correctable
 
-class Gem::CommandLineError < Gem::Exception; end
+    @unknown_command = unknown_command
+    super("Unknown command #{unknown_command}")
+  end
+
+  def self.attach_correctable
+    return if defined?(@attached)
+
+    if defined?(DidYouMean::SPELL_CHECKERS) && defined?(DidYouMean::Correctable)
+      if DidYouMean.respond_to?(:correct_error)
+        DidYouMean.correct_error(Gem::UnknownCommandError, Gem::UnknownCommandSpellChecker)
+      else
+        DidYouMean::SPELL_CHECKERS["Gem::UnknownCommandError"] =
+          Gem::UnknownCommandSpellChecker
+
+        prepend DidYouMean::Correctable
+      end
+    end
+
+    @attached = true
+  end
+end
 
 class Gem::DependencyError < Gem::Exception; end
 
@@ -29,10 +48,9 @@ class Gem::DependencyRemovalException < Gem::Exception; end
 # and #conflicting_dependencies
 
 class Gem::DependencyResolutionError < Gem::DependencyError
-
   attr_reader :conflict
 
-  def initialize conflict
+  def initialize(conflict)
     @conflict = conflict
     a, b = conflicting_dependencies
 
@@ -42,7 +60,6 @@ class Gem::DependencyResolutionError < Gem::DependencyError
   def conflicting_dependencies
     @conflict.conflicting_dependencies
   end
-
 end
 
 ##
@@ -52,6 +69,13 @@ class Gem::GemNotInHomeException < Gem::Exception
   attr_accessor :spec
 end
 
+###
+# Raised when removing a gem with the uninstall command fails
+
+class Gem::UninstallError < Gem::Exception
+  attr_accessor :spec
+end
+
 class Gem::DocumentError < Gem::Exception; end
 
 ##
@@ -63,15 +87,13 @@ class Gem::EndOfYAMLException < Gem::Exception; end
 # operating on the given directory.
 
 class Gem::FilePermissionError < Gem::Exception
-
   attr_reader :directory
 
-  def initialize directory
+  def initialize(directory)
     @directory = directory
 
     super "You don't have write permissions for the #{directory} directory."
   end
-
 end
 
 ##
@@ -86,7 +108,6 @@ class Gem::GemNotFoundException < Gem::Exception; end
 # Raised by the DependencyInstaller when a specific gem cannot be found
 
 class Gem::SpecificGemNotFoundException < Gem::GemNotFoundException
-
   ##
   # Creates a new SpecificGemNotFoundException for a gem with the given +name+
   # and +version+.  Any +errors+ encountered when attempting to find the gem
@@ -114,7 +135,6 @@ class Gem::SpecificGemNotFoundException < Gem::GemNotFoundException
   # Errors encountered attempting to find the gem.
 
   attr_reader :errors
-
 end
 
 ##
@@ -122,11 +142,10 @@ end
 # inability to find a valid possible spec for a request.
 
 class Gem::ImpossibleDependenciesError < Gem::Exception
-
   attr_reader :conflicts
   attr_reader :request
 
-  def initialize request, conflicts
+  def initialize(request, conflicts)
     @request   = request
     @conflicts = conflicts
 
@@ -135,7 +154,7 @@ class Gem::ImpossibleDependenciesError < Gem::Exception
 
   def build_message # :nodoc:
     requester  = @request.requester
-    requester  = requester ? requester.spec.full_name : 'The user'
+    requester  = requester ? requester.spec.full_name : "The user"
     dependency = @request.dependency
 
     message = "#{requester} requires #{dependency} but it conflicted:\n".dup
@@ -150,11 +169,17 @@ class Gem::ImpossibleDependenciesError < Gem::Exception
   def dependency
     @request.dependency
   end
-
 end
 
 class Gem::InstallError < Gem::Exception; end
 
+class Gem::RuntimeRequirementNotMetError < Gem::InstallError
+  attr_accessor :suggestion
+  def message
+    [suggestion, super].compact.join("\n\t")
+  end
+end
+
 ##
 # Potentially raised when a specification is validated.
 class Gem::InvalidSpecificationException < Gem::Exception; end
@@ -189,26 +214,32 @@ class Gem::RubyVersionMismatch < Gem::Exception; end
 
 class Gem::VerificationError < Gem::Exception; end
 
+##
+# Raised by Gem::WebauthnListener when an error occurs during security
+# device verification.
+
+class Gem::WebauthnVerificationError < Gem::Exception
+  def initialize(message)
+    super "Security device verification failed: #{message}"
+  end
+end
+
 ##
 # Raised to indicate that a system exit should occur with the specified
 # exit_code
 
 class Gem::SystemExitException < SystemExit
-
   ##
   # The exit code for the process
 
-  attr_accessor :exit_code
+  alias_method :exit_code, :status
 
   ##
   # Creates a new SystemExitException with the given +exit_code+
 
   def initialize(exit_code)
-    @exit_code = exit_code
-
-    super "Exiting RubyGems with exit_code #{exit_code}"
+    super exit_code, "Exiting RubyGems with exit_code #{exit_code}"
   end
-
 end
 
 ##
@@ -216,7 +247,6 @@ end
 # there is no spec.
 
 class Gem::UnsatisfiableDependencyError < Gem::DependencyError
-
   ##
   # The unsatisfiable dependency.  This is a
   # Gem::Resolver::DependencyRequest, not a Gem::Dependency
@@ -232,10 +262,10 @@ class Gem::UnsatisfiableDependencyError < Gem::DependencyError
   # Creates a new UnsatisfiableDependencyError for the unsatisfiable
   # Gem::Resolver::DependencyRequest +dep+
 
-  def initialize dep, platform_mismatch=nil
-    if platform_mismatch and !platform_mismatch.empty?
-      plats = platform_mismatch.map { |x| x.platform.to_s }.sort.uniq
-      super "Unable to resolve dependency: No match for '#{dep}' on this platform. Found: #{plats.join(', ')}"
+  def initialize(dep, platform_mismatch=nil)
+    if platform_mismatch && !platform_mismatch.empty?
+      plats = platform_mismatch.map {|x| x.platform.to_s }.sort.uniq
+      super "Unable to resolve dependency: No match for '#{dep}' on this platform. Found: #{plats.join(", ")}"
     else
       if dep.explicit?
         super "Unable to resolve dependency: user requested '#{dep}'"
@@ -261,10 +291,10 @@ class Gem::UnsatisfiableDependencyError < Gem::DependencyError
   def version
     @dependency.requirement
   end
-
 end
 
 ##
 # Backwards compatible typo'd exception class for early RubyGems 2.0.x
 
 Gem::UnsatisfiableDepedencyError = Gem::UnsatisfiableDependencyError # :nodoc:
+Gem.deprecate_constant :UnsatisfiableDepedencyError

data/lib/rubygems/ext/build_error.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 ##
 # Raised when there is an error while building extensions.
 
+require_relative "../exceptions"
+
 class Gem::Ext::BuildError < Gem::InstallError
 end
-