Class: Bundler::Resolver

Inherits:
Object
  • Object
show all
Includes:
Molinillo::SpecificationProvider, Molinillo::UI
Defined in:
lib/bundler/resolver.rb

Defined Under Namespace

Classes: SpecGroup

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Molinillo::SpecificationProvider

#allow_missing?

Methods included from Molinillo::UI

#output, #progress_rate

Constructor Details

#initialize(index, source_requirements, base, gem_version_promoter, additional_base_requirements, platforms) ⇒ Resolver



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/bundler/resolver.rb', line 195

def initialize(index, source_requirements, base, gem_version_promoter, additional_base_requirements, platforms)
  @index = index
  @source_requirements = source_requirements
  @base = base
  @resolver = Molinillo::Resolver.new(self, self)
  @search_for = {}
  @base_dg = Molinillo::DependencyGraph.new
  @base.each do |ls|
    dep = Dependency.new(ls.name, ls.version)
    @base_dg.add_vertex(ls.name, DepProxy.new(dep, ls.platform), true)
  end
  additional_base_requirements.each {|d| @base_dg.add_vertex(d.name, d) }
  @platforms = platforms
  @gem_version_promoter = gem_version_promoter
end

Class Method Details

.resolve(requirements, index, source_requirements = {}, base = [], gem_version_promoter = GemVersionPromoter.new, additional_base_requirements = [], platforms = nil) ⇒ Object

Figures out the best possible configuration of gems that satisfies the list of passed dependencies and any child dependencies without causing any gem activation errors.

Parameters

*dependencies<Gem::Dependency>

The list of dependencies to resolve

Returns

<GemBundle>,nil

If the list of dependencies can be resolved, a

collection of gemspecs is returned. Otherwise, nil is returned.


187
188
189
190
191
192
193
# File 'lib/bundler/resolver.rb', line 187

def self.resolve(requirements, index, source_requirements = {}, base = [], gem_version_promoter = GemVersionPromoter.new, additional_base_requirements = [], platforms = nil)
  platforms = Set.new(platforms) if platforms
  base = SpecSet.new(base) unless base.is_a?(SpecSet)
  resolver = new(index, source_requirements, base, gem_version_promoter, additional_base_requirements, platforms)
  result = resolver.start(requirements)
  SpecSet.new(result)
end

Instance Method Details

#after_resolutionObject



249
250
251
# File 'lib/bundler/resolver.rb', line 249

def after_resolution
  Bundler.ui.info ""
end

#before_resolutionObject



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

def before_resolution
  Bundler.ui.info "Resolving dependencies...", debug?
end

#debug(depth = 0) ⇒ void

This method returns an undefined value.

Conveys debug information to the user.



233
234
235
236
237
238
# File 'lib/bundler/resolver.rb', line 233

def debug(depth = 0)
  return unless debug?
  debug_info = yield
  debug_info = debug_info.inspect unless debug_info.is_a?(String)
  STDERR.puts debug_info.split("\n").map {|s| "  " * depth + s }
end

#debug?Boolean



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

def debug?
  return @debug_mode if defined?(@debug_mode)
  @debug_mode = ENV["DEBUG_RESOLVER"] || ENV["DEBUG_RESOLVER_TREE"] || false
end

#dependencies_for(specification) ⇒ Object



259
260
261
# File 'lib/bundler/resolver.rb', line 259

def dependencies_for(specification)
  specification.dependencies_for_activated_platforms
end

#index_for(dependency) ⇒ Object



300
301
302
# File 'lib/bundler/resolver.rb', line 300

def index_for(dependency)
  @source_requirements[dependency.name] || @index
end

#indicate_progressObject



253
254
255
# File 'lib/bundler/resolver.rb', line 253

def indicate_progress
  Bundler.ui.info ".", false unless debug?
end

#name_for(dependency) ⇒ Object



304
305
306
# File 'lib/bundler/resolver.rb', line 304

def name_for(dependency)
  dependency.name
end

#name_for_explicit_dependency_sourceObject



308
309
310
311
312
# File 'lib/bundler/resolver.rb', line 308

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

#name_for_locking_dependency_sourceObject



314
315
316
317
318
# File 'lib/bundler/resolver.rb', line 314

def name_for_locking_dependency_source
  Bundler.default_lockfile.basename.to_s
rescue
  "Gemfile.lock"
end

#requirement_satisfied_by?(requirement, activated, spec) ⇒ Boolean



320
321
322
323
324
# File 'lib/bundler/resolver.rb', line 320

def requirement_satisfied_by?(requirement, activated, spec)
  return false unless requirement.matches_spec?(spec) || spec.source.is_a?(Source::Gemspec)
  spec.activate_platform!(requirement.__platform) if !@platforms || @platforms.include?(requirement.__platform)
  true
end

#search_for(dependency) ⇒ Object



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/bundler/resolver.rb', line 263

def search_for(dependency)
  platform = dependency.__platform
  dependency = dependency.dep unless dependency.is_a? Gem::Dependency
  search = @search_for[dependency] ||= begin
    index = index_for(dependency)
    results = index.search(dependency, @base[dependency.name])
    if vertex = @base_dg.vertex_named(dependency.name)
      locked_requirement = vertex.payload.requirement
    end
    spec_groups = if results.any?
      nested = []
      results.each do |spec|
        version, specs = nested.last
        if version == spec.version
          specs << spec
        else
          nested << [spec.version, [spec]]
        end
      end
      nested.reduce([]) do |groups, (version, specs)|
        next groups if locked_requirement && !locked_requirement.satisfied_by?(version)
        groups << SpecGroup.new(specs)
      end
    else
      []
    end
    # GVP handles major itself, but it's still a bit risky to trust it with it
    # until we get it settled with new behavior. For 2.x it can take over all cases.
    if @gem_version_promoter.major?
      spec_groups
    else
      @gem_version_promoter.sort_versions(dependency, spec_groups)
    end
  end
  search.select {|sg| sg.for?(platform) }.each {|sg| sg.activate_platform!(platform) }
end

#sort_dependencies(dependencies, activated, conflicts) ⇒ Object



326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/bundler/resolver.rb', line 326

def sort_dependencies(dependencies, activated, conflicts)
  dependencies.sort_by do |dependency|
    name = name_for(dependency)
    [
      @base_dg.vertex_named(name) ? 0 : 1,
      activated.vertex_named(name).payload ? 0 : 1,
      amount_constrained(dependency),
      conflicts[name] ? 0 : 1,
      activated.vertex_named(name).payload ? 0 : search_for(dependency).count,
    ]
  end
end

#start(requirements) ⇒ Object



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/bundler/resolver.rb', line 211

def start(requirements)
  verify_gemfile_dependencies_are_found!(requirements)
  dg = @resolver.resolve(requirements, @base_dg)
  dg.map(&:payload).
    reject {|sg| sg.name.end_with?("\0") }.
    map(&:to_specs).flatten
rescue Molinillo::VersionConflict => e
  raise VersionConflict.new(e.conflicts.keys.uniq, e.message)
rescue Molinillo::CircularDependencyError => e
  names = e.dependencies.sort_by(&:name).map {|d| "gem '#{d.name}'" }
  raise CyclicDependencyError, "Your bundle requires gems that depend" \
    " on each other, creating an infinite loop. Please remove" \
    " #{names.count > 1 ? "either " : ""}#{names.join(" or ")}" \
    " and try again."
end