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
17
# 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
  @specification = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &blk) ⇒ Object (private)



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

def method_missing(method, *args, &blk)
  raise "LazySpecification has not been materialized yet (calling :#{method} #{args.inspect})" unless @specification

  return super unless respond_to?(method)

  @specification.send(method, *args, &blk)
end

Instance Attribute Details

#dependenciesObject (readonly)

Returns the value of attribute dependencies.



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

def dependencies
  @dependencies
end

#force_ruby_platformObject

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

#nameObject (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#platformObject (readonly)

Returns the value of attribute platform.



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

def platform
  @platform
end

#remoteObject

Returns the value of attribute remote.



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

def remote
  @remote
end

#sourceObject

Returns the value of attribute source.



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

def source
  @source
end

#versionObject (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



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

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

#__materialize__(candidates) ⇒ Object



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/bundler/lazy_specification.rb', line 94

def __materialize__(candidates)
  @specification = begin
    search = candidates.reverse.find do |spec|
      spec.is_a?(StubSpecification) ||
        (spec.matches_current_ruby? &&
          spec.matches_current_rubygems?)
    end
    if search.nil? && Bundler.frozen_bundle?
      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
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)


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

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

#full_nameObject



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

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

#git_versionObject



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

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

#hashObject



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

def hash
  identifier.hash
end

#identifierObject



122
123
124
# File 'lib/bundler/lazy_specification.rb', line 122

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

#materialize_for_installationObject



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/bundler/lazy_specification.rb', line 76

def materialize_for_installation
  source.local!

  candidates = if source.is_a?(Source::Path) || !ruby_platform_materializes_to_ruby_platform?
    target_platform = ruby_platform_materializes_to_ruby_platform? ? platform : local_platform

    source.specs.search(Dependency.new(name, version)).select do |spec|
      MatchPlatform.platforms_match?(spec.platform, target_platform)
    end
  else
    source.specs.search(self)
  end

  return self if candidates.empty?

  __materialize__(candidates)
end

#respond_to?(*args) ⇒ Boolean

Returns:

  • (Boolean)


110
111
112
# File 'lib/bundler/lazy_specification.rb', line 110

def respond_to?(*args)
  super || @specification ? @specification.respond_to?(*args) : nil
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)


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

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_lockObject



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

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_sObject



114
115
116
117
118
119
120
# File 'lib/bundler/lazy_specification.rb', line 114

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