Class: Gem::Commands::CleanupCommand

Inherits:
Gem::Command show all
Defined in:
lib/rubygems/commands/cleanup_command.rb

Instance Attribute Summary

Attributes inherited from Gem::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, extra_args, extra_args=, #get_all_gem_names, #get_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

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

#initializeCleanupCommand

Returns a new instance of CleanupCommand.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/rubygems/commands/cleanup_command.rb', line 7

def initialize
  super 'cleanup',
        'Clean up old versions of installed gems in the local repository',
        :force => false, :install_dir => Gem.dir

  add_option('-d', '--dryrun', "") do |value, options|
    options[:dryrun] = true
  end

  @candidate_gems  = nil
  @default_gems    = []
  @full            = nil
  @gems_to_cleanup = nil
  @original_home   = nil
  @original_path   = nil
  @primary_gems    = nil
end

Instance Method Details

#argumentsObject

:nodoc:



25
26
27
# File 'lib/rubygems/commands/cleanup_command.rb', line 25

def arguments # :nodoc:
  "GEMNAME       name of gem to cleanup"
end

#clean_gemsObject



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/rubygems/commands/cleanup_command.rb', line 76

def clean_gems
  get_primary_gems
  get_candidate_gems
  get_gems_to_cleanup

  @full = Gem::DependencyList.from_specs

  deplist = Gem::DependencyList.new
  @gems_to_cleanup.each do |spec| deplist.add spec end

  deps = deplist.strongly_connected_components.flatten

  @original_home = Gem.dir
  @original_path = Gem.path

  deps.reverse_each do |spec|
    uninstall_dep spec
  end

  Gem::Specification.reset
end

#defaults_strObject

:nodoc:



29
30
31
# File 'lib/rubygems/commands/cleanup_command.rb', line 29

def defaults_str # :nodoc:
  "--no-dryrun"
end

#descriptionObject

:nodoc:



33
34
35
36
37
38
39
40
41
# File 'lib/rubygems/commands/cleanup_command.rb', line 33

def description # :nodoc:
  <<-EOF
The cleanup command removes old gems from GEM_HOME.  If an older version is
installed elsewhere in GEM_PATH the cleanup command won't touch it.

Older gems that are required to satisify the dependencies of gems
are not removed.
  EOF
end

#executeObject



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/rubygems/commands/cleanup_command.rb', line 47

def execute
  say "Cleaning up installed gems..."

  if options[:args].empty? then
    done     = false
    last_set = nil

    until done do
      clean_gems

      this_set = @gems_to_cleanup.map { |spec| spec.full_name }.sort

      done = this_set.empty? || last_set == this_set

      last_set = this_set
    end
  else
    clean_gems
  end

  say "Clean Up Complete"

  if Gem.configuration.really_verbose then
    skipped = @default_gems.map { |spec| spec.full_name }

    say "Skipped default gems: #{skipped.join ', '}"
  end
end

#get_candidate_gemsObject



98
99
100
101
102
103
104
105
106
# File 'lib/rubygems/commands/cleanup_command.rb', line 98

def get_candidate_gems
  @candidate_gems = unless options[:args].empty? then
                      options[:args].map do |gem_name|
                        Gem::Specification.find_all_by_name gem_name
                      end.flatten
                    else
                      Gem::Specification.to_a
                    end
end

#get_gems_to_cleanupObject



108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/rubygems/commands/cleanup_command.rb', line 108

def get_gems_to_cleanup
  gems_to_cleanup = @candidate_gems.select { |spec|
    @primary_gems[spec.name].version != spec.version
  }

  default_gems, gems_to_cleanup = gems_to_cleanup.partition { |spec|
    spec.default_gem?
  }

  @default_gems += default_gems
  @default_gems.uniq!
  @gems_to_cleanup = gems_to_cleanup.uniq
end

#get_primary_gemsObject



122
123
124
125
126
127
128
129
130
131
# File 'lib/rubygems/commands/cleanup_command.rb', line 122

def get_primary_gems
  @primary_gems = {}

  Gem::Specification.each do |spec|
    if @primary_gems[spec.name].nil? or
       @primary_gems[spec.name].version < spec.version then
      @primary_gems[spec.name] = spec
    end
  end
end

#uninstall_dep(spec) ⇒ Object



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/rubygems/commands/cleanup_command.rb', line 133

def uninstall_dep spec
  return unless @full.ok_to_remove?(spec.full_name)

  if options[:dryrun] then
    say "Dry Run Mode: Would uninstall #{spec.full_name}"
    return
  end

  say "Attempting to uninstall #{spec.full_name}"

  uninstall_options = {
    :executables => false,
    :version => "= #{spec.version}",
  }

  uninstall_options[:user_install] = Gem.user_dir == spec.base_dir

  uninstaller = Gem::Uninstaller.new spec.name, uninstall_options

  begin
    uninstaller.uninstall
  rescue Gem::DependencyRemovalException, Gem::InstallError,
         Gem::GemNotInHomeException, Gem::FilePermissionError => e
    say "Unable to uninstall #{spec.full_name}:"
    say "\t#{e.class}: #{e.message}"
  end
ensure
  # Restore path Gem::Uninstaller may have changed
  Gem.use_paths @original_home, *@original_path
end

#usageObject

:nodoc:



43
44
45
# File 'lib/rubygems/commands/cleanup_command.rb', line 43

def usage # :nodoc:
  "#{program_name} [GEMNAME ...]"
end