gem-tldr 1.0

data/.autotest

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/autorun'
+end
+

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0 / 2011-02-25
+
+* Major enhancements
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/rubygems/commands/tldr_command.rb
+lib/rubygems_plugin.rb
+test/test_gem_commands_tldr_command.rb

data/README.txt

@@ -0,0 +1,74 @@
+= gem-tldr
+
+* https://github.com/drbrain/gem-tldr
+
+== DESCRIPTION:
+
+Are your gems taking up too much disk space?  Documentation got you down?
+Comments stuck in your craw?  Tests taking too much space?  Fix all that by
+with <tt>gem tldr</tt>.
+
+I know that disk space is at a premium these days with an introductory netbook
+or a small AWS EC2 instance containing a mere 160GB.  <tt>gem tldr</tt>
+removes the test directory, build artifacts like .c and .h files, comments in
+your ruby source files and comments in your ruby source.
+
+== FEATURES/PROBLEMS:
+
+* May destroy strings with embedded # characters
+* There's no way to know something is broken as tests have been deleted
+
+== SYNOPSIS:
+
+  gem tldr
+
+If you don't want the TL;DR you can provide -V.
+
+If you want to see what <tt>gem tldr</tt> would do to your installed gems
+provide <tt>--dry-run</tt>.
+
+You can restore your installed gems through
+
+  gem pristine
+
+== REQUIREMENTS:
+
+* Fearlessness
+
+== INSTALL:
+
+Don't
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Eric Hodel
+
+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,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :minitest
+Hoe.plugin :git
+
+Hoe.spec 'gem-tldr' do
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+
+  rdoc_locations << 'docs.seattlerb.org:/data/www/docs.seattlerb.org/gem-tldr'
+end
+
+# vim: syntax=ruby

data/lib/rubygems/commands/tldr_command.rb

