rubygems-compile 1.0.0-universal-macruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mark Rada
+
+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/README.rdoc

@@ -0,0 +1,58 @@
+= rubygems-compile
+
+A set of rubygems commands for <tt>macgem</tt> that interface with the
+MacRuby compiler. This gem requires MacRuby 0.11 or newer.
+
+All you need to do is:
+
+  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.
+
+  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
+
+* 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/Rakefile

@@ -0,0 +1,24 @@
+require 'rake/testtask'
+require 'rake/gempackagetask'
+require 'rubygems/dependency_installer'
+
+task :default => :gem
+
+Rake::TestTask.new(:test) do |test|
+  test.libs     << 'lib' << 'test'
+  test.pattern   = 'test/**/test_*.rb'
+  test.verbose   = true
+  test.ruby_opts = ['-rhelper']
+end
+
+eval IO.read('rubygems-compile.gemspec')
+
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = true
+end
+
+desc 'Build the gem and install it'
+task :install => :gem do
+  Gem::Installer.new("pkg/#{GEM_SPEC.file_name}").install
+end

data/lib/rubygems-compile/analysis.rb

@@ -0,0 +1,11 @@
+require 'ripper'
+
+class GemAnalyzer < Ripper::SexpBuilder
+
+  def on_command command, args
+    puts args.class
+    puts command.class
+    super.tap { |x| puts x.inspect }
+  end
+
+end

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

@@ -0,0 +1,27 @@
+class Gem::Commands::AutoCompileCommand < Gem::Command
+  include Gem::UserInteraction
+
+  def initialize
+    super 'auto_compile', 'Enable gem compilation at install time'
+  end
+
+  def description # :nodoc:
+    'Toggle a setting that enables compiling gems at install time.'
+  end
+
+  def usage
+    "#{progname}"
+  end
+
+  def execute
+    Gem.configuration[:compile] = if Gem.configuration[:compile]
+                                    say 'Disabling automatic compilation'
+                                    false
+                                  else
+                                    say 'Enabling automatic compilation'
+                                    true
+                                  end
+    Gem.configuration.write
+  end
+
+end

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

@@ -0,0 +1,51 @@
+require 'rubygems/dependency_list'
+
+##
+# Use the MacRuby compiler to compile installed gems.
+
+class Gem::Commands::CompileCommand < Gem::Command
+  include Gem::VersionOption
+  include Gem::CompileMethods
+
+  def initialize
+    super 'compile', 'Compile (or recompile) installed gems',
+          ignore: true, all: false
+
+    add_version_option
+    add_option(
+               '-a', '--all', 'Compile all installed gem'
+               ) do |all,opts| opts[:all] = all end
+    add_option(
+               '-I', '--[no-]ignore-dependencies', 'Also compile dependencies'
+               ) do |value, options| options[:ignore] = value end
+  end
+
+  def arguments # :nodoc:
+    'GEMNAME          name of the gem to compile'
+  end
+
+  def defaults_str # :nodoc:
+    super + '--ignore-dependencies'
+  end
+
+  def usage # :nodoc:
+    "#{program_name} GEMNAME [GEMNAME ...]"
+  end
+
+  ##
+  # Determine which gems need to be compiled, then create and run a compiler
+  # object for each of them.
+
+  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'
+    end
+
+    compiler = Gem::Compiler.new
+    gems.each { |gem| compiler.compile(gem) }
+  end
+
+end

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

@@ -0,0 +1,39 @@
+class Gem::Commands::UncompileCommand < Gem::Command
+  include Gem::VersionOption
+  include Gem::CompileMethods
+
+  def initialize
+    super 'uncompile', 'Uncompile installed gems',
+          ignore: true, all: false
+
+    add_version_option
+    add_option(
+               '-a', '--all', 'Uncompile all installed gem'
+               ) do |all,opts| opts[:all] = all end
+    add_option(
+               '-I', '--[no-]ignore-dependencies', 'Also uncompile dependencies'
+               ) do |value, options| options[:ignore] = value end
+  end
+
+  def arguments # :nodoc:
+    'GEMNAME          name of the gem to uncompile'
+  end
+
+  def defaults_str # :nodoc:
+    super + '--ignore-dependencies'
+  end
+
+  def usage # :nodoc:
+    "#{program_name} GEMNAME [GEMNAME ...]"
+  end
+
+  ##
+  # Determine which gems need to be uncompiled, then create and run
+  # an uncompiler object for each of them.
+
+  def execute
+    uncompiler = Gem::Uncompiler.new
+    execution_list.each { |gem| uncompiler.uncompile(gem) }
+  end
+
+end

