123456789_123456789_123456789_123456789_123456789_

Class: Gem::Uninstaller

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, 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

Instance Attribute Summary

DefaultUserInteraction - Included

#ui

See DefaultUserInteraction.ui
#ui=

See DefaultUserInteraction.ui=

Instance Method Summary

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

This code is based directly on the Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

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

Constructs an uninstaller that will uninstall gem

[ GitHub ] 

  


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



def initialize(gem, options = {})
  # TODO document the valid options
  @gem                = gem
  @version            = options[:version] || Gem::Requirement.default
  @gem_home           = File.realpath(options[:install_dir] || Gem.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 options[:install_dir]
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 303



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 29



attr_reader :bin_dir


  








  

    #gem_home   (readonly)
  



  

    

The gem repository the gem will be installed into


  



  [ GitHub ]


  

  


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



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 40



attr_reader :spec


  







Instance Method Details



  

    #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 310



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.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?'
  return ask_yes_no(msg.join("\n"), false)
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 291



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 334



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 'rubygems/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 280



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


  








  

    #remove(spec)  
  



  

    
spec



the spec of the gem to be uninstalled


list



the list of all such gems





Warning: this method modifies the list parameter.  Once it has uninstalled a gem, it is removed from that list.


  





  
Raises:





  [ GitHub ]


  

  


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



def remove(spec)
  unless path_ok?(@gem_home, spec) or
         (@user_install and path_ok?(Gem.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)

  safe_delete { FileUtils.rm_r spec.full_gem_path }
  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 }

  Gem::RDoc.new(spec).remove

  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 }
  say "Successfully uninstalled #{spec.full_name}"

  Gem::Specification.reset
end


  








  

    #remove_all(list)  
  



  

    

Removes all gems in list.



NOTE: removes uninstalled gems from list.


  



  [ GitHub ]


  

  


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



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


  








  

    #remove_executables(spec)  
  



  

    

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


  



  [ GitHub ]


  

  


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



def remove_executables(spec)
  return if spec.nil? or spec.executables.empty?

  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


  








  

    #safe_delete(&block)  
  

  [ GitHub ]


  

  


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



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

  raise e
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 76



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

  list = []

  dirs =
    Gem::Specification.dirs +
    [Gem.default_specifications_dir]

  Gem::Specification.each_spec dirs 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 do |spec|
    spec.default_gem?
  end

  default_specs.each do |default_spec|
    say "Gem #{default_spec.full_name} cannot be uninstalled because it is a default gem"
  end

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

  list.sort!

  if list.empty?
    return unless other_repo_specs.any?

    other_repos = other_repo_specs.map { |spec| spec.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 { |gem| gem.full_name }
    gem_names << "All versions"

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

    if index == list.size
      remove_all list
    elsif 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(spec)  
  



  

    

Uninstalls gem #spec


  



  [ GitHub ]


  

  


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



def uninstall_gem(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 @spec

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

  @spec = nil
end