Module: Gem::LocalRemoteOptions (Ruby 2.2.2)
Description: Module : Gem::LocalRemoteOptions - Ruby 2.2.2

- Home
- Core 2.2.2
- Std-lib 2.2.2
- Downloads

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

### Home Classes Methods

### In Files

- rubygems/local_remote_options.rb

### Methods

- #accept_uri_http
- #add_bulk_threshold_option
- #add_clear_sources_option
- #add_local_remote_options
- #add_proxy_option
- #add_source_option
- #add_update_sources_option
- #both?
- #local?
- #remote?

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

Mixin methods for local and remote Gem::Command options.

### Public Instance Methods

accept_uri_http() click to toggle source

Allows OptionParser to handle HTTP URIs.

                   # File rubygems/local_remote_options.rb, line 18
    def accept_uri_http
      OptionParser.accept URI::HTTP do |value|
        begin
          uri = URI.parse value
        rescue URI::InvalidURIError
          raise OptionParser::InvalidArgument, value
        end

        unless ['http', 'https', 'file'].include?(uri.scheme)
           raise OptionParser::InvalidArgument, value
        end

        value
      end
    end

add_bulk_threshold_option() click to toggle source

Add the –bulk-threshold option

                   # File rubygems/local_remote_options.rb, line 63
    def add_bulk_threshold_option
      add_option(:"Local/Remote", '-B', '--bulk-threshold COUNT',
                 "Threshold for switching to bulk",
                 "synchronization (default #{Gem.configuration.bulk_threshold})") do
        |value, options|
        Gem.configuration.bulk_threshold = value.to_i
      end
    end

add_clear_sources_option() click to toggle source

Add the –clear-sources option

                   # File rubygems/local_remote_options.rb, line 75
    def add_clear_sources_option
      add_option(:"Local/Remote", '--clear-sources',
                 'Clear the gem sources') do |value, options|

        Gem.sources = nil
        options[:sources_cleared] = true
      end
    end

add_local_remote_options() click to toggle source

Add local/remote options to the command line parser.

                   # File rubygems/local_remote_options.rb, line 37
    def add_local_remote_options
      add_option(:"Local/Remote", '-l', '--local',
                 'Restrict operations to the LOCAL domain') do |value, options|
        options[:domain] = :local
      end

      add_option(:"Local/Remote", '-r', '--remote',
        'Restrict operations to the REMOTE domain') do |value, options|
        options[:domain] = :remote
      end

      add_option(:"Local/Remote", '-b', '--both',
                 'Allow LOCAL and REMOTE operations') do |value, options|
        options[:domain] = :both
      end

      add_bulk_threshold_option
      add_clear_sources_option
      add_source_option
      add_proxy_option
      add_update_sources_option
    end

add_proxy_option() click to toggle source

Add the –http-proxy option

                   # File rubygems/local_remote_options.rb, line 87
    def add_proxy_option
      accept_uri_http

      add_option(:"Local/Remote", '-p', '--[no-]http-proxy [URL]', URI::HTTP,
                 'Use HTTP proxy for remote operations') do |value, options|
        options[:http_proxy] = (value == false) ? :no_proxy : value
        Gem.configuration[:http_proxy] = options[:http_proxy]
      end
    end

add_source_option() click to toggle source

Add the –source option

                   # File rubygems/local_remote_options.rb, line 100
    def add_source_option
      accept_uri_http

      add_option(:"Local/Remote", '-s', '--source URL', URI::HTTP,
                 'Append URL to list of remote gem sources') do |source, options|

        source << '/' if source !~ /\/\z/

        if options.delete :sources_cleared then
          Gem.sources = [source]
        else
          Gem.sources << source unless Gem.sources.include?(source)
        end
      end
    end

add_update_sources_option() click to toggle source

Add the –update-sources option

                   # File rubygems/local_remote_options.rb, line 119
    def add_update_sources_option
      add_option(:Deprecated, '-u', '--[no-]update-sources',
                 'Update local source cache') do |value, options|
        Gem.configuration.update_sources = value
      end
    end

both?() click to toggle source

Is fetching of local and remote information enabled?

                   # File rubygems/local_remote_options.rb, line 129
    def both?
      options[:domain] == :both
    end

local?() click to toggle source

Is local fetching enabled?

                   # File rubygems/local_remote_options.rb, line 136
    def local?
      options[:domain] == :local || options[:domain] == :both
    end

remote?() click to toggle source

Is remote fetching enabled?

                   # File rubygems/local_remote_options.rb, line 143
    def remote?
      options[:domain] == :remote || options[:domain] == :both
    end