123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::UninstallCommand

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

Overview

::Gem uninstaller command line tool

See gem help uninstall

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::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::VersionOption - Included

#add_platform_option

Add the –platform option to the option parser.

#add_prerelease_option

Add the –prerelease option to the option parser.

#add_version_option

Add the –version option to the option parser.

#get_platform_from_requirements

Extract platform given on the command line.

::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

#extract_gem_name_and_version, #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

Returns a value representing the “cost” of transforming str1 into str2 Vendored version of DidYouMean::Levenshtein.distance from the ruby/did_you_mean gem @ 1.4.0 github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37.

#truncate_text, #min3

Constructor Details

.newUninstallCommand

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 16

def initialize
  super "uninstall", "Uninstall gems from the local repository",
        :version => Gem::Requirement.default, :user_install => true,
        :check_dev => false, :vendor => false

  add_option("-a", "--[no-]all",
    "Uninstall all matching versions"
  ) do |value, options|
    options[:all] = value
  end

  add_option("-I", "--[no-]ignore-dependencies",
             "Ignore dependency requirements while",
             "uninstalling") do |value, options|
    options[:ignore] = value
  end

  add_option("-D", "--[no-]check-development",
             "Check development dependencies while uninstalling",
             "(default: false)") do |value, options|
    options[:check_dev] = value
  end

  add_option("-x", "--[no-]executables",
               "Uninstall applicable executables without",
               "confirmation") do |value, options|
    options[:executables] = value
  end

  add_option("-i", "--install-dir DIR",
             "Directory to uninstall gem from") do |value, options|
    options[:install_dir] = File.expand_path(value)
  end

  add_option("-n", "--bindir DIR",
             "Directory to remove executables from") do |value, options|
    options[:bin_dir] = File.expand_path(value)
  end

  add_option("--[no-]user-install",
             "Uninstall from user's home directory",
             "in addition to GEM_HOME.") do |value, options|
    options[:user_install] = value
  end

  add_option("--[no-]format-executable",
             "Assume executable names match Ruby's prefix and suffix.") do |value, options|
    options[:format_executable] = value
  end

  add_option("--[no-]force",
             "Uninstall all versions of the named gems",
             "ignoring dependencies") do |value, options|
    options[:force] = value
  end

  add_option("--[no-]abort-on-dependent",
             "Prevent uninstalling gems that are",
             "depended on by other gems.") do |value, options|
    options[:abort_on_dependent] = value
  end

  add_version_option
  add_platform_option

  add_option("--vendor",
             "Uninstall gem from the vendor directory.",
             "Only for use by gem repackagers.") do |value, options|
    unless Gem.vendor_dir
      raise Gem::OptionParser::InvalidOption.new "your platform is not supported"
    end

    alert_warning "Use your OS package manager to uninstall vendor gems"
    options[:vendor] = true
    options[:install_dir] = Gem.vendor_dir
  end
end

Instance Method Details

#arguments

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 94

def arguments # :nodoc:
  "GEMNAME       name of gem to uninstall"
end

#check_version

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 117

def check_version # :nodoc:
  if options[:version] != Gem::Requirement.default &&
     get_all_gem_names.size > 1
    alert_error "Can't use --version with multiple gems. You can specify multiple gems with" \
                " version requirements using `gem uninstall 'my_gem:1.0.0' 'my_other_gem:~>2.0.0'`"
    terminate_interaction 1
  end
end

#defaults_str

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 98

def defaults_str # :nodoc:
  "--version '#{Gem::Requirement.default}' --no-force " +
    "--user-install"
end

#description

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 103

def description # :nodoc:
  <<-EOF
The uninstall command removes a previously installed gem.

RubyGems will ask for confirmation if you are attempting to uninstall a gem
that is a dependency of an existing gem.  You can use the
--ignore-dependencies option to skip this check.
  EOF
end

#execute

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 126

def execute
  check_version

  # Consider only gem specifications installed at `--install-dir`
  Gem::Specification.dirs = options[:install_dir] if options[:install_dir]

  if options[:all] && !options[:args].empty?
    uninstall_specific
  elsif options[:all]
    uninstall_all
  else
    uninstall_specific
  end
end

#uninstall(gem_name)

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 198

def uninstall(gem_name)
  Gem::Uninstaller.new(gem_name, options).uninstall
end

#uninstall_all

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 141

def uninstall_all
  specs = Gem::Specification.reject {|spec| spec.default_gem? }

  specs.each do |spec|
    options[:version] = spec.version
    uninstall_gem spec.name
  end

  alert "Uninstalled all gems in #{options[:install_dir] || Gem.dir}"
end

#uninstall_gem(gem_name)

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 184

def uninstall_gem(gem_name)
  uninstall(gem_name)
rescue Gem::GemNotInHomeException => e
  spec = e.spec
  alert("In order to remove #{spec.name}, please execute:\n" +
        "\tgem uninstall #{spec.name} --install-dir=#{spec.installation_path}")
rescue Gem::UninstallError => e
  spec = e.spec
  alert_error("Error: unable to successfully uninstall '#{spec.name}' which is " +
        "located at '#{spec.full_gem_path}'. This is most likely because" +
        "the current user does not have the appropriate permissions")
  terminate_interaction 1
end

#uninstall_specific

[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 152

def uninstall_specific
  deplist = Gem::DependencyList.new
  original_gem_version = {}

  get_all_gem_names_and_versions.each do |name, version|
    original_gem_version[name] = version || options[:version]

    gem_specs = Gem::Specification.find_all_by_name(name, original_gem_version[name])

    say("Gem '#{name}' is not installed") if gem_specs.empty?
    gem_specs.each do |spec|
      deplist.add spec
    end
  end

  deps = deplist.strongly_connected_components.flatten.reverse

  gems_to_uninstall = {}

  deps.each do |dep|
    unless gems_to_uninstall[dep.name]
      gems_to_uninstall[dep.name] = true

      unless original_gem_version[dep.name] == Gem::Requirement.default
        options[:version] = dep.version
      end

      uninstall_gem(dep.name)
    end
  end
end

#usage

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/uninstall_command.rb', line 113

def usage # :nodoc:
  "#{program_name} GEMNAME [GEMNAME ...]"
end