@@ -0,0 +1,148 @@
+require 'fileutils'
+require 'find'
+require 'rubygems/command'
+
+##
+# TL;DR your gems with <tt>gem tldr</tt>
+
+class Gem::Commands::TldrCommand < Gem::Command
+
+  VERSION = '1.0'
+
+  def initialize
+    super 'tldr', 'Documentation? Tests? They use too much disk space!'
+
+    add_option '--dry-run', "don't do anything" do |value, options|
+      options[:dry_run] = true
+    end
+  end
+
+  def usage # :nodoc:
+    program_name
+  end
+
+  def execute
+    @verbose = Gem.configuration.really_verbose
+
+    if @verbose then
+      if options[:dry_run] then
+        extend FileUtils::DryRun
+      else
+        extend FileUtils::Verbose
+      end
+    elsif options[:dry_run] then
+      extend FileUtils::NoWrite
+    else
+      extend FileUtils
+    end
+
+    beginning_size = total_size
+
+    Gem.source_index.each do |name, spec|
+      say "TL;DR #{name}"
+      Dir.chdir spec.full_gem_path do
+        remove_tests spec
+        remove_built_documentation spec
+        remove_build_artifacts spec
+        remove_file_comments spec
+      end
+    end
+
+    ending_size = total_size
+
+    saved = beginning_size - ending_size
+
+    say "start: #{beginning_size}B end: #{ending_size}B saved: #{saved}B"
+  end
+
+  ##
+  # Find the total size of your Gem path directories
+
+  def total_size
+    size = 0
+
+    Gem.path.each do |directory|
+      Find.find directory do |path|
+        stat = File.stat path
+        next unless stat.file?
+        size += stat.size
+      end
+    end
+
+    size
+  end
+
+  ##
+  # Remove the documentation for +spec+
+
+  def remove_built_documentation spec
+    doc_dir = File.join spec.installation_path, 'doc', spec.full_name
+
+    say "\tRemoving built documentation" if @verbose
+    rm_rf doc_dir
+  end
+
+  ##
+  # Remove build artifacts for C extensions from +spec+
+
+  def remove_build_artifacts spec
+    spec.extensions.each do |extension|
+      next unless extension =~ /extconf\.rb$/
+      extension_dir = File.dirname extension
+
+      say "\tRemoving build artifacts in #{extension_dir}" if @verbose
+
+      Dir["#{extension_dir}/**/*.{c,h,java,o}"].each do |artifact|
+        rm_f artifact
+      end
+
+      Dir["#{extension_dir}/**/*.dSYM"].each do |artifact|
+        rm_rf artifact
+      end
+
+      rm_f File.join(extension_dir, 'Makefile')
+      rm_f File.join(extension_dir, 'extconf.rb')
+      rm_f File.join(extension_dir, 'mkmf.log')
+    end
+  end
+
+  ##
+  # Remove comments in the ruby files of +spec+
+
+  def remove_file_comments spec
+    say "\tStripping comments" if @verbose
+    return if options[:dry_run]
+    spec.require_paths.each do |path|
+      Dir["#{path}/**/*.rb"].each do |file|
+        ruby = File.read file
+
+        stripped = strip_comments ruby
+
+        open file, 'w' do |io|
+          io.write stripped
+        end
+      end
+    end
+  end
+
+  ##
+  # Remove the tests (and specs) of +spec+
+
+  def remove_tests spec
+    say "\tRemoving tests" if @verbose
+    Dir['{test,spec}'].each do |dir|
+      rm_rf dir
+    end
+  end
+
+  ##
+  # Strips comments out of +ruby+.  Destructive!
+
+  def strip_comments ruby
+    ruby.gsub!(/^[ \t]*#[^{@$].*?\r?\n/, '')
+    ruby.gsub!(/[ \t]*#[^{@$].*?$/, '')
+    ruby
+  end
+
+end
+

data/lib/rubygems_plugin.rb

@@ -0,0 +1,4 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :tldr
+

data/test/test_gem_commands_tldr_command.rb

@@ -0,0 +1,41 @@
+require 'rubygems/test_case'
+require 'rubygems/commands/tldr_command'
+
+class TestGemCommandsTldrCommand < Gem::TestCase
+
+  def setup
+    super
+
+    @cmd = Gem::Commands::TldrCommand.new
+  end
+
+  def test_strip_comments
+    ruby = <<-'RUBY'
+# comment for C
+class C
+
+  # comment for m
+  def m # :yields: something
+    puts "hello #{world}"
+  end
+
+end
+    RUBY
+
+    @cmd.strip_comments ruby
+
+    expected = <<-'EXPECTED'
+class C
+
+  def m
+    puts "hello #{world}"
+  end
+
+end
+    EXPECTED
+
+    assert_equal expected, ruby
+  end
+
+end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: gem-tldr
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2011-02-25 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :development
+  version_requirements: *id002
+description: |-
+  Are your gems taking up too much disk space?  Documentation got you down?
+  Comments stuck in your craw?  Tests taking too much space?  Fix all that by
+  with <tt>gem tldr</tt>.
+  
+  I know that disk space is at a premium these days with an introductory netbook
+  or a small AWS EC2 instance containing a mere 160GB.  <tt>gem tldr</tt>
+  removes the test directory, build artifacts like .c and .h files, comments in
+  your ruby source files and comments in your ruby source.
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/rubygems/commands/tldr_command.rb
+- lib/rubygems_plugin.rb
+- test/test_gem_commands_tldr_command.rb
+- .gemtest
+has_rdoc: true
+homepage: https://github.com/drbrain/gem-tldr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gem-tldr
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Are your gems taking up too much disk space?  Documentation got you down? Comments stuck in your craw?  Tests taking too much space?  Fix all that by with <tt>gem tldr</tt>
+test_files: 
+- test/test_gem_commands_tldr_command.rb

metadata.gz.sig

@@ -0,0 +1 @@
+tܥ��PFfPy�~k�|�$�������g�ë��LzX���W���y���J��1�̡�r�x1{�� 5�Y�唑�%߽�1�oXJƕ�.	��n�1�V