Class: Bundler::LazySpecification

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

Constant Summary

Constants included from GemHelpers

GemHelpers::GENERICS, GemHelpers::GENERIC_CACHE

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ForcePlatform

#default_force_ruby_platform

Methods included from MatchPlatform

#match_platform, platforms_match?

Methods included from GemHelpers

generic, generic_local_platform, generic_local_platform_is_ruby?, local_platform, platform_specificity_match, same_deps, same_specificity, select_best_local_platform_match, select_best_platform_match, sort_best_platform_match

Methods included from MatchMetadata

#matches_current_metadata?, #matches_current_ruby?, #matches_current_rubygems?

Constructor Details

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

Returns a new instance of LazySpecification.



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/bundler/lazy_specification.rb', line 24

def initialize(name, version, platform, source = nil)
  @name          = name
  @version       = version
  @dependencies  = []
  @required_ruby_version = Gem::Requirement.default
  @required_rubygems_version = Gem::Requirement.default
  @platform = platform || Gem::Platform::RUBY

  @original_source = source
  @source = source

  @force_ruby_platform = default_force_ruby_platform
end

Instance Attribute Details

#dependencies ⇒ Object Also known as: runtime_dependencies

Returns the value of attribute dependencies.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def dependencies
  @dependencies
end

#force_ruby_platform ⇒ Object

Returns the value of attribute force_ruby_platform.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def force_ruby_platform
  @force_ruby_platform
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



11
12
13
 
# File 'lib/bundler/lazy_specification.rb', line 11

def name
  @name
end

#platform ⇒ Object (readonly)

Returns the value of attribute platform.



11
12
13
 
# File 'lib/bundler/lazy_specification.rb', line 11

def platform
  @platform
end

#remote ⇒ Object

Returns the value of attribute remote.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def remote
  @remote
end

#required_ruby_version ⇒ Object

Returns the value of attribute required_ruby_version.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def required_ruby_version
  @required_ruby_version
end

#required_rubygems_version ⇒ Object

Returns the value of attribute required_rubygems_version.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def required_rubygems_version
  @required_rubygems_version
end

#source ⇒ Object

Returns the value of attribute source.



12
13
14
 
# File 'lib/bundler/lazy_specification.rb', line 12

def source
  @source
end

#version ⇒ Object (readonly)

Returns the value of attribute version.



11
12
13
 
# File 'lib/bundler/lazy_specification.rb', line 11

def version
  @version
end

Class Method Details

.from_spec(s) ⇒ Object 



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

def self.from_spec(s)
  lazy_spec = new(s.name, s.version, s.platform, s.source)
  lazy_spec.dependencies = s.dependencies
  lazy_spec.required_ruby_version = s.required_ruby_version
  lazy_spec.required_rubygems_version = s.required_rubygems_version
  lazy_spec
end

Instance Method Details

#==(other) ⇒ Object 



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

def ==(other)
  full_name == other.full_name
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.



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/bundler/lazy_specification.rb', line 133

def __materialize__(candidates, fallback_to_non_installable: Bundler.frozen_bundle?)
  search = candidates.reverse.find do |spec|
    spec.is_a?(StubSpecification) || spec.matches_current_metadata?
  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) 


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

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

#force_ruby_platform! ⇒ Object 



154
155
156
 
# File 'lib/bundler/lazy_specification.rb', line 154

def force_ruby_platform!
  @force_ruby_platform = true
end

#full_name ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/bundler/lazy_specification.rb', line 42

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

#git_version ⇒ Object 



149
150
151
152
 
# File 'lib/bundler/lazy_specification.rb', line 149

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

#hash ⇒ Object 



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

def hash
  full_name.hash
end

#lock_name ⇒ Object 



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

def lock_name
  @lock_name ||= name_tuple.lock_name
end

#materialize_for_installation ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/bundler/lazy_specification.rb', line 102

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

#name_tuple ⇒ Object 



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

def name_tuple
  Gem::NameTuple.new(@name, @version, @platform)
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) 


84
85
86
87
88
 
# File 'lib/bundler/lazy_specification.rb', line 84

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

#source_changed? ⇒ Boolean

Returns:

  • (Boolean) 


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

def source_changed?
  @original_source != source
end

#to_lock ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/bundler/lazy_specification.rb', line 90

def to_lock
  out = String.new
  out << "    #{lock_name}\n"

  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 



145
146
147
 
# File 'lib/bundler/lazy_specification.rb', line 145

def to_s
  lock_name
end