Home Classes Methods

In Files

rubygems/available_set.rb

Parent

Object

Methods

::new
#<<
#add
#all_specs
#each
#each_spec
#empty?
#find_all
#inject_into_list
#match_platform!
#pick_best!
#prefetch
#remove_installed!
#size
#sorted
#source_for
#to_request_set

Included Modules

Enumerable

Class/Module Index

Gem::AvailableSet

Constants

Tuple

Attributes

set[R]

Public Class Methods

new() click to toggle source

 
               # File rubygems/available_set.rb, line 9
def initialize
  @set = []
  @sorted = nil
  @remote = true
end

Public Instance Methods

<<(o) click to toggle source

 
               # File rubygems/available_set.rb, line 23
def <<(o)
  case o
  when Gem::AvailableSet
    s = o.set
  when Array
    s = o.map do |sp,so|
      if !sp.kind_of?(Gem::Specification) or !so.kind_of?(Gem::Source)
        raise TypeError, "Array must be in [[spec, source], ...] form"
      end

      Tuple.new(sp,so)
    end
  else
    raise TypeError, "must be a Gem::AvailableSet"
  end

  @set += s
  @sorted = nil

  self
end

add(spec, source) click to toggle source

 
               # File rubygems/available_set.rb, line 17
def add(spec, source)
  @set << Tuple.new(spec, source)
  @sorted = nil
  self
end

all_specs() click to toggle source

 
               # File rubygems/available_set.rb, line 71
def all_specs
  @set.map { |t| t.spec }
end

each() click to toggle source

Yields each Tuple in this AvailableSet

 
               # File rubygems/available_set.rb, line 48
def each
  return enum_for __method__ unless block_given?

  @set.each do |tuple|
    yield tuple
  end
end

each_spec() click to toggle source

Yields the Gem::Specification for each Tuple in this AvailableSet

 
               # File rubygems/available_set.rb, line 59
def each_spec
  return enum_for __method__ unless block_given?

  each do |tuple|
    yield tuple.spec
  end
end

empty?() click to toggle source

 
               # File rubygems/available_set.rb, line 67
def empty?
  @set.empty?
end

find_all(req) click to toggle source

Used by the Resolver, the protocol to use a AvailableSet as a search Set.

 
               # File rubygems/available_set.rb, line 125
def find_all(req)
  dep = req.dependency

  match = @set.find_all do |t|
    dep.match? t.spec
  end

  match.map do |t|
    Gem::Resolver::LocalSpecification.new(self, t.spec, t.source)
  end
end

inject_into_list(dep_list) click to toggle source

 
               # File rubygems/available_set.rb, line 161
def inject_into_list(dep_list)
  @set.each { |t| dep_list.add t.spec }
end

match_platform!() click to toggle source

 
               # File rubygems/available_set.rb, line 75
def match_platform!
  @set.reject! { |t| !Gem::Platform.match(t.spec.platform) }
  @sorted = nil
  self
end

pick_best!() click to toggle source

 
               # File rubygems/available_set.rb, line 140
def pick_best!
  return self if empty?

  @set = [sorted.first]
  @sorted = nil
  self
end

prefetch(reqs) click to toggle source

 
               # File rubygems/available_set.rb, line 137
def prefetch(reqs)
end

remove_installed!(dep) click to toggle source

 
               # File rubygems/available_set.rb, line 148
def remove_installed!(dep)
  @set.reject! do |t|
    # already locally installed
    Gem::Specification.any? do |installed_spec|
      dep.name == installed_spec.name and
        dep.requirement.satisfied_by? installed_spec.version
    end
  end

  @sorted = nil
  self
end

size() click to toggle source

 
               # File rubygems/available_set.rb, line 88
def size
  @set.size
end

sorted() click to toggle source

 
               # File rubygems/available_set.rb, line 81
def sorted
  @sorted ||= @set.sort do |a,b|
    i = b.spec <=> a.spec
    i != 0 ? i : (a.source <=> b.source)
  end
end

source_for(spec) click to toggle source

 
               # File rubygems/available_set.rb, line 92
def source_for(spec)
  f = @set.find { |t| t.spec == spec }
  f.source
end

to_request_set(development = :none) click to toggle source

Converts this AvailableSet into a RequestSet that can be used to install gems.

If development is :none then no development dependencies are installed. Other options are :shallow for only direct development dependencies of the gems in this set or :all for all development dependencies.

 
               # File rubygems/available_set.rb, line 105
def to_request_set development = :none
  request_set = Gem::RequestSet.new
  request_set.development = :all == development

  each_spec do |spec|
    request_set.always_install << spec

    request_set.gem spec.name, spec.version
    request_set.import spec.development_dependencies if
      :shallow == development
  end

  request_set
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.