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 -
#abort_on_dependent? ⇒ Boolean
readonly
Internal use only
Should the uninstallation abort if a dependency will go unsatisfied?
DefaultUserInteraction
- Included
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(spec)
Uninstalls gem #spec
- #announce_deletion_of(spec) private
- #default_spec_matches?(spec) ⇒ Boolean private
- #default_specs_that_match(spec) ⇒ Array 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
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
Text
- Included
#clean_text | Remove any non-printable characters and make the text suitable for printing. |
#format_text | Wraps |
#levenshtein_distance | Returns a value representing the “cost” of transforming str1 into str2 Vendored version of |
#truncate_text, #min3 |
Constructor Details
.new(gem, options = {}) ⇒ Uninstaller
Constructs an uninstaller that will uninstall gem
# File 'lib/rubygems/uninstaller.rb', line 48
def initialize(gem, = {}) # TODO document the valid options @gem = gem @version = [:version] || Gem::Requirement.default @gem_home = File.realpath( [:install_dir] || Gem.dir) @plugins_dir = Gem.plugindir(@gem_home) @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] # Optimization: populated during #uninstall @default_specs_matching_uninstall_params = [] end
Instance Attribute Details
#abort_on_dependent? ⇒ Boolean
(readonly)
Should the uninstallation abort if a dependency will go unsatisfied?
See .new.
# File 'lib/rubygems/uninstaller.rb', line 328
def abort_on_dependent? # :nodoc: @abort_on_dependent end
#bin_dir (readonly)
The directory a gem’s executables will be installed into
# File 'lib/rubygems/uninstaller.rb', line 32
attr_reader :bin_dir
#gem_home (readonly)
The gem repository the gem will be installed into
# 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
# 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 384
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)
Asks if it is OK to remove #spec. Returns true if it is OK.
# File 'lib/rubygems/uninstaller.rb', line 335
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?" return ask_yes_no(msg.join("\n"), false) end
#default_spec_matches?(spec) ⇒ Boolean
(private)
# File 'lib/rubygems/uninstaller.rb', line 397
def default_spec_matches?(spec) !default_specs_that_match(spec).empty? end
#default_specs_that_match(spec) ⇒ Array
(private)
#dependencies_ok?(spec) ⇒ Boolean
Returns true if it is OK to remove #spec or this is a forced uninstallation.
# File 'lib/rubygems/uninstaller.rb', line 316
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)
Returns the formatted version of the executable filename
# File 'lib/rubygems/uninstaller.rb', line 359
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
?
#regenerate_plugins
Regenerates plugin wrappers after removal.
# File 'lib/rubygems/uninstaller.rb', line 295
def regenerate_plugins latest = Gem::Specification.latest_spec_for(@spec.name) return if latest.nil? regenerate_plugins_for(latest, @plugins_dir) end
#remove(spec)
- spec
-
the spec of the gem to be uninstalled
# File 'lib/rubygems/uninstaller.rb', line 242
def remove(spec) unless path_ok?(@gem_home, spec) || (@user_install && 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 } 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) Gem::Specification.reset end
#remove_all(list)
Removes all gems in list
.
NOTE: removes uninstalled gems from list
.
# File 'lib/rubygems/uninstaller.rb', line 235
def remove_all(list) list.each {|spec| uninstall_gem spec } end
#remove_executables(spec)
Removes installed executables and batch files (windows only) for #spec.
# File 'lib/rubygems/uninstaller.rb', line 181
def remove_executables(spec) return if 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
#remove_plugins(spec)
Remove any plugin wrappers for #spec.
#safe_delete(&block)
[ GitHub ]# File 'lib/rubygems/uninstaller.rb', line 371
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.
# File 'lib/rubygems/uninstaller.rb', line 83
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 warn_cannot_uninstall_default_gems(default_specs - list) @default_specs_matching_uninstall_params = default_specs list, other_repo_specs = list.partition do |spec| @gem_home == spec.base_dir || (@user_install && 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 = ["#{@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 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
# File 'lib/rubygems/uninstaller.rb', line 151
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_plugins @spec remove @spec regenerate_plugins Gem.post_uninstall_hooks.each do |hook| hook.call self end @spec = nil end