Class: Gem::Commands::CleanupCommand (Ruby 2.3.7)
Description: Class : Gem::Commands::CleanupCommand - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/commands/cleanup_command.rb

### Parent

Gem::Command

### Methods

- ::new
- #clean_gems
- #execute
- #get_candidate_gems
- #get_gems_to_cleanup
- #get_primary_gems
- #uninstall_dep

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Commands::CleanupCommand

### Public Class Methods

new() click to toggle source

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

      add_option('-n', '-d', '--dryrun',
                 'Do not uninstall gems') 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

### Public Instance Methods

clean_gems() click to toggle source

                   # File rubygems/commands/cleanup_command.rb, line 77
    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

execute() click to toggle source

                   # File rubygems/commands/cleanup_command.rb, line 48
    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"

      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 rubygems/commands/cleanup_command.rb, line 99
    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_cleanup() click to toggle source

                   # File rubygems/commands/cleanup_command.rb, line 109
    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_gems() click to toggle source

                   # File rubygems/commands/cleanup_command.rb, line 123
    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) click to toggle source

                   # File rubygems/commands/cleanup_command.rb, line 134
    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