data/lib/rubygems-compile/commands.rb

@@ -0,0 +1,8 @@
+require 'rubygems-compile/commands/compile_command'
+Gem::CommandManager.instance.register_command :compile
+
+require 'rubygems-compile/commands/uncompile_command'
+Gem::CommandManager.instance.register_command :uncompile
+
+require 'rubygems-compile/commands/autocompile_command'
+Gem::CommandManager.instance.register_command :auto_compile

data/lib/rubygems-compile/common_methods.rb

@@ -0,0 +1,39 @@
+module Gem
+
+  module CompileMethods
+
+    def execution_list
+      gems_list.map do |gem|
+        candidates = Gem.source_index.find_name(gem, options[:version])
+
+        if candidates.empty?
+          alert_error "#{gem} is not installed. Skipping."
+          next
+        end
+
+        candidates << dependencies_for(*candidates) unless options[:ignore]
+        candidates
+      end.flatten.uniq
+    end
+
+    def gems_list
+      installed_gems = Gem.source_index.all_gems
+      if options[:all] then
+        installed_gems.map { |_, spec| spec.name }
+      else
+        get_all_gem_names
+      end
+    end
+
+    def dependencies_for *specs
+      specs.map { |spec|
+        spec.runtime_dependencies.map { |dep|
+          deps = Gem.source_index.find_name(dep.name,dep.requirement)
+          deps + dependencies_for(*deps)
+        }
+      }
+    end
+
+  end
+
+end

data/lib/rubygems-compile/compiler.rb

@@ -0,0 +1,70 @@
+class Gem::Compiler
+  include Gem::UserInteraction
+
+  def initialize
+    @current_directory = []
+    @config            = Gem.configuration
+  end
+
+  def call gem
+    @spec = gem.is_a?(Gem::Specification) ? gem : gem.spec
+
+    if @spec.name == 'rubygems-compile'
+      alert_info 'You cannot compile rubygems-compile' if @config.really_verbose
+      return
+    end
+
+    say compilation_message if @config.verbose
+
+    gem_files.each do |file|
+      say compile_file_msg(file) if @config.really_verbose
+      absolute_file_path = File.join(@spec.full_gem_path, file)
+      MacRuby::Compiler.new(
+                            bundle: true,
+                            output: "#{absolute_file_path}o",
+                             files: [absolute_file_path]
+                            ).run
+    end
+  end
+
+  alias_method :compile, :call
+
+  def compilation_message
+    slash = @config.really_verbose ? '/' : ''
+    "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.
+  # ++
+  #
+  # 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)/ }
+      .select { |file| file.match /\.rb$/ }
+  end
+
+  def compile_file_msg file
+    name = File.basename(file)
+    dirs = file.chomp(name).split(File::SEPARATOR)
+    tabs = "\t" * dirs.count
+
+    dirs.each_with_index do |dir, index|
+      unless @current_directory[index] == dir
+        @current_directory[index] = dir
+        say( "\t" * (index + 1) + dir + File::SEPARATOR)
+      end
+    end
+
+    "#{tabs}#{name} => #{name}o"
+  end
+
+end

data/lib/rubygems-compile/post_install_hook.rb

@@ -0,0 +1,9 @@
+##
+# The setting that we look for here is toggled using the +autocompile+
+# command.
+
+if Gem.configuration[:compile]
+  module Gem
+    @post_install_hooks << ::Gem::Compiler.new
+  end
+end

data/lib/rubygems-compile/uncompiler.rb

@@ -0,0 +1,31 @@
+class Gem::Uncompiler
+  include Gem::UserInteraction
+
+  def initialize
+    @config = Gem.configuration
+  end
+
+  def uncompile gem
+    @spec = gem.is_a?(Gem::Specification) ? gem : gem.spec
+
+    say uncompilation_message if @config.verbose
+
+    gem_files.each do |file|
+      say "\tAsploded #{file}" if @config.really_verbose
+      absolute_file_path = File.join(@spec.full_gem_path, file)
+      FileUtils.rm absolute_file_path
+    end
+  end
+
+  def uncompilation_message
+    slash = @config.really_verbose ? '/' : ''
+    "Uncompiling #{@spec.full_name}#{slash}"
+  end
+
+  def gem_files
+    Dir.glob(File.join(@spec.full_gem_path, '**','*.rbo')).map do |file|
+      file.sub /#{@spec.full_gem_path}\//, ''
+    end
+  end
+
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,23 @@
+if RUBY_VERSION.to_f < 0.11
+
+  ui = Gem::UserInteraction.new
+  ui.alert_warning 'rubygems-compile requires MacRuby 0.11 or newer'
+  ui.alert_warning 'rubygems-compile will not be loaded'
+
+else
+
+  require 'rbconfig'
+  require 'fileutils'
+  require 'rubygems/version_option'
+
+  unless MacRuby.const_defined?(:Compiler)
+    load File.join(RbConfig::CONFIG['bindir'], 'macrubyc')
+  end
+
+  require 'rubygems-compile/common_methods'
+  require 'rubygems-compile/compiler'
+  require 'rubygems-compile/uncompiler'
+  require 'rubygems-compile/commands'
+  require 'rubygems-compile/post_install_hook'
+
+end

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rubygems/command_manager'
+require 'rubygems_plugin'
+
+gem     'minitest-macruby-pride', '>= 2.2.0'
+require 'minitest/autorun'
+require 'minitest/pride'

