Class: Bundler::Resolver::Candidate

Inherits:

Object

• Object
• Bundler::Resolver::Candidate

Includes:

Comparable

Defined in:

lib/bundler/resolver/candidate.rb

Overview

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 they 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.

Instance Attribute Summary

• #version ⇒ Object readonly

  Returns the value of attribute version.

Instance Method Summary

• #<=>(other) ⇒ Object
• #==(other) ⇒ Object
• #dependencies ⇒ Object
• #eql?(other) ⇒ Boolean
• #hash ⇒ Object
• #initialize(version, group: nil, priority: -1)) ⇒ Candidate constructor

  A new instance of Candidate.

• #prerelease? ⇒ Boolean
• #segments ⇒ Object
• #sort_obj ⇒ Object
• #to_s ⇒ Object
• #to_specs(package, most_specific_locked_platform) ⇒ Object

Constructor Details

#initialize(version, group: nil, priority: -1)) ⇒ Candidate

Returns a new instance of Candidate.

# File 'lib/bundler/resolver/candidate.rb', line 27

def initialize(version, group: nil, priority: -1)
  @spec_group = group || SpecGroup.new([])
  @version = Gem::Version.new(version)
  @priority = priority
end

Instance Attribute Details

#version ⇒ Object (readonly)

Returns the value of attribute version.

# File 'lib/bundler/resolver/candidate.rb', line 25

def version
  @version
end

Instance Method Details

#<=>(other) ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 55

def <=>(other)
  return unless other.is_a?(self.class)

  sort_obj <=> other.sort_obj
end

#==(other) ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 61

def ==(other)
  return unless other.is_a?(self.class)

  sort_obj == other.sort_obj
end

#dependencies ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 33

def dependencies
  @spec_group.dependencies
end

#eql?(other) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/bundler/resolver/candidate.rb', line 67

def eql?(other)
  return unless other.is_a?(self.class)

  sort_obj.eql?(other.sort_obj)
end

#hash ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 73

def hash
  sort_obj.hash
end

#prerelease? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/bundler/resolver/candidate.rb', line 43

def prerelease?
  @version.prerelease?
end

#segments ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 47

def segments
  @version.segments
end

#sort_obj ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 51

def sort_obj
  [@version, @priority]
end

#to_s ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 77

def to_s
  @version.to_s
end

#to_specs(package, most_specific_locked_platform) ⇒ Object

# File 'lib/bundler/resolver/candidate.rb', line 37

def to_specs(package, most_specific_locked_platform)
  return [] if package.meta?

  @spec_group.to_specs(package.force_ruby_platform?, most_specific_locked_platform)
end