class Bundler::Resolver::Candidate

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.

Attributes

version[R]

Public Class Methods

new(version, specs: []) click to toggle source

# File bundler/resolver/candidate.rb, line 27
def initialize(version, specs: [])
  @spec_group = Resolver::SpecGroup.new(specs)
  @platforms = specs.map(&:platform).sort_by(&:to_s).uniq
  @version = Gem::Version.new(version)
  @ruby_only = @platforms == [Gem::Platform::RUBY]
end

Public Instance Methods

<=>(other) click to toggle source

# File bundler/resolver/candidate.rb, line 60
def <=>(other)
  return unless other.is_a?(self.class)
  return @version <=> other.version unless canonical? && other.canonical?

  sort_obj <=> other.sort_obj
end

==(other) click to toggle source

# File bundler/resolver/candidate.rb, line 67
def ==(other)
  return unless other.is_a?(self.class)
  return @version == other.version unless canonical? && other.canonical?

  sort_obj == other.sort_obj
end

canonical?() click to toggle source

# File bundler/resolver/candidate.rb, line 56
def canonical?
  !@spec_group.empty?
end

dependencies() click to toggle source

# File bundler/resolver/candidate.rb, line 34
def dependencies
  @spec_group.dependencies
end

eql?(other) click to toggle source

# File bundler/resolver/candidate.rb, line 74
def eql?(other)
  return unless other.is_a?(self.class)
  return @version.eql?(other.version) unless canonical? || other.canonical?

  sort_obj.eql?(other.sort_obj)
end

hash() click to toggle source

# File bundler/resolver/candidate.rb, line 81
def hash
  sort_obj.hash
end

prerelease?() click to toggle source

# File bundler/resolver/candidate.rb, line 44
def prerelease?
  @version.prerelease?
end

segments() click to toggle source

# File bundler/resolver/candidate.rb, line 48
def segments
  @version.segments
end

sort_obj() click to toggle source

# File bundler/resolver/candidate.rb, line 52
def sort_obj
  [@version, @ruby_only ? -1 : 1]
end

to_s() click to toggle source

# File bundler/resolver/candidate.rb, line 85
def to_s
  return @version.to_s if @platforms.empty? || @ruby_only

  "#{@version} (#{@platforms.join(", ")})"
end

to_specs(package) click to toggle source

# File bundler/resolver/candidate.rb, line 38
def to_specs(package)
  return [] if package.meta?

  @spec_group.to_specs(package.force_ruby_platform?)
end