rubygems-compile 0.0.3 → 0.2.0

data/README.rdoc

@@ -1,39 +1,45 @@
 = rubygems-compile
 
-A post-install hook for `macgem` to automatically compile rubygems
-when you install them.
+A compile command for `macgem` to install and compile gems using the MacRuby compiler.
 
 All you need to do is:
 
      gem install rubygems-compile
 
-And then you're off to the races! When you install gems you should get a bunch of output about files being compiled.
+And then you're off to the races! When you install gems using `macgem compile` the gem will also be compiled.
 
-== TODO
-
-Right now, all you need to do is install the gem and it will be used every time you install a new gem (or reinstall an existing gem).
+== Description
 
-In the future, there are a few different ways this plugin operate:
+`rubygems-compile` provides two additional commands for `macgem`. The first is `compile`; you can now say `macgem compile nokogiri` and the `nokogiri` gem will be installed and compiled. Then, whenever you use `nokogiri`, the compiled version of the gem files will be loaded instead of the uncompiled version of the gem files.
 
-* A gemspec property
-  * spec.compile_for_macruby = true
-* A gem command
-  * gem compile nokogiri
-  * gem compile --remove-original-files nokogiri
-    * I can't remove the original .rb files and leave *.rbo files because of how rubygems identifies gems (unless I modify gemspec files)
-* A gem install option
-  * gem install --compile nokogiri
+`macgem compile` is a superset of the `gem install` command, so you can still use all the options you would normally use. `macgem compile` has one extra option to delete all the original .rb files after the .rbo is generated; use this option with caution.
 
-I'm not sure which is best, and maybe all of them will get implemented.
+Some gems work perfectly when compiled, and some do not (for various reasons), so you should try a gem non-compiled first. If you dove head first into using compiled gems and you need to back-peddle, you will have to uninstall and then reinstall the gem (NOTE: a `macgem decompile` to remove the .rbo files and, if needed, reinstall the gem all in one step is included but only works for normal cases (no dependency decompiling, no custom install directories)).
 
 == Caveats
 
-* Large gems will take a long time to compile
-* This has only been tested on a few gems, but should not break existing gems since we leave the original files around
-* Some gems specifically require a file with the .rb extension, defeating the purpose of having a compiled version of the gem
+* Large gems will take a long time to compile, but these are the gems that will benefit the most from being compiled
+* This has only been tested on a few gems, but should not break existing gems since we leave the original files around by default
+* As of MacRuby 0.9, you cannot get usable backtrace data for compiled ruby files
+  * This may be fixed for MacRuby 0.10
+* The 1-to-1 correlation of .rb files to .rbo files can make gems quite a bit bigger on disk
 
-== Copyright
+== Known Reasons A Compiled Gem Will Not Work
+
+* Using non-standard file suffixes (e.g. `mime-types` has a `.rb.data` file)
+  * This will be addressed in a later release
+* Gems that explicitly require a file with the file suffix (e.g. `require 'nokogiri.rb'`)
+  * This should be addressable in a future release
 
-Copyright (c) 2011 Mark Rada. See LICENSE.txt for
-further details.
+== TODO
+
+* A gem install option would be most natural instead of compile command
+  * gem install --compile nokogiri
+* Code parsing to WARN about gems that will not work when compiled
+* Compile multiple .rb files to a single .rbo binary (instead of an .rbo for each .rb)
+  * A naive implementation will not work for gems that are loaded modularly
+* Files in bin/ usually don't include the file extension and are not compiled
+
+== Copyright
 
+Copyright (c) 2011 Mark Rada. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :'gem:build'
+
+namespace :macruby do
+  desc 'AOT compile'
+  task :compile do
+    FileList["lib/**/*.rb"].each do |source|
+      name = File.basename source
+      puts "#{name} => #{name}o"
+      `macrubyc --arch x86_64 -C '#{source}' -o '#{source}o'`
+    end
+  end
+
+  desc 'Clean MacRuby binaries'
+  task :clean do
+    FileList["lib/**/*.rbo"].each do |bin|
+      rm bin
+    end
+  end
+end
+
+namespace :gem do
+  desc 'Build the gem'
+  task :build do
+    puts `gem build -v rubygems-compile.gemspec`
+  end
+
+  desc 'Build the gem and install it'
+  task :install => :build do
+    puts `gem install #{Dir.glob('rubygems-compile*.gem').sort.reverse.first}`
+  end
+end

data/lib/rubygems-compile/common_methods.rb

@@ -0,0 +1,22 @@
+module Gem
+module Compile
+module Methods
+
+  MACRUBYC = File.join(RbConfig::CONFIG['bindir'], 'macrubyc')
+
+  def get_specs_for_gems gem_names # :nodoc:
+    gem_names.flatten.map { |gem|
+      Gem.source_index.find_name gem
+    }.flatten.compact
+  end
+
+  def find_files_to_compile gem # :nodoc:
+    files = gem.files - gem.test_files - gem.extra_rdoc_files
+    files = files.reject do |file| file.match /^(?:test|spec)/ end
+    # this cuts out the .rb.data file in the mime-types gem
+    files.select do |file| file.match /\.rb$/ end
+  end
+
+end
+end
+end

