Class: Gem::Commands::UninstallCommand (Ruby 2.7.2)
Description: Class : Gem::Commands::UninstallCommand - Ruby 2.7.2

### Home Classes Methods

### In Files

- rubygems/commands/uninstall_command.rb

### Parent

Gem::Command

### Methods

- ::new
- #execute
- #uninstall
- #uninstall_all
- #uninstall_gem
- #uninstall_specific

### Included Modules

- Gem::VersionOption

### Class/Module Index

Quicksearch

- Bundler
- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::BundlerVersionFinder
- 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::InfoCommand
- 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::SetupCommand::MakeDirs
- Gem::Commands::SigninCommand
- Gem::Commands::SignoutCommand
- 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::MissingSpecError
- Gem::MissingSpecVersionError
- 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::Delegates
- Gem::Resolver::Molinillo::Delegates::ResolutionState
- Gem::Resolver::Molinillo::Delegates::SpecificationProvider
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Action
- Gem::Resolver::Molinillo::DependencyGraph::AddEdgeNoCircular
- Gem::Resolver::Molinillo::DependencyGraph::DeleteEdge
- Gem::Resolver::Molinillo::DependencyGraph::DetachVertexNamed
- Gem::Resolver::Molinillo::DependencyGraph::Log
- Gem::Resolver::Molinillo::DependencyGraph::Tag
- 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::RuntimeRequirementNotMetError
- Gem::S3URISigner
- Gem::S3URISigner::ConfigurationError
- Gem::S3URISigner::InstanceProfileError
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::SecurityOption
- 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::SpecificationPolicy
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::ThreadedDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::UninstallError
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UriParser
- Gem::UriParsing
- 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::UninstallCommand

Gem uninstaller command line tool

See `gem help uninstall`

### Public Class Methods

new() click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 16
    def initialize
      super 'uninstall', 'Uninstall gems from the local repository',
            :version => Gem::Requirement.default, :user_install => true,
            :check_dev => false, :vendor => false

      add_option('-a', '--[no-]all',
        'Uninstall all matching versions'
      ) do |value, options|
        options[:all] = value
      end

      add_option('-I', '--[no-]ignore-dependencies',
                 'Ignore dependency requirements while',
                 'uninstalling') do |value, options|
        options[:ignore] = value
      end

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

      add_option('-x', '--[no-]executables',
                   'Uninstall applicable executables without',
                   'confirmation') do |value, options|
        options[:executables] = value
      end

      add_option('-i', '--install-dir DIR',
                 'Directory to uninstall gem from') do |value, options|
        options[:install_dir] = File.expand_path(value)
      end

      add_option('-n', '--bindir DIR',
                 'Directory to remove executables from') do |value, options|
        options[:bin_dir] = File.expand_path(value)
      end

      add_option('--[no-]user-install',
                 'Uninstall from user\s home directory',
                 'in addition to GEM_HOME.') do |value, options|
        options[:user_install] = value
      end

      add_option('--[no-]format-executable',
                 'Assume executable names match Ruby\s prefix and suffix.') do |value, options|
        options[:format_executable] = value
      end

      add_option('--[no-]force',
                 'Uninstall all versions of the named gems',
                 'ignoring dependencies') do |value, options|
        options[:force] = value
      end

      add_option('--[no-]abort-on-dependent',
                 'Prevent uninstalling gems that are',
                 'depended on by other gems.') do |value, options|
        options[:abort_on_dependent] = value
      end

      add_version_option
      add_platform_option

      add_option('--vendor',
                 'Uninstall gem from the vendor directory.',
                 'Only for use by gem repackagers.') do |value, options|
        unless Gem.vendor_dir
          raise OptionParser::InvalidOption.new 'your platform is not supported'
        end

        alert_warning 'Use your OS package manager to uninstall vendor gems'
        options[:vendor] = true
        options[:install_dir] = Gem.vendor_dir
      end
    end

### Public Instance Methods

execute() click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 126
    def execute
      check_version

      if options[:all] and not options[:args].empty?
        uninstall_specific
      elsif options[:all]
        uninstall_all
      else
        uninstall_specific
      end
    end

uninstall(gem_name) click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 195
    def uninstall(gem_name)
      Gem::Uninstaller.new(gem_name, options).uninstall
    end

uninstall_all() click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 138
    def uninstall_all
      specs = Gem::Specification.reject { |spec| spec.default_gem? }

      specs.each do |spec|
        options[:version] = spec.version
        uninstall_gem spec.name
      end

      alert "Uninstalled all gems in #{options[:install_dir] || Gem.dir}"
    end

uninstall_gem(gem_name) click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 181
    def uninstall_gem(gem_name)
      uninstall(gem_name)
    rescue Gem::GemNotInHomeException => e
      spec = e.spec
      alert("In order to remove #{spec.name}, please execute:\n" +
            "\tgem uninstall #{spec.name} --install-dir=#{spec.installation_path}")
    rescue Gem::UninstallError => e
      spec = e.spec
      alert_error("Error: unable to successfully uninstall '#{spec.name}' which is " +
            "located at '#{spec.full_gem_path}'. This is most likely because" +
            "the current user does not have the appropriate permissions")
      terminate_interaction 1
    end

uninstall_specific() click to toggle source

                   # File rubygems/commands/uninstall_command.rb, line 149
    def uninstall_specific
      deplist = Gem::DependencyList.new
      original_gem_version = {}

      get_all_gem_names_and_versions.each do |name, version|
        original_gem_version[name] = version || options[:version]

        gem_specs = Gem::Specification.find_all_by_name(name, original_gem_version[name])

        say("Gem '#{name}' is not installed") if gem_specs.empty?
        gem_specs.each do |spec|
          deplist.add spec
        end
      end

      deps = deplist.strongly_connected_components.flatten.reverse

      gems_to_uninstall = {}

      deps.each do |dep|
        unless gems_to_uninstall[dep.name]
          gems_to_uninstall[dep.name] = true

          unless original_gem_version[dep.name] == Gem::Requirement.default
            options[:version] = dep.version
          end

          uninstall_gem(dep.name)
        end
      end
    end