class Bundler::Resolver

Constants

ALL

Public Class Methods

new(index, source_requirements, base, ruby_version, gem_version_promoter, additional_base_requirements) click to toggle source
# File lib/bundler/resolver.rb, line 185
def initialize(index, source_requirements, base, ruby_version, gem_version_promoter, additional_base_requirements)
  @index = index
  @source_requirements = source_requirements
  @base = base
  @resolver = Molinillo::Resolver.new(self, self)
  @search_for = {}
  @base_dg = Molinillo::DependencyGraph.new
  @base.each {|ls| @base_dg.add_vertex(ls.name, Dependency.new(ls.name, ls.version), true) }
  additional_base_requirements.each {|d| @base_dg.add_vertex(d.name, d) }
  @ruby_version = ruby_version
  @gem_version_promoter = gem_version_promoter
end
resolve(requirements, index, source_requirements = {}, base = [], ruby_version = nil, gem_version_promoter = GemVersionPromoter.new, additional_base_requirements = []) click to toggle source

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.
# File lib/bundler/resolver.rb, line 178
def self.resolve(requirements, index, source_requirements = {}, base = [], ruby_version = nil, gem_version_promoter = GemVersionPromoter.new, additional_base_requirements = [])
  base = SpecSet.new(base) unless base.is_a?(SpecSet)
  resolver = new(index, source_requirements, base, ruby_version, gem_version_promoter, additional_base_requirements)
  result = resolver.start(requirements)
  SpecSet.new(result)
end

Public Instance Methods

after_resolution() click to toggle source
# File lib/bundler/resolver.rb, line 234
def after_resolution
  Bundler.ui.info ""
end
before_resolution() click to toggle source
# File lib/bundler/resolver.rb, line 230
def before_resolution
  Bundler.ui.info "Resolving dependencies...", false
end
debug(depth = 0) { || ... } click to toggle source

Conveys debug information to the user.

@param [Integer] depth the current depth of the resolution process. @return [void]

# File lib/bundler/resolver.rb, line 218
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?() click to toggle source
# File lib/bundler/resolver.rb, line 225
def debug?
  return @debug_mode if defined?(@debug_mode)
  @debug_mode = ENV["DEBUG_RESOLVER"] || ENV["DEBUG_RESOLVER_TREE"]
end
dependencies_for(specification) click to toggle source
# File lib/bundler/resolver.rb, line 244
def dependencies_for(specification)
  specification.dependencies_for_activated_platforms
end
index_for(dependency) click to toggle source
# File lib/bundler/resolver.rb, line 285
def index_for(dependency)
  @source_requirements[dependency.name] || @index
end
indicate_progress() click to toggle source
# File lib/bundler/resolver.rb, line 238
def indicate_progress
  Bundler.ui.info ".", false
end
name_for(dependency) click to toggle source
# File lib/bundler/resolver.rb, line 289
def name_for(dependency)
  dependency.name
end
name_for_explicit_dependency_source() click to toggle source
# File lib/bundler/resolver.rb, line 293
def name_for_explicit_dependency_source
  Bundler.default_gemfile.basename.to_s
rescue
  "Gemfile"
end
name_for_locking_dependency_source() click to toggle source
# File lib/bundler/resolver.rb, line 299
def name_for_locking_dependency_source
  Bundler.default_lockfile.basename.to_s
rescue
  "Gemfile.lock"
end
requirement_satisfied_by?(requirement, activated, spec) click to toggle source
# File lib/bundler/resolver.rb, line 305
def requirement_satisfied_by?(requirement, activated, spec)
  requirement.matches_spec?(spec) || spec.source.is_a?(Source::Gemspec)
end
search_for(dependency) click to toggle source
# File lib/bundler/resolver.rb, line 248
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, @ruby_version) }.each {|sg| sg.activate_platform!(platform) }
end
sort_dependencies(dependencies, activated, conflicts) click to toggle source
# File lib/bundler/resolver.rb, line 309
def sort_dependencies(dependencies, activated, conflicts)
  dependencies.sort_by do |dependency|
    name = name_for(dependency)
    [
      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) click to toggle source
# File lib/bundler/resolver.rb, line 198
def start(requirements)
  verify_gemfile_dependencies_are_found!(requirements)
  dg = @resolver.resolve(requirements, @base_dg)
  dg.map(&:payload).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

Private Instance Methods

amount_constrained(dependency) click to toggle source
# File lib/bundler/resolver.rb, line 323
def amount_constrained(dependency)
  @amount_constrained ||= {}
  @amount_constrained[dependency.name] ||= begin
    if (base = @base[dependency.name]) && !base.empty?
      dependency.requirement.satisfied_by?(base.first.version) ? 0 : 1
    else
      all = index_for(dependency).search(dependency.name).size
      if all <= 1
        all
      else
        search = search_for(dependency).size
        search - all
      end
    end
  end
end
formatted_versions_with_platforms(versions_with_platforms) click to toggle source
# File lib/bundler/resolver.rb, line 370
def formatted_versions_with_platforms(versions_with_platforms)
  version_platform_strs = versions_with_platforms.map do |vwp|
    version = vwp.first
    platform = vwp.last
    version_platform_str = String.new(version.to_s)
    version_platform_str << " #{platform}" unless platform.nil?
  end
  version_platform_strs.join(", ")
end
verify_gemfile_dependencies_are_found!(requirements) click to toggle source
# File lib/bundler/resolver.rb, line 340
def verify_gemfile_dependencies_are_found!(requirements)
  requirements.each do |requirement|
    next if requirement.name == "bundler"
    next unless search_for(requirement).empty?
    if (base = @base[requirement.name]) && !base.empty?
      version = base.first.version
      message = "You have requested:\n"              "  #{requirement.name} #{requirement.requirement}\n\n"              "The bundle currently has #{requirement.name} locked at #{version}.\n"              "Try running `bundle update #{requirement.name}`\n\n"              "If you are updating multiple gems in your Gemfile at once,\n"              "try passing them all to `bundle update`"
    elsif requirement.source
      name = requirement.name
      specs = @source_requirements[name][name]
      versions_with_platforms = specs.map {|s| [s.version, s.platform] }
      message = String.new("Could not find gem '#{requirement}' in #{requirement.source}.\n")
      message << if versions_with_platforms.any?
                   "Source contains '#{name}' at: #{formatted_versions_with_platforms(versions_with_platforms)}"
                 else
                   "Source does not contain any versions of '#{requirement}'"
                 end
    else
      message = "Could not find gem '#{requirement}' in any of the gem sources "              "listed in your Gemfile or available on this machine."
    end
    raise GemNotFound, message
  end
end