rubygems-update 2.6.0 → 3.4.22

data/lib/rubygems/commands/environment_command.rb

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
-require 'rubygems/command'
 
-class Gem::Commands::EnvironmentCommand < Gem::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:
     args = <<-EOF
-          packageversion  display the package version
-          gemdir          display the path where gems are installed
-          gempath         display path used to search for gems
+          home            display the path where gems are installed. Aliases: gemhome, gemdir, GEM_HOME
+          path            display path used to search for gems. Aliases: gempath, GEM_PATH
+          user_gemhome    display the path where gems are installed when `--user-install` is given. Aliases: user_gemdir
           version         display the gem format version
           remotesources   display the remote gem servers
           platform        display the supported gem platforms
           <omitted>       display everything
     EOF
-    return args.gsub(/^\s+/, '')
+    args.gsub(/^\s+/, "")
   end
 
   def description # :nodoc:
@@ -76,14 +76,14 @@ lib/rubygems/defaults/operating_system.rb
     arg = options[:args][0]
     out <<
       case arg
-      when /^packageversion/ then
-        Gem::RubyGemsPackageVersion
       when /^version/ then
         Gem::VERSION
       when /^gemdir/, /^gemhome/, /^home/, /^GEM_HOME/ then
         Gem.dir
       when /^gempath/, /^path/, /^GEM_PATH/ then
         Gem.path.join(File::PATH_SEPARATOR)
+      when /^user_gemdir/, /^user_gemhome/ then
+        Gem.user_dir
       when /^remotesources/ then
         Gem.sources.to_a.join("\n")
       when /^platform/ then
@@ -97,7 +97,7 @@ lib/rubygems/defaults/operating_system.rb
     true
   end
 
-  def add_path out, path
+  def add_path(out, path)
     path.each do |component|
       out << "     - #{component}\n"
     end
@@ -120,6 +120,8 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - RUBY EXECUTABLE: #{Gem.ruby}\n"
 
+    out << "  - GIT EXECUTABLE: #{git_path}\n"
+
     out << "  - EXECUTABLE DIRECTORY: #{Gem.bindir}\n"
 
     out << "  - SPEC CACHE DIRECTORY: #{Gem.spec_cache_dir}\n"
@@ -128,7 +130,7 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - RUBYGEMS PLATFORMS:\n"
     Gem.platforms.each do |platform|
-      out << "    - #{platform}\n"
+      out << "     - #{platform}\n"
     end
 
     out << "  - GEM PATHS:\n"
@@ -140,7 +142,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
 
@@ -151,10 +153,26 @@ 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
   end
 
+  private
+
+  ##
+  # Git binary path
+
+  def git_path
+    exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+    ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+      exts.each do |ext|
+        exe = File.join(path, "git#{ext}")
+        return exe if File.executable?(exe) && !File.directory?(exe)
+      end
+    end
+
+    nil
+  end
 end

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,15 +1,20 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/local_remote_options'
-require 'rubygems/version_option'
 
-class Gem::Commands::FetchCommand < Gem::Command
+require_relative "../command"
+require_relative "../local_remote_options"
+require_relative "../version_option"
 
+class Gem::Commands::FetchCommand < Gem::Command
   include Gem::LocalRemoteOptions
   include Gem::VersionOption
 
   def initialize
-    super 'fetch', 'Download a gem and place it in the current directory'
+    defaults = {
+      :suggest_alternate => true,
+      :version => Gem::Requirement.default,
+    }
+
+    super "fetch", "Download a gem and place it in the current directory", defaults
 
     add_bulk_threshold_option
     add_proxy_option
@@ -19,10 +24,14 @@ class Gem::Commands::FetchCommand < Gem::Command
     add_version_option
     add_platform_option
     add_prerelease_option
+
+    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:
@@ -43,36 +52,44 @@ then repackaging it.
     "#{program_name} GEMNAME [GEMNAME ...]"
   end
 
+  def check_version # :nodoc:
+    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
+    end
+  end
+
   def execute
-    version = options[:version] || Gem::Requirement.default
+    check_version
+    version = options[:version]
 
     platform  = Gem.platforms.last
-    gem_names = get_all_gem_names
+    gem_names = get_all_gem_names_and_versions
 
-    gem_names.each do |gem_name|
-      dep = Gem::Dependency.new gem_name, version
+    gem_names.each do |gem_name, gem_version|
+      gem_version ||= version
+      dep = Gem::Dependency.new gem_name, gem_version
       dep.prerelease = options[:prerelease]
+      suppress_suggestions = !options[:suggest_alternate]
 
       specs_and_sources, errors =
         Gem::SpecFetcher.fetcher.spec_for_dependency dep
 
