rubygems-update 2.6.1 → 3.5.0

data/lib/rubygems/commands/open_command.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
-require 'English'
-require 'rubygems/command'
-require 'rubygems/version_option'
-require 'rubygems/util'
 
-class Gem::Commands::OpenCommand < Gem::Command
+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 EDITOR', String,
-               "Opens gem sources in EDITOR") do |editor, options|
-      options[:editor] = editor || get_env_editor
+    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
+      options[:version] = version
     end
   end
 
@@ -32,21 +30,21 @@ class Gem::Commands::OpenCommand < Gem::Command
   def description # :nodoc:
     <<-EOF
         The open command opens gem in editor and changes current path
-        to gem's source directory. Editor can be specified with -e option,
-        otherwise rubygems will look for editor in $EDITOR, $VISUAL and
-        $GEM_EDITOR variables.
+        to gem's source directory.
+        Editor command can be specified with -e option, otherwise rubygems
+        will look for editor in $EDITOR, $VISUAL and $GEM_EDITOR variables.
     EOF
   end
 
   def usage # :nodoc:
-    "#{program_name} GEMNAME [-e EDITOR]"
+    "#{program_name} [-e COMMAND] GEMNAME"
   end
 
   def get_env_editor
-    ENV['GEM_EDITOR'] ||
-      ENV['VISUAL'] ||
-      ENV['EDITOR'] ||
-      'vi'
+    ENV["GEM_EDITOR"] ||
+      ENV["VISUAL"] ||
+      ENV["EDITOR"] ||
+      "vi"
   end
 
   def execute
@@ -58,21 +56,25 @@ class Gem::Commands::OpenCommand < Gem::Command
     terminate_interaction 1 unless found
   end
 
-  def open_gem name
+  def open_gem(name)
     spec = spec_for name
+
     return false unless spec
 
+    if spec.default_gem?
+      say "'#{name}' is a default gem and can't be opened."
+      return false
+    end
+
     open_editor(spec.full_gem_path)
   end
 
-  def open_editor path
-    Dir.chdir(path) do
-      system(*@editor.split(/\s+/) + [path])
-    end
+  def open_editor(path)
+    system(*@editor.split(/\s+/) + [path], { chdir: path })
   end
 
-  def spec_for name
-    spec = Gem::Specification.find_all_by_name(name, @version).last
+  def spec_for(name)
+    spec = Gem::Specification.find_all_by_name(name, @version).first
 
     return spec if spec
 

data/lib/rubygems/commands/outdated_command.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/local_remote_options'
-require 'rubygems/spec_fetcher'
-require 'rubygems/version_option'
 
-class Gem::Commands::OutdatedCommand < Gem::Command
+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,16 +1,24 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/local_remote_options'
-require 'rubygems/gemcutter_utilities'
+
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../gemcutter_utilities"
+require_relative "../text"
 
 class Gem::Commands::OwnerCommand < Gem::Command
+  include Gem::Text
   include Gem::LocalRemoteOptions
   include Gem::GemcutterUtilities
 
   def description # :nodoc:
     <<-EOF
 The owner command lets you add and remove owners of a gem on a push
