Class: Gem::Resolver
- Inherits:
-
Object
- Object
- Gem::Resolver
- Includes:
- Molinillo::SpecificationProvider, Molinillo::UI
- Defined in:
- lib/rubygems/resolver.rb
Overview
Given a set of Gem::Dependency objects as needed
and a way to query the set of available specs via set
, calculates a set of ActivationRequest objects which indicate all the specs that should be activated to meet the all the requirements.
Defined Under Namespace
Modules: Molinillo Classes: APISet, APISpecification, ActivationRequest, BestSet, ComposedSet, Conflict, CurrentSet, DependencyRequest, GitSet, GitSpecification, IndexSet, IndexSpecification, InstalledSpecification, InstallerSet, LocalSpecification, LockSet, LockSpecification, RequirementList, Set, SourceSet, SpecSpecification, Specification, Stats, VendorSet, VendorSpecification
Constant Summary collapse
- DEBUG_RESOLVER =
If the DEBUG_RESOLVER environment variable is set then debugging mode is enabled for the resolver. This will display information about the state of the resolver while a set of dependencies is being resolved.
!ENV['DEBUG_RESOLVER'].nil?
- DependencyConflict =
TODO: Remove in RubyGems 3
Gem::Resolver::Conflict
Instance Attribute Summary collapse
-
#development ⇒ Object
Set to true if all development dependencies should be considered.
-
#development_shallow ⇒ Object
Set to true if immediate development dependencies should be considered.
-
#ignore_dependencies ⇒ Object
When true, no dependencies are looked up for requested gems.
-
#missing ⇒ Object
readonly
List of dependencies that could not be found in the configured sources.
-
#skip_gems ⇒ Object
Hash of gems to skip resolution.
-
#soft_missing ⇒ Object
When a missing dependency, don’t stop.
-
#stats ⇒ Object
readonly
Returns the value of attribute stats.
Class Method Summary collapse
-
.compose_sets(*sets) ⇒ Object
Combines
sets
into a ComposedSet that allows specification lookup in a uniform manner. -
.for_current_gems(needed) ⇒ Object
Creates a Resolver that queries only against the already installed gems for the
needed
dependencies.
Instance Method Summary collapse
-
#activation_request(dep, possible) ⇒ Object
Creates an ActivationRequest for the given
dep
and the lastpossible
specification. - #allow_missing?(dependency) ⇒ Boolean
- #debug? ⇒ Boolean
- #dependencies_for(specification) ⇒ Object
-
#explain(stage, *data) ⇒ Object
:nodoc:.
-
#explain_list(stage) ⇒ Object
:nodoc:.
-
#find_possible(dependency) ⇒ Object
Extracts the specifications that may be able to fulfill
dependency
and returns those that match the local platform and all those that match. -
#initialize(needed, set = nil) ⇒ Resolver
constructor
Create Resolver object which will resolve the tree starting with
needed
Dependency objects. - #name_for(dependency) ⇒ Object
- #output ⇒ Object
-
#requests(s, act, reqs = []) ⇒ Object
:nodoc:.
- #requirement_satisfied_by?(requirement, activated, spec) ⇒ Boolean
-
#resolve ⇒ Object
Proceed with resolution! Returns an array of ActivationRequest objects.
- #search_for(dependency) ⇒ Object
-
#select_local_platforms(specs) ⇒ Object
Returns the gems in
specs
that match the local platform.
Methods included from Molinillo::SpecificationProvider
#name_for_explicit_dependency_source, #name_for_locking_dependency_source, #sort_dependencies
Methods included from Molinillo::UI
#after_resolution, #before_resolution, #debug, #indicate_progress, #progress_rate
Constructor Details
#initialize(needed, set = nil) ⇒ Resolver
Create Resolver object which will resolve the tree starting with needed
Dependency objects.
set
is an object that provides where to look for specifications to satisfy the Dependencies. This defaults to IndexSet, which will query rubygems.org.
105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/rubygems/resolver.rb', line 105 def initialize needed, set = nil @set = set || Gem::Resolver::IndexSet.new @needed = needed @development = false @development_shallow = false @ignore_dependencies = false @missing = [] @skip_gems = {} @soft_missing = false @stats = Gem::Resolver::Stats.new end |
Instance Attribute Details
#development ⇒ Object
Set to true if all development dependencies should be considered.
29 30 31 |
# File 'lib/rubygems/resolver.rb', line 29 def development @development end |
#development_shallow ⇒ Object
Set to true if immediate development dependencies should be considered.
34 35 36 |
# File 'lib/rubygems/resolver.rb', line 34 def development_shallow @development_shallow end |
#ignore_dependencies ⇒ Object
When true, no dependencies are looked up for requested gems.
39 40 41 |
# File 'lib/rubygems/resolver.rb', line 39 def ignore_dependencies @ignore_dependencies end |
#missing ⇒ Object (readonly)
List of dependencies that could not be found in the configured sources.
44 45 46 |
# File 'lib/rubygems/resolver.rb', line 44 def missing @missing end |
#skip_gems ⇒ Object
Hash of gems to skip resolution. Keyed by gem name, with arrays of gem specifications as values.
52 53 54 |
# File 'lib/rubygems/resolver.rb', line 52 def skip_gems @skip_gems end |
#soft_missing ⇒ Object
When a missing dependency, don’t stop. Just go on and record what was missing.
58 59 60 |
# File 'lib/rubygems/resolver.rb', line 58 def soft_missing @soft_missing end |
#stats ⇒ Object (readonly)
Returns the value of attribute stats.
46 47 48 |
# File 'lib/rubygems/resolver.rb', line 46 def stats @stats end |
Class Method Details
.compose_sets(*sets) ⇒ Object
Combines sets
into a ComposedSet that allows specification lookup in a uniform manner. If one of the sets
is itself a ComposedSet its sets are flattened into the result ComposedSet.
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/rubygems/resolver.rb', line 65 def self.compose_sets *sets sets.compact! sets = sets.map do |set| case set when Gem::Resolver::BestSet then set when Gem::Resolver::ComposedSet then set.sets else set end end.flatten case sets.length when 0 then raise ArgumentError, 'one set in the composition must be non-nil' when 1 then sets.first else Gem::Resolver::ComposedSet.new(*sets) end end |
.for_current_gems(needed) ⇒ Object
Creates a Resolver that queries only against the already installed gems for the needed
dependencies.
93 94 95 |
# File 'lib/rubygems/resolver.rb', line 93 def self.for_current_gems needed new needed, Gem::Resolver::CurrentSet.new end |
Instance Method Details
#activation_request(dep, possible) ⇒ Object
Creates an ActivationRequest for the given dep
and the last possible
specification.
Returns the Specification and the ActivationRequest
139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/rubygems/resolver.rb', line 139 def activation_request dep, possible # :nodoc: spec = possible.pop explain :activate, [spec.full_name, possible.size] explain :possible, possible activation_request = Gem::Resolver::ActivationRequest.new spec, dep, possible return spec, activation_request end |
#allow_missing?(dependency) ⇒ Boolean
254 255 256 257 |
# File 'lib/rubygems/resolver.rb', line 254 def allow_missing?(dependency) @missing << dependency @soft_missing end |
#debug? ⇒ Boolean
180 181 182 |
# File 'lib/rubygems/resolver.rb', line 180 def debug? DEBUG_RESOLVER end |
#dependencies_for(specification) ⇒ Object
240 241 242 243 244 |
# File 'lib/rubygems/resolver.rb', line 240 def dependencies_for(specification) return [] if @ignore_dependencies spec = specification.spec requests(spec, specification) end |
#explain(stage, *data) ⇒ Object
:nodoc:
118 119 120 121 122 123 |
# File 'lib/rubygems/resolver.rb', line 118 def explain stage, *data # :nodoc: return unless DEBUG_RESOLVER d = data.map { |x| x.pretty_inspect }.join(", ") $stderr.printf "%10s %s\n", stage.to_s.upcase, d end |
#explain_list(stage) ⇒ Object
:nodoc:
125 126 127 128 129 130 131 |
# File 'lib/rubygems/resolver.rb', line 125 def explain_list stage # :nodoc: return unless DEBUG_RESOLVER data = yield $stderr.printf "%10s (%d entries)\n", stage.to_s.upcase, data.size PP.pp data, $stderr unless data.empty? end |
#find_possible(dependency) ⇒ Object
Extracts the specifications that may be able to fulfill dependency
and returns those that match the local platform and all those that match.
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/rubygems/resolver.rb', line 203 def find_possible dependency # :nodoc: all = @set.find_all dependency if (skip_dep_gems = skip_gems[dependency.name]) && !skip_dep_gems.empty? matching = all.select do |api_spec| skip_dep_gems.any? { |s| api_spec.version == s.version } end all = matching unless matching.empty? end matching_platform = select_local_platforms all return matching_platform, all end |
#name_for(dependency) ⇒ Object
250 251 252 |
# File 'lib/rubygems/resolver.rb', line 250 def name_for(dependency) dependency.name end |
#output ⇒ Object
176 177 178 |
# File 'lib/rubygems/resolver.rb', line 176 def output @output ||= debug? ? $stdout : File.open(Gem::Util::NULL_DEVICE, 'w') end |
#requests(s, act, reqs = []) ⇒ Object
:nodoc:
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/rubygems/resolver.rb', line 151 def requests s, act, reqs=[] # :nodoc: return reqs if @ignore_dependencies s.fetch_development_dependencies if @development s.dependencies.reverse_each do |d| next if d.type == :development and not @development next if d.type == :development and @development_shallow and act.development? next if d.type == :development and @development_shallow and act.parent reqs << Gem::Resolver::DependencyRequest.new(d, act) @stats.requirement! end @set.prefetch reqs @stats.record_requirements reqs reqs end |
#requirement_satisfied_by?(requirement, activated, spec) ⇒ Boolean
246 247 248 |
# File 'lib/rubygems/resolver.rb', line 246 def requirement_satisfied_by?(requirement, activated, spec) requirement.matches_spec? spec end |
#resolve ⇒ Object
Proceed with resolution! Returns an array of ActivationRequest objects.
189 190 191 192 193 194 195 196 197 |
# File 'lib/rubygems/resolver.rb', line 189 def resolve locking_dg = Molinillo::DependencyGraph.new Molinillo::Resolver.new(self, self).resolve(@needed.map { |d| DependencyRequest.new d, nil }, locking_dg).tsort.map(&:payload).compact rescue Molinillo::VersionConflict => e conflict = e.conflicts.values.first raise Gem::DependencyResolutionError, Conflict.new(conflict.requirement_trees.first.first, conflict.existing, conflict.requirement) ensure @output.close if defined?(@output) and !debug? end |
#search_for(dependency) ⇒ Object
228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/rubygems/resolver.rb', line 228 def search_for(dependency) possibles, all = find_possible(dependency) if !@soft_missing && possibles.empty? @missing << dependency exc = Gem::UnsatisfiableDependencyError.new dependency, all exc.errors = @set.errors raise exc end possibles.sort_by { |s| [s.source, s.version, Gem::Platform.local =~ s.platform ? 1 : 0] }. map { |s| ActivationRequest.new s, dependency, [] } end |
#select_local_platforms(specs) ⇒ Object
Returns the gems in specs
that match the local platform.
222 223 224 225 226 |
# File 'lib/rubygems/resolver.rb', line 222 def select_local_platforms specs # :nodoc: specs.select do |spec| Gem::Platform.installable? spec end end |