Class: Gem::Uninstaller

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, `InstallerUninstallerUtils`, `UserInteraction`, `DefaultUserInteraction`, `Text`
Inherits:	Object
Defined in:	lib/rubygems/uninstaller.rb

Overview

An Uninstaller.

The uninstaller fires pre and post uninstall hooks. Hooks can be added either through a rubygems_plugin.rb file in an installed gem or via a rubygems/defaults/#RUBY_ENGINE.rb or rubygems/defaults/operating_system.rb file. See pre_uninstall and post_uninstall for details.

Class Method Summary

.new(gem, options = {}) ⇒ Uninstaller constructor

Constructs an uninstaller that will uninstall gem

Instance Attribute Summary

#bin_dir readonly

The directory a gem’s executables will be installed into.
#gem_home readonly

The gem repository the gem will be uninstalled from.
#spec readonly

The Specification for the gem being uninstalled, only set during #uninstall_gem
#abort_on_dependent? ⇒ Boolean readonly Internal use only

Should the uninstallation abort if a dependency will go unsatisfied?

`DefaultUserInteraction` - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

#path_ok?(gem_dir, spec) ⇒ Boolean

Is #spec in gem_dir?
#regenerate_plugins

Regenerates plugin wrappers after removal.
#remove(spec)

spec
the spec of the gem to be uninstalled.
#remove_all(list)

Removes all gems in list.
#remove_executables(spec)

Removes installed executables and batch files (windows only) for #spec.
#safe_delete(&block)
#uninstall

Performs the uninstall of the gem.
#uninstall_gem(stub)

Uninstalls gem #spec
#announce_deletion_of(spec) private
#default_spec_matches?(spec) ⇒ Boolean private
#default_specs_that_match(spec) ⇒ Array private
#plugin_dir_for(spec) private
#rm_r(path, exclusions:) private
#specification_record private
#warn_cannot_uninstall_default_gems(specs) private
#ask_if_ok(spec) Internal use only

Asks if it is OK to remove #spec.
#dependencies_ok?(spec) ⇒ Boolean Internal use only

Returns true if it is OK to remove #spec or this is a forced uninstallation.
#formatted_program_filename(filename) Internal use only

Returns the formatted version of the executable filename
#remove_plugins(spec) Internal use only

Remove any plugin wrappers for #spec.

`InstallerUninstallerUtils` - Included

#regenerate_plugins_for, #remove_plugins_for

`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.

`DefaultUserInteraction` - Included

#use_ui

See DefaultUserInteraction.use_ui

`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

.new(gem, options = {}) ⇒ `Uninstaller`

Constructs an uninstaller that will uninstall gem

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 48


def initialize(gem, options = {})
  # TODO: document the valid options
  @gem                = gem
  @version            = options[:version] || Gem::Requirement.default
  @install_dir        = options[:install_dir]
  @gem_home           = File.realpath(@install_dir || Gem.dir)
  @user_dir           = File.exist?(Gem.user_dir) ? File.realpath(Gem.user_dir) : Gem.user_dir
  @force_executables  = options[:executables]
  @force_all          = options[:all]
  @force_ignore       = options[:ignore]
  @bin_dir            = options[:bin_dir]
  @format_executable  = options[:format_executable]
  @abort_on_dependent = options[:abort_on_dependent]

  # Indicate if development dependencies should be checked when
  # uninstalling. (default: false)
  #
  @check_dev = options[:check_dev]

  if options[:force]
    @force_all = true
    @force_ignore = true
  end

  # only add user directory if install_dir is not set
  @user_install = false
  @user_install = options[:user_install] unless @install_dir

  # Optimization: populated during #uninstall
  @default_specs_matching_uninstall_params = []
end

Instance Attribute Details

#abort_on_dependent? ⇒ `Boolean` (readonly)

This method is for internal use only.

Should the uninstallation abort if a dependency will go unsatisfied?

See .new.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 333


def abort_on_dependent? # :nodoc:
  @abort_on_dependent
end

#bin_dir (readonly)

