lib/rubygems/dependency.rb

   1 #--
   2 # Copyright 2006 by Chad Fowler, Rich Kilmer, Jim Weirich and others.
   3 # All rights reserved.
   4 # See LICENSE.txt for permissions.
   5 #++
   6
   7 require 'rubygems'
   8
   9 ##
  10 # The Dependency class holds a Gem name and a Gem::Requirement
  11
  12 class Gem::Dependency
  13
  14   ##
  15   # Valid dependency types.
  16   #--
  17   # When this list is updated, be sure to change
  18   # Gem::Specification::CURRENT_SPECIFICATION_VERSION as well.
  19
  20   TYPES = [
  21     :development,
  22     :runtime,
  23   ]
  24
  25   ##
  26   # Dependency name or regular expression.
  27
  28   attr_accessor :name
  29
  30   ##
  31   # Dependency type.
  32
  33   attr_reader :type
  34
  35   ##
  36   # Dependent versions.
  37
  38   attr_writer :version_requirements
  39
  40   ##
  41   # Orders dependencies by name only.
  42
  43   def <=>(other)
  44     [@name] <=> [other.name]
  45   end
  46
  47   ##
  48   # Constructs a dependency with +name+ and +requirements+.
  49
  50   def initialize(name, version_requirements, type=:runtime)
  51     @name = name
  52
  53     unless TYPES.include? type
  54       raise ArgumentError, "Valid types are #{TYPES.inspect}, not #{@type.inspect}"
  55     end
  56
  57     @type = type
  58
  59     @version_requirements = Gem::Requirement.create version_requirements
  60     @version_requirement = nil   # Avoid warnings.
  61   end
  62
  63   def version_requirements
  64     normalize if defined? @version_requirement and @version_requirement
  65     @version_requirements
  66   end
  67
  68   def requirement_list
  69     version_requirements.as_list
  70   end
  71
  72   alias requirements_list requirement_list
  73
  74   def normalize
  75     ver = @version_requirement.instance_eval { @version }
  76     @version_requirements = Gem::Requirement.new([ver])
  77     @version_requirement = nil
  78   end
  79
  80   def to_s # :nodoc:
  81     "#{name} (#{version_requirements}, #{@type || :runtime})"
  82   end
  83
  84   def ==(other) # :nodoc:
  85     self.class === other &&
  86       self.name == other.name &&
  87       self.type == other.type &&
  88       self.version_requirements == other.version_requirements
  89   end
  90
  91   ##
  92   # Uses this dependency as a pattern to compare to the dependency +other+.
  93   # This dependency will match if the name matches the other's name, and other
  94   # has only an equal version requirement that satisfies this dependency.
  95
  96   def =~(other)
  97     return false unless self.class === other
  98
  99     pattern = @name
 100     pattern = /\A#{@name}\Z/ unless Regexp === pattern
 101
 102     return false unless pattern =~ other.name
 103
 104     reqs = other.version_requirements.requirements
 105
 106     return false unless reqs.length == 1
 107     return false unless reqs.first.first == '='
 108
 109     version = reqs.first.last
 110
 111     version_requirements.satisfied_by? version
 112   end
 113
 114   def hash # :nodoc:
 115     name.hash + type.hash + version_requirements.hash
 116   end
 117
 118 end
 119