Class: Gem::Uninstaller

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
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 Gem.pre_uninstall and Gem.post_uninstall for details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize(gem, options = {}) ⇒ Uninstaller

Constructs an uninstaller that will uninstall gem



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubygems/uninstaller.rb', line 44

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

#bin_dir ⇒ Object (readonly)

The directory a gem’s executables will be installed into



28
29
30
 
# File 'lib/rubygems/uninstaller.rb', line 28

def bin_dir
  @bin_dir
end

#gem_home ⇒ Object (readonly)

The gem repository the gem will be installed into



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

def gem_home
  @gem_home
end

#spec ⇒ Object (readonly)

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



39
40
41
 
# File 'lib/rubygems/uninstaller.rb', line 39

def spec
  @spec
end

Instance Method Details

#abort_on_dependent? ⇒ Boolean

Should the uninstallation abort if a dependency will go unsatisfied?

See ::new.

Returns:

  • (Boolean) 


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

def abort_on_dependent? # :nodoc:
  @abort_on_dependent
end

#ask_if_ok(spec) ⇒ Object

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/rubygems/uninstaller.rb', line 307

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

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

Returns:

  • (Boolean) 


288
289
290
291
292
293
 
# File 'lib/rubygems/uninstaller.rb', line 288

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) ⇒ Object

Returns the formatted version of the executable filename



331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/rubygems/uninstaller.rb', line 331

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 then
    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?

Returns:

  • (Boolean) 


277
278
279
280
281
282
 
# File 'lib/rubygems/uninstaller.rb', line 277

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) ⇒ Object

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:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/rubygems/uninstaller.rb', line 236

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 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.remove_spec spec
end

#remove_all(list) ⇒ Object

Removes all gems in list.

NOTE: removes uninstalled gems from list.



225
226
227
 
# File 'lib/rubygems/uninstaller.rb', line 225

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

#remove_executables(spec) ⇒ Object

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/rubygems/uninstaller.rb', line 171

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 ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rubygems/uninstaller.rb', line 75

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

  if list.empty? then
    if other_repo_specs.empty?
      if default_specs.empty?
        raise Gem::InstallError, "gem #{@gem.inspect} is not installed"
      else
        message =
          "gem #{@gem.inspect} cannot be uninstalled " +
          "because it is a default gem"
        raise Gem::InstallError, message
      end
    end

    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 then
    remove_all list

  elsif list.size > 1 then
    gem_names = list.collect {|gem| gem.full_name} + ["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) ⇒ Object

Uninstalls gem spec



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/rubygems/uninstaller.rb', line 143

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