data/lib/rubygems-compile/compile.rb

@@ -0,0 +1,70 @@
+require 'rbconfig'
+require 'fileutils'
+require 'rubygems/command'
+require 'rubygems/commands/install_command'
+require 'rubygems-compile/common_methods'
+
+##
+# Use the MacRuby compiler to compile gems at install time. This
+# includes the option to remove the original *.rb files leaving
+# only the compiled *.rbo files.
+
+class Gem::Commands::CompileCommand < Gem::Commands::InstallCommand
+  include Gem::Compile::Methods
+
+  def initialize
+    super # so that InstallCommand options are registered
+    @command = 'compile' # now we override certain attributes
+    @summary = 'Install and compile gems using the MacRuby compiler'
+    @program_name = 'gem compile'
+
+    defaults[:'remove-original-files'] = false
+    add_option( '-r', '--[no-]remove-original-files',
+                'Delete the original *.rb source files after compiling',
+                ) do |value, options|
+      options[:'remove-original-files'] = value
+    end
+  end
+
+  def defaults_str # :nodoc:
+    super + "\n--no-remove-original-files"
+  end
+
+  ##
+  # Lookup the gems and their listed files. It will only compile files
+  # that are located in the `require_path` for a gem.
+
+  def execute
+
+    verbose      = Gem.configuration.verbose
+    slash        = verbose.is_a?(Fixnum) ? '/' : ''
+    post_compile = Proc.new do |_,_| end
+
+    if options[:'remove-original-files']
+      post_compile = Proc.new do |file, full_path|
+        say "\tRemoving #{file}" if verbose.is_a? Fixnum
+        FileUtils.rm full_path
+        end
+    end
+
+    Gem.post_install do |gem|
+      spec = gem.spec
+      say "Compiling #{spec.name}-#{spec.version}#{slash}" if verbose
+
+      path  = spec.full_gem_path
+      files = find_files_to_compile spec
+
+      files.each { |file|
+        say "\t#{file} => #{file}o" if verbose.is_a? Fixnum
+        full_path = path + '/' + file
+        `#{MACRUBYC} -C '#{full_path}' -o '#{full_path}o'`
+        post_compile.call file, full_path
+      }
+    end
+
+    super
+  end
+
+end
+
+Gem::CommandManager.instance.register_command :compile

data/lib/rubygems-compile/decompile.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+require 'rubygems/command'
+require 'rubygems/commands/install_command'
+require 'rubygems-compile/common_methods'
+
+##
+# @todo need to look at dependencies too? use --include-dependencies option?
+#
+# Remove the compiled files for a gem. This is sometimes necessary for
+# gems that do not work after being compiled.
+
+class Gem::Commands::DecompileCommand < Gem::Commands::InstallCommand
+  include Gem::Compile::Methods
+
+  def initialize
+    super
+    @command = 'decompile'
+    @summary = 'Remove compiled *.rbo files for gems, possibily reinstalling'
+    @program_name = 'gem decompilecompile'
+  end
+
+  ##
+  # Try to only remove *.rbo files, but in the case that the original *.rb files
+  # are gone, we will also have to reinstall the gem.
+
+  def execute
+
+    verbose   = Gem.configuration.verbose
+    slash     = verbose.is_a?(Fixnum) ? '/' : ''
+
+    get_specs_for_gems(get_all_gem_names).each { |gem|
+      say "Decompiling #{gem.name}-#{gem.version}#{slash}" if verbose
+
+      path      = gem.full_gem_path
+      files     = find_files_to_compile gem
+      reinstall = false
+
+      files.each { |file|
+        say "\tRemoving #{file}o" if verbose.is_a? Fixnum
+        full_path = "#{path}/#{file}"
+        FileUtils.rm( full_path + 'o' )
+        reinstall = true unless File.exists? full_path
+      }
+
+      super if reinstall
+    }
+
+  end
+
+end
+
+Gem::CommandManager.instance.register_command :decompile

data/lib/rubygems-compile/monkey_patches.rb

