Class: Gem::Commands::SourcesCommand
- Inherits:
-
Gem::Command
- Object
- Gem::Command
- Gem::Commands::SourcesCommand
- Includes:
- LocalRemoteOptions
- Defined in:
- lib/rubygems/commands/sources_command.rb
Instance Attribute Summary
Attributes inherited from Gem::Command
#command, #defaults, #options, #program_name, #summary
Instance Method Summary collapse
-
#add_source(source_uri) ⇒ Object
:nodoc:.
-
#check_rubygems_https(source_uri) ⇒ Object
:nodoc:.
-
#clear_all ⇒ Object
:nodoc:.
-
#defaults_str ⇒ Object
:nodoc:.
-
#description ⇒ Object
:nodoc:.
- #execute ⇒ Object
-
#initialize ⇒ SourcesCommand
constructor
A new instance of SourcesCommand.
-
#list ⇒ Object
:nodoc:.
-
#list? ⇒ Boolean
:nodoc:.
-
#remove_cache_file(desc, path) ⇒ Object
:nodoc:.
-
#remove_source(source_uri) ⇒ Object
:nodoc:.
-
#update ⇒ Object
:nodoc:.
Methods included from LocalRemoteOptions
#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?
Methods inherited from Gem::Command
add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #arguments, #begins?, build_args, build_args=, common_options, extra_args, extra_args=, #get_all_gem_names, #get_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #usage, #when_invoked
Methods included from UserInteraction
#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Constructor Details
#initialize ⇒ SourcesCommand
Returns a new instance of SourcesCommand.
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
# File 'lib/rubygems/commands/sources_command.rb', line 11 def initialize require 'fileutils' super 'sources', 'Manage the sources and cache file RubyGems uses to search for gems' add_option '-a', '--add SOURCE_URI', 'Add source' do |value, | [:add] = value end add_option '-l', '--list', 'List sources' do |value, | [:list] = value end add_option '-r', '--remove SOURCE_URI', 'Remove source' do |value, | [:remove] = value end add_option '-c', '--clear-all', 'Remove all sources (clear the cache)' do |value, | [:clear_all] = value end add_option '-u', '--update', 'Update source cache' do |value, | [:update] = value end add_proxy_option end |
Instance Method Details
#add_source(source_uri) ⇒ Object
:nodoc:
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/rubygems/commands/sources_command.rb', line 41 def add_source(source_uri) # :nodoc: check_rubygems_https source_uri source = Gem::Source.new source_uri begin if Gem.sources.include? source say "source #{source_uri} already present in the cache" else source.load_specs :released Gem.sources << source Gem.configuration.write say "#{source_uri} added to sources" end rescue URI::Error, ArgumentError say "#{source_uri} is not a URI" terminate_interaction 1 rescue Gem::RemoteFetcher::FetchError => e say "Error fetching #{source_uri}:\n\t#{e.message}" terminate_interaction 1 end end |
#check_rubygems_https(source_uri) ⇒ Object
:nodoc:
65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/rubygems/commands/sources_command.rb', line 65 def check_rubygems_https(source_uri) # :nodoc: uri = URI source_uri if uri.scheme and uri.scheme.downcase == 'http' and uri.host.downcase == 'rubygems.org' question = "https://rubygems.org is recommended for security over \#{uri}\n\nDo you want to add this insecure source?\n QUESTION\n\n terminate_interaction 1 unless ask_yes_no question\n end\nend\n".chomp |
#clear_all ⇒ Object
:nodoc:
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/rubygems/commands/sources_command.rb', line 80 def clear_all # :nodoc: path = Gem.spec_cache_dir FileUtils.rm_rf path unless File.exist? path say "*** Removed specs cache ***" else unless File.writable? path say "*** Unable to remove source cache (write protected) ***" else say "*** Unable to remove source cache ***" end terminate_interaction 1 end end |
#defaults_str ⇒ Object
:nodoc:
97 98 99 |
# File 'lib/rubygems/commands/sources_command.rb', line 97 def defaults_str # :nodoc: '--list' end |
#description ⇒ Object
:nodoc:
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/rubygems/commands/sources_command.rb', line 101 def description # :nodoc: "RubyGems fetches gems from the sources you have configured (stored in your\n~/.gemrc).\n\nThe default source is https://rubygems.org, but you may have other sources\nconfigured. This guide will help you update your sources or configure\nyourself to use your own gem server.\n\nWithout any arguments the sources lists your currently configured sources:\n\n$ gem sources\n*** CURRENT SOURCES ***\n\nhttps://rubygems.org\n\nThis may list multiple sources or non-rubygems sources. You probably\nconfigured them before or have an old `~/.gemrc`. If you have sources you\ndo not recognize you should remove them.\n\nRubyGems has been configured to serve gems via the following URLs through\nits history:\n\n* http://gems.rubyforge.org (RubyGems 1.3.6 and earlier)\n* http://rubygems.org (RubyGems 1.3.7 through 1.8.25)\n* https://rubygems.org (RubyGems 2.0.1 and newer)\n\nSince all of these sources point to the same set of gems you only need one\nof them in your list. https://rubygems.org is recommended as it brings the\nprotections of an SSL connection to gem downloads.\n\nTo add a source use the --add argument:\n\n $ gem sources --add https://rubygems.org\n https://rubygems.org added to sources\n\nRubyGems will check to see if gems can be installed from the source given\nbefore it is added.\n\nTo remove a source use the --remove argument:\n\n $ gem sources --remove http://rubygems.org\n http://rubygems.org removed from sources\n\n EOF\nend\n" |
#execute ⇒ Object
164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/rubygems/commands/sources_command.rb', line 164 def execute clear_all if [:clear_all] source_uri = [:add] add_source source_uri if source_uri source_uri = [:remove] remove_source source_uri if source_uri update if [:update] list if list? end |
#list ⇒ Object
:nodoc:
148 149 150 151 152 153 154 155 |
# File 'lib/rubygems/commands/sources_command.rb', line 148 def list # :nodoc: say "*** CURRENT SOURCES ***" say Gem.sources.each do |src| say src end end |
#list? ⇒ Boolean
:nodoc:
157 158 159 160 161 162 |
# File 'lib/rubygems/commands/sources_command.rb', line 157 def list? # :nodoc: !([:add] || [:clear_all] || [:remove] || [:update]) end |
#remove_cache_file(desc, path) ⇒ Object
:nodoc:
198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/rubygems/commands/sources_command.rb', line 198 def remove_cache_file(desc, path) # :nodoc: FileUtils.rm_rf path if not File.exist?(path) say "*** Removed #{desc} source cache ***" elsif not File.writable?(path) say "*** Unable to remove #{desc} source cache (write protected) ***" else say "*** Unable to remove #{desc} source cache ***" end end |
#remove_source(source_uri) ⇒ Object
:nodoc:
178 179 180 181 182 183 184 185 186 187 |
# File 'lib/rubygems/commands/sources_command.rb', line 178 def remove_source(source_uri) # :nodoc: unless Gem.sources.include? source_uri say "source #{source_uri} not present in cache" else Gem.sources.delete source_uri Gem.configuration.write say "#{source_uri} removed from sources" end end |
#update ⇒ Object
:nodoc:
189 190 191 192 193 194 195 196 |
# File 'lib/rubygems/commands/sources_command.rb', line 189 def update # :nodoc: Gem.sources.each_source do |src| src.load_specs :released src.load_specs :latest end say "source cache successfully updated" end |