Module: Gem::LocalRemoteOptions

Included in:
Commands::DependencyCommand, Commands::FetchCommand, Commands::InstallCommand, Commands::OutdatedCommand, Commands::OwnerCommand, Commands::PushCommand, Commands::SourcesCommand, Commands::SpecificationCommand, Commands::UpdateCommand, Commands::YankCommand, QueryUtils
Defined in:
lib/rubygems/local_remote_options.rb

Overview

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

Instance Method Summary collapse

Instance Method Details

#accept_uri_http ⇒ Object

Allows Gem::OptionParser to handle HTTP URIs.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# 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 ⇒ Object

Add the –bulk-threshold option



66
67
68
69
70
71
72
 
# 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 ⇒ Object

Add the –clear-sources option



77
78
79
80
81
82
83
 
# 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 ⇒ Object

Add local/remote options to the command line parser.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# 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 ⇒ Object

Add the –http-proxy option



88
89
90
91
92
93
94
95
96
 
# 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 ⇒ Object

Add the –source option



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# 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 ⇒ Object

Add the –update-sources option



119
120
121
122
123
124
 
# 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

#both? ⇒ Boolean

Is fetching of local and remote information enabled?

Returns:

  • (Boolean) 


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

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

#local? ⇒ Boolean

Is local fetching enabled?

Returns:

  • (Boolean) 


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

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

#remote? ⇒ Boolean

Is remote fetching enabled?

Returns:

  • (Boolean) 


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

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