Gem::Commands::SourcesCommand

Public Class Methods

new() click to toggle source

 
               # File 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_proxy_option
end

Public Instance Methods

defaults_str() click to toggle source

 
               # File rubygems/commands/sources_command.rb, line 40
def defaults_str
  '--list'
end

execute() click to toggle source

 
               # File rubygems/commands/sources_command.rb, line 44
  def execute
    options[:list] = !(options[:add] ||
                       options[:clear_all] ||
                       options[:remove] ||
                       options[:update])

    if options[:clear_all] then
      path = File.join Gem.user_home, '.gem', 'specs'
      FileUtils.rm_rf path

      unless File.exist? path then
        say "*** Removed specs cache ***"
      else
        unless File.writable? path then
          say "*** Unable to remove source cache (write protected) ***"
        else
          say "*** Unable to remove source cache ***"
        end

        terminate_interaction 1
      end
    end

    if source_uri = options[:add] then
      uri = URI source_uri

      if uri.scheme and uri.scheme.downcase == 'http' and
         uri.host.downcase == 'rubygems.org' then
        question = "https://rubygems.org is recommended for security over #{uri}

Do you want to add this insecure source?
".chomp

        terminate_interaction 1 unless ask_yes_no question
      end

      source = Gem::Source.new source_uri

      begin
        if Gem.sources.include? source_uri then
          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

    if options[:remove] then
      source_uri = options[:remove]

      unless Gem.sources.include? source_uri then
        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

    if options[:update] then
      Gem.sources.each_source do |src|
        src.load_specs :released
        src.load_specs :latest
      end

      say "source cache successfully updated"
    end

    if options[:list] then
      say "*** CURRENT SOURCES ***"
      say

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

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Included Modules

Class/Module Index

Gem::Commands::SourcesCommand

Public Class Methods

Public Instance Methods