123456789_123456789_123456789_123456789_123456789_

Class: Gem::Resolver::InstallerSet

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Set
Instance Chain:
self, Set
Inherits: Gem::Resolver::Set
Defined in: lib/rubygems/resolver/installer_set.rb

Overview

A set of gems for installation sourced from remote sources and local .gem files

Class Method Summary

Set - Inherited

.new

Instance Attribute Summary

Set - Inherited

#errors

Errors encountered when resolving gems.
#prerelease

When true, allows matching of requests to prerelease gems.
#remote

Set to true to disable network access for this set.
#remote?

When true, this set is allowed to access the network when looking up specifications or dependencies.

Instance Method Summary

Set - Inherited

#find_all

The find_all method must be implemented.
#prefetch

The #prefetch method may be overridden, but this is not necessary.

Constructor Details

.new(domain) ⇒ InstallerSet

Creates a new InstallerSet that will look for gems in domain.

[ GitHub ] 

  


# File 'lib/rubygems/resolver/installer_set.rb', line 32



def initialize(domain)
  super()

  @domain = domain
  @remote = consider_remote?

  @f = Gem::SpecFetcher.fetcher

  @always_install      = []
  @ignore_dependencies = false
  @ignore_installed    = false
  @local               = {}
  @local_source        = Gem::Source::Local.new
  @remote_set          = Gem::Resolver::BestSet.new
  @specs               = {}
end


  







Instance Attribute Details



  

    #always_install   (readonly)
  

  

    This method is for internal use only.
  



  

    

::Gem::List of ::Gem::Specification objects that must always be installed.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 11



attr_reader :always_install # :nodoc:


  








  

    #consider_local?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  



  

    

Should local gems should be considered?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 93



def consider_local? # :nodoc:
  @domain == :both or @domain == :local
end


  








  

    #consider_remote?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  



  

    

Should remote gems should be considered?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 100



def consider_remote? # :nodoc:
  @domain == :both or @domain == :remote
end


  








  

    #ignore_dependencies   (rw)
  

  

    This method is for internal use only.
  



  

    

Only install gems in the always_install list


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 16



attr_accessor :ignore_dependencies # :nodoc:


  








  

    #ignore_installed   (rw)
  

  

    This method is for internal use only.
  



  

    

Do not look in the installed set when finding specifications.  This is used by the –install-dir option to gem install


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 22



attr_accessor :ignore_installed # :nodoc:


  








  

    #prerelease=(allow_prerelease)   (writeonly)
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 164



def prerelease=(allow_prerelease)
  super

  @remote_set.prerelease = allow_prerelease
end


  








  

    #remote=(remote)   (writeonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 216



def remote=(remote) # :nodoc:
  case @domain
  when :local then
    @domain = :both if remote
  when :remote then
    @domain = nil unless remote
  when :both then
    @domain = :local unless remote
  end
end


  








  

    #remote_set   (readonly)
  

  

    This method is for internal use only.
  



  

    

The remote_set looks up remote gems for installation.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 27



attr_reader :remote_set # :nodoc:


  







Instance Method Details



  

    #add_always_install(dependency)  
  



  

    

Looks up the latest specification for dependency and adds it to the always_install list.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 53



def add_always_install(dependency)
  request = Gem::Resolver::DependencyRequest.new dependency, nil

  found = find_all request

  found.delete_if { |s|
    s.version.prerelease? and not s.local?
  } unless dependency.prerelease?

  found = found.select do |s|
    Gem::Source::SpecificFile === s.source or
      Gem::Platform::RUBY == s.platform or
      Gem::Platform.local === s.platform
  end

  if found.empty?
    exc = Gem::UnsatisfiableDependencyError.new request
    exc.errors = errors

    raise exc
  end

  newest = found.max_by do |s|
    [s.version, s.platform == Gem::Platform::RUBY ? -1 : 1]
  end

  @always_install << newest.spec
end


  








  

    #add_local(dep_name, spec, source)  
  



  

    

Adds a local gem requested using dep_name with the given spec that can be loaded and installed using the source.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 86



def add_local(dep_name, spec, source)
  @local[dep_name] = [spec, source]
end


  








  

    #errors  
  



  

    

Errors encountered while resolving gems


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 107



def errors
  @errors + @remote_set.errors
end


  








  

    #find_all(req)  
  



  

    

Returns an array of IndexSpecification objects matching DependencyRequest req.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 115



def find_all(req)
  res = []

  dep  = req.dependency

  return res if @ignore_dependencies and
            @always_install.none? { |spec| dep.match? spec }

  name = dep.name

  dep.matching_specs.each do |gemspec|
    next if @always_install.any? { |spec| spec.name == gemspec.name }

    res << Gem::Resolver::InstalledSpecification.new(self, gemspec)
  end unless @ignore_installed

  if consider_local?
    matching_local = @local.values.select do |spec, _|
      req.match? spec
    end.map do |spec, source|
      Gem::Resolver::LocalSpecification.new self, spec, source
    end

    res.concat matching_local

    begin
      if local_spec = @local_source.find_gem(name, dep.requirement)
        res << Gem::Resolver::IndexSpecification.new(
          self, local_spec.name, local_spec.version,
          @local_source, local_spec.platform)
      end
    rescue Gem::Package::FormatError
      # ignore
    end
  end

  res.delete_if do |spec|
    spec.version.prerelease? and not dep.prerelease?
  end

  res.concat @remote_set.find_all req if consider_remote?

  res
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 170



def inspect # :nodoc:
  always_install = @always_install.map { |s| s.full_name }

  '#<%s domain: %s specs: %p always install: %p>' % [
    self.class, @domain, @specs.keys, always_install,
  ]
end


  








  

    #load_spec(name, ver, platform, source)  
  

  

    This method is for internal use only.
  



  

    

Called from IndexSpecification to get a true Specification object.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 182



def load_spec(name, ver, platform, source) # :nodoc:
  key = "#{name}-#{ver}-#{platform}"

  @specs.fetch key do
    tuple = Gem::NameTuple.new name, ver, platform

    @specs[key] = source.fetch_spec tuple
  end
end


  








  

    #local?(dep_name)  ⇒ Boolean 
  

  

    This method is for internal use only.
  



  

    

Has a local gem for dep_name been added to this set?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 195



def local?(dep_name) # :nodoc:
  spec, _ = @local[dep_name]

  spec
end


  








  

    #prefetch(reqs)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 160



def prefetch(reqs)
  @remote_set.prefetch(reqs) if consider_remote?
end


  








  

    #pretty_print(q)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/installer_set.rb', line 201



def pretty_print(q) # :nodoc:
  q.group 2, '[InstallerSet', ']' do
    q.breakable
    q.text "domain: #{@domain}"

    q.breakable
    q.text 'specs: '
    q.pp @specs.keys

    q.breakable
    q.text 'always install: '
    q.pp @always_install
  end
end