data/test/test_autocompile_command.rb

@@ -0,0 +1,22 @@
+class TestAutoCompile < MiniTest::Unit::TestCase
+
+  def setup
+    @command = Gem::Commands::AutoCompileCommand.new
+  end
+
+  def test_turn_on
+  end
+
+  def test_turn_on_when_already_on
+  end
+
+  def test_turn_off
+  end
+
+  def test_turn_off_when_already_off
+  end
+
+  def test_calls_compile_on_each_gem_after_installation
+  end
+
+end

data/test/test_compile_command.rb

@@ -0,0 +1,36 @@
+class TestCompileCommand < MiniTest::Unit::TestCase
+  def setup
+    @command = Gem::Commands::CompileCommand.new
+  end
+end
+
+class Test < TestCompileCommand
+  def test_finds_all_files
+    # gets into all require dirs
+    # does not compile test files
+  end
+  def test_recompiles_rbos_if_they_already_exist
+    # to support use on nightly builds
+  end
+end
+
+class TestCompileInterface < TestCompileCommand
+  def test_has_an_option_to_compile_all_installed_gems
+    # by extension, this is also needed to support nightly build users
+  end
+end
+
+class TestCompileSpecialCases < TestCompileCommand
+  def test_refuses_to_compile_itself
+    # obvious
+  end
+
+  def test_loads_rubyc_without_warning
+    # this might not be doable without upstream load guarding; minor issue
+  end
+
+  # important to test so we don't break rubygems
+  def test_skips_loading_on_older_macruby_versions
+    # and prints a message
+  end
+end

data/test/test_uncompile_command.rb

@@ -0,0 +1,16 @@
+class TestUncompileCommand < MiniTest::Unit::TestCase
+
+  def setup
+    @command = Gem::Commands::UncompileCommand.new
+  end
+
+  def test_removes_rbo_files
+  end
+
+  def test_leaves_rb_files
+  end
+
+  def test_can_uncompile_multiple_gems_at_once
+  end
+
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-compile
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.0.0
+platform: universal-macruby
+authors:
+- Mark Rada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-02 00:00:00 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-macruby-pride
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: 'A set of rubygems commands that interface with the MacRuby compiler.
+
+'
+email: mrada@marketcircle.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/rubygems-compile/analysis.rb
+- lib/rubygems-compile/commands/autocompile_command.rb
+- lib/rubygems-compile/commands/compile_command.rb
+- lib/rubygems-compile/commands/uncompile_command.rb
+- lib/rubygems-compile/commands.rb
+- lib/rubygems-compile/common_methods.rb
+- lib/rubygems-compile/compiler.rb
+- lib/rubygems-compile/post_install_hook.rb
+- lib/rubygems-compile/uncompiler.rb
+- lib/rubygems_plugin.rb
+- test/helper.rb
+- test/test_autocompile_command.rb
+- test/test_compile_command.rb
+- test/test_uncompile_command.rb
+- Rakefile
+- .gemtest
+- LICENSE.txt
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ferrous26/rubygems-compile
+licenses:
+- MIT
+post_install_message: "\n***********************************************************\n\nPlease
+  uninstall previous versions of this gem, or else\nrubygems will try to load each
+  version of the gem.\n\nThis version of rubygems-compile requires MacRuby 0.11 or\nnewer;
+  the functionality has changed significantly since\npre-1.0 releases, see the README:\n\n
+  \   https://github.com/ferrous26/rubygems-compile\n\n***********************************************************\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: "0"
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A set of rubygems commands that interface with the MacRuby compiler
+test_files:
+- test/helper.rb
+- test/test_autocompile_command.rb
+- test/test_compile_command.rb
+- test/test_uncompile_command.rb
+- Rakefile
+- .gemtest