-      if platform then
-        filtered = specs_and_sources.select { |s,| s.platform == platform }
+      if platform
+        filtered = specs_and_sources.select {|s,| s.platform == platform }
         specs_and_sources = filtered unless filtered.empty?
       end
 
-      spec, source = specs_and_sources.max_by { |s,| s.version }
+      spec, source = specs_and_sources.max_by {|s,| s }
 
-      if spec.nil? then
-        show_lookup_failure gem_name, version, errors, options[:domain]
+      if spec.nil?
+        show_lookup_failure gem_name, gem_version, errors, suppress_suggestions, options[:domain]
         next
       end
-
       source.download spec
-
       say "Downloaded #{spec.full_name}"
     end
   end
-
 end
-

data/lib/rubygems/commands/generate_index_command.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'rubygems/command'
-require 'rubygems/indexer'
+
+require_relative "../command"
+require_relative "../indexer"
 
 ##
 # Generates a index files for use as a gem server.
@@ -8,26 +9,28 @@ require 'rubygems/indexer'
 # See `gem help generate_index`
 
 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
 
-    add_option '--update',
-               'Update modern indexes with gems added',
-               'since the last update' do |value, options|
+    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
     end
   end
@@ -66,20 +69,18 @@ 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]) then
-      alert_error "unknown directory name #{directory}."
+    if !File.exist?(options[:directory]) ||
+       !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] then
+      if options[:update]
         indexer.update_index
       else
         indexer.generate_index
       end
     end
   end
-
 end
-

data/lib/rubygems/commands/help_command.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-require 'rubygems/command'
 
-class Gem::Commands::HelpCommand < Gem::Command
+require_relative "../command"
 
+class Gem::Commands::HelpCommand < Gem::Command
   # :stopdoc:
   EXAMPLES = <<-EOF
 Some examples of 'gem' usage.
@@ -38,7 +38,7 @@ Some examples of 'gem' usage.
 
 * Create a gem:
 
-    See http://guides.rubygems.org/make-your-own-gem/
+    See https://guides.rubygems.org/make-your-own-gem/
 
 * See information about RubyGems:
 
@@ -269,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],
@@ -277,11 +277,11 @@ platform.
     ["examples",         EXAMPLES],
     ["gem_dependencies", GEM_DEPENDENCIES],
     ["platforms",        PLATFORMS],
-  ]
+  ].freeze
   # :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
@@ -297,8 +297,8 @@ platform.
       begins? command, arg
     end
 
-    if help then
-      if Symbol === help then
+    if help
+      if Symbol === help
         send help
       else
         say help
@@ -306,10 +306,10 @@ platform.
       return
     end
 
-    if options[:help] then
+    if options[:help]
       show_help
 
-    elsif arg then
+    elsif arg
       show_command_help arg
 
     else
@@ -324,17 +324,19 @@ platform.
 
     margin_width = 4
 
-    desc_width = @command_manager.command_names.map { |n| n.size }.max + 4
+    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)
-    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?
+
       summary =
-        if command then
+        if command
           command.summary
         else
           "[No command found for #{cmd_name}]"
@@ -356,20 +358,18 @@ platform.
     say out.join("\n")
   end
 
-  def show_command_help command_name # :nodoc:
+  def show_command_help(command_name) # :nodoc:
     command_name = command_name.downcase
 
     possibilities = @command_manager.find_command_possibilities command_name
 
-    if possibilities.size == 1 then
+    if possibilities.size == 1
       command = @command_manager[possibilities.first]
       command.invoke("--help")
-    elsif possibilities.size > 1 then
-      alert_warning "Ambiguous command #{command_name} (#{possibilities.join(', ')})"
+    elsif possibilities.size > 1
+      alert_warning "Ambiguous command #{command_name} (#{possibilities.join(", ")})"
     else
-      alert_warning "Unknown command #{command_name}.  Try: gem help commands"
+      alert_warning "Unknown command #{command_name}. Try: gem help commands"
     end
   end
-
 end
-

data/lib/rubygems/commands/info_command.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+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
+
+    add_query_options
+
+    remove_option("-d")
+
+    defaults[:details] = true
+    defaults[:exact] = true
+  end
+
+  def description # :nodoc:
+    "Info prints information about the gem such as name,"\
+    " description, website, license and installed paths"
+  end
+
+  def usage # :nodoc:
+    "#{program_name} GEMNAME"
+  end
+
+  def arguments # :nodoc:
+    "GEMNAME        name of the gem to print information about"
+  end
+
+  def defaults_str
+    "--local"
+  end
+end