rubygems-update 3.3.18 → 3.6.2

data/lib/rubygems/commands/environment_command.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-require_relative '../command'
+
+require_relative "../command"
 
 class Gem::Commands::EnvironmentCommand < Gem::Command
   def initialize
-    super 'environment', 'Display information about the RubyGems environment'
+    super "environment", "Display information about the RubyGems environment"
   end
 
   def arguments # :nodoc:
@@ -16,7 +17,7 @@ class Gem::Commands::EnvironmentCommand < Gem::Command
           platform        display the supported gem platforms
           <omitted>       display everything
     EOF
-    return args.gsub(/^\s+/, '')
+    args.gsub(/^\s+/, "")
   end
 
   def description # :nodoc:
@@ -107,9 +108,7 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - RUBYGEMS VERSION: #{Gem::VERSION}\n"
 
-    out << "  - RUBY VERSION: #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}"
-    out << " patchlevel #{RUBY_PATCHLEVEL}" if defined? RUBY_PATCHLEVEL
-    out << ") [#{RUBY_PLATFORM}]\n"
+    out << "  - RUBY VERSION: #{RUBY_VERSION} (#{RUBY_RELEASE_DATE} patchlevel #{RUBY_PATCHLEVEL}) [#{RUBY_PLATFORM}]\n"
 
     out << "  - INSTALLATION DIRECTORY: #{Gem.dir}\n"
 
@@ -141,7 +140,7 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - GEM CONFIGURATION:\n"
     Gem.configuration.each do |name, value|
-      value = value.gsub(/./, '*') if name == 'gemcutter_key'
+      value = value.gsub(/./, "*") if name == "gemcutter_key"
       out << "     - #{name.inspect} => #{value.inspect}\n"
     end
 
@@ -152,7 +151,7 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - SHELL PATH:\n"
 
-    shell_path = ENV['PATH'].split(File::PATH_SEPARATOR)
+    shell_path = ENV["PATH"].split(File::PATH_SEPARATOR)
     add_path out, shell_path
 
     out
@@ -172,6 +171,6 @@ lib/rubygems/defaults/operating_system.rb
       end
     end
 
-    return nil
+    nil
   end
 end

