bundler 2.2.16 → 2.4.19

data/lib/bundler/plugin.rb

@@ -13,8 +13,9 @@ module Bundler
     class MalformattedPlugin < PluginError; end
     class UndefinedCommandError < PluginError; end
     class UnknownSourceError < PluginError; end
+    class PluginInstallError < PluginError; end
 
-    PLUGIN_FILE_NAME = "plugins.rb".freeze
+    PLUGIN_FILE_NAME = "plugins.rb"
 
     module_function
 
@@ -35,15 +36,16 @@ module Bundler
     # @param [Hash] options various parameters as described in description.
     #               Refer to cli/plugin for available options
     def install(names, options)
+      raise InvalidOption, "You cannot specify `--branch` and `--ref` at the same time." if options["branch"] && options["ref"]
+
       specs = Installer.new.install(names, options)
 
       save_plugins names, specs
-    rescue PluginError => e
+    rescue PluginError
       specs_to_delete = specs.select {|k, _v| names.include?(k) && !index.commands.values.include?(k) }
       specs_to_delete.each_value {|spec| Bundler.rm_rf(spec.full_gem_path) }
 
-      names_list = names.map {|name| "`#{name}`" }.join(", ")
-      Bundler.ui.error "Failed to install the following plugins: #{names_list}. The underlying error was: #{e.message}.\n #{e.backtrace.join("\n ")}"
+      raise
     end
 
     # Uninstalls plugins by the given names
@@ -164,7 +166,7 @@ module Bundler
     end
 
     # To be called from Cli class to pass the command and argument to
-    # approriate plugin class
+    # appropriate plugin class
     def exec_command(command, args)
       raise UndefinedCommandError, "Command `#{command}` not found" unless command? command
 
@@ -183,7 +185,7 @@ module Bundler
       !index.source_plugin(name.to_s).nil?
     end
 
-    # @return [Class] that handles the source. The calss includes API::Source
+    # @return [Class] that handles the source. The class includes API::Source
     def source(name)
       raise UnknownSourceError, "Source #{name} not found" unless source? name
 
@@ -245,10 +247,11 @@ module Bundler
     # @param [Array<String>] names of inferred source plugins that can be ignored
     def save_plugins(plugins, specs, optional_plugins = [])
       plugins.each do |name|
+        next if index.installed?(name)
+
         spec = specs[name]
-        validate_plugin! Pathname.new(spec.full_gem_path)
-        installed = register_plugin(name, spec, optional_plugins.include?(name))
-        Bundler.ui.info "Installed plugin #{name}" if installed
+
+        save_plugin(name, spec, optional_plugins.include?(name))
       end
     end
 
@@ -263,6 +266,22 @@ module Bundler
       raise MalformattedPlugin, "#{PLUGIN_FILE_NAME} was not found in the plugin." unless plugin_file.file?
     end
 
+    # Validates and registers a plugin.
+    #
+    # @param [String] name the name of the plugin
+    # @param [Specification] spec of installed plugin
+    # @param [Boolean] optional_plugin, removed if there is conflict with any
+    #                     other plugin (used for default source plugins)
+    #
+    # @raise [PluginInstallError] if validation or registration raises any error
+    def save_plugin(name, spec, optional_plugin = false)
+      validate_plugin! Pathname.new(spec.full_gem_path)
+      installed = register_plugin(name, spec, optional_plugin)
+      Bundler.ui.info "Installed plugin #{name}" if installed
+    rescue PluginError => e
+      raise PluginInstallError, "Failed to install plugin `#{spec.name}`, due to #{e.class} (#{e.message})"
+    end
+
     # Runs the plugins.rb file in an isolated namespace, records the plugin
     # actions it registers for and then passes the data to index to be stored.
     #
@@ -309,6 +328,8 @@ module Bundler
     #
     # @param [String] name of the plugin
     def load_plugin(name)
