Class: Bundler::LazySpecification

Inherits:
Object
  • Object
show all
Includes:
MatchPlatform
Defined in:
lib/bundler/lazy_specification.rb

Constant Summary

Constants included from GemHelpers

GemHelpers::GENERICS, GemHelpers::GENERIC_CACHE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MatchPlatform

#match_platform, platforms_match?

Methods included from GemHelpers

generic, generic_local_platform, local_platform, platform_specificity_match, same_deps, same_specificity, select_best_platform_match, sort_best_platform_match

Constructor Details

#initialize(name, version, platform, source = nil) ⇒ LazySpecification

Returns a new instance of LazySpecification.



10
11
12
13
14
15
16
 
# File 'lib/bundler/lazy_specification.rb', line 10

def initialize(name, version, platform, source = nil)
  @name          = name
  @version       = version
  @dependencies  = []
  @platform      = platform || Gem::Platform::RUBY
  @source        = source
end

Instance Attribute Details

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



7
8
9
 
# File 'lib/bundler/lazy_specification.rb', line 7

def dependencies
  @dependencies
end

#force_ruby_platform ⇒ Object

Returns the value of attribute force_ruby_platform.



8
9
10
 
# File 'lib/bundler/lazy_specification.rb', line 8

def force_ruby_platform
  @force_ruby_platform
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



7
8
9
 
# File 'lib/bundler/lazy_specification.rb', line 7

def name
  @name
end

#platform ⇒ Object (readonly)

Returns the value of attribute platform.



7
8
9
 
# File 'lib/bundler/lazy_specification.rb', line 7

def platform
  @platform
end

#remote ⇒ Object

Returns the value of attribute remote.



8
9
10
 
# File 'lib/bundler/lazy_specification.rb', line 8

def remote
  @remote
end

#source ⇒ Object

Returns the value of attribute source.



8
9
10
 
# File 'lib/bundler/lazy_specification.rb', line 8

def source
  @source
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



7
8
9
 
# File 'lib/bundler/lazy_specification.rb', line 7

def version
  @version
end

Instance Method Details

#==(other) ⇒ Object 



26
27
28
 
# File 'lib/bundler/lazy_specification.rb', line 26

def ==(other)
  identifier == other.identifier
end

#__materialize__(candidates, fallback_to_non_installable: Bundler.frozen_bundle?) ⇒ Object

If in frozen mode, we fallback to a non-installable candidate because by doing this we avoid re-resolving and potentially end up changing the lock file, which is not allowed. In that case, we will give a proper error about the mismatch higher up the stack, right before trying to install the bad gem.



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/bundler/lazy_specification.rb', line 106

def __materialize__(candidates, fallback_to_non_installable: Bundler.frozen_bundle?)
  search = candidates.reverse.find do |spec|
    spec.is_a?(StubSpecification) ||
      (spec.matches_current_ruby? &&
       spec.matches_current_rubygems?)
  end
  if search.nil? && fallback_to_non_installable
    search = candidates.last
  else
    search.dependencies = dependencies if search && search.full_name == full_name && (search.is_a?(RemoteSpecification) || search.is_a?(EndpointSpecification))
  end
  search
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/bundler/lazy_specification.rb', line 30

def eql?(other)
  identifier.eql?(other.identifier)
end

#full_name ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/bundler/lazy_specification.rb', line 18

def full_name
  if platform == Gem::Platform::RUBY
    "#{@name}-#{@version}"
  else
    "#{@name}-#{@version}-#{platform}"
  end
end

#git_version ⇒ Object 



132
133
134
135
 
# File 'lib/bundler/lazy_specification.rb', line 132

def git_version
  return unless source.is_a?(Bundler::Source::Git)
  " #{source.revision[0..6]}"
end

#hash ⇒ Object 



34
35
36
 
# File 'lib/bundler/lazy_specification.rb', line 34

def hash
  identifier.hash
end

#identifier ⇒ Object 



128
129
130
 
# File 'lib/bundler/lazy_specification.rb', line 128

def identifier
  @__identifier ||= [name, version, platform.to_s]
end

#materialize_for_installation ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/bundler/lazy_specification.rb', line 75

def materialize_for_installation
  source.local!

  matching_specs = source.specs.search(use_exact_resolved_specifications? ? self : [name, version])
  return self if matching_specs.empty?

  candidates = if use_exact_resolved_specifications?
    matching_specs
  else
    target_platform = ruby_platform_materializes_to_ruby_platform? ? platform : local_platform

    installable_candidates = GemHelpers.select_best_platform_match(matching_specs, target_platform)

    specification = __materialize__(installable_candidates, :fallback_to_non_installable => false)
    return specification unless specification.nil?

    if target_platform != platform
      installable_candidates = GemHelpers.select_best_platform_match(matching_specs, platform)
    end

    installable_candidates
  end

  __materialize__(candidates)
end

#satisfies?(dependency) ⇒ Boolean

Does this locked specification satisfy dependency?

NOTE: Rubygems default requirement is “>= 0”, which doesn’t match prereleases of 0 versions, like “0.0.0.dev” or “0.0.0.SNAPSHOT”. However, bundler users expect those to work. We need to make sure that Gemfile dependencies without explicit requirements (which use “>= 0” under the hood by default) are still valid for locked specs using this kind of versions. The method implements an ad-hoc fix for that. A better solution might be to change default rubygems requirement of dependencies to be “>= 0.A” but that’s a major refactoring likely to break things. Hopefully we can attempt it in the future.

Returns:

  • (Boolean) 


52
53
54
55
56
 
# File 'lib/bundler/lazy_specification.rb', line 52

def satisfies?(dependency)
  effective_requirement = dependency.requirement == Gem::Requirement.default ? Gem::Requirement.new(">= 0.A") : dependency.requirement

  @name == dependency.name && effective_requirement.satisfied_by?(Gem::Version.new(@version))
end

#to_lock ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bundler/lazy_specification.rb', line 58

def to_lock
  out = String.new

  if platform == Gem::Platform::RUBY
    out << "    #{name} (#{version})\n"
  else
    out << "    #{name} (#{version}-#{platform})\n"
  end

  dependencies.sort_by(&:to_s).uniq.each do |dep|
    next if dep.type == :development
    out << "    #{dep.to_lock}\n"
  end

  out
end

#to_s ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/bundler/lazy_specification.rb', line 120

def to_s
  @__to_s ||= if platform == Gem::Platform::RUBY
    "#{name} (#{version})"
  else
    "#{name} (#{version}-#{platform})"
  end
end