Class: Gem::Commands::CleanupCommand
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
| Class Chain: 
          self,
           ::Gem::Command | |
| Instance Chain: | |
| Inherits: | Gem::Command 
 | 
| Defined in: | lib/rubygems/commands/cleanup_command.rb | 
Constant Summary
::Gem::Command - Inherited
  
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  | 
| .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
| #command | The name of the command. | 
| #defaults | The default options for the command. | 
| #options | The options for the command. | 
| #program_name | The name of the command for command-line invocation. | 
| #summary | A short description of the command. | 
::Gem::DefaultUserInteraction - Included
Instance Method Summary
- #clean_gems
- #execute
- #get_candidate_gems
- #get_gems_to_cleanup
- #get_primary_gems
- #uninstall_dep(spec)
- #arguments Internal use only
- #defaults_str Internal use only
- #description Internal use only
- #usage Internal use only
::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  | 
| #check_deprecated_options, | |
| #defaults_str | Override to display the default values of the command options. | 
| #deprecate_option | Mark a command-line option as deprecated, and optionally specify a deprecation horizon. | 
| #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  | 
| #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  | 
| #configure_options, | |
| #create_option_parser | Creates an option parser and fills it in with the help info for the command. | 
| #option_is_deprecated?, | |
| #parser | Create on demand parser. | 
| #wrap | Wraps  | 
| #add_parser_description, #add_parser_options, #add_parser_summary | |
::Gem::UserInteraction - Included
| #alert | Displays an alert  | 
| #alert_error | Displays an error  | 
| #alert_warning | Displays a warning  | 
| #ask | Asks a  | 
| #ask_for_password | Asks for a password with a  | 
| #ask_yes_no | Asks a yes or no  | 
| #choose_from_list | Asks the user to answer  | 
| #say | Displays the given  | 
| #terminate_interaction | Terminates the RubyGems process with the given  | 
| #verbose | Calls  | 
::Gem::DefaultUserInteraction - Included
::Gem::Text - Included
| #clean_text | Remove any non-printable characters and make the text suitable for printing. | 
| #format_text | Wraps  | 
| #levenshtein_distance | This code is based directly on the  | 
| #truncate_text, #min3 | |
Constructor Details
    .new  ⇒ CleanupCommand 
  
# 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, :check_dev => true add_option('-n', '-d', '--dryrun', 'Do not uninstall gems') do |value, | [:dryrun] = true end add_option('-D', '--[no-]check-development', 'Check development dependencies while uninstalling', '(default: true)') do |value, | [:check_dev] = value end add_option('--[no-]user-install', 'Cleanup in user\'s home directory instead', 'of GEM_HOME.') do |value, | [: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
Instance Method Details
#arguments
# File 'lib/rubygems/commands/cleanup_command.rb', line 40
def arguments # :nodoc: "GEMNAME name of gem to cleanup" end
#clean_gems
[ GitHub ]# File 'lib/rubygems/commands/cleanup_command.rb', line 91
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
#defaults_str
# File 'lib/rubygems/commands/cleanup_command.rb', line 44
def defaults_str # :nodoc: "--no-dryrun" end
#description
# File 'lib/rubygems/commands/cleanup_command.rb', line 48
def description # :nodoc: <<-EOF The cleanup command removes old versions of gems from GEM_HOME that are not required to meet a dependency. If a gem is installed elsewhere in GEM_PATH the cleanup command won't delete it. If no gems are named all gems in GEM_HOME are cleaned. EOF end
#execute
[ GitHub ]# File 'lib/rubygems/commands/cleanup_command.rb', line 62
def execute say "Cleaning up installed gems..." if [: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
[ GitHub ]# File 'lib/rubygems/commands/cleanup_command.rb', line 113
def get_candidate_gems @candidate_gems = unless [:args].empty? [: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 123
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 = [: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
[ GitHub ]# File 'lib/rubygems/commands/cleanup_command.rb', line 143
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)
[ GitHub ]# File 'lib/rubygems/commands/cleanup_command.rb', line 154
def uninstall_dep(spec) return unless @full.ok_to_remove?(spec.full_name, [:check_dev]) if [:dryrun] say "Dry Run Mode: Would uninstall #{spec.full_name}" return end say "Attempting to uninstall #{spec.full_name}" = { :executables => false, :version => "= #{spec.version}", } [:user_install] = Gem.user_dir == spec.base_dir uninstaller = Gem::Uninstaller.new spec.name, 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.}" end ensure # Restore path Gem::Uninstaller may have changed Gem.use_paths @original_home, *@original_path end
#usage
# File 'lib/rubygems/commands/cleanup_command.rb', line 58
def usage # :nodoc: "#{program_name} [GEMNAME ...]" end