rubygems-update 3.5.5 → 3.6.9

data/{POLICIES.md → doc/rubygems/POLICIES.md}

@@ -65,6 +65,59 @@ Bundler:
     have to work on weekends.
 *   Continue with the regular release process below.
 
+### Branching
+
+Bundler releases are synchronized with rubygems releases at the moment. That
+means that releases for both share the same stable branch, and they should
+generally happen together.
+
+The current conventional naming for stable branches is `x+1.y`, where `x.y` is
+the version of `bundler` that will be released. This is because `rubygems-x+1.y`
+will be released at the same time.
+
+For example, `rubygems-3.2.0` and `bundler-2.2.0` were both released from the
+`3.2` stable branch.
+
+Once a stable branch has been cut from `master`, changes for that minor release
+series are only made _intentionally_, via patch releases. That is to say,
+changes to `master` by default _won't_ make their way into the current stable
+branch, and development on `master` will be targeting the next minor
+or major release.
+
+There is a `bin/rake prepare_release[<target_rubygems_version>]` rake task
+that helps with creating a release. It takes a single argument, the _exact
+rubygems release_ being made (e.g.  `3.2.3` when releasing bundler `2.2.3`).
+This task checks out the appropriate stable branch (`3.2`, for example), grabs
+all merged but unreleased PRs from both bundler & rubygems from GitHub that are
+compatible with the target release level, and then cherry-picks those changes
+(and only those changes) to a new branch based off the stable branch. Then bumps
+the version in all version files, synchronizes both changelogs to include all
+backported changes and commits that change on top of the cherry-picks.
+
+Note that this task requires all user facing pull requests to be tagged with
+specific labels. See [Merging a PR](../bundler/playbooks/MERGING_A_PR.md) for details.
+
+Also note that when this task cherry-picks, it cherry-picks the merge commits
+using the following command:
+
+```bash
+$ git cherry-pick -m 1 MERGE_COMMIT_SHAS
+```
+
+For example, for PR [#5029](https://github.com/rubygems/bundler/pull/5029), we
+cherry picked commit [dd6aef9](https://github.com/rubygems/bundler/commit/dd6aef97a5f2e7173f406267256a8c319d6134ab),
+not [4fe9291](https://github.com/rubygems/bundler/commit/4fe92919f51e3463f0aad6fa833ab68044311f03)
+using:
+
+```bash
+$ git cherry-pick -m 1 dd6aef9
+```
+
+After running the task, you'll have a release branch ready to be merged into the
+stable branch. You'll want to open a PR from this branch into the stable branch
+and provided CI is green, you can go ahead, merge the PR and run release tasks
+as specified below from the updated stable branch.
+
 ### Automatic changelog and backport generation
 
 PR labels and titles are used to automatically generate changelogs for patch and
@@ -85,35 +138,51 @@ backporting a PR generates conflicts that are solved by backporting another PR
 with no user visible changes. You can use these special labels to also backport
 the other PR and not get any conflicts.
 
+### Breaking changes
+
+Bundler cares a lot about preserving compatibility. As a result, changes that
+break backwards compatibility should (whenever this is possible) include a feature
+release that is backwards compatible, and issue warnings for all options and
+behaviors that will change.
+
+We only release major breaking changes when incrementing the _major_ version of
+Bundler and RubyGems. However, experience shows that almost every single part of
+Bundler and RubyGems is depended on by someone in ways hard to anticipate. So if
+we were strict about breaking changes we'd need to hold on from making progress
+a lot, or continuously increment the major version, emptying "really major"
+versions from their meaning. Because of this, we also may release "small"
+breaking changes in minor releases. "Small" here means that we expect them to
+affect only very few users in rare cases.
+
 ### Steps for patch releases
 
 *   Confirm all PRs that you want backported are properly tagged with `rubygems:
     <type>` or `bundler: <type>` labels at GitHub.
-*   Run `rake prepare_release[<target_version>]`. This will create a PR to the
-    stable branch with the backports included in the release, and proper
-    changelogs and version bumps. It will also create a PR to merge release
-    changelogs into master.
+*   Run `bin/rake prepare_release[<target_rubygems_version>]`. This will create
+    a PR to the stable branch with the backports included in the release, and
+    proper changelogs and version bumps. It will also create a PR to merge
+    release changelogs into master.
 *   Once CI passes, merge the release PR, switch to the stable branch and pull
     the PR just merged.
-*   Release `bundler` with `rake bundler:release`.
-*   Release `rubygems` with `rake release`.
+*   Release `bundler` with `bin/rake bundler:release`.
+*   Release `rubygems` with `bin/rake release`.
 
 ### Steps for minor and major releases
 
 *   Confirm all PRs that you want listed in changelogs are properly tagged with
     `rubygems: <type>` or `bundler: <type>` labels at GitHub.
-*   Run `rake prepare_release[<target_version>]`. This will create a new stable
-    branch off the master branch, and create a PR to it with the proper version
-    bumps and changelogs. It will also create a PR to merge release changelogs
-    into master.
+*   Run `bin/rake prepare_release[<target_rubygems_version>]`. This will create
+    a new stable branch off the master branch, and create a PR to it with the
+    proper version bumps and changelogs. It will also create a PR to merge
+    release changelogs into master.
 *   Replace the stable branch in the workflows with the new stable branch, and
     push that change to the release PR.
 *   Replace version numbers with the next ".dev" version, and push that change
     to the master PR.
 *   Once CI passes, merge the release PR, switch to  the stable branch and pull
     the PR just merged.
-*   Release `bundler` with `rake bundler:release`.
-*   Release `rubygems` with `rake release`.
+*   Release `bundler` with `bin/rake bundler:release`.
+*   Release `rubygems` with `bin/rake release`.
 
 ## Committer Access
 

data/exe/update_rubygems

@@ -34,5 +34,5 @@ else
   update_dir = File.dirname(update_dir)
   Dir.chdir update_dir
   ENV["GEM_PREV_VER"] = Gem::VERSION
-  abort unless system(Gem.ruby, "setup.rb", *ARGV)
+  abort unless system(Gem.ruby, "--disable-gems", "setup.rb", *ARGV)
 end

data/lib/rubygems/basic_specification.rb

@@ -71,11 +71,7 @@ class Gem::BasicSpecification
   # Return true if this spec can require +file+.
 
   def contains_requirable_file?(file)
-    if @ignored
-      return false
-    elsif missing_extensions?
-      @ignored = true
-
+    if ignored?
       if platform == Gem::Platform::RUBY || Gem::Platform.local === platform
         warn "Ignoring #{full_name} because its extensions are not built. " \
              "Try: gem pristine #{name} --version #{version}"
@@ -93,11 +89,34 @@ class Gem::BasicSpecification
     end
   end
 
+  ##
+  # Return true if this spec should be ignored because it's missing extensions.
+
+  def ignored?
+    return @ignored unless @ignored.nil?
+
+    @ignored = missing_extensions?
+  end
+
   def default_gem?
-    loaded_from &&
+    !loaded_from.nil? &&
       File.dirname(loaded_from) == Gem.default_specifications_dir
   end
 
+  ##
+  # Regular gems take precedence over default gems
+
+  def default_gem_priority
+    default_gem? ? 1 : -1
+  end
+
+  ##
+  # Gems higher up in +gem_path+ take precedence
+
+  def base_dir_priority(gem_path)
+    gem_path.index(base_dir) || gem_path.size
+  end
+
   ##
   # Returns full path to the directory where gem's extensions are installed.
 
@@ -115,7 +134,6 @@ class Gem::BasicSpecification
   end
 
   def find_full_gem_path # :nodoc:
-    # TODO: also, shouldn't it default to full_name if it hasn't been written?
     File.expand_path File.join(gems_dir, full_name)
   end
 
@@ -123,10 +141,10 @@ class Gem::BasicSpecification
 
   ##
   # The full path to the gem (install path + full name).
+  #
+  # TODO: This is duplicated with #gem_dir. Eventually either of them should be deprecated.
 
   def full_gem_path
-    # TODO: This is a heavily used method by gems, so we'll need
-    # to aleast just alias it to #gem_dir rather than remove it.
     @full_gem_path ||= find_full_gem_path
   end
 
@@ -143,6 +161,19 @@ class Gem::BasicSpecification
     end
   end
 
+  ##
+  # Returns the full name of this Gem (see `Gem::BasicSpecification#full_name`).
+  # Information about where the gem is installed is also included if not
+  # installed in the default GEM_HOME.
+
+  def full_name_with_location
+    if base_dir != Gem.dir
+      "#{full_name} in #{base_dir}"
+    else
+      full_name
+    end
+  end
+
   ##
   # Full paths in the gem to add to <code>$LOAD_PATH</code> when this gem is
   # activated.
@@ -189,9 +220,11 @@ class Gem::BasicSpecification
   ##
   # Returns the full path to this spec's gem directory.
   # eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0
+  #
+  # TODO: This is duplicated with #full_gem_path. Eventually either of them should be deprecated.
 
   def gem_dir
-    @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
+    @gem_dir ||= find_full_gem_path
   end
 
   ##

data/lib/rubygems/bundler_version_finder.rb

@@ -21,7 +21,7 @@ module Gem::BundlerVersionFinder
   end
 
   def self.bundle_update_bundler_version
-    return unless File.basename($0) == "bundle"
+    return unless ["bundle", "bundler"].include? File.basename($0)
     return unless "update".start_with?(ARGV.first || " ")
     bundler_version = nil
     update_index = nil

data/lib/rubygems/command.rb

@@ -6,7 +6,7 @@
 # See LICENSE.txt for permissions.
 #++
 
-require_relative "optparse"
+require_relative "vendored_optparse"
 require_relative "requirement"
 require_relative "user_interaction"
 
@@ -650,9 +650,6 @@ RubyGems is a package manager for Ruby.
     gem help platforms           gem platforms guide
     gem help <COMMAND>           show help on COMMAND
                                    (e.g. 'gem help install')
-    gem server                   present a web page at
-                                 http://localhost:8808/
-                                 with info about installed gems
   Further information:
     https://guides.rubygems.org
   HELP

data/lib/rubygems/command_manager.rb

@@ -60,6 +60,7 @@ class Gem::CommandManager
     :push,
     :query,
     :rdoc,
+    :rebuild,
     :search,
     :server,
     :signin,
@@ -106,7 +107,7 @@ class Gem::CommandManager
   # Register all the subcommands supported by the gem command.
 
   def initialize
-    require_relative "timeout"
+    require_relative "vendored_timeout"
     @commands = {}
 
     BUILTIN_COMMANDS.each do |name|
@@ -229,18 +230,16 @@ class Gem::CommandManager
   def load_and_instantiate(command_name)
     command_name = command_name.to_s
     const_name = command_name.capitalize.gsub(/_(.)/) { $1.upcase } << "Command"
-    load_error = nil
 
     begin
       begin
         require "rubygems/commands/#{command_name}_command"
-      rescue LoadError => e
-        load_error = e
+      rescue LoadError
+        # it may have been defined from a rubygems_plugin.rb file
       end
+
       Gem::Commands.const_get(const_name).new
     rescue StandardError => e
-      e = load_error if load_error
-
       alert_error clean_text("Loading command: #{command_name} (#{e.class})\n\t#{e}")
       ui.backtrace e
     end

data/lib/rubygems/commands/build_command.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require_relative "../command"
+require_relative "../gemspec_helpers"
 require_relative "../package"
 require_relative "../version_option"
 
 class Gem::Commands::BuildCommand < Gem::Command
   include Gem::VersionOption
+  include Gem::GemspecHelpers
 
   def initialize
     super "build", "Build a gem from a gemspec"
@@ -75,17 +77,6 @@ Gems can be saved to a specified filename with the output option:
 
   private
 
-  def find_gemspec(glob = "*.gemspec")
-    gemspecs = Dir.glob(glob).sort
-
-    if gemspecs.size > 1
-      alert_error "Multiple gemspecs found: #{gemspecs}, please specify one"
-      terminate_interaction(1)
-    end
-
-    gemspecs.first
-  end
-
   def build_gem
     gemspec = resolve_gem_name
 

data/lib/rubygems/commands/cleanup_command.rb

@@ -38,8 +38,6 @@ class Gem::Commands::CleanupCommand < Gem::Command
     @default_gems    = []
     @full            = nil
     @gems_to_cleanup = nil
-    @original_home   = nil
-    @original_path   = nil
     @primary_gems    = nil
   end
 
@@ -95,9 +93,6 @@ If no gems are named all gems in GEM_HOME are cleaned.
   end
 
   def clean_gems
-    @original_home = Gem.dir
-    @original_path = Gem.path
-
     get_primary_gems
     get_candidate_gems
     get_gems_to_cleanup
@@ -112,17 +107,15 @@ If no gems are named all gems in GEM_HOME are cleaned.
     deps.reverse_each do |spec|
       uninstall_dep spec
     end
-
-    Gem::Specification.reset
   end
 
   def get_candidate_gems
     @candidate_gems = if options[:args].empty?
       Gem::Specification.to_a
     else
-      options[:args].map do |gem_name|
+      options[:args].flat_map do |gem_name|
         Gem::Specification.find_all_by_name gem_name
-      end.flatten
+      end
     end
   end
 
@@ -133,7 +126,7 @@ If no gems are named all gems in GEM_HOME are cleaned.
 
     default_gems, gems_to_cleanup = gems_to_cleanup.partition(&:default_gem?)
 
-    uninstall_from = options[:user_install] ? Gem.user_dir : @original_home
+    uninstall_from = options[:user_install] ? Gem.user_dir : Gem.dir
 
     gems_to_cleanup = gems_to_cleanup.select do |spec|
       spec.base_dir == uninstall_from
@@ -181,8 +174,5 @@ If no gems are named all gems in GEM_HOME are cleaned.
       say "Unable to uninstall #{spec.full_name}:"
       say "\t#{e.class}: #{e.message}"
     end
-  ensure
-    # Restore path Gem::Uninstaller may have changed
-    Gem.use_paths @original_home, *@original_path
   end
 end

data/lib/rubygems/commands/contents_command.rb

@@ -102,15 +102,22 @@ prefix or only the files that are requireable.
   end
 
   def files_in_default_gem(spec)
-    spec.files.map do |file|
-      case file
-      when %r{\A#{spec.bindir}/}
-        # $' is POSTMATCH
-        [RbConfig::CONFIG["bindir"], $']
-      when /\.so\z/
-        [RbConfig::CONFIG["archdir"], file]
+    spec.files.filter_map do |file|
+      if file.start_with?("#{spec.bindir}/")
+        [RbConfig::CONFIG["bindir"], file.delete_prefix("#{spec.bindir}/")]
       else
-        [RbConfig::CONFIG["rubylibdir"], file]
+        gem spec.name, spec.version
+
+        require_path = spec.require_paths.find do |path|
+          file.start_with?("#{path}/")
+        end
+
+        requirable_part = file.delete_prefix("#{require_path}/")
+
+        resolve = $LOAD_PATH.resolve_feature_path(requirable_part)&.last
+        next unless resolve
+
+        [resolve.delete_suffix(requirable_part), requirable_part]
       end
     end
   end
@@ -182,8 +189,8 @@ prefix or only the files that are requireable.
   end
 
   def specification_directories # :nodoc:
-    options[:specdirs].map do |i|
+    options[:specdirs].flat_map do |i|
       [i, File.join(i, "specifications")]
-    end.flatten
+    end
   end
 end

data/lib/rubygems/commands/environment_command.rb

@@ -15,6 +15,7 @@ class Gem::Commands::EnvironmentCommand < Gem::Command
           version         display the gem format version
           remotesources   display the remote gem servers
           platform        display the supported gem platforms
+          credentials     display the path where credentials are stored
           <omitted>       display everything
     EOF
     args.gsub(/^\s+/, "")
@@ -88,6 +89,8 @@ lib/rubygems/defaults/operating_system.rb
         Gem.sources.to_a.join("\n")
       when /^platform/ then
         Gem.platforms.join(File::PATH_SEPARATOR)
+      when /^credentials/, /^creds/ then
+        Gem.configuration.credentials_path
       when nil then
         show_environment
       else
@@ -114,6 +117,8 @@ lib/rubygems/defaults/operating_system.rb
 
     out << "  - USER INSTALLATION DIRECTORY: #{Gem.user_dir}\n"
 
+    out << "  - CREDENTIALS FILE: #{Gem.configuration.credentials_path}\n"
+
     out << "  - RUBYGEMS PREFIX: #{Gem.prefix}\n" unless Gem.prefix.nil?
 
     out << "  - RUBY EXECUTABLE: #{Gem.ruby}\n"

data/lib/rubygems/commands/exec_command.rb

@@ -57,8 +57,6 @@ to the same gem path as user-installed gems.
   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
@@ -74,9 +72,6 @@ to the same gem path as user-installed gems.
     end
 
     load!
-  ensure
-    ENV.update(gem_paths) if gem_paths
-    Gem.clear_paths
   end
 
   private
@@ -143,7 +138,7 @@ to the same gem path as user-installed gems.
   end
 
   def set_gem_exec_install_paths
-    home = File.join(Gem.dir, "gem_exec")
+    home = Gem.dir
 
     ENV["GEM_PATH"] = ([home] + Gem.path).join(File::PATH_SEPARATOR)
     ENV["GEM_HOME"] = home
@@ -200,7 +195,7 @@ to the same gem path as user-installed gems.
     argv = ARGV.clone
     ARGV.replace options[:args]
 
-    exe = executable = options[:executable]
+    executable = options[:executable]
 
     contains_executable = Gem.loaded_specs.values.select do |spec|
       spec.executables.include?(executable)
@@ -211,13 +206,22 @@ to the same gem path as user-installed gems.
     end
 
     if contains_executable.empty?
-      if (spec = Gem.loaded_specs[executable]) && (exe = spec.executable)
-        contains_executable << spec
-      else
+      spec = Gem.loaded_specs[executable]
+
+      if spec.nil? || spec.executables.empty?
         alert_error "Failed to load executable `#{executable}`," \
               " are you sure the gem `#{options[:gem_name]}` contains it?"
         terminate_interaction 1
       end
+
+      if spec.executables.size > 1
+        alert_error "Ambiguous which executable from gem `#{executable}` should be run: " \
+              "the options are #{spec.executables.sort}, specify one via COMMAND, and use `-g` and `-v` to specify gem and version"
+        terminate_interaction 1
+      end
+
+      contains_executable << spec
+      executable = spec.executable
     end
 
     if contains_executable.size > 1
@@ -227,8 +231,11 @@ to the same gem path as user-installed gems.
       terminate_interaction 1
     end
 
-    load Gem.activate_bin_path(contains_executable.first.name, exe, ">= 0.a")
+    old_exe = $0
+    $0 = executable
+    load Gem.activate_bin_path(contains_executable.first.name, executable, ">= 0.a")
   ensure
+    $0 = old_exe if old_exe
     ARGV.replace argv
   end
 

data/lib/rubygems/commands/fetch_command.rb

@@ -63,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
@@ -86,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/help_command.rb

@@ -59,7 +59,7 @@ 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:
 
@@ -172,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
 ==================================

data/lib/rubygems/commands/install_command.rb

@@ -224,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})"