Class: Gem::RequestSet (Ruby 2.2.4)
Description: Class : Gem::RequestSet - Ruby 2.2.4

- Home
- Core 2.2.4
- Std-lib 2.2.4
- Downloads

Support for the Ruby 2.2 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/request_set.rb
- rubygems/request_set/gem_dependency_api.rb
- rubygems/request_set/lockfile.rb

### Parent

Object

### Namespace

- CLASS Gem::RequestSet::GemDependencyAPI
- CLASS Gem::RequestSet::Lockfile

### Methods

- ::new
- #gem
- #import
- #install
- #install_from_gemdeps
- #install_into
- #load_gemdeps
- #resolve
- #resolve_current
- #sorted_requests
- #specs
- #specs_in

### Included Modules

- TSort

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConfigFile::Psych
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StringSink
- Gem::StringSource
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::RequestSet

A RequestSet groups a request to activate a set of dependencies.

    nokogiri = Gem::Dependency.new 'nokogiri', '~> 1.6'
    pg = Gem::Dependency.new 'pg', '~> 0.14'

    set = Gem::RequestSet.new nokogiri, pg

    requests = set.resolve

    p requests.map { |r| r.full_name }
    #=> ["nokogiri-1.6.0", "mini_portile-0.5.1", "pg-0.17.0"]

### Attributes

always_install[RW]

Array of gems to install even if already installed

dependencies[R]
development[RW]
development_shallow[RW]

Set to true if you want to install only direct development dependencies.

errors[R]

Errors fetching gems during resolution.

ignore_dependencies[RW]

When true, dependency resolution is not performed, only the requested gems are installed.

prerelease[RW]

If true, allow dependencies to match prerelease gems.

remote[RW]

When false no remote sets are used for resolving gems.

soft_missing[RW]

Treat missing dependencies as silent errors

### Public Class Methods

new(*deps) click to toggle source

Creates a RequestSet for a list of Gem::Dependency objects, `deps`. You can then resolve and install the resolved list of dependencies.

    nokogiri = Gem::Dependency.new 'nokogiri', '~> 1.6'
    pg = Gem::Dependency.new 'pg', '~> 0.14'

    set = Gem::RequestSet.new nokogiri, pg

                   # File rubygems/request_set.rb, line 88
    def initialize *deps
      @dependencies = deps

      @always_install      = []
      @conservative        = false
      @dependency_names    = {}
      @development         = false
      @development_shallow = false
      @errors              = []
      @git_set             = nil
      @ignore_dependencies = false
      @install_dir         = Gem.dir
      @prerelease          = false
      @remote              = true
      @requests            = []
      @sets                = []
      @soft_missing        = false
      @sorted              = nil
      @specs               = nil
      @vendor_set          = nil

      yield self if block_given?
    end

### Public Instance Methods

gem(name, *reqs) click to toggle source

Declare that a gem of name `name` with `reqs` requirements is needed.

                   # File rubygems/request_set.rb, line 115
    def gem name, *reqs
      if dep = @dependency_names[name] then
        dep.requirement.concat reqs
      else
        dep = Gem::Dependency.new name, reqs
        @dependency_names[name] = dep
        @dependencies << dep
      end
    end

import(deps) click to toggle source

Add `deps` Gem::Dependency objects to the set.

                   # File rubygems/request_set.rb, line 128
    def import deps
      @dependencies.concat deps
    end

install(options, &block) click to toggle source

Installs gems for this RequestSet using the Gem::Installer `options`.

If a `block` is given an activation `request` and `installer` are yielded. The `installer` will be `nil` if a gem matching the request was already installed.

                   # File rubygems/request_set.rb, line 139
    def install options, &block # :yields: request, installer
      if dir = options[:install_dir]
        requests = install_into dir, false, options, &block
        return requests
      end

      cache_dir = options[:cache_dir] || Gem.dir
      @prerelease = options[:prerelease]

      requests = []

      sorted_requests.each do |req|
        if req.installed? then
          req.spec.spec.build_extensions

          if @always_install.none? { |spec| spec == req.spec.spec } then
            yield req, nil if block_given?
            next
          end
        end

        path = req.download cache_dir

        inst = Gem::Installer.new path, options

        yield req, inst if block_given?

        requests << inst.install
      end

      requests
    ensure
      raise if $!
      return requests if options[:gemdeps]

      specs = requests.map do |request|
        case request
        when Gem::Resolver::ActivationRequest then
          request.spec.spec
        else
          request
        end
      end

      require 'rubygems/dependency_installer'
      inst = Gem::DependencyInstaller.new options
      inst.installed_gems.replace specs

      Gem.done_installing_hooks.each do |hook|
        hook.call inst, specs
      end unless Gem.done_installing_hooks.empty?
    end

