The Dependency
class holds a Gem
name and a Gem::Requirement
.
Valid dependency types.
Dependency
name or regular expression.
Allows you to force this dependency to be a prerelease.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 35
def initialize(name, *requirements)
case name
when String then # ok
when Regexp then
msg = ["NOTE: Dependency.new w/ a regexp is deprecated.",
"Dependency.new called from #{Gem.location_of_caller.join(":")}"]
warn msg.join("\n") unless Gem::Deprecate.skip
else
raise ArgumentError,
"dependency name must be a String, was #{name.inspect}"
end
type = Symbol === requirements.last ? requirements.pop : :runtime
requirements = requirements.first if 1 == requirements.length # unpack
unless TYPES.include? type
raise ArgumentError, "Valid types are #{TYPES.inspect}, " +
"not #{type.inspect}"
end
@name = name
@requirement = Gem::Requirement.create requirements
@type = type
@prerelease = false
# This is for Marshal backwards compatibility. See the comments in
# +requirement+ for the dirty details.
@version_requirements = @requirement
end
Constructs a dependency with name
and requirements
. The last argument can optionally be the dependency type, which defaults to :runtime
.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 179
def <=>(other)
self.name <=> other.name
end
Dependencies are ordered by name.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 189
def =~(other)
unless Gem::Dependency === other
return unless other.respond_to?(:name) && other.respond_to?(:version)
other = Gem::Dependency.new other.name, other.version
end
return false unless name === other.name
reqs = other.requirement.requirements
return false unless reqs.length == 1
return false unless reqs.first.first == "="
version = reqs.first.last
requirement.satisfied_by? version
end
Uses this dependency as a pattern to compare to other
. This dependency will match if the name matches the other’s name, and other has only an equal version requirement that satisfies this dependency.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 340
def identity
if prerelease?
if specific?
:complete
else
:abs_latest
end
elsif latest_version?
:latest
else
:released
end
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 95
def latest_version?
@requirement.none?
end
Is this dependency simply asking for the latest version of a gem?
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 221
def match?(obj, version=nil, allow_prerelease=false)
if !version
name = obj.name
version = obj.version
else
name = obj
end
return false unless self.name === name
version = Gem::Version.new version
return true if requirement.none? && !version.prerelease?
return false if version.prerelease? &&
!allow_prerelease &&
!prerelease?
requirement.satisfied_by? version
end
Does this dependency match the specification described by name
and version
or match spec
?
NOTE: Unlike matches_spec?
this method does not return true when the version is a prerelease version unless this is a prerelease dependency.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 248
def matches_spec?(spec)
return false unless name === spec.name
return true if requirement.none?
requirement.satisfied_by?(spec.version)
end
Does this dependency match spec
?
NOTE: This is not a convenience method. Unlike match?
this method returns true when spec
is a prerelease version even if this dependency is not a prerelease dependency.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 274
def matching_specs(platform_only = false)
env_req = Gem.env_requirement(name)
matches = Gem::Specification.stubs_for(name).find_all do |spec|
requirement.satisfied_by?(spec.version) && env_req.satisfied_by?(spec.version)
end.map(&:to_spec)
if prioritizes_bundler?
require_relative "bundler_version_finder"
Gem::BundlerVersionFinder.prioritize!(matches)
end
if platform_only
matches.reject! do |spec|
spec.nil? || !Gem::Platform.match_spec?(spec)
end
end
matches
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 258
def merge(other)
unless name == other.name
raise ArgumentError,
"#{self} and #{other} have different names"
end
default = Gem::Requirement.default
self_req = self.requirement
other_req = other.requirement
return self.class.new name, self_req if other_req == default
return self.class.new name, other_req if self_req == default
self.class.new name, self_req.as_list.concat(other_req.as_list)
end
Merges the requirements of other
into this dependency
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 87
def prerelease?
@prerelease || requirement.prerelease?
end
Does this dependency require a prerelease?
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 301
def prioritizes_bundler?
name == "bundler".freeze && !specific?
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 117
def requirement
return @requirement if defined?(@requirement) && @requirement
# @version_requirements and @version_requirement are legacy ivar
# names, and supported here because older gems need to keep
# working and Dependency doesn't implement marshal_dump and
# marshal_load. In a happier world, this would be an
# attr_accessor. The horrifying instance_variable_get you see
# below is also the legacy of some old restructurings.
#
# Note also that because of backwards compatibility (loading new
# gems in an old RubyGems installation), we can't add explicit
# marshaling to this class until we want to make a big
# break. Maybe 2.0.
#
# Children, define explicit marshal and unmarshal behavior for
# public classes. Marshal formats are part of your public API.
# REFACTOR: See above
if defined?(@version_requirement) && @version_requirement
version = @version_requirement.instance_variable_get :@version
@version_requirement = nil
@version_requirements = Gem::Requirement.new version
end
@requirement = @version_requirements if defined?(@version_requirements)
end
What does this dependency require?
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 146
def requirements_list
requirement.as_list
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 165
def runtime?
@type == :runtime || !@type
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 297
def specific?
@requirement.specific?
end
True if the dependency will not always match the latest version.
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 325
def to_spec
matches = self.to_specs.compact
active = matches.find {|spec| spec.activated? }
return active if active
unless prerelease?
# Move prereleases to the end of the list for >= 0 requirements
pre, matches = matches.partition {|spec| spec.version.prerelease? }
matches += pre if requirement == Gem::Requirement.default
end
matches.first
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 305
def to_specs
matches = matching_specs true
# TODO: check Gem.activated_spec[self.name] in case matches falls outside
if matches.empty?
specs = Gem::Specification.stubs_for name
if specs.empty?
raise Gem::MissingSpecError.new name, requirement
else
raise Gem::MissingSpecVersionError.new name, requirement, specs
end
end
# TODO: any other resolver validations should go here
matches
end
# File tmp/rubies/ruby-3.2.0/lib/rubygems/dependency.rb, line 161
def type
@type ||= :runtime
end
Dependency
type.