rubygems-update 3.3.18 → 3.4.19

data/lib/rubygems/commands/exec_command.rb

@@ -0,0 +1,249 @@
+# 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
+    gem_paths = { "GEM_HOME" => Gem.paths.home, "GEM_PATH" => Gem.paths.path.join(File::PATH_SEPARATOR), "GEM_SPEC_CACHE" => Gem.paths.spec_cache_dir }.compact
+
+    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!
+  ensure
+    ENV.update(gem_paths) if gem_paths
+    Gem.clear_paths
+  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 = File.join(Gem.dir, "gem_exec")
+
+    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
+
+    load Gem.activate_bin_path(contains_executable.first.name, exe, ">= 0.a")
+  ensure
+    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
@@ -10,10 +11,10 @@ class Gem::Commands::FetchCommand < Gem::Command
   def initialize
     defaults = {
       :suggest_alternate => true,
-      :version           => Gem::Requirement.default,
+      :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

data/lib/rubygems/commands/generate_index_command.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require_relative '../command'
-require_relative '../indexer'
+
+require_relative "../command"
+require_relative "../indexer"
 
 ##
 # Generates a index files for use as a gem server.
@@ -9,27 +10,27 @@ require_relative '../indexer'
 
 class Gem::Commands::GenerateIndexCommand < Gem::Command
   def initialize
-    super 'generate_index',
-          'Generates the index files for a gem server directory',
-          :directory => '.', :build_modern => true
+    super "generate_index",
+          "Generates the index files for a gem server directory",
+          :directory => ".", :build_modern => true
 
-    add_option '-d', '--directory=DIRNAME',
-               'repository base dir containing gems subdir' do |dir, options|
+    add_option "-d", "--directory=DIRNAME",
+               "repository base dir containing gems subdir" do |dir, options|
       options[:directory] = File.expand_path dir
     end
 
-    add_option '--[no-]modern',
-               'Generate indexes for RubyGems',
-               '(always true)' do |value, options|
+    add_option "--[no-]modern",
+               "Generate indexes for RubyGems",
+               "(always true)" do |value, options|
       options[:build_modern] = value
     end
 
-    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.')
+    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|
+    add_option "--update",
+               "Update modern indexes with gems added",
+               "since the last update" do |value, options|
       options[:update] = value
     end
   end
@@ -68,8 +69,8 @@ Marshal::MINOR_VERSION constants.  It is used to ensure compatibility.
     # 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])
+    if !File.exist?(options[:directory]) ||
+       !File.directory?(options[:directory])
       alert_error "unknown directory name #{options[:directory]}."
       terminate_interaction 1
     else

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,7 +53,7 @@ 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
@@ -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`.
@@ -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
@@ -326,7 +327,7 @@ platform.
     desc_width = @command_manager.command_names.map {|n| n.size }.max + 4
 
     summary_width = 80 - margin_width - desc_width
-    wrap_indent = ' ' * (margin_width + desc_width)
+    wrap_indent = " " * (margin_width + desc_width)
     format = "#{' ' * margin_width}%-#{desc_width}s%s"
 
     @command_manager.command_names.each do |cmd_name|

data/lib/rubygems/commands/info_command.rb

@@ -1,7 +1,7 @@
 # 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
@@ -13,7 +13,7 @@ class Gem::Commands::InfoCommand < Gem::Command
 
     add_query_options
 
-    remove_option('-d')
+    remove_option("-d")
 
     defaults[:details] = true
     defaults[:exact] = true

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,
+      :lock => true,
       :suggest_alternate => true,
-      :version           => Gem::Requirement.default,
-      :without_groups    => [],
+      :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
@@ -46,8 +49,8 @@ class Gem::Commands::InstallCommand < Gem::Command
 
   def defaults_str # :nodoc:
     "--both --version '#{Gem::Requirement.default}' --no-force\n" +
-    "--install-dir #{Gem.dir} --lock\n" +
-    install_update_defaults_str
+      "--install-dir #{Gem.dir} --lock\n" +
+      install_update_defaults_str
   end
 
   def description # :nodoc:
@@ -134,15 +137,15 @@ You can use `i` command instead of `install`.
   end
 
   def check_install_dir # :nodoc:
-    if options[:install_dir] and options[:user_install]
+    if options[:install_dir] && 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,7 +160,7 @@ 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
@@ -168,11 +171,13 @@ You can use `i` command instead of `install`.
 
     show_installed
 
+    say update_suggestion if eglible_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 +196,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)
 
@@ -247,11 +252,11 @@ 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:
@@ -270,7 +275,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,7 +10,7 @@ class Gem::Commands::ListCommand < Gem::Command
   include Gem::QueryUtils
 
   def initialize
-    super 'list', 'Display local gems whose name matches REGEXP',
+    super "list", "Display local gems whose name matches REGEXP",
          :domain => :local, :details => false, :versions => true,
          :installed => nil, :version => Gem::Requirement.default
 

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',
+    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

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