@@ -0,0 +1,11 @@
+unless Gem.suffixes.include? '.rbo'
+  module Gem
+    class << self
+      # To get around how rubygems-1.4.2 set's suffixes
+      alias_method :rubygems_compile_suffixes, :suffixes
+      def suffixes
+        ['.rbo'] + rubygems_compile_suffixes
+      end
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -1,16 +1,3 @@
-Gem.post_install do |gem|
-
-  spec  = gem.spec
-  dir   = gem.gem_home + '/gems/' + spec.name + '-' + spec.version.version
-
-  files = spec.files - spec.test_files - spec.extra_rdoc_files
-  files = files.reject { |file| file.match /^(?:test|spec)/ }
-
-  files.each do |file|
-    next unless file.match /\.rb$/
-    puts "Compiling #{file} to #{file}o"
-    file = "#{dir}/#{file}"
-    `macrubyc -C '#{file}' -o '#{file}o'`
-  end
-
-end
+require 'rubygems-compile/monkey_patches'
+require 'rubygems-compile/compile'
+require 'rubygems-compile/decompile'

data/test/helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rubygems/command_manager'
+require 'rubygems_plugin'
+
+gem     'minitest', '>= 2.0.2'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+class MiniTest::Unit::TestCase
+  def setup
+    @command = Gem::Commands::CompileCommand.new
+  end
+end

data/test/test_find_files_to_compile.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestFindFilesToCompile < MiniTest::Unit::TestCase
+
+  def setup
+    super
+    @test_gem = MiniTest::Mock.new
+  end
+
+  def test_strips_test_files
+    @test_gem.expect :files, [
+      'test/file1', 'test/file2', 'spec/file1', 'spec/file2', 'setup.rb'
+                            ]
+    @test_gem.expect :test_files, [ 'test/file1', 'spec/file1' ]
+    @test_gem.expect :extra_rdoc_files, []
+
+    assert_equal [ 'setup.rb' ], @command.find_files_to_compile(@test_gem)
+  end
+
+  def test_strips_non_ruby_source_files
+    @test_gem.expect :files, [
+      'README.rdoc', 'LICENSE.txt', 'Gemfile', 'setup.rb'
+                            ]
+    @test_gem.expect :test_files, []
+    @test_gem.expect :extra_rdoc_files, [
+      'README.rdoc', 'LICENSE.txt', 'Gemfile'
+                                       ]
+    assert_equal [ 'setup.rb' ], @command.find_files_to_compile(@test_gem)
+  end
+
+  def test_returns_array_of_files
+    source_files = [
+      'lib/gem.rb', 'lib/gem/helper.rb', 'ext/help/extconf.rb', 'setup.rb'
+                   ]
+    @test_gem.expect :files, source_files
+    @test_gem.expect :test_files, []
+    @test_gem.expect :extra_rdoc_files, []
+
+    ret = @command.find_files_to_compile @test_gem
+    assert_instance_of Array, ret
+    assert_equal source_files, ret
+  end
+
+end

data/test/test_get_specs_for_gems.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+class TestGetSpecsForGems < MiniTest::Unit::TestCase
+
+  def test_doesnt_explode_with_bad_gem_names
+    assert_empty @command.get_specs_for_gems ['not_a_real_gem']
+  end
+
+  def test_takes_an_array
+    assert @command.get_specs_for_gems ['minitest', 'not_a_real_gem']
+  end
+
+  def test_returns_gemspecs
+    ret = @command.get_specs_for_gems ['minitest']
+    assert_instance_of Array, ret
+    assert_instance_of Gem::Specification, ret.first
+  end
+
+end

metadata

@@ -2,32 +2,32 @@
 name: rubygems-compile
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-19 00:00:00 -05:00
+date: 2011-03-06 00:00:00 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 2.0.2
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 2.0.2
 description: 'A rubygems post-install hook to compile gems using the MacRuby compiler.
 
 '
@@ -35,12 +35,21 @@ email: mrada@marketcircle.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- Rakefile
 - LICENSE.txt
 - README.rdoc
 files:
+- lib/rubygems-compile/common_methods.rb
+- lib/rubygems-compile/compile.rb
+- lib/rubygems-compile/decompile.rb
+- lib/rubygems-compile/monkey_patches.rb
 - lib/rubygems_plugin.rb
+- Rakefile
 - LICENSE.txt
 - README.rdoc
+- test/test_find_files_to_compile.rb
+- test/test_get_specs_for_gems.rb
+- test/helper.rb
 has_rdoc: true
 homepage: http://github.com/ferrous26/rubygems-compile
 licenses:
@@ -49,9 +58,19 @@ post_install_message: '
 
   ***********************************************************
 
-  Make sure to uninstall earlier versions of rubygems-compile
 
-  or you will end up compiling your gems multiple times.
+  Please uninstall previous versions of this gem, or else
+
+  rubygems will try to load each version of the gem.
+
+
+  The functionality of this gem has changed since the 0.0.x
+
+  series. It now operates as its own command, see the README.
+
+
+  https://github.com/ferrous26/rubygems-compile
+
 
   ***********************************************************
 
@@ -78,4 +97,7 @@ rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: A rubygems post-install hook using the MacRuby compiler to compile gems
-test_files: []
+test_files:
+- test/test_find_files_to_compile.rb
+- test/test_get_specs_for_gems.rb
+- test/helper.rb