+      return unless name && !name.empty?
+
       # Need to ensure before this that plugin root where the rest of gems
       # are installed to be on load path to support plugin deps. Currently not
       # done to avoid conflicts

data/lib/bundler/process_lock.rb

@@ -12,7 +12,7 @@ module Bundler
         yield
         f.flock(File::LOCK_UN)
       end
-    rescue Errno::EACCES, Errno::ENOLCK, *[SharedHelpers.const_get_safely(:ENOTSUP, Errno)].compact
+    rescue Errno::EACCES, Errno::ENOLCK, Errno::ENOTSUP, Errno::EPERM, Errno::EROFS
       # In the case the user does not have access to
       # create the lock file or is using NFS where
       # locks are not available we skip locking.

data/lib/bundler/remote_specification.rb

@@ -6,6 +6,7 @@ module Bundler
   # be seeded with what we're given from the source's abbreviated index - the
   # full specification will only be fetched when necessary.
   class RemoteSpecification
+    include MatchRemoteMetadata
     include MatchPlatform
     include Comparable
 
@@ -16,7 +17,8 @@ module Bundler
     def initialize(name, version, platform, spec_fetcher)
       @name         = name
       @version      = Gem::Version.create version
-      @platform     = platform
+      @original_platform = platform || Gem::Platform::RUBY
+      @platform     = Gem::Platform.new(platform)
       @spec_fetcher = spec_fetcher
       @dependencies = nil
     end
@@ -28,10 +30,10 @@ module Bundler
     end
 
     def full_name
-      if platform == Gem::Platform::RUBY || platform.nil?
+      @full_name ||= if @platform == Gem::Platform::RUBY
         "#{@name}-#{@version}"
       else
-        "#{@name}-#{@version}-#{platform}"
+        "#{@name}-#{@version}-#{@platform}"
       end
     end
 
@@ -98,9 +100,9 @@ module Bundler
     end
 
     def _remote_specification
-      @_remote_specification ||= @spec_fetcher.fetch_spec([@name, @version, @platform])
+      @_remote_specification ||= @spec_fetcher.fetch_spec([@name, @version, @original_platform])
       @_remote_specification || raise(GemspecError, "Gemspec data for #{full_name} was" \
-        " missing from the server! Try installing with `--full-index` as a workaround.")
+        " missing from the server!")
     end
 
     def method_missing(method, *args, &blk)

data/lib/bundler/resolver/base.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative "package"
+
+module Bundler
+  class Resolver
+    class Base
+      attr_reader :packages, :requirements, :source_requirements
+
+      def initialize(source_requirements, dependencies, base, platforms, options)
+        @source_requirements = source_requirements
+
+        @base = base
+
+        @packages = Hash.new do |hash, name|
+          hash[name] = Package.new(name, platforms, **options)
+        end
+
+        @requirements = dependencies.map do |dep|
+          dep_platforms = dep.gem_platforms(platforms)
+
+          # Dependencies scoped to external platforms are ignored
+          next if dep_platforms.empty?
+
+          name = dep.name
+
+          @packages[name] = Package.new(name, dep_platforms, **options.merge(:dependency => dep))
+
+          dep
+        end.compact
+      end
+
+      def [](name)
+        @base[name]
+      end
+
+      def delete(specs)
+        @base.delete(specs)
+      end
+
+      def get_package(name)
+        @packages[name]
+      end
+
+      def base_requirements
+        @base_requirements ||= build_base_requirements
+      end
+
+      def unlock_names(names)
+        indirect_pins = indirect_pins(names)
+
+        if indirect_pins.any?
+          loosen_names(indirect_pins)
+        else
+          pins = pins(names)
+
+          if pins.any?
+            loosen_names(pins)
+          else
+            unrestrict_names(names)
+          end
+        end
+      end
+
+      def include_prereleases(names)
+        names.each do |name|
+          get_package(name).consider_prereleases!
+        end
+      end
+
+      private
+
+      def indirect_pins(names)
+        names.select {|name| @base_requirements[name].exact? && @requirements.none? {|dep| dep.name == name } }
+      end
+
+      def pins(names)
+        names.select {|name| @base_requirements[name].exact? }
+      end
+
+      def loosen_names(names)
+        names.each do |name|
+          version = @base_requirements[name].requirements.first[1]
+
+          @base_requirements[name] = Gem::Requirement.new(">= #{version}")
+
+          @base.delete_by_name(name)
+        end
+      end
+
+      def unrestrict_names(names)
+        names.each do |name|
+          @base_requirements.delete(name)
+        end
+      end
+
+      def build_base_requirements
+        base_requirements = {}
+        @base.each do |ls|
+          req = Gem::Requirement.new(ls.version)
+          base_requirements[ls.name] = req
+        end
+        base_requirements
+      end
+    end
+  end
+end

