Module: Gem::LocalRemoteOptions
| Relationships & Source Files | |
| Extension / Inclusion / Inheritance Descendants | |
| Included In: 
        Commands::DependencyCommand,
          Commands::FetchCommand,
          Commands::InstallCommand,
          Commands::ListCommand,
          Commands::OutdatedCommand,
          Commands::OwnerCommand,
          Commands::PushCommand,
          Commands::QueryCommand,
          Commands::SearchCommand,
          Commands::SourcesCommand,
          Commands::SpecificationCommand,
          Commands::UpdateCommand,
          Commands::YankCommand
       | |
| Defined in: | lib/rubygems/local_remote_options.rb | 
Overview
Mixin methods for local and remote Command options.
Instance Attribute Summary
- 
    
      #both?  ⇒ Boolean 
    
    readonly
    Is fetching of local and remote information enabled? 
- 
    
      #local?  ⇒ Boolean 
    
    readonly
    Is local fetching enabled? 
- 
    
      #remote?  ⇒ Boolean 
    
    readonly
    Is remote fetching enabled? 
Instance Method Summary
- 
    
      #accept_uri_http  
    
    Allows OptionParser to handle HTTP URIs. 
- 
    
      #add_bulk_threshold_option  
    
    Add the –bulk-threshold option. 
- 
    
      #add_clear_sources_option  
    
    Add the –clear-sources option. 
- 
    
      #add_local_remote_options  
    
    Add local/remote options to the command line parser. 
- 
    
      #add_proxy_option  
    
    Add the –http-proxy option. 
- 
    
      #add_source_option  
    
    Add the –source option. 
- 
    
      #add_update_sources_option  
    
    Add the –update-sources option. 
Instance Attribute Details
    #both?  ⇒ Boolean  (readonly)
  
Is fetching of local and remote information enabled?
# File 'lib/rubygems/local_remote_options.rb', line 130
def both? [:domain] == :both end
    #local?  ⇒ Boolean  (readonly)
  
Is local fetching enabled?
# File 'lib/rubygems/local_remote_options.rb', line 137
def local? [:domain] == :local || [:domain] == :both end
    #remote?  ⇒ Boolean  (readonly)
  
Is remote fetching enabled?
# File 'lib/rubygems/local_remote_options.rb', line 144
def remote? [:domain] == :remote || [:domain] == :both end
Instance Method Details
#accept_uri_http
Allows OptionParser to handle HTTP URIs.
# File 'lib/rubygems/local_remote_options.rb', line 19
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', 's3'].include?(uri.scheme) raise OptionParser::InvalidArgument, value end value end end
#add_bulk_threshold_option
Add the –bulk-threshold option
# File 'lib/rubygems/local_remote_options.rb', line 64
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, | Gem.configuration.bulk_threshold = value.to_i end end
#add_clear_sources_option
Add the –clear-sources option
#add_local_remote_options
Add local/remote options to the command line parser.
# File 'lib/rubygems/local_remote_options.rb', line 38
def add_option(:"Local/Remote", '-l', '--local', 'Restrict operations to the LOCAL domain') do |value, | [:domain] = :local end add_option(:"Local/Remote", '-r', '--remote', 'Restrict operations to the REMOTE domain') do |value, | [:domain] = :remote end add_option(:"Local/Remote", '-b', '--both', 'Allow LOCAL and REMOTE operations') do |value, | [: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
Add the –http-proxy option
# File 'lib/rubygems/local_remote_options.rb', line 88
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, | [:http_proxy] = (value == false) ? :no_proxy : value Gem.configuration[:http_proxy] = [:http_proxy] end end
#add_source_option
Add the –source option
# File 'lib/rubygems/local_remote_options.rb', line 101
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, | source << '/' if source !~ /\/\z/ if .delete :sources_cleared then Gem.sources = [source] else Gem.sources << source unless Gem.sources.include?(source) end end end
#add_update_sources_option
Add the –update-sources option
# File 'lib/rubygems/local_remote_options.rb', line 120
def add_update_sources_option add_option(:Deprecated, '-u', '--[no-]update-sources', 'Update local source cache') do |value, | Gem.configuration.update_sources = value end end