Class: Bundler::Resolver

Inherits:
Object
  • Object
show all
Includes:
GemHelpers
Defined in:
lib/bundler/resolver.rb,
lib/bundler/resolver/base.rb,
lib/bundler/resolver/root.rb,
lib/bundler/resolver/package.rb,
lib/bundler/resolver/candidate.rb,
lib/bundler/resolver/spec_group.rb,
lib/bundler/resolver/incompatibility.rb

Overview

This class implements the interface needed by PubGrub for resolution. It is equivalent to the `PubGrub::BasicPackageSource` class provided by PubGrub by default and used by the most simple PubGrub consumers.

Defined Under Namespace

Classes: Base, Candidate, Incompatibility, Package, Root, SpecGroup

Constant Summary

Constants included from GemHelpers

GemHelpers::GENERICS, GemHelpers::GENERIC_CACHE

Instance Method Summary collapse

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(source_requirements, base, gem_version_promoter, additional_base_requirements) ⇒ Resolver

Returns a new instance of Resolver.



19
20
21
22
23
 
# File 'lib/bundler/resolver.rb', line 19

def initialize(source_requirements, base, gem_version_promoter, additional_base_requirements)
  @source_requirements = source_requirements
  @base = Resolver::Base.new(base, additional_base_requirements)
  @gem_version_promoter = gem_version_promoter
end

Instance Method Details

#all_versions_for(package) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/bundler/resolver.rb', line 216

def all_versions_for(package)
  name = package.name
  results = (@base[name] + @all_specs[name]).uniq(&:full_name)
  locked_requirement = base_requirements[name]
  results = filter_matching_specs(results, locked_requirement) if locked_requirement

  versions = results.group_by(&:version).reduce([]) do |groups, (version, specs)|
    platform_specs = package.platforms.flat_map {|platform| select_best_platform_match(specs, platform) }
    next groups if platform_specs.empty?

    ruby_specs = select_best_platform_match(specs, Gem::Platform::RUBY)
    groups << Resolver::Candidate.new(version, :specs => ruby_specs) if ruby_specs.any?

    next groups if platform_specs == ruby_specs

    groups << Resolver::Candidate.new(version, :specs => platform_specs)

    groups
  end

  sort_versions(package, versions)
end

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
163
164
165
166
 
# File 'lib/bundler/resolver.rb', line 160

def debug?
  ENV["BUNDLER_DEBUG_RESOLVER"] ||
    ENV["BUNDLER_DEBUG_RESOLVER_TREE"] ||
    ENV["DEBUG_RESOLVER"] ||
    ENV["DEBUG_RESOLVER_TREE"] ||
    false
end

#incompatibilities_for(package, version) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/bundler/resolver.rb', line 168

def incompatibilities_for(package, version)
  package_deps = @cached_dependencies[package]
  sorted_versions = @sorted_versions[package]
  package_deps[version].map do |dep_package, dep_constraint|
    if package == dep_package
      cause = PubGrub::Incompatibility::CircularDependency.new(dep_package, dep_constraint.constraint_string)
      return [PubGrub::Incompatibility.new([PubGrub::Term.new(dep_constraint, true)], :cause => cause)]
    end

    low = high = sorted_versions.index(version)

    # find version low such that all >= low share the same dep
    while low > 0 && package_deps[sorted_versions[low - 1]][dep_package] == dep_constraint
      low -= 1
    end
    low =
      if low == 0
        nil
      else
        sorted_versions[low]
      end

    # find version high such that all < high share the same dep
    while high < sorted_versions.length && package_deps[sorted_versions[high]][dep_package] == dep_constraint
      high += 1
    end
    high =
      if high == sorted_versions.length
        nil
      else
        sorted_versions[high]
      end

    range = PubGrub::VersionRange.new(:min => low, :max => high, :include_min => true)

    self_constraint = PubGrub::VersionConstraint.new(package, :range => range)

    dep_term = PubGrub::Term.new(dep_constraint, false)
    self_term = PubGrub::Term.new(self_constraint, true)

    custom_explanation = if dep_package.meta? && package.root?
      "current #{dep_package} version is #{dep_constraint.constraint_string}"
    end

    PubGrub::Incompatibility.new([self_term, dep_term], :cause => :dependency, :custom_explanation => custom_explanation)
  end
end

#name_for_explicit_dependency_source ⇒ Object 



243
244
245
246
247
 
# File 'lib/bundler/resolver.rb', line 243

def name_for_explicit_dependency_source
  Bundler.default_gemfile.basename.to_s
rescue StandardError
  "Gemfile"
end

#no_versions_incompatibility_for(package, unsatisfied_term) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bundler/resolver.rb', line 137

def no_versions_incompatibility_for(package, unsatisfied_term)
  cause = PubGrub::Incompatibility::NoVersions.new(unsatisfied_term)
  name = package.name
  constraint = unsatisfied_term.constraint
  constraint_string = constraint.constraint_string
  requirements = constraint_string.split(" OR ").map {|req| Gem::Requirement.new(req.split(",")) }

  if name == "bundler"
    custom_explanation = "the current Bundler version (#{Bundler::VERSION}) does not satisfy #{constraint}"
    extended_explanation = bundler_not_found_message(requirements)
  else
    specs_matching_other_platforms = filter_matching_specs(@all_specs[name], requirements)

    platforms_explanation = specs_matching_other_platforms.any? ? " for any resolution platforms (#{package.platforms.join(", ")})" : ""
    custom_explanation = "#{constraint} could not be found in #{repository_for(package)}#{platforms_explanation}"

    label = "#{name} (#{constraint_string})"
    extended_explanation = other_specs_matching_message(specs_matching_other_platforms, label) if specs_matching_other_platforms.any?
  end

  Incompatibility.new([unsatisfied_term], :cause => cause, :custom_explanation => custom_explanation, :extended_explanation => extended_explanation)
