gem_leaves 1.0.6

data/History.txt

@@ -0,0 +1,38 @@
+== 1.0.6 / 2009-01-05
+
+* Fixed doubling documentation in the installed gem.
+* First release on RubyForge. Celebrate! :-)
+
+== 1.0.5 / 2008-12-07
+
+* New --ignore option.
+* New pipe output format.
+
+== 1.0.4 / 2008-09-27
+
+* Renamed Manifest.txt; one step closer to Echoe standard.
+* Changed gem's name, for consistency's sake.
+* Added the gemspec generated by Echoe.
+* Tweaks to general doc.
+* Changed a bit the way we talk to RubyGems, to avoid deprecation warnings
+  with the new RubyGems 1.3.0.
+
+== 1.0.3 / 2008-01-08
+
+* Adios, hoe! Moved to echoe.
+* New output format: DOT diagram.
+
+== 1.0.2 / 2007-12-03
+
+* Now the pruning uses the exact match on the gem's short name (so, ignoring
+  capistrano doesn't mask capistrano-ext too).
+
+== 1.0.1 / 2007-12-01
+
+* No leaves, no output.
+* Corrected a huge bug in the configuration file loading function.
+* Reformatted the options' descriptions.
+
+== 1.0.0 / 2007-11-30
+
+* Birthday!

data/Manifest

@@ -0,0 +1,7 @@
+bin/gem_leaves
+gem_leaves.gemspec
+History.txt
+lib/gem_leaves.rb
+Manifest
+Rakefile
+README.txt

data/README.txt

@@ -0,0 +1,55 @@
+gem_leaves
+    by Gufo Pelato
+
+== DESCRIPTION:
+  
+gem_leaves is a rather dumb tool which lists the _leaves_ of your system. I
+call _leaves_ the gems with no reverse dependency which can be safely
+removed without breaking anything.
+
+== FEATURES/PROBLEMS:
+  
+* User can customize the tool's behaviour with a simple, YAML configuration
+  file.
+* The tool can generate/regenerate its own configuration file.
+
+== SYNOPSIS:
+
+  $ gem_leaves
+
+For options' list see output of
+
+  $ gem_leaves -h
+
+== REQUIREMENTS:
+
+* RubyGems
+
+== INSTALL:
+
+  $ sudo gem install gem_leaves
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007, 2008, 2009 Gufo Pelato
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'echoe'
+require './lib/gem_leaves.rb'
+
+Echoe.new('gem_leaves', GemLeaves::VERSION) do |p|
+  p.author = 'Gufo Pelato'
+  p.summary = 'A dumb tool to list removable gems.'
+  p.need_tar_gz = false
+  p.project = 'gemleaves'
+  p.gemspec_format = :yaml
+  p.retain_gemspec = true
+  p.rdoc_pattern = /^README|^LICENSE/
+  p.url = 'http://github.com/baldowl/gem_leaves'
+end

data/bin/gem_leaves

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'gem_leaves'
+GemLeaves.new(ARGV).run

data/gem_leaves.gemspec

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: gem_leaves
+version: !ruby/object:Gem::Version 
+  version: 1.0.6
+platform: ruby
+authors: 
+- Gufo Pelato
+autorequire: 
+bindir: bin
+
+date: 2009-01-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A dumb tool to list removable gems.
+email: ""
+executables: 
+- gem_leaves
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- bin/gem_leaves
+- gem_leaves.gemspec
+- History.txt
+- lib/gem_leaves.rb
+- Manifest
+- Rakefile
+- README.txt
+has_rdoc: true
+homepage: http://github.com/baldowl/gem_leaves
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Gem_leaves
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: gemleaves
+rubygems_version: 1.3.1
+specification_version: 2
+summary: A dumb tool to list removable gems.
+test_files: []

data/lib/gem_leaves.rb

