Class: Gem::DependencyInstaller (Ruby 2.3.2)
Description: Class : Gem::DependencyInstaller - Ruby 2.3.2

- Home
- Core 2.3.2
- Std-lib 2.3.2
- Downloads

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

### Home Classes Methods

### In Files

- rubygems/dependency_installer.rb

### Parent

Object

### Methods

- ::new
- #consider_local?
- #consider_remote?
- #find_spec_by_name_and_version
- #install

### Included Modules

- Gem::UserInteraction

### 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::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::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- 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::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- 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::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- 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::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::DependencyInstaller

Installs a gem along with all its dependencies from local and remote gems.

### Attributes

document[R]

Documentation types. For use by the Gem.done_installing hook

errors[R]

Errors from SpecFetcher while searching for remote specifications

installed_gems[R]

List of gems installed by install in alphabetic order

### Public Class Methods

new(options = {}) click to toggle source

Creates a new installer instance.

Options are:

:cache_dir

  Alternate repository path to store .gem files in.

:domain

  :local, :remote, or :both. :local only searches gems in the current directory. :remote searches only gems in Gem.sources. :both searches both.

:env_shebang

  See Gem::Installer.new.

:force

  See Gem::Installer#install.

:format_executable

  See Gem::Installer#initialize.

:ignore_dependencies

  Don't install any dependencies.

:install_dir

  See Gem::Installer#install.

:prerelease

  Allow prerelease versions. See install.

:security_policy

  See Gem::Installer.new and Gem::Security.

:user_install

  See Gem::Installer.new

:wrappers

  See Gem::Installer.new

:build_args

  See Gem::Installer.new

                   # File rubygems/dependency_installer.rb, line 72
    def initialize options = {}
      @only_install_dir = !!options[:install_dir]
      @install_dir = options[:install_dir] || Gem.dir
      @build_root = options[:build_root]

      options = DEFAULT_OPTIONS.merge options

      @bin_dir             = options[:bin_dir]
      @dev_shallow         = options[:dev_shallow]
      @development         = options[:development]
      @document            = options[:document]
      @domain              = options[:domain]
      @env_shebang         = options[:env_shebang]
      @force               = options[:force]
      @format_executable   = options[:format_executable]
      @ignore_dependencies = options[:ignore_dependencies]
      @prerelease          = options[:prerelease]
      @security_policy     = options[:security_policy]
      @user_install        = options[:user_install]
      @wrappers            = options[:wrappers]
      @build_args          = options[:build_args]
      @build_docs_in_background = options[:build_docs_in_background]
      @install_as_default  = options[:install_as_default]

      # Indicates that we should not try to update any deps unless
      # we absolutely must.
      @minimal_deps        = options[:minimal_deps]

      @available      = nil
      @installed_gems = []
      @toplevel_specs = nil

      @cache_dir = options[:cache_dir] || @install_dir

      @errors = []
    end

### Public Instance Methods

consider_local?() click to toggle source

Indicated, based on the requested domain, if local gems should be considered.

                   # File rubygems/dependency_installer.rb, line 182
    def consider_local?
      @domain == :both or @domain == :local
    end

consider_remote?() click to toggle source

Indicated, based on the requested domain, if remote gems should be considered.

                   # File rubygems/dependency_installer.rb, line 190
    def consider_remote?
      @domain == :both or @domain == :remote
    end

find_spec_by_name_and_version(gem_name, version = Gem::Requirement.default, prerelease = false) click to toggle source

Finds a spec and the source_uri it came from for gem `gem_name` and `version`. Returns an Array of specs and sources required for installation of the gem.

                   # File rubygems/dependency_installer.rb, line 274
    def find_spec_by_name_and_version gem_name,
                                      version = Gem::Requirement.default,
                                      prerelease = false
      set = Gem::AvailableSet.new

      if consider_local?
        if gem_name =~ /\.gem$/ and File.file? gem_name then
          src = Gem::Source::SpecificFile.new(gem_name)
          set.add src.spec, src
        elsif gem_name =~ /\.gem$/ then
          Dir[gem_name].each do |name|
            begin
              src = Gem::Source::SpecificFile.new name
              set.add src.spec, src
            rescue Gem::Package::FormatError
            end
          end
        else
          local = Gem::Source::Local.new

          if s = local.find_gem(gem_name, version)
            set.add s, local
          end
        end
      end

      if set.empty?
        dep = Gem::Dependency.new gem_name, version
        dep.prerelease = true if prerelease

        set = find_gems_with_sources(dep, true)
        set.match_platform!
      end

      if set.empty?
        raise Gem::SpecificGemNotFoundException.new(gem_name, version, @errors)
      end

      @available = set
    end

install(dep_or_name, version = Gem::Requirement.default) click to toggle source

Installs the gem `dep_or_name` and all its dependencies. Returns an Array of installed gem specifications.

If the `:prerelease` option is set and there is a prerelease for `dep_or_name` the prerelease version will be installed.

Unless explicitly specified as a prerelease dependency, prerelease gems that `dep_or_name` depend on will not be installed.

If c-1.a depends on b-1 and a-1.a and there is a gem b-1.a available then c-1.a, b-1 and a-1.a will be installed. b-1.a will need to be installed separately.

                   # File rubygems/dependency_installer.rb, line 382
    def install dep_or_name, version = Gem::Requirement.default
      request_set = resolve_dependencies dep_or_name, version

      @installed_gems = []

      options = {
        :bin_dir             => @bin_dir,
        :build_args          => @build_args,
        :document            => @document,
        :env_shebang         => @env_shebang,
        :force               => @force,
        :format_executable   => @format_executable,
        :ignore_dependencies => @ignore_dependencies,
        :prerelease          => @prerelease,
        :security_policy     => @security_policy,
        :user_install        => @user_install,
        :wrappers            => @wrappers,
        :build_root          => @build_root,
        :install_as_default  => @install_as_default
      }
      options[:install_dir] = @install_dir if @only_install_dir

      request_set.install options do |_, installer|
        @installed_gems << installer.spec if installer
      end

      @installed_gems.sort!

      # Since this is currently only called for docs, we can be lazy and just say
      # it's documentation. Ideally the hook adder could decide whether to be in
      # the background or not, and what to call it.
      in_background "Installing documentation" do
        Gem.done_installing_hooks.each do |hook|
          hook.call self, @installed_gems
        end
      end unless Gem.done_installing_hooks.empty?

      @installed_gems
    end