Class: Bundler::Resolver::Package

Inherits:
Object
  • Object
show all
Defined in:
lib/bundler/resolver/package.rb

Overview

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

Direct Known Subclasses

Root

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, platforms, locked_specs:, unlock:, prerelease: false, prefer_local: false, dependency: nil, new_platforms: []) ⇒ Package

Returns a new instance of Package.



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/bundler/resolver/package.rb', line 18

def initialize(name, platforms, locked_specs:, unlock:, prerelease: false, prefer_local: false, dependency: nil, new_platforms: [])
  @name = name
  @platforms = platforms
  @locked_version = locked_specs.version_for(name)
  @unlock = unlock
  @dependency = dependency || Dependency.new(name, @locked_version)
  @platforms |= [Gem::Platform::RUBY] if @dependency.default_force_ruby_platform
  @top_level = !dependency.nil?
  @prerelease = @dependency.prerelease? || @locked_version&.prerelease? || prerelease ? :consider_first : :ignore
  @prefer_local = prefer_local
  @new_platforms = new_platforms
end

Instance Attribute Details

#dependency ⇒ Object (readonly)

Returns the value of attribute dependency.



16
17
18
 
# File 'lib/bundler/resolver/package.rb', line 16

def dependency
  @dependency
end

#locked_version ⇒ Object (readonly)

Returns the value of attribute locked_version.



16
17
18
 
# File 'lib/bundler/resolver/package.rb', line 16

def locked_version
  @locked_version
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



16
17
18
 
# File 'lib/bundler/resolver/package.rb', line 16

def name
  @name
end

#platforms ⇒ Object (readonly)

Returns the value of attribute platforms.



16
17
18
 
# File 'lib/bundler/resolver/package.rb', line 16

def platforms
  @platforms
end

Instance Method Details

#==(other) ⇒ Object 



54
55
56
 
# File 'lib/bundler/resolver/package.rb', line 54

def ==(other)
  self.class == other.class && @name == other.name
end

#consider_prereleases! ⇒ Object 



74
75
76
 
# File 'lib/bundler/resolver/package.rb', line 74

def consider_prereleases!
  @prerelease = :consider_last
end

#consider_remote_versions! ⇒ Object 



82
83
84
 
# File 'lib/bundler/resolver/package.rb', line 82

def consider_remote_versions!
  @prefer_local = false
end

#current_platform? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/bundler/resolver/package.rb', line 90

def current_platform?
  @dependency.current_platform?
end

#force_ruby_platform? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/bundler/resolver/package.rb', line 86

def force_ruby_platform?
  @dependency.force_ruby_platform
end

#hash ⇒ Object 



58
59
60
 
# File 'lib/bundler/resolver/package.rb', line 58

def hash
  @name.hash
end

#ignores_prereleases? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/bundler/resolver/package.rb', line 66

def ignores_prereleases?
  @prerelease == :ignore
end

#meta? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/bundler/resolver/package.rb', line 50

def meta?
  @name.end_with?("\0")
end

#platform_specs(specs) ⇒ Object 



31
32
33
34
35
36
 
# File 'lib/bundler/resolver/package.rb', line 31

def platform_specs(specs)
  platforms.map do |platform|
    prefer_locked = @new_platforms.include?(platform) ? false : !unlock?
    MatchPlatform.select_best_platform_match(specs, platform, prefer_locked: prefer_locked)
  end
end

#prefer_local? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/bundler/resolver/package.rb', line 78

def prefer_local?
  @prefer_local
end

#prerelease_specified? ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/bundler/resolver/package.rb', line 70

def prerelease_specified?
  @prerelease == :consider_first
end

#root? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/bundler/resolver/package.rb', line 42

def root?
  false
end

#to_s ⇒ Object 



38
39
40
 
# File 'lib/bundler/resolver/package.rb', line 38

def to_s
  @name.delete("\0")
end

#top_level? ⇒ Boolean

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/bundler/resolver/package.rb', line 46

def top_level?
  @top_level
end

#unlock? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/bundler/resolver/package.rb', line 62

def unlock?
  @unlock == true || @unlock.include?(name)
end