Module: Gem::InstallUpdateOptions (Ruby 2.3.2)
Description: Module : Gem::InstallUpdateOptions - 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/install_update_options.rb

### Methods

- #add_install_update_options
- #install_update_defaults_str

### 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::InstallUpdateOptions

Mixin methods for install and update options for Gem::Commands

### Public Instance Methods

add_install_update_options() click to toggle source

Add the install/update options to the option parser.

                   # File rubygems/install_update_options.rb, line 24
    def add_install_update_options
      # TODO: use @parser.accept
      OptionParser.accept Gem::Security::Policy do |value|
        require 'rubygems/security'

        raise OptionParser::InvalidArgument, 'OpenSSL not installed' unless
          defined?(Gem::Security::HighSecurity)

        value = Gem::Security::Policies[value]
        valid = Gem::Security::Policies.keys.sort
        message = "#{value} (#{valid.join ', '} are valid)"
        raise OptionParser::InvalidArgument, message if value.nil?
        value
      end

      add_option(:"Install/Update", '-i', '--install-dir DIR',
                 'Gem repository directory to get installed',
                 'gems') do |value, options|
        options[:install_dir] = File.expand_path(value)
      end

      add_option(:"Install/Update", '-n', '--bindir DIR',
                 'Directory where binary files are',
                 'located') do |value, options|
        options[:bin_dir] = File.expand_path(value)
      end

      add_option(:"Install/Update",       '--[no-]document [TYPES]', Array,
                 'Generate documentation for installed gems',
                 'List the documentation types you wish to',
                 'generate.  For example: rdoc,ri') do |value, options|
        options[:document] = case value
                             when nil   then %w[ri]
                             when false then []
                             else            value
                             end
      end

      add_option(:"Install/Update", '--build-root DIR',
                 'Temporary installation root. Useful for building',
                 'packages. Do not use this when installing remote gems.') do |value, options|
        options[:build_root] = File.expand_path(value)
      end

      add_option(:"Install/Update", '--vendor',
                 'Install gem into the vendor directory.',
                 'Only for use by gem repackagers.') do |value, options|
        unless Gem.vendor_dir then
          raise OptionParser::InvalidOption.new 'your platform is not supported'
        end

        options[:vendor] = true
        options[:install_dir] = Gem.vendor_dir
      end

      add_option(:"Install/Update", '-N', '--no-document',
                 'Disable documentation generation') do |value, options|
        options[:document] = []
      end

      add_option(:Deprecated, '--[no-]rdoc',
                 'Generate RDoc for installed gems',
                 'Use --document instead') do |value, options|
        if value then
          options[:document] << 'rdoc'
        else
          options[:document].delete 'rdoc'
        end

        options[:document].uniq!
      end

      add_option(:Deprecated, '--[no-]ri',
                 'Generate ri data for installed gems.',
                 'Use --document instead') do |value, options|
        if value then
          options[:document] << 'ri'
        else
          options[:document].delete 'ri'
        end

        options[:document].uniq!
      end

      add_option(:"Install/Update", '-E', '--[no-]env-shebang',
                 "Rewrite the shebang line on installed",
                 "scripts to use /usr/bin/env") do |value, options|
        options[:env_shebang] = value
      end

      add_option(:"Install/Update", '-f', '--[no-]force',
                 'Force gem to install, bypassing dependency',
                 'checks') do |value, options|
        options[:force] = value
      end

      add_option(:"Install/Update", '-w', '--[no-]wrappers',
                 'Use bin wrappers for executables',
                 'Not available on dosish platforms') do |value, options|
        options[:wrappers] = value
      end

      add_option(:"Install/Update", '-P', '--trust-policy POLICY',
                 Gem::Security::Policy,
                 'Specify gem trust policy') do |value, options|
        options[:security_policy] = value
      end

      add_option(:"Install/Update", '--ignore-dependencies',
                 'Do not install any required dependent gems') do |value, options|
        options[:ignore_dependencies] = value
      end

      add_option(:"Install/Update",       '--[no-]format-executable',
                 'Make installed executable names match ruby.',
                 'If ruby is ruby18, foo_exec will be',
                 'foo_exec18') do |value, options|
        options[:format_executable] = value
      end

      add_option(:"Install/Update",       '--[no-]user-install',
                 'Install in user\'s home directory instead',
                 'of GEM_HOME.') do |value, options|
        options[:user_install] = value
      end

      add_option(:"Install/Update", "--development",
                  "Install additional development",
                  "dependencies") do |value, options|
        options[:development] = true
        options[:dev_shallow] = true
      end

      add_option(:"Install/Update", "--development-all",
                  "Install development dependencies for all",
                  "gems (including dev deps themselves)") do |value, options|
        options[:development] = true
        options[:dev_shallow] = false
      end

      add_option(:"Install/Update", "--conservative",
                  "Don't attempt to upgrade gems already",
                  "meeting version requirement") do |value, options|
        options[:conservative] = true
        options[:minimal_deps] = true
      end

      add_option(:"Install/Update", "--minimal-deps",
                  "Don't upgrade any dependencies that already",
                  "meet version requirements") do |value, options|
        options[:minimal_deps] = true
      end

      add_option(:"Install/Update", "--[no-]post-install-message",
                  "Print post install message") do |value, options|
        options[:post_install_message] = value
      end
    end

install_update_defaults_str() click to toggle source

Default options for the gem install command.

                   # File rubygems/install_update_options.rb, line 186
    def install_update_defaults_str
      '--document=rdoc,ri --wrappers'
    end