Class: Gem::Commands::CleanupCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, ::Gem::Command
Instance Chain: self, ::Gem::Command, ::Gem::UserInteraction, ::Gem::DefaultUserInteraction, ::Gem::Text
Inherits:	Gem::Command Object Gem::Command Gem::Commands::CleanupCommand
Defined in:	lib/rubygems/commands/cleanup_command.rb

Class Attribute Summary

::Gem::Command - Inherited

.build_args	Arguments used when building gems.
.build_args=, .extra_args, .extra_args=

Class Method Summary

.new ⇒ CleanupCommand constructor

::Gem::Command - Inherited

.add_common_option,
.add_specific_extra_args	Add a list of extra arguments for the given command.
.common_options,
.new	Initializes a generic gem command named `command`.
.specific_extra_args	Return an array of extra arguments for the command.
.specific_extra_args_hash	Accessor for the specific extra args hash (self initializing).

Instance Attribute Summary

::Gem::Command - Inherited

#defaults	The default options for the command.
#program_name	The name of the command for command-line invocation.
#summary	A short description of the command.
#command	The name of the command.
#options	The options for the command.

::Gem::DefaultUserInteraction - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

::Gem::Command - Inherited

#add_extra_args	Adds extra args from ~/.gemrc.
#add_option	Add a command-line option and handler to the command.
#arguments	Override to provide details of the arguments a command takes.
#begins?	True if `long` begins with the characters from `short`.
#defaults_str	Override to display the default values of the command options.
#description	Override to display a longer description of what this command does.
#execute	Override to provide command handling.
#get_all_gem_names	Get all gem names from the command line.
#get_all_gem_names_and_versions	Get all [gem, version] from the command line.
#get_one_gem_name	Get a single gem name from the command line.
#get_one_optional_argument	Get a single optional argument from the command line.
#handle_options	Handle the given list of arguments by parsing them and recording the results.
#handles?	True if the command handles the given argument list.
#invoke	Invoke the command with the given list of arguments.
#invoke_with_build_args	Invoke the command with the given list of normal arguments and additional build arguments.
#merge_options	Merge a set of command options with the set of default options (without modifying the default option hash).
#remove_option	Remove previously defined command-line argument `name`.
#show_help	Display the help message for the command.
#show_lookup_failure	Display to the user that a gem couldn't be found and reasons why.
#usage	Override to display the usage for an individual gem command.
#when_invoked	Call the given block when invoked.
#add_parser_run_info	Adds a section with `title` and `content` to the parser help view.
#configure_options,
#create_option_parser	Creates an option parser and fills it in with the help info for the command.
#parser	Create on demand parser.
#wrap	Wraps `text` to `width`

::Gem::UserInteraction - Included

#alert	Displays an alert `statement`.
#alert_error	Displays an error `statement` to the error output location.
#alert_warning	Displays a warning `statement` to the warning output location.
#ask	Asks a `question` and returns the answer.
#ask_for_password	Asks for a password with a `prompt`
#ask_yes_no	Asks a yes or no `question`.
#choose_from_list	Asks the user to answer `question` with an answer from the given `list`.
#say	Displays the given `statement` on the standard output (or equivalent).
#terminate_interaction	Terminates the RubyGems process with the given `exit_code`
#verbose	Calls `say` with `msg` or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

#use_ui

See DefaultUserInteraction.use_ui

::Gem::Text - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	This code is based directly on the ::Gem::Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text

Constructor Details

.new ⇒ `CleanupCommand`

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 8


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

Instance Method Details

#clean_gems

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 78


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 do |spec| deplist.add spec end

  deps = deplist.strongly_connected_components.flatten

  deps.reverse_each do |spec|
    uninstall_dep spec
  end

  Gem::Specification.reset
end

#execute

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 49


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

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 100


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

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 110


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?
  }

  gems_to_cleanup = gems_to_cleanup.select { |spec|
    spec.base_dir == @original_home
  }

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

#get_primary_gems

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 129


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)

[ GitHub ]

# File 'lib/rubygems/commands/cleanup_command.rb', line 140


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

Class: Gem::Commands::CleanupCommand

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

Constructor Details

.new ⇒ CleanupCommand

Instance Method Details

#clean_gems

#execute

#get_candidate_gems

#get_gems_to_cleanup

#get_primary_gems

#uninstall_dep(spec)

.new ⇒ `CleanupCommand`