Class: LibGems::Uninstaller

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/libgems/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 LibGems.pre_uninstall and LibGems.post_uninstall for details.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#methname

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/libgems/uninstaller.rb', line 60

def initialize(gem, options = {})
  @gem = gem
  @version = options[:version] || LibGems::Requirement.default
  gem_home = options[:install_dir] || LibGems.dir
  @gem_home = File.expand_path gem_home
  @force_executables = options[:executables]
  @force_all = options[:all]
  @force_ignore = options[:ignore]
  @bin_dir = options[:bin_dir]

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

  spec_dir = File.join @gem_home, 'specifications'
  @source_index = LibGems::SourceIndex.from_gems_in spec_dir

  if @user_install then
    user_dir = File.join LibGems.user_dir, 'specifications'
    @user_index = LibGems::SourceIndex.from_gems_in user_dir
  end
end

Instance Attribute Details

#bin_dir ⇒ Object (readonly)

The directory a gem’s executables will be installed into



44
45
46
 
# File 'lib/libgems/uninstaller.rb', line 44

def bin_dir
  @bin_dir
end

#gem_home ⇒ Object (readonly)

The gem repository the gem will be installed into



49
50
51
 
# File 'lib/libgems/uninstaller.rb', line 49

def gem_home
  @gem_home
end

#spec ⇒ Object (readonly)

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



55
56
57
 
# File 'lib/libgems/uninstaller.rb', line 55

def spec
  @spec
end

Instance Method Details

#ask_if_ok(spec) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/libgems/uninstaller.rb', line 263

def ask_if_ok(spec)
  msg = ['']
  msg << 'You have requested to uninstall the gem:'
  msg << "\t#{spec.full_name}"
  spec.dependent_gems.each do |gem,dep,satlist|
    msg <<
      ("#{gem.name}-#{gem.version} depends on " +
      "[#{dep.name} (#{dep.requirement})]")
  end
  msg << 'If you remove this gems, one or more dependencies will not be met.'
  msg << 'Continue with Uninstall?'
  return ask_yes_no(msg.join("\n"), true)
end

#dependencies_ok?(spec) ⇒ Boolean

Returns:

  • (Boolean) 


255
256
257
258
259
260
261
 
# File 'lib/libgems/uninstaller.rb', line 255

def dependencies_ok?(spec)
  return true if @force_ignore

  deplist = LibGems::DependencyList.from_source_index @source_index
  deplist.add(*@user_index.gems.values) if @user_install
  deplist.ok_to_remove?(spec.full_name) || ask_if_ok(spec)
end

#path_ok?(gem_dir, spec) ⇒ Boolean

Is spec in gem_dir?

Returns:

  • (Boolean) 


248
249
250
251
252
253
 
# File 'lib/libgems/uninstaller.rb', line 248

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, list) ⇒ 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:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/libgems/uninstaller.rb', line 197

def remove(spec, list)
  unless dependencies_ok? spec then
    raise LibGems::DependencyRemovalException,
          "Uninstallation aborted due to dependent gem(s)"
  end

  unless path_ok?(@gem_home, spec) or
         (@user_install and path_ok?(LibGems.user_dir, spec)) then
    e = LibGems::GemNotInHomeException.new \
          "Gem is not installed in directory #{@gem_home}"
    e.spec = spec

    raise e
  end

  raise LibGems::FilePermissionError, spec.installation_path unless
    File.writable?(spec.installation_path)

  FileUtils.rm_rf spec.full_gem_path

  original_platform_name = [
    spec.name, spec.version, spec.original_platform].join '-'

  spec_dir = File.join spec.installation_path, 'specifications'
  gemspec = File.join spec_dir, spec.spec_name

  unless File.exist? gemspec then
    gemspec = File.join spec_dir, "#{original_platform_name}.gemspec"
  end

  FileUtils.rm_rf gemspec

  cache_dir = File.join spec.installation_path, 'cache'
  gem = File.join cache_dir, spec.file_name

  unless File.exist? gem then
    gem = File.join cache_dir, "#{original_platform_name}.gem"
  end

  FileUtils.rm_rf gem

  LibGems::DocManager.new(spec).uninstall_doc

  say "Successfully uninstalled #{spec.full_name}"

  list.delete spec
end

#remove_all(list) ⇒ Object

Removes all gems in list.

NOTE: removes uninstalled gems from list.



186
187
188
 
# File 'lib/libgems/uninstaller.rb', line 186

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

#remove_executables(spec) ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/libgems/uninstaller.rb', line 139

def remove_executables(spec)
  return if spec.nil?

  unless spec.executables.empty? then
    bindir = @bin_dir ? @bin_dir : LibGems.bindir(spec.installation_path)

    list = @source_index.find_name(spec.name).delete_if { |s|
      s.version == spec.version
    }

    executables = spec.executables.clone

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

    return if executables.empty?

    answer = if @force_executables.nil? then
               ask_yes_no("Remove executables:\n" \
                          "\t#{spec.executables.join(", ")}\n\nin addition to the gem?",
                          true) # " # appease ruby-mode - don't ask
             else
               @force_executables
             end

    unless answer then
      say "Executables and scripts will remain installed."
    else
      raise LibGems::FilePermissionError, bindir unless File.writable? bindir

      spec.executables.each do |exe_name|
        say "Removing #{exe_name}"
        FileUtils.rm_f File.join(bindir, exe_name)
        FileUtils.rm_f File.join(bindir, "#{exe_name}.bat")
      end
    end
  end
end

#uninstall ⇒ Object

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



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
 
# File 'lib/libgems/uninstaller.rb', line 87

def uninstall
  list = @source_index.find_name @gem, @version
  list += @user_index.find_name @gem, @version if @user_install

  if list.empty? then
    raise LibGems::InstallError, "cannot uninstall, check `gem list -d #{@gem}`"

  elsif list.size > 1 and @force_all then
    remove_all list.dup

  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.dup
    elsif index >= 0 && index < list.size then
      uninstall_gem list[index], list.dup
    else
      say "Error: must enter a number [1-#{list.size+1}]"
    end
  else
    uninstall_gem list.first, list.dup
  end
end

#uninstall_gem(spec, specs) ⇒ Object

Uninstalls gem spec



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/libgems/uninstaller.rb', line 118

def uninstall_gem(spec, specs)
  @spec = spec

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

  remove_executables @spec
  remove @spec, specs

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

  @spec = nil
end