install_from_gemdeps(options, &block) click to toggle source

Installs from the gem dependencies files in the `:gemdeps` option in `options`, yielding to the `block` as in install.

If `:without_groups` is given in the `options`, those groups in the gem dependencies file are not used. See Gem::Installer for other `options`.

                   # File rubygems/request_set.rb, line 199
    def install_from_gemdeps options, &block
      gemdeps = options[:gemdeps]

      @install_dir = options[:install_dir] || Gem.dir
      @prerelease  = options[:prerelease]
      @remote      = options[:domain] != :local
      @conservative = true if options[:conservative]

      gem_deps_api = load_gemdeps gemdeps, options[:without_groups], true

      resolve

      if options[:explain]
        puts "Gems to install:"

        sorted_requests.each do |spec|
          puts "  #{spec.full_name}"
        end

        if Gem.configuration.really_verbose
          @resolver.stats.display
        end
      else
        installed = install options, &block

        if options.fetch :lock, true then
          lockfile =
            Gem::RequestSet::Lockfile.new self, gemdeps, gem_deps_api.dependencies
          lockfile.write
        end

        installed
      end
    end

install_into(dir, force = true, options = {}) click to toggle source

                   # File rubygems/request_set.rb, line 234
    def install_into dir, force = true, options = {}
      gem_home, ENV['GEM_HOME'] = ENV['GEM_HOME'], dir

      existing = force ? [] : specs_in(dir)
      existing.delete_if { |s| @always_install.include? s }

      dir = File.expand_path dir

      installed = []

      options[:development] = false
      options[:install_dir] = dir
      options[:only_install_dir] = true
      @prerelease = options[:prerelease]

      sorted_requests.each do |request|
        spec = request.spec

        if existing.find { |s| s.full_name == spec.full_name } then
          yield request, nil if block_given?
          next
        end

        spec.install options do |installer|
          yield request, installer if block_given?
        end

        installed << request
      end

      installed
    ensure
      ENV['GEM_HOME'] = gem_home
    end

load_gemdeps(path, without_groups = [], installing = false) click to toggle source

Load a dependency management file.

                   # File rubygems/request_set.rb, line 272
    def load_gemdeps path, without_groups = [], installing = false
      @git_set    = Gem::Resolver::GitSet.new
      @vendor_set = Gem::Resolver::VendorSet.new

      @git_set.root_dir = @install_dir

      lockfile = Gem::RequestSet::Lockfile.new self, path
      lockfile.parse

      gf = Gem::RequestSet::GemDependencyAPI.new self, path
      gf.installing = installing
      gf.without_groups = without_groups if without_groups
      gf.load
    end

resolve(set = Gem::Resolver::BestSet.new) click to toggle source

Resolve the requested dependencies and return an Array of Specification objects to be activated.

                   # File rubygems/request_set.rb, line 333
    def resolve set = Gem::Resolver::BestSet.new
      @sets << set
      @sets << @git_set
      @sets << @vendor_set

      set = Gem::Resolver.compose_sets(*@sets)
      set.remote = @remote
      set.prerelease = @prerelease

      resolver = Gem::Resolver.new @dependencies, set
      resolver.development         = @development
      resolver.development_shallow = @development_shallow
      resolver.ignore_dependencies = @ignore_dependencies
      resolver.soft_missing        = @soft_missing

      if @conservative
        installed_gems = {}
        Gem::Specification.find_all do |spec|
          (installed_gems[spec.name] ||= []) << spec
        end
        resolver.skip_gems = installed_gems
      end

      @resolver = resolver

      @requests = resolver.resolve

      @errors = set.errors

      @requests
    end

resolve_current() click to toggle source

Resolve the requested dependencies against the gems available via Gem.path and return an Array of Specification objects to be activated.

                   # File rubygems/request_set.rb, line 369
    def resolve_current
      resolve Gem::Resolver::CurrentSet.new
    end

sorted_requests() click to toggle source

                   # File rubygems/request_set.rb, line 373
    def sorted_requests
      @sorted ||= strongly_connected_components.flatten
    end

specs() click to toggle source

                   # File rubygems/request_set.rb, line 377
    def specs
      @specs ||= @requests.map { |r| r.full_spec }
    end

specs_in(dir) click to toggle source

                   # File rubygems/request_set.rb, line 381
    def specs_in dir
      Dir["#{dir}/specifications/*.gemspec"].map do |g|
        Gem::Specification.load g
      end
    end