Class: Gem::Dependency

Relationships & Source Files
Inherits:	Object
Defined in:	lib/rubygems/dependency.rb

Overview

The Dependency class holds a ::Gem name and a Requirement.

Constant Summary

TYPES =

Valid dependency types.

# File 'lib/rubygems/dependency.rb', line 15
```
[
  :development,
  :runtime,
].freeze
```

Class Method Summary

.new(name, *requirements) ⇒ Dependency constructor

Constructs a dependency with #name and requirements.

Instance Attribute Summary

#filters_bundler? ⇒ Boolean readonly
#latest_version? ⇒ Boolean readonly

Is this dependency simply asking for the latest version of a gem?
#name rw

Dependency name or regular expression.
#prerelease=(value) rw

Allows you to force this dependency to be a prerelease.
#prerelease? ⇒ Boolean rw

Does this dependency require a prerelease?
#runtime? ⇒ Boolean readonly
#specific? ⇒ Boolean readonly

True if the dependency will not always match the latest version.

Instance Method Summary

#<=>(other)

Dependencies are ordered by name.
#===(other)

Alias for #=~.
#=~(other) (also: #===)

Uses this dependency as a pattern to compare to other.
#identity
#match?(name) ⇒ Boolean

Does this dependency match the specification described by #name and version or match spec?
#matches_spec?(spec) ⇒ Boolean

Does this dependency match spec?
#matching_specs(platform_only = false)
#merge(other)

Merges the requirements of other into this dependency.
#requirement

What does this dependency require?
#requirements_list
#to_spec
#to_specs
#type

Dependency type.
#==(other) Internal use only
#hash Internal use only

A dependency’s hash is the XOR of the hashes of #name, #type, and #requirement.
#inspect Internal use only
#pretty_print(q) Internal use only
#to_s Internal use only

Constructor Details

.new(name, *requirements) ⇒ `Dependency`

Constructs a dependency with #name and requirements. The last argument can optionally be the dependency type, which defaults to :runtime.

[ GitHub ]

# File '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

Instance Attribute Details

#filters_bundler? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 298


def filters_bundler?
  name == "bundler".freeze && !specific?
end

#latest_version? ⇒ `Boolean` (readonly)

Is this dependency simply asking for the latest version of a gem?

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 95


def latest_version?
  @requirement.none?
end

#name (rw)

Dependency name or regular expression.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 23


attr_accessor :name

#prerelease=(value) (rw)

Allows you to force this dependency to be a prerelease.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 28


attr_writer :prerelease

#prerelease? ⇒ `Boolean` (rw)

Does this dependency require a prerelease?

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 87


def prerelease?
  @prerelease || requirement.prerelease?
end

#runtime? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 165


def runtime?
  @type == :runtime || !@type
end

#specific? ⇒ `Boolean` (readonly)

True if the dependency will not always match the latest version.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 294


def specific?
  @requirement.specific?
end

Instance Method Details

#<=>(other)

Dependencies are ordered by name.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 179


def <=>(other)
  self.name <=> other.name
end

#==(other)

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 169


def ==(other) # :nodoc:
  Gem::Dependency === other &&
    self.name        == other.name &&
    self.type        == other.type &&
    self.requirement == other.requirement
end

#===(other)

Alias for #=~.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 207


alias === =~

#=~(other) Also known as: #===

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.

[ GitHub ]

# File '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

#hash

This method is for internal use only.

A dependency’s hash is the XOR of the hashes of #name, #type, and #requirement.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 70


def hash # :nodoc:
  name.hash ^ type.hash ^ requirement.hash
end

#identity

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 337


def identity
  if prerelease?
    if specific?
      :complete
    else
      :abs_latest
    end
  elsif latest_version?
    :latest
  else
    :released
  end
end

#inspect

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 74


def inspect # :nodoc:
  if prerelease?
    "<%s type=%p name=%p requirements=%p prerelease=ok>" %
      [self.class, self.type, self.name, requirement.to_s]
  else
    "<%s type=%p name=%p requirements=%p>" %
      [self.class, self.type, self.name, requirement.to_s]
  end
end

#match?(name) ⇒ `Boolean` #match?(name, version) ⇒ `Boolean` #match?(spec) ⇒ `Boolean`

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.

[ GitHub ]

# File '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? and not version.prerelease?
  return false if version.prerelease? and
                  not allow_prerelease and
                  not prerelease?

  requirement.satisfied_by? version
end

#matches_spec?(spec) ⇒ `Boolean`

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.

[ GitHub ]

# File '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

#matching_specs(platform_only = false)

[ GitHub ]

# File '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)

  Gem::BundlerVersionFinder.filter!(matches) if filters_bundler?

  if platform_only
    matches.reject! do |spec|
      spec.nil? || !Gem::Platform.match_spec?(spec)
    end
  end

  matches
end

#merge(other)

Merges the requirements of other into this dependency

[ GitHub ]

# File '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

#pretty_print(q)

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 99


def pretty_print(q) # :nodoc:
  q.group 1, 'Gem::Dependency.new(', ')' do
    q.pp name
    q.text ','
    q.breakable

    q.pp requirement

    q.text ','
    q.breakable

    q.pp type
  end
end

#requirement

What does this dependency require?

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 117


def requirement
  return @requirement if defined?(@requirement) and @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

#requirements_list

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 146


def requirements_list
  requirement.as_list
end

#to_s

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 150


def to_s # :nodoc:
  if type != :runtime
    "#{name} (#{requirement}, #{type})"
  else
    "#{name} (#{requirement})"
  end
end

#to_spec

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 322


def to_spec
  matches = self.to_specs.compact

  active = matches.find {|spec| spec.activated? }
  return active if active

  return matches.first if 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

  matches.first
end

#to_specs

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 302


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

#type

Dependency type.

[ GitHub ]

# File 'lib/rubygems/dependency.rb', line 161


def type
  @type ||= :runtime
end

Class: Gem::Dependency

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name, *requirements) ⇒ Dependency

Instance Attribute Details

#filters_bundler? ⇒ Boolean (readonly)

#latest_version? ⇒ Boolean (readonly)

#name (rw)

#prerelease=(value) (rw)

#prerelease? ⇒ Boolean (rw)

#runtime? ⇒ Boolean (readonly)

#specific? ⇒ Boolean (readonly)

Instance Method Details

#<=>(other)

#==(other)

#===(other)

#=~(other) Also known as: #===

#hash

#identity

#inspect

#match?(name) ⇒ Boolean #match?(name, version) ⇒ Boolean #match?(spec) ⇒ Boolean

#matches_spec?(spec) ⇒ Boolean

#matching_specs(platform_only = false)

#merge(other)

#pretty_print(q)

#requirement

#requirements_list

#to_s

#to_spec

#to_specs

#type

.new(name, *requirements) ⇒ `Dependency`

#filters_bundler? ⇒ `Boolean` (readonly)

#latest_version? ⇒ `Boolean` (readonly)

#prerelease? ⇒ `Boolean` (rw)

#runtime? ⇒ `Boolean` (readonly)

#specific? ⇒ `Boolean` (readonly)

#match?(name) ⇒ `Boolean` #match?(name, version) ⇒ `Boolean` #match?(spec) ⇒ `Boolean`

#matches_spec?(spec) ⇒ `Boolean`