# class Gem::Dependency

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

### Constants

TYPES

  Valid dependency types.

### Attributes

name[RW]

`Dependency` name or regular expression.

prerelease[W]

Allows you to force this dependency to be a prerelease.

### Public Class Methods

new(name, *requirements) click to toggle source

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

    # File lib/rubygems/dependency.rb, line 36
    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

### Public Instance Methods

<=>(other) click to toggle source

Dependencies are ordered by name.

    # File lib/rubygems/dependency.rb, line 180
    def <=>(other)
      self.name <=> other.name
    end

===(other)
Alias for: =~
=~(other) click to toggle source

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 lib/rubygems/dependency.rb, line 190
    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

Also aliased as: ===
identity() click to toggle source

    # File lib/rubygems/dependency.rb, line 341
    def identity
      if prerelease?
        if specific?
          :complete
        else
          :abs_latest
        end
      elsif latest_version?
        :latest
      else
        :released
      end
    end

latest_version?() click to toggle source

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

    # File lib/rubygems/dependency.rb, line 96
    def latest_version?
      @requirement.none?
    end

match? name → true or false click to toggle source
match? name, version → true or false
match? spec → true or false

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 lib/rubygems/dependency.rb, line 222
    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

matches_spec?(spec) click to toggle source

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 lib/rubygems/dependency.rb, line 249
    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) click to toggle source

    # File lib/rubygems/dependency.rb, line 275
    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

merge(other) click to toggle source

Merges the requirements of `other` into this dependency

    # File lib/rubygems/dependency.rb, line 259
    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

prerelease?() click to toggle source

Does this dependency require a prerelease?

    # File lib/rubygems/dependency.rb, line 88
    def prerelease?
      @prerelease || requirement.prerelease?
    end

prioritizes_bundler?() click to toggle source

    # File lib/rubygems/dependency.rb, line 302
    def prioritizes_bundler?
      name == "bundler" && !specific?
    end

requirement() click to toggle source

What does this dependency require?

    # File lib/rubygems/dependency.rb, line 118
    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

requirements_list() click to toggle source

    # File lib/rubygems/dependency.rb, line 147
    def requirements_list
      requirement.as_list
    end

runtime?() click to toggle source

    # File lib/rubygems/dependency.rb, line 166
    def runtime?
      @type == :runtime || !@type
    end

specific?() click to toggle source

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

    # File lib/rubygems/dependency.rb, line 298
    def specific?
      @requirement.specific?
    end

to_spec() click to toggle source

    # File lib/rubygems/dependency.rb, line 326
    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

to_specs() click to toggle source

    # File lib/rubygems/dependency.rb, line 306
    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() click to toggle source

`Dependency` type.

    # File lib/rubygems/dependency.rb, line 162
    def type
      @type ||= :runtime
    end