123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::SourcesCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Gem::Command
Defined in: lib/rubygems/commands/sources_command.rb

Constant Summary

::Gem::Command - Inherited

HELP

Class Attribute Summary

::Gem::Command - Inherited

.build_args

Arguments used when building gems.

.build_args=, .extra_args, .extra_args=

Class Method Summary

::Gem::Command - Inherited

.add_common_option,
.add_specific_extra_args

Add a list of extra arguments for the given command.

.common_options,
.new

Initializes a generic gem command named command.

.specific_extra_args

Return an array of extra arguments for the command.

.specific_extra_args_hash

Accessor for the specific extra args hash (self initializing).

Instance Attribute Summary

::Gem::LocalRemoteOptions - Included

#both?

Is fetching of local and remote information enabled?

#local?

Is local fetching enabled?

#remote?

Is remote fetching enabled?

::Gem::Command - Inherited

#command

The name of the command.

#defaults

The default options for the command.

#deprecated?,
#options

The options for the command.

#program_name

The name of the command for command-line invocation.

#summary

A short description of the command.

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::LocalRemoteOptions - Included

#accept_uri_http

Allows ::Gem::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.

::Gem::Command - Inherited

#add_extra_args

Adds extra args from ~/.gemrc.

#add_option

Add a command-line option and handler to the command.

#arguments

Override to provide details of the arguments a command takes.

#begins?

True if long begins with the characters from short.

#check_deprecated_options,
#defaults_str

Override to display the default values of the command options.

#deprecate_option

Mark a command-line option as deprecated, and optionally specify a deprecation horizon.

#description

Override to display a longer description of what this command does.

#execute

Override to provide command handling.

#get_all_gem_names

Get all gem names from the command line.

#get_all_gem_names_and_versions

Get all [gem, version] from the command line.

#get_one_gem_name

Get a single gem name from the command line.

#get_one_optional_argument

Get a single optional argument from the command line.

#handle_options

Handle the given list of arguments by parsing them and recording the results.

#handles?

True if the command handles the given argument list.

#invoke

Invoke the command with the given list of arguments.

#invoke_with_build_args

Invoke the command with the given list of normal arguments and additional build arguments.

#merge_options

Merge a set of command options with the set of default options (without modifying the default option hash).

#remove_option

Remove previously defined command-line argument name.

#show_help

Display the help message for the command.

#show_lookup_failure

Display to the user that a gem couldn’t be found and reasons why –.

#usage

Override to display the usage for an individual gem command.

#when_invoked

Call the given block when invoked.

#add_parser_run_info

Adds a section with title and content to the parser help view.

#configure_options,
#create_option_parser

Creates an option parser and fills it in with the help info for the command.

#option_is_deprecated?,
#parser

Create on demand parser.

#wrap

Wraps text to width

#add_parser_description, #add_parser_options, #add_parser_summary

::Gem::UserInteraction - Included

#alert

Displays an alert statement.

#alert_error

Displays an error statement to the error output location.

#alert_warning

Displays a warning statement to the warning output location.

#ask

Asks a question and returns the answer.

#ask_for_password

Asks for a password with a prompt

#ask_yes_no

Asks a yes or no question.

#choose_from_list

Asks the user to answer question with an answer from the given #list.

#say

Displays the given statement on the standard output (or equivalent).

#terminate_interaction

Terminates the RubyGems process with the given exit_code

#verbose

Calls say with msg or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

#clean_text

Remove any non-printable characters and make the text suitable for printing.

#format_text

Wraps text to wrap characters and optionally indents by indent characters.

#levenshtein_distance

This code is based directly on the ::Gem::Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.

#truncate_text, #min3

Constructor Details

.newSourcesCommand

[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 10

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, options|
    options[:add] = value
  end

  add_option '-l', '--list', 'List sources' do |value, options|
    options[:list] = value
  end

  add_option '-r', '--remove SOURCE_URI', 'Remove source' do |value, options|
    options[:remove] = value
  end

  add_option '-c', '--clear-all',
             'Remove all sources (clear the cache)' do |value, options|
    options[:clear_all] = value
  end

  add_option '-u', '--update', 'Update source cache' do |value, options|
    options[:update] = value
  end

  add_option '-f', '--[no-]force', "Do not show any confirmation prompts and behave as if 'yes' was always answered" do |value, options|
    options[:force] = value
  end

  add_proxy_option
end

Instance Attribute Details

#list (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 165

def list # :nodoc:
  say "*** CURRENT SOURCES ***"
  say

  Gem.sources.each do |src|
    say src
  end
end

#list?Boolean (readonly)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 174

def list? # :nodoc:
  !(options[:add] ||
    options[:clear_all] ||
    options[:remove] ||
    options[:update])
end

Instance Method Details

#add_source(source_uri)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 44

def add_source(source_uri) # :nodoc:
  check_rubygems_https source_uri

  source = Gem::Source.new source_uri

  check_typo_squatting(source)

  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)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 82

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 = <<-QUESTION.chomp
https://rubygems.org is recommended for security over #{uri}

Do you want to add this insecure source?
    QUESTION

    terminate_interaction 1 unless options[:force] || ask_yes_no(question)
  end
end

#check_typo_squatting(source)

[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 70

def check_typo_squatting(source)
  if source.typo_squatting?("rubygems.org")
    question = <<-QUESTION.chomp
#{source.uri.to_s} is too similar to https://rubygems.org

Do you want to add this source?
    QUESTION

    terminate_interaction 1 unless options[:force] || ask_yes_no(question)
  end
end

#clear_all

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 97

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

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 114

def defaults_str # :nodoc:
  '--list'
end

#description

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 118

def description # :nodoc:
  <<-EOF
RubyGems fetches gems from the sources you have configured (stored in your
~/.gemrc).

The default source is https://rubygems.org, but you may have other sources
configured.  This guide will help you update your sources or configure
yourself to use your own gem server.

Without any arguments the sources lists your currently configured sources:

$ gem sources
*** CURRENT SOURCES ***

https://rubygems.org

This may list multiple sources or non-rubygems sources.  You probably
configured them before or have an old `~/.gemrc`.  If you have sources you
do not recognize you should remove them.

RubyGems has been configured to serve gems via the following URLs through
its history:

* http://gems.rubyforge.org (RubyGems 1.3.6 and earlier)
* https://rubygems.org/       (RubyGems 1.3.7 through 1.8.25)
* https://rubygems.org      (RubyGems 2.0.1 and newer)

Since all of these sources point to the same set of gems you only need one
of them in your list.  https://rubygems.org is recommended as it brings the
protections of an SSL connection to gem downloads.

To add a source use the --add argument:

  $ gem sources --add https://rubygems.org
  https://rubygems.org added to sources

RubyGems will check to see if gems can be installed from the source given
before it is added.

To remove a source use the --remove argument:

  $ gem sources --remove https://rubygems.org/
  https://rubygems.org/ removed from sources

  EOF
end

#execute

[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 181

def execute
  clear_all if options[:clear_all]

  source_uri = options[:add]
  add_source source_uri if source_uri

  source_uri = options[:remove]
  remove_source source_uri if source_uri

  update if options[:update]

  list if list?
end

#remove_cache_file(desc, path)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 215

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)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 195

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

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/sources_command.rb', line 206

def update # :nodoc:
  Gem.sources.each_source do |src|
    src.load_specs :released
    src.load_specs :latest
  end

  say "source cache successfully updated"
end