class Gem::Commands::CleanupCommand - RDoc Documentation

# class Gem::Commands::CleanupCommand

### Public Class Methods

new() click to toggle source
Calls superclass method `Gem::Command::new`

    # File lib/rubygems/commands/cleanup_command.rb, line 7
    def initialize
      super 'cleanup',
            'Clean up old versions of installed gems',
            :force => false, :install_dir => Gem.dir,
            :check_dev => true

      add_option('-n', '-d', '--dry-run',
                 'Do not uninstall gems') do |value, options|
        options[:dryrun] = true
      end

      add_option(:Deprecated, '--dryrun',
                 'Do not uninstall gems') do |value, options|
        options[:dryrun] = true
      end
      deprecate_option('--dryrun', extra_msg: 'Use --dry-run instead')

      add_option('-D', '--[no-]check-development',
                 'Check development dependencies while uninstalling',
                 '(default: true)') do |value, options|
        options[:check_dev] = value
      end

      add_option('--[no-]user-install',
                 'Cleanup in user\'s home directory instead',
                 'of GEM_HOME.') do |value, options|
        options[:user_install] = value
      end

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

### Public Instance Methods

clean_gems() click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 96
    def clean_gems
      @original_home = Gem.dir
      @original_path = Gem.path

      get_primary_gems
      get_candidate_gems
      get_gems_to_cleanup

      @full = Gem::DependencyList.from_specs

      deplist = Gem::DependencyList.new
      @gems_to_cleanup.each {|spec| deplist.add spec }

      deps = deplist.strongly_connected_components.flatten

      deps.reverse_each do |spec|
        uninstall_dep spec
      end

      Gem::Specification.reset
    end

execute() click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 67
    def execute
      say "Cleaning up installed gems..."

      if options[:args].empty?
        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"

      verbose do
        skipped = @default_gems.map {|spec| spec.full_name }

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

get_candidate_gems() click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 118
    def get_candidate_gems
      @candidate_gems = unless options[:args].empty?
                          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_cleanup() click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 128
    def get_gems_to_cleanup
      gems_to_cleanup = @candidate_gems.select do |spec|
        @primary_gems[spec.name].version != spec.version
      end

      default_gems, gems_to_cleanup = gems_to_cleanup.partition do |spec|
        spec.default_gem?
      end

      uninstall_from = options[:user_install] ? Gem.user_dir : @original_home

      gems_to_cleanup = gems_to_cleanup.select do |spec|
        spec.base_dir == uninstall_from
      end

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

get_primary_gems() click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 148
    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
          @primary_gems[spec.name] = spec
        end
      end
    end

uninstall_dep(spec) click to toggle source

    # File lib/rubygems/commands/cleanup_command.rb, line 159
    def uninstall_dep(spec)
      return unless @full.ok_to_remove?(spec.full_name, options[:check_dev])

      if options[:dryrun]
        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