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.

[View source]

18
19
20
21
22
23
24
25
26
27
28
 
# 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)
  @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

[View source]

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

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

#consider_prereleases! ⇒ Object

[View source]

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

def consider_prereleases!
  @prerelease = :consider_last
end

#consider_remote_versions! ⇒ Object

[View source]

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

def consider_remote_versions!
  @prefer_local = false
end

#current_platform? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def current_platform?
  @dependency.current_platform?
end

#force_ruby_platform? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def force_ruby_platform?
  @dependency.force_ruby_platform
end

#hash ⇒ Object

[View source]

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

def hash
  @name.hash
end

#ignores_prereleases? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def ignores_prereleases?
  @prerelease == :ignore
end

#meta? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

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

#platform_specs(specs) ⇒ Object

[View source]

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

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

#prefer_local? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def prefer_local?
  @prefer_local
end

#prerelease_specified? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def prerelease_specified?
  @prerelease == :consider_first
end

#root? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def root?
  false
end

#to_s ⇒ Object

[View source]

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

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

#top_level? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

def top_level?
  @top_level
end

#unlock? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

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

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