-server (the default is https://rubygems.org).
+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 dependent on the push server.
+For rubygems.org, both e-mail and handle are supported, even though the
+user identifier field is called "email".
 
 The owner of a gem has the permission to push new versions, yank existing
 versions or edit the HTML page of the gem.  Be careful of who you give push
@@ -27,20 +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
-    defaults.merge! :add => [], :remove => []
+    add_otp_option
+    defaults.merge! add: [], remove: []
 
-    add_option '-a', '--add EMAIL', 'Add an owner' 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 EMAIL', 'Remove an owner' 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' 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
@@ -48,7 +59,7 @@ permission to.
   def execute
     @host = options[:host]
 
-    sign_in
+    sign_in(scope: get_owner_scope)
     name = get_one_gem_name
 
     add_owners    name, options[:add]
@@ -56,45 +67,58 @@ permission to.
     show_owners   name
   end
 
-  def show_owners name
+  def show_owners(name)
+    Gem.load_yaml
+
     response = rubygems_api_request :get, "api/v1/gems/#{name}/owners.yaml" do |request|
       request.add_field "Authorization", api_key
     end
 
     with_response response do |resp|
-      owners = YAML.load resp.body
+      owners = Gem::SafeYAML.load clean_text(resp.body)
 
       say "Owners for gem: #{name}"
       owners.each do |owner|
-        say "- #{owner['email']}"
+        say "- #{owner["email"] || owner["handle"] || owner["id"]}"
       end
     end
   end
 
-  def add_owners name, owners
+  def add_owners(name, owners)
     manage_owners :post, name, owners
   end
 
-  def remove_owners name, owners
+  def remove_owners(name, owners)
     manage_owners :delete, name, owners
   end
 
-  def manage_owners method, name, owners
+  def manage_owners(method, name, owners)
     owners.each do |owner|
-      begin
-        response = rubygems_api_request method, "api/v1/gems/#{name}/owners" do |request|
-          request.set_form_data 'email' => owner
-          request.add_field "Authorization", api_key
-        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
 
-        action = method == :delete ? "Removing" : "Adding"
+  private
 
-        with_response response, "#{action} #{owner}"
-      rescue
-        # ignore
-      end
+  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.add_field "Authorization", api_key
     end
   end
 
+  def get_owner_scope(method: nil)
+    if method == :post || options.any? && options[:add].any?
+      :add_owner
+    elsif method == :delete || options.any? && options[:remove].any?
+      :remove_owner
+    end
+  end
 end
-

data/lib/rubygems/commands/pristine_command.rb

@@ -1,51 +1,73 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/package'
-require 'rubygems/installer'
-require 'rubygems/version_option'
 
-class Gem::Commands::PristineCommand < Gem::Command
+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|
-      options[:skip] = value
+    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('-E', '--[no-]env-shebang',
-               'Rewrite executables with a shebang',
-               'of /usr/bin/env') 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|
       options[:env_shebang] = value
     end
 
-    add_version_option('restore to', 'pristine condition')
+    add_option("-i", "--install-dir DIR",
+               "Gem repository to get binstubs and plugins installed") do |value, options|
+      options[:install_dir] = File.expand_path(value)
+    end
+
+    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")
   end
 
   def arguments # :nodoc:
@@ -53,7 +75,7 @@ class Gem::Commands::PristineCommand < Gem::Command
   end
 
   def defaults_str # :nodoc:
-    '--extensions'
+    "--extensions"
   end
 
   def description # :nodoc:
@@ -81,31 +103,30 @@ extensions will be restored.
   end
 
   def execute
-    specs = if options[:all] then
-              Gem::Specification.map
-
-            # `--extensions` must be explicitly given to pristine only gems
-            # with extensions.
-            elsif options[:extensions_set] and
-                  options[:extensions] and options[:args].empty? then
-              Gem::Specification.select do |spec|
-                spec.extensions and not spec.extensions.empty?
-              end
-            else
-              get_all_gem_names.map do |gem_name|
-                Gem::Specification.find_all_by_name gem_name, options[:version]
-              end.flatten
-            end
-
-    if specs.to_a.empty? then
-      raise Gem::Exception,
-            "Failed to find gems #{options[:args]} #{options[:version]}"
+    specs = if options[:all]
+      Gem::Specification.map
+
+    # `--extensions` must be explicitly given to pristine only gems
+    # with extensions.
+    elsif options[:extensions_set] &&
+          options[:extensions] && options[:args].empty?
+      Gem::Specification.select do |spec|
+        spec.extensions && !spec.extensions.empty?
+      end
+    elsif options[:only_missing_extensions]
+      Gem::Specification.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
     end
 
-    install_dir = Gem.dir # TODO use installer option
+    specs = specs.select {|spec| spec.platform == RUBY_ENGINE || Gem::Platform.local === spec.platform || spec.platform == Gem::Platform::RUBY }
 
-    raise Gem::FilePermissionError.new(install_dir) unless
-      File.writable?(install_dir)
+    if specs.to_a.empty?
+      raise Gem::Exception,
+            "Failed to find gems #{options[:args]} #{options[:version]}"
+    end
 
     say "Restoring gems to pristine condition..."
 
@@ -115,25 +136,22 @@ extensions will be restored.
         next
       end
 
-      if spec.name == options[:skip]
-        say "Skipped #{spec.full_name}, it was given through options"
-        next
-      end
-
-      if spec.bundled_gem_in_old_ruby?
-        say "Skipped #{spec.full_name}, it is bundled with old Ruby"
-        next
+      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] then
+      unless spec.extensions.empty? || options[:extensions] || options[:only_executables] || options[:only_plugins]
         say "Skipped #{spec.full_name}, it needs to compile an extension"
         next
       end
 
       gem = spec.cache_file
 
-      unless File.exist? gem then
-        require 'rubygems/remote_fetcher'
+      unless File.exist?(gem) || options[:only_executables] || options[:only_plugins]
+        require_relative "../remote_fetcher"
 
         say "Cached gem for #{spec.full_name} not found, attempting to fetch..."
 
@@ -150,23 +168,33 @@ extensions will be restored.
       end
 
       env_shebang =
-        if options.include? :env_shebang then
+        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
 
-      installer = Gem::Installer.at(gem,
-                                     :wrappers => true,
-                                     :force => true,
-                                     :install_dir => spec.base_dir,
-                                     :env_shebang => env_shebang,
-                                     :build_args => spec.build_args)
+      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,
+      }
 
