Class: Bundler::Resolver

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

Defined Under Namespace

Classes: Base, SpecGroup

Constant Summary

Constants included from GemHelpers

GemHelpers::GENERICS, GemHelpers::GENERIC_CACHE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Molinillo::SpecificationProvider

#allow_missing?, #name_for_locking_dependency_source

Methods included from Molinillo::UI

#output, #progress_rate

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, platforms) ⇒ Resolver

Returns a new instance of Resolver.



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

def initialize(source_requirements, base, gem_version_promoter, additional_base_requirements, platforms)
  @source_requirements = source_requirements
  @base = Resolver::Base.new(base, additional_base_requirements)
  @resolver = Molinillo::Resolver.new(self, self)
  @results_for = {}
  @search_for = {}
  @platforms = platforms
  @resolving_only_for_ruby = platforms == [Gem::Platform::RUBY]
  @gem_version_promoter = gem_version_promoter
end

Class Method Details

.platform_sort_key(platform) ⇒ Object 



212
213
214
215
216
 
# File 'lib/bundler/resolver.rb', line 212

def self.platform_sort_key(platform)
  # Prefer specific platform to not specific platform
  return ["99-LAST", "", "", ""] if Gem::Platform::RUBY == platform
  ["00", *platform.to_a.map {|part| part || "" }]
end

.resolve(requirements, 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.



21
22
23
24
25
 
# File 'lib/bundler/resolver.rb', line 21

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

Instance Method Details

#after_resolution ⇒ Object 



106
107
108
 
# File 'lib/bundler/resolver.rb', line 106

def after_resolution
  Bundler.ui.info ""
end

#before_resolution ⇒ Object 



102
103
104
 
# File 'lib/bundler/resolver.rb', line 102

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.

Parameters:

  • depth (Integer) (defaults to: 0) —

    the current depth of the resolution process.



85
86
87
88
89
90
 
# File 'lib/bundler/resolver.rb', line 85

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

#debug? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#dependencies_equal?(dependencies, other_dependencies) ⇒ Boolean

Returns:

  • (Boolean) 


192
193
194
 
# File 'lib/bundler/resolver.rb', line 192

def dependencies_equal?(dependencies, other_dependencies)
  dependencies.map(&:dep) == other_dependencies.map(&:dep)
end

#dependencies_for(specification) ⇒ Object 



116
117
118
 
# File 'lib/bundler/resolver.rb', line 116

def dependencies_for(specification)
  specification.dependencies_for_activated_platforms
end

#index_for(dependency) ⇒ Object 



166
167
168
 
# File 'lib/bundler/resolver.rb', line 166

def index_for(dependency)
  source_for(dependency.name).specs
end

#indicate_progress ⇒ Object 



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

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

#name_for(dependency) ⇒ Object 



178
179
180
 
# File 'lib/bundler/resolver.rb', line 178

def name_for(dependency)
  dependency.name
end

#name_for_explicit_dependency_source ⇒ Object 



182
183
184
185
186
 
# File 'lib/bundler/resolver.rb', line 182

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

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

Returns:

  • (Boolean) 


188
189
190
 
# File 'lib/bundler/resolver.rb', line 188

def requirement_satisfied_by?(requirement, activated, spec)
  requirement.matches_spec?(spec) || spec.source.is_a?(Source::Gemspec)
end

#results_for(dependency) ⇒ Object 



174
175
176
 
# File 'lib/bundler/resolver.rb', line 174

def results_for(dependency)
  @results_for[dependency] ||= index_for(dependency).search(dependency)
end

#search_for(dependency_proxy) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/bundler/resolver.rb', line 120

def search_for(dependency_proxy)
  platform = dependency_proxy.__platform
  dependency = dependency_proxy.dep
  name = dependency.name
  @search_for[dependency_proxy] ||= begin
    locked_results = @base[name].select {|spec| requirement_satisfied_by?(dependency, nil, spec) }
    locked_requirement = base_requirements[name]
    results = results_for(dependency) + locked_results
    results = results.select {|spec| requirement_satisfied_by?(locked_requirement, nil, spec) } if locked_requirement

    if !@prerelease_specified[name] && locked_results.empty?
      # Move prereleases to the beginning of the list, so they're considered
      # last during resolution.
      pre, results = results.partition {|spec| spec.version.prerelease? }
      results = pre + results
    end

    if results.any?
      results = @gem_version_promoter.sort_versions(dependency, results)

      results.group_by(&:version).reduce([]) do |groups, (_, specs)|
        next groups unless specs.any? {|spec| spec.match_platform(platform) }

        specs_by_platform = Hash.new do |current_specs, current_platform|
          current_specs[current_platform] = select_best_platform_match(specs, current_platform)
        end

        spec_group_ruby = SpecGroup.create_for(specs_by_platform, [Gem::Platform::RUBY], Gem::Platform::RUBY)
        if spec_group_ruby
          spec_group_ruby.force_ruby_platform = dependency.force_ruby_platform
          groups << spec_group_ruby
        end

        next groups if @resolving_only_for_ruby || dependency.force_ruby_platform

        spec_group = SpecGroup.create_for(specs_by_platform, @platforms, platform)
        groups << spec_group

        groups
      end
    else
      []
    end
  end
end

#sort_dependencies(dependencies, activated, conflicts) ⇒ Object 



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

def sort_dependencies(dependencies, activated, conflicts)
  dependencies.sort_by do |dependency|
    name = name_for(dependency)
    vertex = activated.vertex_named(name)
    [
      @base[name].any? ? 0 : 1,
      vertex.payload ? 0 : 1,
      vertex.root? ? 0 : 1,
      amount_constrained(dependency),
      conflicts[name] ? 0 : 1,
      vertex.payload ? 0 : search_for(dependency).count,
      self.class.platform_sort_key(dependency.__platform),
    ]
  end
end

#source_for(name) ⇒ Object 



170
171
172
 
# File 'lib/bundler/resolver.rb', line 170

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

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



38
39
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
73
74
75
76
77
 
# File 'lib/bundler/resolver.rb', line 38

def start(requirements, exclude_specs: [])
  @metadata_requirements, regular_requirements = requirements.partition {|dep| dep.name.end_with?("\0") }

  exclude_specs.each do |spec|
    remove_from_candidates(spec)
  end

  @gem_version_promoter.prerelease_specified = @prerelease_specified = {}
  requirements.each {|dep| @prerelease_specified[dep.name] ||= dep.prerelease? }

  verify_gemfile_dependencies_are_found!(requirements)
  result = @resolver.resolve(requirements).
    map(&:payload).
    reject {|sg| sg.name.end_with?("\0") }.
    map(&:to_specs).
    flatten

  SpecSet.new(SpecSet.new(result).for(regular_requirements, false, @platforms))
rescue Molinillo::VersionConflict => e
  conflicts = e.conflicts

  deps_to_unlock = conflicts.values.inject([]) do |deps, conflict|
    deps |= conflict.requirement_trees.flatten.map {|req| base_requirements[req.name] }.compact
  end

  if deps_to_unlock.any?
    @base.unlock_deps(deps_to_unlock)
    reset_spec_cache
    retry
  end

  message = version_conflict_message(e)
  raise VersionConflict.new(conflicts.keys.uniq, 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