end

#parse_dependency(package, dependency) ⇒ Object 



121
122
123
124
125
126
127
128
129
 
# File 'lib/bundler/resolver.rb', line 121

def parse_dependency(package, dependency)
  range = if repository_for(package).is_a?(Source::Gemspec)
    PubGrub::VersionRange.any
  else
    requirement_to_range(dependency)
  end

  PubGrub::VersionConstraint.new(package, :range => range)
end

#raise_not_found!(package) ⇒ Object

Raises:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/bundler/resolver.rb', line 249

def raise_not_found!(package)
  name = package.name
  source = source_for(name)
  specs = @all_specs[name]
  matching_part = name
  requirement_label = SharedHelpers.pretty_dependency(package.dependency)
  cache_message = begin
                      " or in gems cached in #{Bundler.settings.app_cache_path}" if Bundler.app_cache.exist?
                    rescue GemfileNotFound
                      nil
                    end
  specs_matching_requirement = filter_matching_specs(specs, package.dependency.requirement)

  if specs_matching_requirement.any?
    specs = specs_matching_requirement
    matching_part = requirement_label
    platforms = package.platforms
    platform_label = platforms.size == 1 ? "platform '#{platforms.first}" : "platforms '#{platforms.join("', '")}"
    requirement_label = "#{requirement_label}' with #{platform_label}"
  end

  message = String.new("Could not find gem '#{requirement_label}' in #{source}#{cache_message}.\n")

  if specs.any?
    message << "\n#{other_specs_matching_message(specs, matching_part)}"
  end

  raise GemNotFound, message
end

#setup_solver ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/bundler/resolver.rb', line 40

def setup_solver
  root = Resolver::Root.new(name_for_explicit_dependency_source)
  root_version = Resolver::Candidate.new(0)

  @all_specs = Hash.new do |specs, name|
    specs[name] = source_for(name).specs.search(name).sort_by {|s| [s.version, s.platform.to_s] }
  end

  @sorted_versions = Hash.new do |candidates, package|
    candidates[package] = if package.root?
      [root_version]
    else
      all_versions_for(package).sort
    end
  end

  root_dependencies = prepare_dependencies(@requirements, @packages)

  @cached_dependencies = Hash.new do |dependencies, package|
    dependencies[package] = if package.root?
      { root_version => root_dependencies }
    else
      Hash.new do |versions, version|
        versions[version] = to_dependency_hash(version.dependencies, @packages)
      end
    end
  end

  logger = Bundler::UI::Shell.new
  logger.level = debug? ? "debug" : "warn"

  [root, logger]
end

#solve_versions(root:, logger:) ⇒ Object 



74
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/bundler/resolver.rb', line 74

def solve_versions(root:, logger:)
  solver = PubGrub::VersionSolver.new(:source => self, :root => root, :logger => logger)
  result = solver.solve
  result.map {|package, version| version.to_specs(package) }.flatten.uniq
rescue PubGrub::SolveFailure => e
  incompatibility = e.incompatibility

  names_to_unlock = []
  extended_explanation = nil

  while incompatibility.conflict?
    cause = incompatibility.cause
    incompatibility = cause.incompatibility

    incompatibility.terms.each do |term|
      name = term.package.name
      names_to_unlock << name if base_requirements[name]

      no_versions_incompat = [cause.incompatibility, cause.satisfier].find {|incompat| incompat.cause.is_a?(PubGrub::Incompatibility::NoVersions) }
      next unless no_versions_incompat

      extended_explanation = no_versions_incompat.extended_explanation
    end
  end

  names_to_unlock.uniq!

  if names_to_unlock.any?
    Bundler.ui.debug "Found conflicts with locked dependencies. Retrying with #{names_to_unlock.join(", ")} unlocked...", true

    @base.unlock_names(names_to_unlock)

    root, logger = setup_solver

    retry
  end

  explanation = e.message

  if extended_explanation
    explanation << "\n\n"
    explanation << extended_explanation
  end

  raise SolveFailure.new(explanation)
end

#source_for(name) ⇒ Object 



239
240
241
 
# File 'lib/bundler/resolver.rb', line 239

def source_for(name)
  @source_requirements[name] || @source_requirements[:default]
end

#start(requirements, packages, exclude_specs: []) ⇒ Object 



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

def start(requirements, packages, exclude_specs: [])
  exclude_specs.each do |spec|
    remove_from_candidates(spec)
  end

  @requirements = requirements
  @packages = packages

  root, logger = setup_solver

  Bundler.ui.info "Resolving dependencies...", true

  solve_versions(:root => root, :logger => logger)
end

#versions_for(package, range = VersionRange.any) ⇒ Object 



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

def versions_for(package, range=VersionRange.any)
  versions = range.select_versions(@sorted_versions[package])

  sort_versions(package, versions)
end