The directory a gem’s executables will be installed into

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 32


attr_reader :bin_dir

#gem_home (readonly)

The gem repository the gem will be uninstalled from

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 37


attr_reader :gem_home

#spec (readonly)

The Specification for the gem being uninstalled, only set during #uninstall_gem

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 43


attr_reader :spec

Instance Method Details

#announce_deletion_of(spec) (private)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 399


def announce_deletion_of(spec)
  name = spec.full_name
  say "Successfully uninstalled #{name}"
  if default_spec_matches?(spec)
    say(
      "There was both a regular copy and a default copy of #{name}. The " \
        "regular copy was successfully uninstalled, but the default copy " \
        "was left around because default gems can't be removed."
    )
  end
end

#ask_if_ok(spec)

This method is for internal use only.

Asks if it is OK to remove #spec. Returns true if it is OK.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 340


def ask_if_ok(spec) # :nodoc:
  msg = [""]
  msg << "You have requested to uninstall the gem:"
  msg << "\t#{spec.full_name}"
  msg << ""

  siblings = Gem::Specification.select do |s|
    s.name == spec.name && s.full_name != spec.full_name
  end

  spec.dependent_gems(@check_dev).each do |dep_spec, dep, _satlist|
    unless siblings.any? {|s| s.satisfies_requirement? dep }
      msg << "#{dep_spec.name}-#{dep_spec.version} depends on #{dep}"
    end
  end

  msg << "If you remove this gem, these dependencies will not be met."
  msg << "Continue with Uninstall?"
  ask_yes_no(msg.join("\n"), false)
end

#default_spec_matches?(spec) ⇒ `Boolean` (private)

Returns:

(Boolean) —

true if the specs of any default gems are == to the given #spec.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 412


def default_spec_matches?(spec)
  !default_specs_that_match(spec).empty?
end

#default_specs_that_match(spec) ⇒ `Array` (private)

Returns:

(Array) —

specs of default gems that are == to the given #spec.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 417


def default_specs_that_match(spec)
  @default_specs_matching_uninstall_params.select {|default_spec| spec == default_spec }
end

#dependencies_ok?(spec) ⇒ `Boolean`

This method is for internal use only.

Returns true if it is OK to remove #spec or this is a forced uninstallation.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 321


def dependencies_ok?(spec) # :nodoc:
  return true if @force_ignore

  deplist = Gem::DependencyList.from_specs
  deplist.ok_to_remove?(spec.full_name, @check_dev)
end

#formatted_program_filename(filename)

This method is for internal use only.

Returns the formatted version of the executable filename

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 364


def formatted_program_filename(filename) # :nodoc:
  # TODO perhaps the installer should leave a small manifest
  # of what it did for us to find rather than trying to recreate
  # it again.
  if @format_executable
    require_relative "installer"
    Gem::Installer.exec_format % File.basename(filename)
  else
    filename
  end
end

#path_ok?(gem_dir, spec) ⇒ `Boolean`

Is #spec in gem_dir?

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 310


def path_ok?(gem_dir, spec)
  full_path     = File.join gem_dir, "gems", spec.full_name
  original_path = File.join gem_dir, "gems", spec.original_name

  full_path == spec.full_gem_path || original_path == spec.full_gem_path
end

#plugin_dir_for(spec) (private)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 427


def plugin_dir_for(spec)
  Gem.plugindir(spec.base_dir)
end

#regenerate_plugins

Regenerates plugin wrappers after removal.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 300


def regenerate_plugins
  latest = specification_record.latest_spec_for(@spec.name)
  return if latest.nil?

  regenerate_plugins_for(latest, plugin_dir_for(@spec))
end

#remove(spec)

spec: the spec of the gem to be uninstalled

Raises:

(Gem::FilePermissionError)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 241