-      if options[:only_executables] then
+      if options[:only_executables]
+        installer = Gem::Installer.for_spec(spec, installer_options)
         installer.generate_bin
+      elsif options[:only_plugins]
+        installer = Gem::Installer.for_spec(spec, installer_options)
+        installer.generate_plugins
       else
+        installer = Gem::Installer.at(gem, installer_options)
         installer.install
       end
 

data/lib/rubygems/commands/push_command.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/local_remote_options'
-require 'rubygems/gemcutter_utilities'
-require 'rubygems/package'
+
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../gemcutter_utilities"
+require_relative "../package"
 
 class Gem::Commands::PushCommand < Gem::Command
   include Gem::LocalRemoteOptions
@@ -13,8 +14,10 @@ class Gem::Commands::PushCommand < Gem::Command
 The push command uploads a gem to the push server (the default is
 https://rubygems.org) and adds it to the index.
 
-The gem can be removed from the index (but only the index) using the yank
+The gem can be removed from the index and deleted from the server using the yank
 command.  For further discussion see the help for the yank command.
+
+The push command will use ~/.gem/credentials to authenticate to a server, but you can use the RubyGems environment variable GEM_HOST_API_KEY to set the api key to authenticate.
     EOF
   end
 
@@ -27,77 +30,81 @@ command.  For further discussion see the help for the yank command.
   end
 
   def initialize
-    super 'push', 'Push a gem up to the gem server', :host => self.host
+    super "push", "Push a gem up to the gem server", host: host
+
+    @user_defined_host = false
 
     add_proxy_option
     add_key_option
+    add_otp_option
 
-    add_option('--host HOST',
-               'Push to another gemcutter-compatible host') do |value, options|
+    add_option("--host HOST",
+               "Push to another gemcutter-compatible host",
+               "  (e.g. https://rubygems.org)") do |value, options|
       options[:host] = value
+      @user_defined_host = true
     end
 
     @host = nil
   end
 
   def execute
-    @host = options[:host]
+    gem_name = get_one_gem_name
+    default_gem_server, push_host = get_hosts_for(gem_name)
+
+    @host = if @user_defined_host
+      options[:host]
+    elsif default_gem_server
+      default_gem_server
+    elsif push_host
+      push_host
+    else
+      options[:host]
+    end
 
-    sign_in @host
+    sign_in @host, scope: get_push_scope
 
-    send_gem get_one_gem_name
+    send_gem(gem_name)
   end
 
-  def send_gem name
+  def send_gem(name)
     args = [:post, "api/v1/gems"]
 
-    latest_rubygems_version = Gem.latest_rubygems_version
-
-    if latest_rubygems_version < Gem.rubygems_version and
-         Gem.rubygems_version.prerelease? and
-         Gem::Version.new('2.0.0.rc.2') != Gem.rubygems_version then
-      alert_error <<-ERROR
-You are using a beta release of RubyGems (#{Gem::VERSION}) which is not
-allowed to push gems.  Please downgrade or upgrade to a release version.
-
-The latest released RubyGems version is #{latest_rubygems_version}
-
-You can upgrade or downgrade to the latest release version with:
-
-  gem update --system=#{latest_rubygems_version}
-
-      ERROR
-      terminate_interaction 1
-    end
-
-    gem_data = Gem::Package.new(name)
-
-    unless @host then
-      @host = gem_data.spec.metadata['default_gem_server']
-    end
-
-    push_host = nil
-
-    if gem_data.spec.metadata.has_key?('allowed_push_host')
-      push_host = gem_data.spec.metadata['allowed_push_host']
-    end
+    _, push_host = get_hosts_for(name)
 
     @host ||= push_host
 
     # Always include @host, even if it's nil
-    args += [ @host, push_host ]
+    args += [@host, push_host]
 
     say "Pushing gem to #{@host || Gem.host}..."
 
-    response = rubygems_api_request(*args) do |request|
+    response = send_push_request(name, args)
+
+    with_response response
+  end
+
+  private
+
+  def send_push_request(name, args)
+    rubygems_api_request(*args, scope: get_push_scope) do |request|
       request.body = Gem.read_binary name
       request.add_field "Content-Length", request.body.size
       request.add_field "Content-Type",   "application/octet-stream"
       request.add_field "Authorization",  api_key
     end
+  end
 
-    with_response response
+  def get_hosts_for(name)
+    gem_metadata = Gem::Package.new(name).spec.metadata
+
+    [
+      gem_metadata["default_gem_server"],
+      gem_metadata["allowed_push_host"],
+    ]
   end
 
+  def get_push_scope
+    :push_rubygem
+  end
 end
-