rubygems-compile 1.0.0beta2 → 1.0.0rc1

data/README.markdown

@@ -0,0 +1,73 @@
+# rubygems-compile
+
+A set of rubygems commands for `macgem` that interface with the
+MacRuby compiler. This gem requires MacRuby 0.11 or newer.
+
+All you need to do is:
+
+```bash
+sudo macgem install rubygems-compile --pre
+```
+
+And then you're off to the races!
+
+## Commands
+
+`compile`
+
+  Can be used to compile, or re-compile, any gems that are  already installed.
+
+```bash
+sudo macgem compile nokogiri                        # Compile gems based on names you provide
+sudo macgem compile minitest --version 2.0.2        # Compile a specific version of a gem
+sudo macgem compile --all                           # Compile all installed gems
+sudo macgem compile rspec --no-ignore-dependencies  # Also compile dependencies
+```
+
+`uncompile`
+
+  Can be used to remove the compiled `.rbo` files if a gem does not work well when compiled.
+
+```bash
+sudo macgem uncompile nokogiri                        # Uncompile gems based on names you provide
+sudo macgem uncompile minitest --version 2.0.2        # Compile a specific version of a gem
+sudo macgem uncompile --all                           # Uncompile all installed gems
+sudo macgem uncompile rspec --no-ignore-dependencies  # Also uncompile dependencies
+```
+
+`auto\_compile`
+
+  Can be used to enable a post-install hook that will automatically compile gems when you install them. Call it once to turn on, call it a second time to disable it.
+
+```bash
+sudo macgem auto_compile  # gems will compiled when you install them
+sudo macgem auto_compile  # gems will not be compiled when you install them
+```
+
+## Caveats
+
+* Large gems will take a long time to compile, but these are the gems
+  that will benefit the most from being compiled so please be patient
+* This has only been tested on a few gems, but should not break
+  existing gems since we leave the original files around
+* At the moment, compiled gems will not provide usable backtraces
+  + If you suspect a bug in the way MacRuby compiled a file, try running with pre-compiled files disabled like so: `VM_DISABLE_RBO=1 ruby my_code.rb`
+* `.rbo` files take up more disk space than their `.rb` equivalents
+
+## Known Issues
+
+* Source files using a non-standard suffix (e.g. `mime-types` has a `.rb.data` file) will not get compiled
+  + This might be addressable in a later release, but is not a big deal
+* Gems that explicitly require a file with the file suffix (e.g. `require 'nokogiri.rb'`) will never load the compiled version of the file
+  + Those gems should be updated so that compiled code can be loaded
+
+## TODO
+
+* Code parsing to WARN about gems that will have issues when compiled
+* Parallel compilation to speed up compilation of large gems
+  + This might require changes in the MacRuby compiler
+
+## Copyright
+
+Copyright (c) 2011 Mark Rada. See LICENSE.txt for further details.
+

data/lib/rubygems-compile/commands/compile_command.rb

@@ -38,6 +38,7 @@ class Gem::Commands::CompileCommand < Gem::Command
 
   def execute
     gems = execution_list
+    gems.delete_if { |spec| spec.name == 'rubygems-compile' }
 
     if gems.count >= 10
       alert 'This could take a while; you might want to take a coffee break'

data/lib/rubygems-compile/compiler.rb

@@ -10,7 +10,7 @@ class Gem::Compiler
     @spec = gem.is_a?(Gem::Specification) ? gem : gem.spec
 
     if @spec.name == 'rubygems-compile'
-      alert 'You cannot compile rubygems-compile'
+      alert_info 'You cannot compile rubygems-compile' if @config.really_verbose
       return
     end
 
@@ -19,11 +19,11 @@ class Gem::Compiler
     gem_files.each do |file|
       say compile_file_msg(file) if @config.really_verbose
       absolute_file_path = File.join(@spec.full_gem_path, file)
-      ::Compiler.new(
-                     bundle: true,
-                      files: [absolute_file_path],
-                     output: "#{absolute_file_path}o"
-                     ).run
+      MacRuby::Compiler.new(
+                            bundle: true,
+                            output: "#{absolute_file_path}o",
+                             files: [absolute_file_path]
+                            ).run
     end
   end
 
@@ -34,9 +34,18 @@ class Gem::Compiler
     "Compiling #{@spec.full_name}#{slash}"
   end
 