data/lib/bundler/resolver/candidate.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative "spec_group"
+
+module Bundler
+  class Resolver
+    #
+    # This class is a PubGrub compatible "Version" class that takes Bundler
+    # resolution complexities into account.
+    #
+    # Each Resolver::Candidate has a underlying `Gem::Version` plus a set of
+    # platforms. For example, 1.1.0-x86_64-linux is a different resolution candidate
+    # from 1.1.0 (generic). This is because different platform variants of the
+    # same gem version can bring different dependencies, so they need to be
+    # considered separately.
+    #
+    # Some candidates may also keep some information explicitly about the
+    # package the refer to. These candidates are referred to as "canonical" and
+    # are used when materializing resolution results back into RubyGems
+    # specifications that can be installed, written to lock files, and so on.
+    #
+    class Candidate
+      include Comparable
+
+      attr_reader :version
+
+      def initialize(version, specs: [])
+        @spec_group = Resolver::SpecGroup.new(specs)
+        @version = Gem::Version.new(version)
+        @ruby_only = specs.map(&:platform).uniq == [Gem::Platform::RUBY]
+      end
+
+      def dependencies
+        @spec_group.dependencies
+      end
+
+      def to_specs(package)
+        return [] if package.meta?
+
+        @spec_group.to_specs(package.force_ruby_platform?)
+      end
+
+      def generic!
+        @ruby_only = true
+
+        self
+      end
+
+      def platform_specific!
+        @ruby_only = false
+
+        self
+      end
+
+      def prerelease?
+        @version.prerelease?
+      end
+
+      def segments
+        @version.segments
+      end
+
+      def sort_obj
+        [@version, @ruby_only ? -1 : 1]
+      end
+
+      def <=>(other)
+        return unless other.is_a?(self.class)
+
+        sort_obj <=> other.sort_obj
+      end
+
+      def ==(other)
+        return unless other.is_a?(self.class)
+
+        sort_obj == other.sort_obj
+      end
+
+      def eql?(other)
+        return unless other.is_a?(self.class)
+
+        sort_obj.eql?(other.sort_obj)
+      end
+
+      def hash
+        sort_obj.hash
+      end
+
+      def to_s
+        @version.to_s
+      end
+    end
+  end
+end

data/lib/bundler/resolver/incompatibility.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Bundler
+  class Resolver
+    class Incompatibility < PubGrub::Incompatibility
+      attr_reader :extended_explanation
+
+      def initialize(terms, cause:, custom_explanation: nil, extended_explanation: nil)
+        @extended_explanation = extended_explanation
+
+        super(terms, :cause => cause, :custom_explanation => custom_explanation)
+      end
+    end
+  end
+end