def remove(spec)
  unless path_ok?(@gem_home, spec) ||
         (@user_install && path_ok?(@user_dir, spec))
    e = Gem::GemNotInHomeException.new \
      "Gem '#{spec.full_name}' is not installed in directory #{@gem_home}"
    e.spec = spec

    raise e
  end

  raise Gem::FilePermissionError, spec.base_dir unless
    File.writable?(spec.base_dir)

  full_gem_path = spec.full_gem_path
  exclusions = []

  if default_spec_matches?(spec) && spec.executables.any?
    exclusions = spec.executables.map {|exe| File.join(spec.bin_dir, exe) }
    exclusions << File.dirname(exclusions.last) until exclusions.last == full_gem_path
  end

  safe_delete { rm_r full_gem_path, exclusions: exclusions }
  safe_delete { FileUtils.rm_r spec.extension_dir }

  old_platform_name = spec.original_name

  gem = spec.cache_file
  gem = File.join(spec.cache_dir, "#{old_platform_name}.gem") unless
    File.exist? gem

  safe_delete { FileUtils.rm_r gem }

  begin
    Gem::RDoc.new(spec).remove
  rescue NameError
  end

  gemspec = spec.spec_file

  unless File.exist? gemspec
    gemspec = File.join(File.dirname(gemspec), "#{old_platform_name}.gemspec")
  end

  safe_delete { FileUtils.rm_r gemspec }
  announce_deletion_of(spec)
end

#remove_all(list)

Removes all gems in list.

NOTE: removes uninstalled gems from list.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 234


def remove_all(list)
  list.each {|spec| uninstall_gem spec }
end

#remove_executables(spec)

Removes installed executables and batch files (windows only) for #spec.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 180


def remove_executables(spec)
  return if spec.executables.empty? || default_spec_matches?(spec)

  executables = spec.executables.clone

  # Leave any executables created by other installed versions
  # of this gem installed.

  list = Gem::Specification.find_all do |s|
    s.name == spec.name && s.version != spec.version
  end

  list.each do |s|
    s.executables.each do |exe_name|
      executables.delete exe_name
    end
  end

  return if executables.empty?

  executables = executables.map {|exec| formatted_program_filename exec }

  remove = if @force_executables.nil?
    ask_yes_no("Remove executables:\n" \
               "\t#{executables.join ", "}\n\n" \
               "in addition to the gem?",
               true)
  else
    @force_executables
  end

  if remove
    bin_dir = @bin_dir || Gem.bindir(spec.base_dir)

    raise Gem::FilePermissionError, bin_dir unless File.writable? bin_dir

    executables.each do |exe_name|
      say "Removing #{exe_name}"

      exe_file = File.join bin_dir, exe_name

      safe_delete { FileUtils.rm exe_file }
      safe_delete { FileUtils.rm "#{exe_file}.bat" }
    end
  else
    say "Executables and scripts will remain installed."
  end
end

#remove_plugins(spec)

This method is for internal use only.

Remove any plugin wrappers for #spec.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 291


def remove_plugins(spec) # :nodoc:
  return if spec.plugins.empty?

  remove_plugins_for(spec, plugin_dir_for(spec))
end

#rm_r(path, exclusions:) (private)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 389


def rm_r(path, exclusions:)
  FileUtils::Entry_.new(path).postorder_traverse do |ent|
    ent.remove unless exclusions.include?(ent.path)
  end
end

#safe_delete(&block)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 376


def safe_delete(&block)
  block.call
rescue Errno::ENOENT
  nil
rescue Errno::EPERM
  e = Gem::UninstallError.new
  e.spec = @spec

  raise e
end

#specification_record (private)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 395


def specification_record
  @specification_record ||= @install_dir ? Gem::SpecificationRecord.from_path(@install_dir) : Gem::Specification.specification_record
end

#uninstall

Performs the uninstall of the gem. This removes the spec, the ::Gem directory, and the cached .gem file.

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 84


