123456789_123456789_123456789_123456789_123456789_

Class: Gem::Dependency

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

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

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 38



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



  

    #latest_version?  ⇒ Boolean  (readonly)
  



  

    

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


  





  


  [ GitHub ]


  

  


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



def latest_version?
  @requirement.none?
end


  








  

    #name   (rw)
  



  

    

Dependency name or regular expression.


  



  [ GitHub ]


  

  


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



attr_accessor :name


  








  

    #prerelease=(value)   (rw)
  



  

    

Allows you to force this dependency to be a prerelease.


  



  [ GitHub ]


  

  


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



attr_writer :prerelease


  








  

    #prerelease?  ⇒ Boolean  (rw)
  



  

    

Does this dependency require a prerelease?


  





  


  [ GitHub ]


  

  


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



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


  








  

    #runtime?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



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 182



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


  








  

    #===(other)  
  



  

    

Alias for #=~.


  



  [ GitHub ]


  

  


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



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 192



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


  








  

    

      #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 224



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 251



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 277



def matching_specs platform_only = false
  matches = Gem::Specification.stubs_for(name).find_all { |spec|
    requirement.satisfied_by? spec.version
  }.map(&:to_spec)

  if platform_only
    matches.reject! { |spec|
      spec.nil? || !Gem::Platform.match(spec.platform)
    }
  end

  matches.sort_by { |s| s.sort_obj } # HACK: shouldn't be needed
end


  








  

    #merge(other)  
  



  

    

Merges the requirements of other into this dependency


  



  [ GitHub ]


  

  


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



def merge other
  unless name == other.name then
    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


  








  

    #requirement  
  



  

    

What does this dependency require?


  



  [ GitHub ]


  

  


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



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 149



def requirements_list
  requirement.as_list
end


  








  

    #to_spec  
  

  [ GitHub ]


  

  


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



def to_spec
  matches = self.to_specs

  active = matches.find { |spec| spec && spec.activated? }

  return active if active

  matches.delete_if { |spec| spec.nil? || spec.version.prerelease? } unless prerelease?

  matches.last
end


  








  

    #to_specs  
  

  [ GitHub ]


  

  


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



def to_specs
  matches = matching_specs true

  # TODO: check Gem.activated_spec[self.name] in case matches falls outside

  if matches.empty? then
    specs = Gem::Specification.find_all { |s|
              s.name == name
            }.map { |x| x.full_name }

    if specs.empty?
      total = Gem::Specification.to_a.size
      msg   = "Could not find '#{name}' (#{requirement}) among #{total} total gem(s)\n".dup
    else
      msg   = "Could not find '#{name}' (#{requirement}) - did find: [#{specs.join ','}]\n".dup
    end
    msg << "Checked in 'GEM_PATH=#{Gem.path.join(File::PATH_SEPARATOR)}', execute `gem env` for more information"

    error = Gem::LoadError.new(msg)
    error.name        = self.name
    error.requirement = self.requirement
    raise error
  end

  # TODO: any other resolver validations should go here

  matches
end


  








  

    #type  
  



  

    

Dependency type.


  



  [ GitHub ]


  

  


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



def type
  @type ||= :runtime
end