@@ -0,0 +1,194 @@
+require 'optparse'
+require 'yaml'
+
+# Amateurish prototype of a tool to check the installed gems looking for
+# _leaves_ that can be removed.
+# 
+# I call _leaves_ those gems with no reverse dependency that can be removed
+# without breaking anything. Of course, users may desire to keep something
+# around even if nothing depends on it, so this tool looks for and loads a
+# simple YAML configuration file:
+# 
+#   ignore:
+#     RedCloth: >= 0
+#     capistrano: >= 2
+#     mongrel_cluster: >= 0
+#     piston: >= 0
+#     rake: >= 0.7
+#     rubygems-update: >= 0
+#     ruport-util: = 0.10.0
+#     sources: >= 0
+# 
+# <tt>gem_leaves</tt> can generate its own configuration file merging the
+# leaves list with the content of an already loaded configuration file (if
+# any). The tool looks for the default configuration file,
+# <tt>.gem_leaves.yml</tt>, in the current working directory and the user's
+# home directory.
+
+class GemLeaves
+  VERSION = '1.0.6'
+
+  def initialize(args)
+    @options = {:color => "d0ed0e"}
+    @configuration = {}
+    @leaves = []
+    parse_options(args)
+  end
+
+  def run
+    load_config_file
+    find_leaves
+    show_leaves
+    generate_config_file
+  end
+
+  protected
+
+  # Parses the command line arguments.
+  def parse_options(args)
+    OptionParser.new('Usage: gem_leaves [OPTIONS]') do |p|
+      p.separator ''
+      p.on('-c', '--config-file=FILE', 'Load the named configuration file') {|v| @options[:config_file] = v}
+      p.on('-C', '--color=COLOR', "Set the leaves' color in the DOT diagram") {|v| @options[:color] = v}
+      p.on('-d', '--diagram', 'Generate a DOT diagram on stdout') {|v| @options[:diagram] = v}
+      p.on('-g', '--generate-config-file=FILE',
+        "Generate a new configuration file merging",
+        "the leaves' list with the content of the",
+        "old configuration file (if any)") {|v| @options[:new_config_file] = v}
+      p.on('-i', '--ignore', 'Ignore every configuration file') {|v| @options[:ignore] = v}
+      p.on('-p', '--pipe', 'Pipe Format (name --version ver)') {|v| @options[:pipe] = v}
+      p.on('-r', '--reverse', "Reverse the edges in the DOT diagram") {|v| @options[:reverse] = v}
+      p.parse(args)
+    end
+  end
+
+  # Looks for a YAML configuration file in:
+  # 
+  # 1. the PWD;
+  # 2. the user's home directory.
+  # 
+  # Optionally load a specific configuration file whose name has been set by
+  # the user.
+  def load_config_file
+    if @options[:ignore]
+      @configuration = {'ignore' => {}}
+    else
+      if @options[:config_file].nil?
+        cf = ['.gem_leaves.yml', File.join(find_home, '.gem_leaves.yml')]
+        cf.each {|f| (@configuration = YAML.load_file(f); return) rescue nil}
+        @configuration = {'ignore' => {}}
+      else
+        @configuration = YAML.load_file(@options[:config_file])
+      end
+    end
+  end
+
+  # Lifted from RubyGems 0.9.5; it's a semi-portable way to find the user's
+  # home directory.
+  def find_home
+    ['HOME', 'USERPROFILE'].each do |homekey|
+      return ENV[homekey] if ENV[homekey]
+    end
+    if ENV['HOMEDRIVE'] && ENV['HOMEPATH']
+      return "#{ENV['HOMEDRIVE']}:#{ENV['HOMEPATH']}"
+    end
+    begin
+      File.expand_path("~")
+    rescue StandardError => ex
+      if File::ALT_SEPARATOR
+        "C:/"
+      else
+        "/"
+      end
+    end
+  end
+
+  # Looks at the installed gems to find the _leaves_.
+  def find_leaves
+    root = Gem::Dependency.new //, Gem::Requirement.default
+    srcindex = Gem::SourceIndex.from_installed_gems
+    @gems = srcindex.search root
+    srcindex = prune(srcindex)
+    @leaves = srcindex.search(root).select {|s| s.dependent_gems.empty?}
+  end
+
+  # Remove from the list of installed gems those gems that *must* be kept
+  # and not shown to the user.
+  def prune(srcindex)
+    @configuration['ignore'].each do |k, v|
+      keep = srcindex.find_name(k, v)
+      next if keep.nil?
+      if keep.respond_to?(:each)
+        keep.each {|s| srcindex.remove_spec(s.full_name)}
+      else
+        srcindex.remove_spec(keep.full_name)
+      end
+    end
+    srcindex
+  end
+
+  # Show the leaves using one of the supported output format.
+  def show_leaves
+    if @options[:diagram]
+      diagrammatical_output
+    elsif @options[:pipe]
+      pipe_output
+    else
+      textual_output
+    end
+  end
+
+  # Simply puts the list of _leaves_ to STDOUT in a format suitable to pipe it
+  # to RubyGems.
+  def pipe_output
+    @leaves.sort.each do |leaf|
+      puts "#{leaf.name} --version #{leaf.version}"
+    end
+  end
+
+  # Simply puts the list of _leaves_ to STDOUT. It optionally merges the
+  # content of the already loaded configuration file with the leaves list.
+  def textual_output
+    @leaves.sort.each do |leaf|
+      puts "#{leaf.name} (#{leaf.version})"
+    end
+  end
+
+  # Build a DOT diagram of the installed gems, highlighting the leaves with
+  # a customizable color, leaving those gems that *must* be kept according
+  # to the current configuration in the standard color.
+  def diagrammatical_output
+    diagram = "digraph leaves_diagram {\n"
+    @gems.each do |g|
+      if @options[:reverse]
+        g.dependent_gems.each {|d| diagram << %Q(  "#{d[0].full_name}" -> "#{g.full_name}"\n)}
+      else
+        g.dependent_gems.each {|d| diagram << %Q(  "#{g.full_name}" -> "#{d[0].full_name}"\n)}
+      end
+      if g.dependent_gems.empty?
+        str = %Q(  "#{g.full_name}")
+        if @leaves.include?(g)
+          str += %Q( [color="##{@options[:color]}", style=filled]\n)
+        else
+          str += "\n"
+        end
+        diagram << str
+      end
+    end
+    diagram << "}"
+    puts diagram
+  end
+
+  # Writes the new configuration file merging the optionally already loaded
+  # one with the leaves just found.
+  def generate_config_file
+    if @options[:new_config_file]
+      @leaves.sort.each do |leaf|
+        @configuration['ignore']["#{leaf.name}"] = "= #{leaf.version}"
+      end
+      File.open(@options[:new_config_file], 'w') do |out|
+        YAML.dump(@configuration, out)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: gem_leaves
+version: !ruby/object:Gem::Version 
+  version: 1.0.6
+platform: ruby
+authors: 
+- Gufo Pelato
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A dumb tool to list removable gems.
+email: ""
+executables: 
+- gem_leaves
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- bin/gem_leaves
+- gem_leaves.gemspec
+- History.txt
+- lib/gem_leaves.rb
+- Manifest
+- Rakefile
+- README.txt
+has_rdoc: true
+homepage: http://github.com/baldowl/gem_leaves
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Gem_leaves
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: gemleaves
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A dumb tool to list removable gems.
+test_files: []
+