rubygems-update 3.3.18 → 3.6.2

data/lib/rubygems/commands/install_command.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../install_update_options'
-require_relative '../dependency_installer'
-require_relative '../local_remote_options'
-require_relative '../validator'
-require_relative '../version_option'
+
+require_relative "../command"
+require_relative "../install_update_options"
+require_relative "../dependency_installer"
+require_relative "../local_remote_options"
+require_relative "../validator"
+require_relative "../version_option"
+require_relative "../update_suggestion"
 
 ##
 # Gem installer command line tool
@@ -17,19 +19,20 @@ class Gem::Commands::InstallCommand < Gem::Command
   include Gem::VersionOption
   include Gem::LocalRemoteOptions
   include Gem::InstallUpdateOptions
+  include Gem::UpdateSuggestion
 
   def initialize
     defaults = Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
-      :format_executable => false,
-      :lock              => true,
-      :suggest_alternate => true,
-      :version           => Gem::Requirement.default,
-      :without_groups    => [],
+      format_executable: false,
+      lock: true,
+      suggest_alternate: true,
+      version: Gem::Requirement.default,
+      without_groups: [],
     })
 
     defaults.merge!(install_update_options)
 
-    super 'install', 'Install a gem into the local repository', defaults
+    super "install", "Install a gem into the local repository", defaults
 
     add_install_update_options
     add_local_remote_options
@@ -45,9 +48,9 @@ class Gem::Commands::InstallCommand < Gem::Command
   end
 
   def defaults_str # :nodoc:
-    "--both --version '#{Gem::Requirement.default}' --no-force\n" +
-    "--install-dir #{Gem.dir} --lock\n" +
-    install_update_defaults_str
+    "--both --version '#{Gem::Requirement.default}' --no-force\n" \
+      "--install-dir #{Gem.dir} --lock\n" +
+      install_update_defaults_str
   end
 
   def description # :nodoc:
@@ -133,16 +136,9 @@ You can use `i` command instead of `install`.
     "#{program_name} [options] GEMNAME [GEMNAME ...] -- --build-flags"
   end
 
-  def check_install_dir # :nodoc:
-    if options[:install_dir] and options[:user_install]
-      alert_error "Use --install-dir or --user-install but not both"
-      terminate_interaction 1
-    end
-  end
-
   def check_version # :nodoc:
-    if options[:version] != Gem::Requirement.default and
-         get_all_gem_names.size > 1
+    if options[:version] != Gem::Requirement.default &&
+       get_all_gem_names.size > 1
       alert_error "Can't use --version with multiple gems. You can specify multiple gems with" \
                   " version requirements using `gem install 'my_gem:1.0.0' 'my_other_gem:~>2.0.0'`"
       terminate_interaction 1
@@ -157,9 +153,8 @@ You can use `i` command instead of `install`.
 
     @installed_specs = []
 
-    ENV.delete 'GEM_PATH' if options[:install_dir].nil?
+    ENV.delete "GEM_PATH" if options[:install_dir].nil?
 
-    check_install_dir
     check_version
 
     load_hooks
@@ -168,11 +163,13 @@ You can use `i` command instead of `install`.
 
     show_installed
 
+    say update_suggestion if eligible_for_update?
+
     terminate_interaction exit_code
   end
 
   def install_from_gemdeps # :nodoc:
-    require_relative '../request_set'
+    require_relative "../request_set"
     rs = Gem::RequestSet.new
 
     specs = rs.install_from_gemdeps options do |req, inst|
@@ -191,8 +188,8 @@ You can use `i` command instead of `install`.
   end
 
   def install_gem(name, version) # :nodoc:
-    return if options[:conservative] and
-      not Gem::Dependency.new(name, version).matching_specs.empty?
+    return if options[:conservative] &&
+              !Gem::Dependency.new(name, version).matching_specs.empty?
 
     req = Gem::Requirement.create(version)
 
@@ -227,10 +224,6 @@ You can use `i` command instead of `install`.
       rescue Gem::InstallError => e
         alert_error "Error installing #{gem_name}:\n\t#{e.message}"
         exit_code |= 1