data/lib/rubygems/commands/exec_command.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../dependency_installer"
+require_relative "../gem_runner"
+require_relative "../package"
+require_relative "../version_option"
+
+class Gem::Commands::ExecCommand < Gem::Command
+  include Gem::VersionOption
+
+  def initialize
+    super "exec", "Run a command from a gem", {
+      version: Gem::Requirement.default,
+    }
+
+    add_version_option
+    add_prerelease_option "to be installed"
+
+    add_option "-g", "--gem GEM", "run the executable from the given gem" do |value, options|
+      options[:gem_name] = value
+    end
+
+    add_option(:"Install/Update", "--conservative",
+      "Prefer the most recent installed version, ",
+      "rather than the latest version overall") do |_value, options|
+      options[:conservative] = true
+    end
+  end
+
+  def arguments # :nodoc:
+    "COMMAND  the executable command to run"
+  end
+
+  def defaults_str # :nodoc:
+    "--version '#{Gem::Requirement.default}'"
+  end
+
+  def description # :nodoc:
+    <<-EOF
+The exec command handles installing (if necessary) and running an executable
+from a gem, regardless of whether that gem is currently installed.
+
+The exec command can be thought of as a shortcut to running `gem install` and
+then the executable from the installed gem.
+
+For example, `gem exec rails new .` will run `rails new .` in the current
+directory, without having to manually run `gem install rails`.
+Additionally, the exec command ensures the most recent version of the gem
+is used (unless run with `--conservative`), and that the gem is not installed
+to the same gem path as user-installed gems.
+    EOF
+  end
+
+  def usage # :nodoc:
+    "#{program_name} [options --] COMMAND [args]"
+  end
+
+  def execute
+    check_executable
+
+    print_command
+    if options[:gem_name] == "gem" && options[:executable] == "gem"
+      set_gem_exec_install_paths
+      Gem::GemRunner.new.run options[:args]
+      return
+    elsif options[:conservative]
+      install_if_needed
+    else
+      install
+      activate!
+    end
+
+    load!
+  end
+
+  private
+
+  def handle_options(args)
+    args = add_extra_args(args)
+    check_deprecated_options(args)
+    @options = Marshal.load Marshal.dump @defaults # deep copy
+    parser.order!(args) do |v|
+      # put the non-option back at the front of the list of arguments
+      args.unshift(v)
+
+      # stop parsing once we hit the first non-option,
+      # so you can call `gem exec rails --version` and it prints the rails
+      # version rather than rubygem's
+      break
+    end
+    @options[:args] = args
+
+    options[:executable], gem_version = extract_gem_name_and_version(options[:args].shift)
+    options[:gem_name] ||= options[:executable]
+
+    if gem_version
+      if options[:version].none?
+        options[:version] = Gem::Requirement.new(gem_version)
+      else
+        options[:version].concat [gem_version]
+      end
+    end
+
+    if options[:prerelease] && !options[:version].prerelease?
+      if options[:version].none?
+        options[:version] = Gem::Requirement.default_prerelease
+      else
+        options[:version].concat [Gem::Requirement.default_prerelease]
+      end
+    end
+  end
+
+  def check_executable
+    if options[:executable].nil?
+      raise Gem::CommandLineError,
+        "Please specify an executable to run (e.g. #{program_name} COMMAND)"
+    end
+  end
+
+  def print_command
+    verbose "running #{program_name} with:\n"
+    opts = options.reject {|_, v| v.nil? || Array(v).empty? }
+    max_length = opts.map {|k, _| k.size }.max
+    opts.each do |k, v|
+      next if v.nil?
+      verbose "\t#{k.to_s.rjust(max_length)}: #{v}"
+    end
+    verbose ""
+  end
+
+  def install_if_needed
+    activate!
+  rescue Gem::MissingSpecError
+    verbose "#{Gem::Dependency.new(options[:gem_name], options[:version])} not available locally, installing from remote"
+    install
+    activate!
+  end
+
+  def set_gem_exec_install_paths
+    home = Gem.dir
+
+    ENV["GEM_PATH"] = ([home] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV["GEM_HOME"] = home
+    Gem.clear_paths
+  end
+
+  def install
+    set_gem_exec_install_paths
+
+    gem_name = options[:gem_name]
+    gem_version = options[:version]
+
+    install_options = options.merge(
+      minimal_deps: false,
+      wrappers: true
+    )
+
+    suppress_always_install do
+      dep_installer = Gem::DependencyInstaller.new install_options
+
+      request_set = dep_installer.resolve_dependencies gem_name, gem_version
+
+      verbose "Gems to install:"
+      request_set.sorted_requests.each do |activation_request|
+        verbose "\t#{activation_request.full_name}"
+      end
+
+      request_set.install install_options
+    end
+
+    Gem::Specification.reset
+  rescue Gem::InstallError => e
+    alert_error "Error installing #{gem_name}:\n\t#{e.message}"
+    terminate_interaction 1
+  rescue Gem::GemNotFoundException => e
+    show_lookup_failure e.name, e.version, e.errors, false
+
+    terminate_interaction 2
+  rescue Gem::UnsatisfiableDependencyError => e
+    show_lookup_failure e.name, e.version, e.errors, false,
+                        "'#{gem_name}' (#{gem_version})"
+
+    terminate_interaction 2
+  end
+
+  def activate!
+    gem(options[:gem_name], options[:version])
+    Gem.finish_resolve
+
+    verbose "activated #{options[:gem_name]} (#{Gem.loaded_specs[options[:gem_name]].version})"
+  end
+
+  def load!
+    argv = ARGV.clone
+    ARGV.replace options[:args]
+
+    exe = executable = options[:executable]
+
+    contains_executable = Gem.loaded_specs.values.select do |spec|
+      spec.executables.include?(executable)
+    end
+
+    if contains_executable.any? {|s| s.name == executable }
+      contains_executable.select! {|s| s.name == executable }
+    end
+
+    if contains_executable.empty?
+      if (spec = Gem.loaded_specs[executable]) && (exe = spec.executable)
+        contains_executable << spec
+      else
+        alert_error "Failed to load executable `#{executable}`," \
+              " are you sure the gem `#{options[:gem_name]}` contains it?"
+        terminate_interaction 1
+      end
+    end
+
+    if contains_executable.size > 1
+      alert_error "Ambiguous which gem `#{executable}` should come from: " \
+            "the options are #{contains_executable.map(&:name)}, " \
+            "specify one via `-g`"
+      terminate_interaction 1
+    end
+
+    old_exe = $0
+    $0 = exe
+    load Gem.activate_bin_path(contains_executable.first.name, exe, ">= 0.a")
+  ensure
+    $0 = old_exe if old_exe
+    ARGV.replace argv
+  end
+
+  def suppress_always_install
+    name = :always_install
+    cls = ::Gem::Resolver::InstallerSet
+    method = cls.instance_method(name)
+    cls.remove_method(name)
+    cls.define_method(name) { [] }
+
+    begin
+      yield
+    ensure
+      cls.remove_method(name)
+      cls.define_method(name, method)
+    end
+  end
+end

data/lib/rubygems/commands/fetch_command.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../local_remote_options'
-require_relative '../version_option'
+
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../version_option"
 
 class Gem::Commands::FetchCommand < Gem::Command
   include Gem::LocalRemoteOptions
@@ -9,11 +10,11 @@ class Gem::Commands::FetchCommand < Gem::Command
 
   def initialize
     defaults = {
-      :suggest_alternate => true,
-      :version           => Gem::Requirement.default,
+      suggest_alternate: true,
+      version: Gem::Requirement.default,
     }
 
-    super 'fetch', 'Download a gem and place it in the current directory', defaults
+    super "fetch", "Download a gem and place it in the current directory", defaults
 
     add_bulk_threshold_option
     add_proxy_option
@@ -24,13 +25,13 @@ class Gem::Commands::FetchCommand < Gem::Command
     add_platform_option
     add_prerelease_option
 
-    add_option '--[no-]suggestions', 'Suggest alternates when gems are not found' do |value, options|
+    add_option "--[no-]suggestions", "Suggest alternates when gems are not found" do |value, options|
       options[:suggest_alternate] = value
     end
   end
 
   def arguments # :nodoc:
-    'GEMNAME       name of gem to download'
+    "GEMNAME       name of gem to download"
   end
 
   def defaults_str # :nodoc:
@@ -52,8 +53,8 @@ then repackaging it.
   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 fetch 'my_gem:1.0.0' 'my_other_gem:~>2.0.0'`"
       terminate_interaction 1
@@ -62,6 +63,17 @@ then repackaging it.
 
   def execute
     check_version
+
+    exit_code = fetch_gems
+
+    terminate_interaction exit_code
+  end
+
+  private
+
+  def fetch_gems
+    exit_code = 0
+
     version = options[:version]
 
     platform  = Gem.platforms.last
@@ -85,10 +97,13 @@ then repackaging it.
 
       if spec.nil?
         show_lookup_failure gem_name, gem_version, errors, suppress_suggestions, options[:domain]
+        exit_code |= 2
         next
       end
       source.download spec
       say "Downloaded #{spec.full_name}"
     end
+
+    exit_code
   end
 end

data/lib/rubygems/commands/generate_index_command.rb

@@ -1,85 +1,51 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../indexer'
 
-##
-# Generates a index files for use as a gem server.
-#
-# See `gem help generate_index`
+require_relative "../command"
 
-class Gem::Commands::GenerateIndexCommand < Gem::Command
-  def initialize
-    super 'generate_index',
-          'Generates the index files for a gem server directory',
-          :directory => '.', :build_modern => true
+unless defined? Gem::Commands::GenerateIndexCommand
+  class Gem::Commands::GenerateIndexCommand < Gem::Command
+    module RubygemsTrampoline
+      def description # :nodoc:
+        <<~EOF
+          The generate_index command has been moved to the rubygems-generate_index gem.
+        EOF
+      end
 
-    add_option '-d', '--directory=DIRNAME',
-               'repository base dir containing gems subdir' do |dir, options|
-      options[:directory] = File.expand_path dir
-    end
+      def execute
+        alert_error "Install the rubygems-generate_index gem for the generate_index command"
+      end
 
-    add_option '--[no-]modern',
-               'Generate indexes for RubyGems',
-               '(always true)' do |value, options|
-      options[:build_modern] = value
+      def invoke_with_build_args(args, build_args)
+        name = "rubygems-generate_index"
+        spec = begin
+          Gem::Specification.find_by_name(name)
+        rescue Gem::LoadError
+          require "rubygems/dependency_installer"
+          Gem.install(name, Gem::Requirement.default, Gem::DependencyInstaller::DEFAULT_OPTIONS).find {|s| s.name == name }
+        end
+
+        # remove the methods defined in this file so that the methods defined in the gem are used instead,
+        # and without a method redefinition warning
+        %w[description execute invoke_with_build_args].each do |method|
+          RubygemsTrampoline.remove_method(method)
+        end
+        self.class.singleton_class.remove_method(:new)
+
+        spec.activate
+        Gem.load_plugin_files spec.matches_for_glob("rubygems_plugin#{Gem.suffix_pattern}")
+
+        self.class.new.invoke_with_build_args(args, build_args)
+      end
     end
+    private_constant :RubygemsTrampoline
 
-    deprecate_option('--modern', version: '4.0', extra_msg: 'Modern indexes (specs, latest_specs, and prerelease_specs) are always generated, so this option is not needed.')
-    deprecate_option('--no-modern', version: '4.0', extra_msg: 'The `--no-modern` option is currently ignored. Modern indexes (specs, latest_specs, and prerelease_specs) are always generated.')
-
-    add_option '--update',
-               'Update modern indexes with gems added',
-               'since the last update' do |value, options|
-      options[:update] = value
+    # remove_method(:initialize) warns, but removing new does not warn
+    def self.new
+      command = allocate
+      command.send(:initialize, "generate_index", "Generates the index files for a gem server directory (requires rubygems-generate_index)")
+      command
     end
-  end
-
-  def defaults_str # :nodoc:
-    "--directory . --modern"
-  end
-
-  def description # :nodoc:
-    <<-EOF
-The generate_index command creates a set of indexes for serving gems
-statically.  The command expects a 'gems' directory under the path given to
-the --directory option.  The given directory will be the directory you serve
-as the gem repository.
-
-For `gem generate_index --directory /path/to/repo`, expose /path/to/repo via
-your HTTP server configuration (not /path/to/repo/gems).
 
-When done, it will generate a set of files like this:
-
-  gems/*.gem                                   # .gem files you want to
-                                               # index
-
-  specs.<version>.gz                           # specs index
-  latest_specs.<version>.gz                    # latest specs index
-  prerelease_specs.<version>.gz                # prerelease specs index
-  quick/Marshal.<version>/<gemname>.gemspec.rz # Marshal quick index file
-
-The .rz extension files are compressed with the inflate algorithm.
-The Marshal version number comes from ruby's Marshal::MAJOR_VERSION and
-Marshal::MINOR_VERSION constants.  It is used to ensure compatibility.
-    EOF
-  end
-
-  def execute
-    # This is always true because it's the only way now.
-    options[:build_modern] = true
-
-    if not File.exist?(options[:directory]) or
-       not File.directory?(options[:directory])
-      alert_error "unknown directory name #{options[:directory]}."
-      terminate_interaction 1
-    else
-      indexer = Gem::Indexer.new options.delete(:directory), options
-
-      if options[:update]
-        indexer.update_index
-      else
-        indexer.generate_index
-      end
-    end
+    prepend(RubygemsTrampoline)
   end
 end

data/lib/rubygems/commands/help_command.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-require_relative '../command'
+
+require_relative "../command"
 
 class Gem::Commands::HelpCommand < Gem::Command
   # :stopdoc:
-  EXAMPLES = <<-EOF.freeze
+  EXAMPLES = <<-EOF
 Some examples of 'gem' usage.
 
 * Install 'rake', either from local directory or remote server:
@@ -52,13 +53,13 @@ Some examples of 'gem' usage.
     gem update --system
   EOF
 
-  GEM_DEPENDENCIES = <<-EOF.freeze
+  GEM_DEPENDENCIES = <<-EOF
 A gem dependencies file allows installation of a consistent set of gems across
 multiple environments.  The RubyGems implementation is designed to be
 compatible with Bundler's Gemfile format.  You can see additional
 documentation on the format at:
 
-  http://bundler.io
+  https://bundler.io
 
 RubyGems automatically looks for these gem dependencies files:
 
@@ -171,7 +172,7 @@ and #platforms methods:
 See the bundler Gemfile manual page for a list of platforms supported in a gem
 dependencies file.:
 
-  http://bundler.io/v1.6/man/gemfile.5.html
+  https://bundler.io/v2.5/man/gemfile.5.html
 
 Ruby Version and Engine Dependency
 ==================================
@@ -229,7 +230,7 @@ default.  This may be overridden with the :development_group option:
 
   EOF
 
-  PLATFORMS = <<-'EOF'.freeze
+  PLATFORMS = <<-'EOF'
 RubyGems platforms are composed of three parts, a CPU, an OS, and a
 version.  These values are taken from values in rbconfig.rb.  You can view
 your current platform by running `gem environment`.
@@ -268,7 +269,7 @@ Gem::Platform::CURRENT.  This will correctly mark the gem with your ruby's
 platform.
   EOF
 
-  # NOTE when updating also update Gem::Command::HELP
+  # NOTE: when updating also update Gem::Command::HELP
 
   SUBCOMMANDS = [
     ["commands",         :show_commands],
@@ -280,7 +281,7 @@ platform.
   # :startdoc:
 
   def initialize
-    super 'help', "Provide help on the 'gem' command"
+    super "help", "Provide help on the 'gem' command"
 
     @command_manager = Gem::CommandManager.instance
   end
@@ -323,16 +324,16 @@ platform.
 
     margin_width = 4
 
-    desc_width = @command_manager.command_names.map {|n| n.size }.max + 4
+    desc_width = @command_manager.command_names.map(&:size).max + 4
 
     summary_width = 80 - margin_width - desc_width
-    wrap_indent = ' ' * (margin_width + desc_width)
-    format = "#{' ' * margin_width}%-#{desc_width}s%s"
+    wrap_indent = " " * (margin_width + desc_width)
+    format = "#{" " * margin_width}%-#{desc_width}s%s"
 
     @command_manager.command_names.each do |cmd_name|
       command = @command_manager[cmd_name]
 
-      next if command.deprecated?
+      next if command&.deprecated?
 
       summary =
         if command
@@ -342,7 +343,7 @@ platform.
         end
 
       summary = wrap(summary, summary_width).split "\n"
-      out << sprintf(format, cmd_name, summary.shift)
+      out << format(format, cmd_name, summary.shift)
       until summary.empty? do
         out << "#{wrap_indent}#{summary.shift}"
       end
@@ -366,7 +367,7 @@ platform.
       command = @command_manager[possibilities.first]
       command.invoke("--help")
     elsif possibilities.size > 1
-      alert_warning "Ambiguous command #{command_name} (#{possibilities.join(', ')})"
+      alert_warning "Ambiguous command #{command_name} (#{possibilities.join(", ")})"
     else
       alert_warning "Unknown command #{command_name}. Try: gem help commands"
     end

data/lib/rubygems/commands/info_command.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require_relative '../command'
-require_relative '../query_utils'
+require_relative "../command"
+require_relative "../query_utils"
 
 class Gem::Commands::InfoCommand < Gem::Command
   include Gem::QueryUtils
 
   def initialize
     super "info", "Show information for the given gem",
-         :name => //, :domain => :local, :details => false, :versions => true,
-         :installed => nil, :version => Gem::Requirement.default
+         name: //, domain: :local, details: false, versions: true,
+         installed: nil, version: Gem::Requirement.default
 
     add_query_options
 
-    remove_option('-d')
+    remove_option("-d")
 
     defaults[:details] = true
     defaults[:exact] = true