data/lib/bundler/resolver/package.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Bundler
+  class Resolver
+    #
+    # Represents a gem being resolved, in a format PubGrub likes.
+    #
+    # The class holds the following information:
+    #
+    # * Platforms this gem will be resolved on.
+    # * The locked version of this gem resolution should favor (if any).
+    # * Whether the gem should be unlocked to its latest version.
+    # * The dependency explicit set in the Gemfile for this gem (if any).
+    #
+    class Package
+      attr_reader :name, :platforms, :dependency, :locked_version
+
+      def initialize(name, platforms, locked_specs:, unlock:, prerelease: false, dependency: nil)
+        @name = name
+        @platforms = platforms
+        @locked_version = locked_specs[name].first&.version
+        @unlock = unlock
+        @dependency = dependency || Dependency.new(name, @locked_version)
+        @prerelease = @dependency.prerelease? || @locked_version&.prerelease? || prerelease ? :consider_first : :ignore
+      end
+
+      def to_s
+        @name.delete("\0")
+      end
+
+      def root?
+        false
+      end
+
+      def meta?
+        @name.end_with?("\0")
+      end
+
+      def ==(other)
+        self.class == other.class && @name == other.name
+      end
+
+      def hash
+        @name.hash
+      end
+
+      def unlock?
+        @unlock.empty? || @unlock.include?(name)
+      end
+
+      def ignores_prereleases?
+        @prerelease == :ignore
+      end
+
+      def prerelease_specified?
+        @prerelease == :consider_first
+      end
+
+      def consider_prereleases!
+        @prerelease = :consider_last
+      end
+
+      def force_ruby_platform?
+        @dependency.force_ruby_platform
+      end
+
+      def current_platform?
+        @dependency.current_platform?
+      end
+    end
+  end
+end

data/lib/bundler/resolver/root.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "package"
+
+module Bundler
+  class Resolver
+    #
+    # Represents the Gemfile from the resolver's perspective. It's the root
+    # package and Gemfile entries depend on it.
+    #
+    class Root < Package
+      def initialize(name)
+        @name = name
+      end
+
+      def meta?
+        true
+      end
+
+      def root?
+        true
+      end
+    end
+  end
+end

data/lib/bundler/resolver/spec_group.rb

@@ -3,131 +3,79 @@
 module Bundler
   class Resolver
     class SpecGroup
-      attr_accessor :name, :version, :source
-      attr_accessor :activated_platforms
-
-      def self.create_for(specs, all_platforms, specific_platform)
-        specific_platform_specs = specs[specific_platform]
-        return unless specific_platform_specs.any?
-
-        platforms = all_platforms.select {|p| specs[p].any? }
-
-        new(specific_platform_specs.first, specs, platforms)
-      end
-
-      def initialize(exemplary_spec, specs, relevant_platforms)
-        @exemplary_spec = exemplary_spec
-        @name = exemplary_spec.name
-        @version = exemplary_spec.version
-        @source = exemplary_spec.source
-
-        @all_platforms = relevant_platforms
-        @activated_platforms = relevant_platforms
-        @dependencies = Hash.new do |dependencies, platforms|
-          dependencies[platforms] = dependencies_for(platforms)
-        end
-        @partitioned_dependency_names = Hash.new do |partitioned_dependency_names, platforms|
-          partitioned_dependency_names[platforms] = partitioned_dependency_names_for(platforms)
-        end
+      def initialize(specs)
         @specs = specs
       end
 
-      def to_specs
-        activated_platforms.map do |p|
-          specs = @specs[p]
-          next unless specs.any?
-
-          specs.map do |s|
-            lazy_spec = LazySpecification.new(name, version, s.platform, source)
-            lazy_spec.dependencies.replace s.dependencies
-            lazy_spec
-          end
-        end.flatten.compact.uniq
-      end
-
-      def activate_platform!(platform)
-        self.activated_platforms = [platform]
+      def empty?
+        @specs.empty?
       end
 
-      def activate_all_platforms!
-        self.activated_platforms = @all_platforms
-      end
-
-      def to_s
-        activated_platforms_string = sorted_activated_platforms.join(", ")
-        "#{name} (#{version}) (#{activated_platforms_string})"
+      def name
+        @name ||= exemplary_spec.name
       end
 