def uninstall
  dependency = Gem::Dependency.new @gem, @version

  list = []

  specification_record.stubs.each do |spec|
    next unless dependency.matches_spec? spec

    list << spec
  end

  if list.empty?
    raise Gem::InstallError, "gem #{@gem.inspect} is not installed"
  end

  default_specs, list = list.partition(&:default_gem?)
  warn_cannot_uninstall_default_gems(default_specs - list)
  @default_specs_matching_uninstall_params = default_specs.map(&:to_spec)

  list, other_repo_specs = list.partition do |spec|
    @gem_home == spec.base_dir ||
      (@user_install && spec.base_dir == @user_dir)
  end

  list.sort!

  if list.empty?
    return unless other_repo_specs.any?

    other_repos = other_repo_specs.map(&:base_dir).uniq

    message = ["#{@gem} is not installed in GEM_HOME, try:"]
    message.concat other_repos.map {|repo|
      "\tgem uninstall -i #{repo} #{@gem}"
    }

    raise Gem::InstallError, message.join("\n")
  elsif @force_all
    remove_all list

  elsif list.size > 1
    gem_names = list.map(&:full_name_with_location)
    gem_names << "All versions"

    say
    _, index = choose_from_list "Select gem to uninstall:", gem_names

    if index == list.size
      remove_all list
    elsif index && index >= 0 && index < list.size
      uninstall_gem list[index]
    else
      say "Error: must enter a number [1-#{list.size + 1}]"
    end
  else
    uninstall_gem list.first
  end
end

#uninstall_gem(stub)

Uninstalls gem #spec

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 146


def uninstall_gem(stub)
  spec = stub.to_spec

  @spec = spec

  unless dependencies_ok? spec
    if abort_on_dependent? || !ask_if_ok(spec)
      raise Gem::DependencyRemovalException,
        "Uninstallation aborted due to dependent gem(s)"
    end
  end

  Gem.pre_uninstall_hooks.each do |hook|
    hook.call self
  end

  remove_executables @spec
  remove_plugins @spec
  remove @spec

  specification_record.remove_spec(stub)

  regenerate_plugins

  Gem.post_uninstall_hooks.each do |hook|
    hook.call self
  end

  @spec = nil
end

#warn_cannot_uninstall_default_gems(specs) (private)

[ GitHub ]

# File 'lib/rubygems/uninstaller.rb', line 421


def warn_cannot_uninstall_default_gems(specs)
  specs.each do |spec|
    say "Gem #{spec.full_name} cannot be uninstalled because it is a default gem"
  end
end

Class: Gem::Uninstaller

Overview

Class Method Summary

Instance Attribute Summary

DefaultUserInteraction - Included

Instance Method Summary

InstallerUninstallerUtils - Included

UserInteraction - Included

DefaultUserInteraction - Included

Text - Included

Constructor Details

.new(gem, options = {}) ⇒ Uninstaller

Instance Attribute Details

#abort_on_dependent? ⇒ Boolean (readonly)

#bin_dir (readonly)

#gem_home (readonly)

#spec (readonly)

Instance Method Details

#announce_deletion_of(spec) (private)

#ask_if_ok(spec)

#default_spec_matches?(spec) ⇒ Boolean (private)

#default_specs_that_match(spec) ⇒ Array (private)

#dependencies_ok?(spec) ⇒ Boolean

#formatted_program_filename(filename)

#path_ok?(gem_dir, spec) ⇒ Boolean

#plugin_dir_for(spec) (private)

#regenerate_plugins

#remove(spec)

#remove_all(list)

#remove_executables(spec)

#remove_plugins(spec)

#rm_r(path, exclusions:) (private)

#safe_delete(&block)

#specification_record (private)

#uninstall

#uninstall_gem(stub)

#warn_cannot_uninstall_default_gems(specs) (private)

`DefaultUserInteraction` - Included

`InstallerUninstallerUtils` - Included

`UserInteraction` - Included

`DefaultUserInteraction` - Included

`Text` - Included

.new(gem, options = {}) ⇒ `Uninstaller`

#abort_on_dependent? ⇒ `Boolean` (readonly)

#default_spec_matches?(spec) ⇒ `Boolean` (private)

#default_specs_that_match(spec) ⇒ `Array` (private)

#dependencies_ok?(spec) ⇒ `Boolean`

#path_ok?(gem_dir, spec) ⇒ `Boolean`