Class: Gem::Uninstaller
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
|
|
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 installed into.
-
#spec
readonly
The Specification for the gem being uninstalled, only set during #uninstall_gem
DefaultUserInteraction - Included
Instance Method Summary
-
#path_ok?(gem_dir, spec) ⇒ Boolean
Is #spec in
gem_dir
? -
#remove(spec)
- spec
- the spec of the gem to be uninstalled list
the list of all such gems.
-
#remove_all(list)
Removes all gems in
list
. -
#remove_executables(spec)
Removes installed executables and batch files (windows only) for
gemspec
. -
#uninstall
Performs the uninstall of the gem.
-
#uninstall_gem(spec)
Uninstalls gem #spec
UserInteraction - Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
DefaultUserInteraction - Included
Constructor Details
.new(gem, options = {}) ⇒ Uninstaller
Constructs an uninstaller that will uninstall gem
# File 'lib/rubygems/uninstaller.rb', line 45
def initialize(gem, = {}) # TODO document the valid options @gem = gem @version = [:version] || Gem::Requirement.default @gem_home = File. ( [:install_dir] || Gem.dir) @force_executables = [:executables] @force_all = [:all] @force_ignore = [:ignore] @bin_dir = [:bin_dir] @format_executable = [:format_executable] @abort_on_dependent = [:abort_on_dependent] # Indicate if development dependencies should be checked when # uninstalling. (default: false) # @check_dev = [:check_dev] if [:force] @force_all = true @force_ignore = true end # only add user directory if install_dir is not set @user_install = false @user_install = [:user_install] unless [:install_dir] end
Instance Attribute Details
#bin_dir (readonly)
The directory a gem's executables will be installed into
# File 'lib/rubygems/uninstaller.rb', line 29
attr_reader :bin_dir
#gem_home (readonly)
The gem repository the gem will be installed into
# 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
# File 'lib/rubygems/uninstaller.rb', line 40
attr_reader :spec
Instance Method Details
#path_ok?(gem_dir, spec) ⇒ Boolean
Is #spec in gem_dir
?
#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.
# File 'lib/rubygems/uninstaller.rb', line 240
def remove(spec) unless path_ok?(@gem_home, spec) or (@user_install and path_ok?(Gem.user_dir, spec)) then 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) FileUtils.rm_rf spec.full_gem_path FileUtils.rm_rf spec.extension_dir old_platform_name = spec.original_name gemspec = spec.spec_file unless File.exist? gemspec then gemspec = File.join(File.dirname(gemspec), "#{old_platform_name}.gemspec") end FileUtils.rm_rf gemspec gem = spec.cache_file gem = File.join(spec.cache_dir, "#{old_platform_name}.gem") unless File.exist? gem FileUtils.rm_rf gem Gem::RDoc.new(spec).remove say "Successfully uninstalled #{spec.full_name}" Gem::Specification.reset end
#remove_all(list)
Removes all gems in list
.
NOTE: removes uninstalled gems from list
.
# File 'lib/rubygems/uninstaller.rb', line 229
def remove_all(list) list.each { |spec| uninstall_gem spec } end
#remove_executables(spec)
Removes installed executables and batch files (windows only) for gemspec
.
# File 'lib/rubygems/uninstaller.rb', line 175
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 { |s| s.name == spec.name && s.version != spec.version } 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? then ask_yes_no("Remove executables:\n" + "\t#{executables.join ', '}\n\n" + "in addition to the gem?", true) else @force_executables end if remove then 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 FileUtils.rm_f exe_file FileUtils.rm_f "#{exe_file}.bat" end else say "Executables and scripts will remain installed." end end
#uninstall
Performs the uninstall of the gem. This removes the spec, the ::Gem directory, and the cached .gem
file.
# File 'lib/rubygems/uninstaller.rb', line 76
def uninstall dependency = Gem::Dependency.new @gem, @version list = [] dirs = Gem::Specification.dirs + [Gem::Specification.default_specifications_dir] Gem::Specification.each_spec dirs do |spec| next unless dependency.matches_spec? spec list << spec end default_specs, list = list.partition do |spec| spec.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? then if other_repo_specs.empty? if default_specs.empty? raise Gem::InstallError, "gem #{@gem.inspect} is not installed" else = "gem #{@gem.inspect} cannot be uninstalled " + "because it is a default gem" raise Gem::InstallError, end end other_repos = other_repo_specs.map { |spec| spec.base_dir }.uniq = ["#{@gem} is not installed in GEM_HOME, try:"] .concat other_repos.map { |repo| "\tgem uninstall -i #{repo} #{@gem}" } raise Gem::InstallError, .join("\n") elsif @force_all then remove_all list elsif list.size > 1 then 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 then remove_all list elsif index >= 0 && index < list.size then 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
# File 'lib/rubygems/uninstaller.rb', line 147
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