-      rescue Gem::GemNotFoundException => e
-        show_lookup_failure e.name, e.version, e.errors, suppress_suggestions
-
-        exit_code |= 2
       rescue Gem::UnsatisfiableDependencyError => e
         show_lookup_failure e.name, e.version, e.errors, suppress_suggestions,
                             "'#{gem_name}' (#{gem_version})"
@@ -247,18 +240,18 @@ You can use `i` command instead of `install`.
 
   def load_hooks # :nodoc:
     if options[:install_as_default]
-      require_relative '../install_default_message'
+      require_relative "../install_default_message"
     else
-      require_relative '../install_message'
+      require_relative "../install_message"
     end
-    require_relative '../rdoc'
+    require_relative "../rdoc"
   end
 
   def show_install_errors(errors) # :nodoc:
     return unless errors
 
     errors.each do |x|
-      return unless Gem::SourceFetchProblem === x
+      next unless Gem::SourceFetchProblem === x
 
       require_relative "../uri"
       msg = "Unable to pull data from '#{Gem::Uri.redact(x.source.uri)}': #{x.error.message}"
@@ -270,7 +263,7 @@ You can use `i` command instead of `install`.
   def show_installed # :nodoc:
     return if @installed_specs.empty?
 
-    gems = @installed_specs.length == 1 ? 'gem' : 'gems'
+    gems = @installed_specs.length == 1 ? "gem" : "gems"
     say "#{@installed_specs.length} #{gems} installed"
   end
 end

data/lib/rubygems/commands/list_command.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../query_utils'
+
+require_relative "../command"
+require_relative "../query_utils"
 
 ##
 # Searches for gems starting with the supplied argument.
@@ -9,9 +10,9 @@ class Gem::Commands::ListCommand < Gem::Command
   include Gem::QueryUtils
 
   def initialize
-    super 'list', 'Display local gems whose name matches REGEXP',
-         :domain => :local, :details => false, :versions => true,
-         :installed => nil, :version => Gem::Requirement.default
+    super "list", "Display local gems whose name matches REGEXP",
+         domain: :local, details: false, versions: true,
+         installed: nil, version: Gem::Requirement.default
 
     add_query_options
   end

data/lib/rubygems/commands/lock_command.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
-require_relative '../command'
+
+require_relative "../command"
 
 class Gem::Commands::LockCommand < Gem::Command
   def initialize
-    super 'lock', 'Generate a lockdown list of gems',
-          :strict => false
+    super "lock", "Generate a lockdown list of gems",
+          strict: false
 
-    add_option '-s', '--[no-]strict',
-               'fail if unable to satisfy a dependency' do |strict, options|
+    add_option "-s", "--[no-]strict",
+               "fail if unable to satisfy a dependency" do |strict, options|
       options[:strict] = strict
     end
   end

data/lib/rubygems/commands/mirror_command.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
-require_relative '../command'
+
+require_relative "../command"
 
 unless defined? Gem::Commands::MirrorCommand
   class Gem::Commands::MirrorCommand < Gem::Command
     def initialize
-      super('mirror', 'Mirror all gem files (requires rubygems-mirror)')
+      super("mirror", "Mirror all gem files (requires rubygems-mirror)")
       begin
-        Gem::Specification.find_by_name('rubygems-mirror').activate
+        Gem::Specification.find_by_name("rubygems-mirror").activate
       rescue Gem::LoadError
         # no-op
       end

data/lib/rubygems/commands/open_command.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../version_option'
+
+require_relative "../command"
+require_relative "../version_option"
 
 class Gem::Commands::OpenCommand < Gem::Command
   include Gem::VersionOption
 
   def initialize
-    super 'open', 'Open gem sources in editor'
+    super "open", "Open gem sources in editor"
 