-      def dependencies_for_activated_platforms
-        @dependencies[activated_platforms]
+      def version
+        @version ||= exemplary_spec.version
       end
 
-      def partitioned_dependency_names_for_activated_platforms
-        @partitioned_dependency_names[activated_platforms]
+      def source
+        @source ||= exemplary_spec.source
       end
 
-      def ==(other)
-        return unless other.is_a?(SpecGroup)
-        name == other.name &&
-          version == other.version &&
-          sorted_activated_platforms == other.sorted_activated_platforms &&
-          source == other.source
+      def to_specs(force_ruby_platform)
+        @specs.map do |s|
+          lazy_spec = LazySpecification.new(name, version, s.platform, source)
+          lazy_spec.force_ruby_platform = force_ruby_platform
+          lazy_spec.dependencies.replace s.dependencies
+          lazy_spec
+        end
       end
 
-      def eql?(other)
-        return unless other.is_a?(SpecGroup)
-        name.eql?(other.name) &&
-          version.eql?(other.version) &&
-          sorted_activated_platforms.eql?(other.sorted_activated_platforms) &&
-          source.eql?(other.source)
+      def to_s
+        sorted_spec_names.join(", ")
       end
 
-      def hash
-        name.hash ^ version.hash ^ sorted_activated_platforms.hash ^ source.hash
+      def dependencies
+        @dependencies ||= @specs.map do |spec|
+          __dependencies(spec) + metadata_dependencies(spec)
+        end.flatten.uniq
       end
 
       protected
 
-      def sorted_activated_platforms
-        activated_platforms.sort_by(&:to_s)
+      def sorted_spec_names
+        @sorted_spec_names ||= @specs.map(&:full_name).sort
       end
 
       private
 
-      def dependencies_for(platforms)
-        platforms.map do |platform|
-          __dependencies(platform) + metadata_dependencies(platform)
-        end.flatten
+      def exemplary_spec
+        @specs.first
       end
 
-      def partitioned_dependency_names_for(platforms)
-        return @dependencies[platforms].map(&:name), [] if platforms.size == 1
-
-        @dependencies[platforms].partition do |dep_proxy|
-          @dependencies[platforms].count {|dp| dp.dep == dep_proxy.dep } == platforms.size
-        end.map {|deps| deps.map(&:name) }
-      end
-
-      def __dependencies(platform)
+      def __dependencies(spec)
         dependencies = []
-        @specs[platform].first.dependencies.each do |dep|
+        spec.dependencies.each do |dep|
           next if dep.type == :development
-          dependencies << DepProxy.get_proxy(dep, platform)
+          dependencies << Dependency.new(dep.name, dep.requirement)
         end
         dependencies
       end
 
-      def metadata_dependencies(platform)
-        spec = @specs[platform].first
-        return [] unless spec.is_a?(Gem::Specification)
-        dependencies = []
-        if !spec.required_ruby_version.nil? && !spec.required_ruby_version.none?
-          dependencies << DepProxy.get_proxy(Gem::Dependency.new("Ruby\0", spec.required_ruby_version), platform)
-        end
-        if !spec.required_rubygems_version.nil? && !spec.required_rubygems_version.none?
-          dependencies << DepProxy.get_proxy(Gem::Dependency.new("RubyGems\0", spec.required_rubygems_version), platform)
-        end
-        dependencies
+      def metadata_dependencies(spec)
+        return [] if spec.is_a?(LazySpecification)
+
+        [
+          metadata_dependency("Ruby", spec.required_ruby_version),
+          metadata_dependency("RubyGems", spec.required_rubygems_version),
+        ].compact
+      end
+
+      def metadata_dependency(name, requirement)
+        return if requirement.nil? || requirement.none?
+
+        Dependency.new("#{name}\0", requirement)
       end
     end
   end