123456789_123456789_123456789_123456789_123456789_

Module: Gem::LocalRemoteOptions

Overview

Mixin methods for local and remote Command options.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#both? ⇒ Boolean (readonly)

Is fetching of local and remote information enabled?

[ GitHub ] 

  


# File 'lib/rubygems/local_remote_options.rb', line 129



def both?
  options[:domain] == :both
end


  








  

    #local?  ⇒ Boolean  (readonly)
  



  

    

Is local fetching enabled?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 136



def local?
  options[:domain] == :local || options[:domain] == :both
end


  








  

    #remote?  ⇒ Boolean  (readonly)
  



  

    

Is remote fetching enabled?


  





  


  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 143



def remote?
  options[:domain] == :remote || options[:domain] == :both
end


  







Instance Method Details



  

    #accept_uri_http  
  



  

    

Allows OptionParser to handle HTTP URIs.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 19



def accept_uri_http
  Gem::OptionParser.accept Gem::URI::HTTP do |value|
    begin
      uri = Gem::URI.parse value
    rescue Gem::URI::InvalidURIError
      raise Gem::OptionParser::InvalidArgument, value
    end

    valid_uri_schemes = ["http", "https", "file", "s3"]
    unless valid_uri_schemes.include?(uri.scheme)
      msg = "Invalid uri scheme for #{value}\nPreface URLs with one of #{valid_uri_schemes.map {|s| "#{s}://" }}"
      raise ArgumentError, msg
    end

    value
  end
end


  








  

    #add_bulk_threshold_option  
  



  

    

Add the –bulk-threshold option


  



  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 66



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  
  



  

    

Add the –clear-sources option


  



  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 77



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  
  



  

    

Add local/remote options to the command line parser.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 40



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  
  



  

    

Add the –http-proxy option


  



  [ GitHub ]


  

  


# 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]", Gem::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  
  



  

    

Add the –source option


  



  [ GitHub ]


  

  


# File 'lib/rubygems/local_remote_options.rb', line 101



def add_source_option
  accept_uri_http

  add_option(:"Local/Remote", "-s", "--source URL", Gem::URI::HTTP,
             "Append URL to list of remote gem sources") do |source, options|
    source << "/" unless source.end_with?("/")

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


  








  

    #add_update_sources_option  
  



  

    

Add the –update-sources option


  



  [ GitHub ]


  

  


# File 'lib/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