-    add_option('-e', '--editor COMMAND', String,
+    add_option("-e", "--editor COMMAND", String,
                "Prepends COMMAND to gem path. Could be used to specify editor.") do |command, options|
       options[:editor] = command || get_env_editor
     end
-    add_option('-v', '--version VERSION', String,
+    add_option("-v", "--version VERSION", String,
                "Opens specific gem version") do |version|
       options[:version] = version
     end
@@ -40,10 +41,10 @@ class Gem::Commands::OpenCommand < Gem::Command
   end
 
   def get_env_editor
-    ENV['GEM_EDITOR'] ||
-      ENV['VISUAL'] ||
-      ENV['EDITOR'] ||
-      'vi'
+    ENV["GEM_EDITOR"] ||
+      ENV["VISUAL"] ||
+      ENV["EDITOR"] ||
+      "vi"
   end
 
   def execute
@@ -69,9 +70,7 @@ class Gem::Commands::OpenCommand < Gem::Command
   end
 
   def open_editor(path)
-    Dir.chdir(path) do
-      system(*@editor.split(/\s+/) + [path])
-    end
+    system(*@editor.split(/\s+/) + [path], { chdir: path })
   end
 
   def spec_for(name)

data/lib/rubygems/commands/outdated_command.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../local_remote_options'
-require_relative '../spec_fetcher'
-require_relative '../version_option'
+
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../spec_fetcher"
+require_relative "../version_option"
 
 class Gem::Commands::OutdatedCommand < Gem::Command
   include Gem::LocalRemoteOptions
   include Gem::VersionOption
 
   def initialize
-    super 'outdated', 'Display all gems that need updates'
+    super "outdated", "Display all gems that need updates"
 
     add_local_remote_options
     add_platform_option

data/lib/rubygems/commands/owner_command.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../local_remote_options'
-require_relative '../gemcutter_utilities'
-require_relative '../text'
+
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../gemcutter_utilities"
+require_relative "../text"
 
 class Gem::Commands::OwnerCommand < Gem::Command
   include Gem::Text
@@ -15,7 +16,7 @@ The owner command lets you add and remove owners of a gem on a push
 server (the default is https://rubygems.org). Multiple owners can be
 added or removed at the same time, if the flag is given multiple times.
 
-The supported user identifiers are dependant on the push server.
+The supported user identifiers are dependent on the push server.
 For rubygems.org, both e-mail and handle are supported, even though the
 user identifier field is called "email".
 
@@ -34,23 +35,23 @@ permission to.
   end
 
   def initialize
-    super 'owner', 'Manage gem owners of a gem on the push server'
+    super "owner", "Manage gem owners of a gem on the push server"
     add_proxy_option
     add_key_option
     add_otp_option
-    defaults.merge! :add => [], :remove => []
+    defaults.merge! add: [], remove: []
 
-    add_option '-a', '--add NEW_OWNER', 'Add an owner by user identifier' do |value, options|
+    add_option "-a", "--add NEW_OWNER", "Add an owner by user identifier" do |value, options|
       options[:add] << value
     end
 
-    add_option '-r', '--remove OLD_OWNER', 'Remove an owner by user identifier' do |value, options|
+    add_option "-r", "--remove OLD_OWNER", "Remove an owner by user identifier" do |value, options|
       options[:remove] << value
     end
 
-    add_option '-h', '--host HOST',
-               'Use another gemcutter-compatible host',
-               '  (e.g. https://rubygems.org)' do |value, options|
+    add_option "-h", "--host HOST",
+               "Use another gemcutter-compatible host",
+               "  (e.g. https://rubygems.org)" do |value, options|
       options[:host] = value
     end
   end
@@ -78,7 +79,7 @@ permission to.
 
       say "Owners for gem: #{name}"
       owners.each do |owner|
-        say "- #{owner['email'] || owner['handle'] || owner['id']}"
+        say "- #{owner["email"] || owner["handle"] || owner["id"]}"
       end
     end
   end
@@ -93,14 +94,14 @@ permission to.
 
   def manage_owners(method, name, owners)
     owners.each do |owner|
-      begin
-        response = send_owner_request(method, name, owner)
-        action = method == :delete ? "Removing" : "Adding"
-
-        with_response response, "#{action} #{owner}"
-      rescue
-        # ignore
-      end
+      response = send_owner_request(method, name, owner)
+      action = method == :delete ? "Removing" : "Adding"
+
+      with_response response, "#{action} #{owner}"
+    rescue Gem::WebauthnVerificationError => e
+      raise e
+    rescue StandardError
+      # ignore early exits to allow for completing the iteration of all owners
     end
   end
 
@@ -108,7 +109,7 @@ permission to.
 
   def send_owner_request(method, name, owner)
     rubygems_api_request method, "api/v1/gems/#{name}/owners", scope: get_owner_scope(method: method) do |request|
-      request.set_form_data 'email' => owner
+      request.set_form_data "email" => owner
       request.add_field "Authorization", api_key
     end
   end

data/lib/rubygems/commands/pristine_command.rb

@@ -1,67 +1,73 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../package'
-require_relative '../installer'
-require_relative '../version_option'
+
+require_relative "../command"
+require_relative "../package"
+require_relative "../installer"
+require_relative "../version_option"
 
 class Gem::Commands::PristineCommand < Gem::Command
   include Gem::VersionOption
 
   def initialize
-    super 'pristine',
-          'Restores installed gems to pristine condition from files located in the gem cache',
-          :version => Gem::Requirement.default,
-          :extensions => true,
-          :extensions_set => false,
-          :all => false
-
-    add_option('--all',
-               'Restore all installed gems to pristine',
-               'condition') do |value, options|
+    super "pristine",
+          "Restores installed gems to pristine condition from files located in the gem cache",
+          version: Gem::Requirement.default,
+          extensions: true,
+          extensions_set: false,
+          all: false
+
+    add_option("--all",
+               "Restore all installed gems to pristine",
+               "condition") do |value, options|
       options[:all] = value
     end
 
-    add_option('--skip=gem_name',
-               'used on --all, skip if name == gem_name') do |value, options|
+    add_option("--skip=gem_name",
+               "used on --all, skip if name == gem_name") do |value, options|
       options[:skip] ||= []
       options[:skip] << value
     end
 
-    add_option('--[no-]extensions',
-               'Restore gems with extensions',
-               'in addition to regular gems') do |value, options|
+    add_option("--[no-]extensions",
+               "Restore gems with extensions",
+               "in addition to regular gems") do |value, options|
       options[:extensions_set] = true
       options[:extensions]     = value
     end
 
-    add_option('--only-executables',
-               'Only restore executables') do |value, options|
+    add_option("--only-missing-extensions",
+               "Only restore gems with missing extensions") do |value, options|
+      options[:only_missing_extensions] = value
+    end
+
+    add_option("--only-executables",
+               "Only restore executables") do |value, options|
       options[:only_executables] = value
     end
 
-    add_option('--only-plugins',
-               'Only restore plugins') do |value, options|
+    add_option("--only-plugins",
+               "Only restore plugins") do |value, options|
       options[:only_plugins] = value
     end
 
-    add_option('-E', '--[no-]env-shebang',
-               'Rewrite executables with a shebang',
-               'of /usr/bin/env') do |value, options|
+    add_option("-E", "--[no-]env-shebang",
+               "Rewrite executables with a shebang",
+               "of /usr/bin/env") do |value, options|
       options[:env_shebang] = value
     end
 
-    add_option('-i', '--install-dir DIR',
-               'Gem repository to get binstubs and plugins installed') do |value, options|
+    add_option("-i", "--install-dir DIR",
+               "Gem repository to get gems restored") do |value, options|
       options[:install_dir] = File.expand_path(value)
     end
 
-    add_option('-n', '--bindir DIR',
-               'Directory where executables are',
-               'located') do |value, options|
+    add_option("-n", "--bindir DIR",
+               "Directory where executables are",
+               "located") do |value, options|
       options[:bin_dir] = File.expand_path(value)
     end
 
-    add_version_option('restore to', 'pristine condition')
+    add_version_option("restore to", "pristine condition")
   end
 
   def arguments # :nodoc:
@@ -69,7 +75,7 @@ class Gem::Commands::PristineCommand < Gem::Command
   end
 
   def defaults_str # :nodoc:
-    '--extensions'
+    "--extensions"
   end
 
   def description # :nodoc:
@@ -97,23 +103,29 @@ extensions will be restored.
   end
 
   def execute
+    install_dir = options[:install_dir]
+
+    specification_record = install_dir ? Gem::SpecificationRecord.from_path(install_dir) : Gem::Specification.specification_record
+
     specs = if options[:all]
-      Gem::Specification.map
+      specification_record.map
 
     # `--extensions` must be explicitly given to pristine only gems
     # with extensions.
-    elsif options[:extensions_set] and
-                  options[:extensions] and options[:args].empty?
-      Gem::Specification.select do |spec|
-        spec.extensions and not spec.extensions.empty?
+    elsif options[:extensions_set] &&
+          options[:extensions] && options[:args].empty?
+      specification_record.select do |spec|
+        spec.extensions && !spec.extensions.empty?
       end
+    elsif options[:only_missing_extensions]
+      specification_record.select(&:missing_extensions?)
     else
-      get_all_gem_names.sort.map do |gem_name|
-        Gem::Specification.find_all_by_name(gem_name, options[:version]).reverse
-      end.flatten
+      get_all_gem_names.sort.flat_map do |gem_name|
+        specification_record.find_all_by_name(gem_name, options[:version]).reverse
+      end
     end
 
-    specs = specs.select {|spec| RUBY_ENGINE == spec.platform || Gem::Platform.local === spec.platform || spec.platform == Gem::Platform::RUBY }
+    specs = specs.select {|spec| spec.platform == RUBY_ENGINE || Gem::Platform.local === spec.platform || spec.platform == Gem::Platform::RUBY }
 
     if specs.to_a.empty?
       raise Gem::Exception,
@@ -122,30 +134,34 @@ extensions will be restored.
 
     say "Restoring gems to pristine condition..."
 
-    specs.each do |spec|
-      if spec.default_gem?
-        say "Skipped #{spec.full_name}, it is a default gem"
-        next
+    specs.group_by(&:full_name_with_location).values.each do |grouped_specs|
+      spec = grouped_specs.find {|s| !s.default_gem? } || grouped_specs.first
+
+      unless only_executables_or_plugins?
+        # Default gemspecs include changes provided by ruby-core installer that
+        # can't currently be pristined (inclusion of compiled extension targets in
+        # the file list). So stick to resetting executables if it's a default gem.
+        options[:only_executables] = true if spec.default_gem?
       end
 
-      if options.has_key? :skip
+      if options.key? :skip
         if options[:skip].include? spec.name
           say "Skipped #{spec.full_name}, it was given through options"
           next
         end
       end
 
-      unless spec.extensions.empty? or options[:extensions] or options[:only_executables] or options[:only_plugins]
-        say "Skipped #{spec.full_name}, it needs to compile an extension"
+      unless spec.extensions.empty? || options[:extensions] || only_executables_or_plugins?
+        say "Skipped #{spec.full_name_with_location}, it needs to compile an extension"
         next
       end
 
       gem = spec.cache_file
 
-      unless File.exist? gem or options[:only_executables] or options[:only_plugins]
-        require_relative '../remote_fetcher'
+      unless File.exist?(gem) || only_executables_or_plugins?
+        require_relative "../remote_fetcher"
 
-        say "Cached gem for #{spec.full_name} not found, attempting to fetch..."
+        say "Cached gem for #{spec.full_name_with_location} not found, attempting to fetch..."
 
         dep = Gem::Dependency.new spec.name, spec.version
         found, _ = Gem::SpecFetcher.fetcher.spec_for_dependency dep
@@ -163,20 +179,19 @@ extensions will be restored.
         if options.include? :env_shebang
           options[:env_shebang]
         else
-          install_defaults = Gem::ConfigFile::PLATFORM_DEFAULTS['install']
-          install_defaults.to_s['--env-shebang']
+          install_defaults = Gem::ConfigFile::PLATFORM_DEFAULTS["install"]
+          install_defaults.to_s["--env-shebang"]
         end
 
       bin_dir = options[:bin_dir] if options[:bin_dir]
-      install_dir = options[:install_dir] if options[:install_dir]
 
       installer_options = {
-        :wrappers => true,
-        :force => true,
-        :install_dir => install_dir || spec.base_dir,
-        :env_shebang => env_shebang,
-        :build_args => spec.build_args,
-        :bin_dir => bin_dir,
+        wrappers: true,
+        force: true,
+        install_dir: install_dir || spec.base_dir,
+        env_shebang: env_shebang,
+        build_args: spec.build_args,
+        bin_dir: bin_dir,
       }
 
       if options[:only_executables]
@@ -190,7 +205,13 @@ extensions will be restored.
         installer.install
       end
 
-      say "Restored #{spec.full_name}"
+      say "Restored #{spec.full_name_with_location}"
     end
   end
+
+  private
+
+  def only_executables_or_plugins?
+    options[:only_executables] || options[:only_plugins]
+  end
 end