Class: Gem::Commands::SourcesCommand

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

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

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

def append_source(source_uri) # :nodoc:
  check_rubygems_https source_uri

  source = Gem::Source.new source_uri

  check_typo_squatting(source)

  begin
    source.load_specs :released
    was_present = Gem.sources.include?(source)
    Gem.sources.append source
    Gem.configuration.write

    if was_present
      say "#{source_uri} moved to end of sources"
    else
      say "#{source_uri} added to sources"
    end
  rescue Gem::URI::Error, ArgumentError
    say "#{source_uri} is not a URI"
    terminate_interaction 1
  rescue Gem::RemoteFetcher::FetchError => e
    say "Error fetching #{Gem::Uri.redact(source.uri)}:\n\t#{e.message}"
    terminate_interaction 1
  end
end

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

def check_rubygems_https(source_uri) # :nodoc:
  uri = Gem::URI source_uri

  if uri.scheme && uri.scheme.casecmp("http").zero? &&
     uri.host.casecmp("rubygems.org").zero?
    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

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

def check_typo_squatting(source)
  if source.typo_squatting?("rubygems.org")
    question = <<-QUESTION.chomp
#{source.uri} 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

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

def clear_all # :nodoc:
  path = Gem.spec_cache_dir
  FileUtils.rm_rf path

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

    terminate_interaction 1
  else
    say "*** Removed specs cache ***"
  end
end

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

def config_file_name
  Gem.configuration.config_file_name
end

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

def configured_sources
  return @configured_sources if defined?(@configured_sources)

  configuration_sources = Gem.configuration.sources
  @configured_sources = Gem::SourceList.from(configuration_sources) if configuration_sources
end

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

def default_sources
  Gem::SourceList.from(Gem.default_sources)
end

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

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

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

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
*** NO CONFIGURED SOURCES, DEFAULT SOURCES LISTED BELOW ***

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.5 and earlier)
* http://rubygems.org       (RubyGems 1.3.6 through 1.8.30, and 2.0.0)
* 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 private gem source use the --prepend argument to insert it before
the default source. This is usually the best place for private gem sources:

  $ gem sources --prepend https://my.private.source
  https://my.private.source added to sources

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

To add or move a source after all other sources, use --append:

  $ gem sources --append https://rubygems.org
  https://rubygems.org moved to end of sources

To remove a source use the --remove argument:

  $ gem sources --remove https://my.private.source/
  https://my.private.source/ removed from sources

  EOF
end

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

def execute
  clear_all if options[:clear_all]

  add_source options[:add] if options[:add]

  prepend_source options[:prepend] if options[:prepend]

  append_source options[:append] if options[:append]

  remove_source options[:remove] if options[:remove]

  update if options[:update]

  list if list?
end

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

def prepend_source(source_uri) # :nodoc:
  check_rubygems_https source_uri

  source = Gem::Source.new source_uri

  check_typo_squatting(source)

  begin
    source.load_specs :released
    was_present = Gem.sources.include?(source)
    Gem.sources.prepend source
    Gem.configuration.write

    if was_present
      say "#{source_uri} moved to top of sources"
    else
      say "#{source_uri} added to sources"
    end
  rescue Gem::URI::Error, ArgumentError
    say "#{source_uri} is not a URI"
    terminate_interaction 1
  rescue Gem::RemoteFetcher::FetchError => e
    say "Error fetching #{Gem::Uri.redact(source.uri)}:\n\t#{e.message}"
    terminate_interaction 1
  end
end

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

def remove_cache_file(desc, path) # :nodoc:
  FileUtils.rm_rf path

  if !File.exist?(path)
    say "*** Removed #{desc} source cache ***"
  elsif !File.writable?(path)
    say "*** Unable to remove #{desc} source cache (write protected) ***"
  else
    say "*** Unable to remove #{desc} source cache ***"
  end
end

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

def remove_source(source_uri) # :nodoc:
  source = Gem::Source.new source_uri

  if configured_sources&.include? source
    Gem.sources.delete source
    Gem.configuration.write

    if default_sources.include?(source) && configured_sources.one?
      alert_warning "Removing a default source when it is the only source has no effect. Add a different source to #{config_file_name} if you want to stop using it as a source."
    else
      say "#{source_uri} removed from sources"
    end
  elsif configured_sources
    say "source #{source_uri} cannot be removed because it's not present in #{config_file_name}"
  else
    say "source #{source_uri} cannot be removed because there are no configured sources in #{config_file_name}"
  end
end

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

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

  say "source cache successfully updated"
end