-  # @todo get better at deciding which files to compile;
-  #       right now we ignore the .rb.data file in the mime-types gem
-  #       and probably some other silly edge cases that are similar
+  ##
+  # --
+  # TODO Get better at deciding which files to compile; right now we
+  #      ignore the .rb.data file in the mime-types gem and probably
+  #      some other silly edge cases that are similar.
+  # ++
+  #
+  # We want to find all the files in a gem to compile, but avoid compiling
+  # test files and other misc. files which are usually found in the top
+  # level or test directory.
+  #
+
   def gem_files
     files = @spec.files - @spec.test_files - @spec.extra_rdoc_files
     files.reject { |file| file.match /^(?:test|spec)/ }

data/lib/rubygems_plugin.rb

@@ -1,4 +1,4 @@
-if RUBY_VERSION.to_f < 0.11
+unless MACRUBY_REVISION.match /^git commit/
 
   ui = Gem::UserInteraction.new
   ui.alert_warning 'rubygems-compile requires MacRuby 0.11 or newer'
@@ -10,7 +10,7 @@ else
   require 'fileutils'
   require 'rubygems/version_option'
 
-  unless Kernel.const_defined?(:Compiler)
+  unless MacRuby.const_defined?(:Compiler)
     load File.join(RbConfig::CONFIG['bindir'], 'macrubyc')
   end
 

metadata

@@ -2,14 +2,14 @@
 name: rubygems-compile
 version: !ruby/object:Gem::Version
   prerelease: 5
-  version: 1.0.0beta2
+  version: 1.0.0rc1
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-14 00:00:00 -04:00
+date: 2011-06-27 00:00:00 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -28,7 +28,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 2.2.0
-description: 'A set of rubygems commands that interface with the MacRuby compiler
+description: 'A set of rubygems commands that interface with the MacRuby compiler.
 
 '
 email: mrada@marketcircle.com
@@ -36,7 +36,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - lib/rubygems-compile/analysis.rb
 - lib/rubygems-compile/commands/autocompile_command.rb
@@ -55,7 +55,7 @@ files:
 - Rakefile
 - .gemtest
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 has_rdoc: true
 homepage: http://github.com/ferrous26/rubygems-compile
 licenses:

data/README.rdoc

@@ -1,59 +0,0 @@
-= rubygems-compile
-
-A set of rubygems commands for <tt>macgem</tt> that interface with the
-MacRuby compiler.
-
-All you need to do is:
-
-  sudo macgem install rubygems-compile
-
-And then you're off to the races!
-
-== Commands
-
-[+compile+] Can be used to compile, or re-compile, any gems that are  already installed.
-
-  sudo macgem compile nokogiri                        # Compile gems based on names you provide
-  sudo macgem compile minitest --version 2.0.2        # Compile a specific version of a gem
-  sudo macgem compile --all                           # Compile all installed gems
-  sudo macgem compile rspec --no-ignore-dependencies  # Also compile dependencies
-
-[+uncompile+] Can be used to remove the compiled <tt>.rbo</tt> files if a gem does not work well when compiled.
-
-  sudo macgem uncompile nokogiri                        # Uncompile gems based on names you provide
-  sudo macgem uncompile minitest --version 2.0.2        # Compile a specific version of a gem
-  sudo macgem uncompile --all                           # Uncompile all installed gems
-  sudo macgem uncompile rspec --no-ignore-dependencies  # Also uncompile dependencies
-
-[+auto_compile+] Can be used to enable a post-install hook that will automatically compile gems when you install them. Call it once to turn on, call it a second time to disable it.
-
-  sudo macgem auto_compile  # gems will compiled when you install them
-  sudo macgem auto_compile  # gems will not be compiled when you install them
-
-== Caveats
-
-* Large gems will take a long time to compile, but these are the gems
-  that will benefit the most from being compiled so please be patient
-* This has only been tested on a few gems, but should not break
-  existing gems since we leave the original files around
-* At the moment, compiled gems will not provide usable backtraces
-* <tt>.rbo</tt> files take up more disk space than their <tt>.rb</tt> equivalents
-
-== Known Issues
-
-* Source files using a non-standard suffix (e.g. <tt>mime-types</tt> has a <tt>.rb.data</tt> file) will not get compiled
-  * This might be addressable in a later release, but is not a big deal
-* Gems that explicitly require a file with the file suffix (e.g. <tt>require 'nokogiri.rb'</tt>) will never load the compiled version of the file
-  * Those gems should be updated so that compiled code can be loaded
-
-== TODO
-
-* Support specifying a version for compile/uncompile commands
-* Code parsing to WARN about gems that will have issues when compiled
-* Parallel compilation to speed up compilation of large gems
-  * This might require changes in the MacRuby compiler
-
-== Copyright
-
-Copyright (c) 2011 Mark Rada. See LICENSE.txt for further details.
-