rubygems-compile 1.0.0rc2 → 1.0.0rc3

data/README.markdown

@@ -15,7 +15,8 @@ And then you're off to the races!
 
 `compile`
 
-  Can be used to compile, or re-compile, any gems that are  already installed.
+  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
@@ -26,7 +27,11 @@ 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.
+  Can be used to remove the compiled `.rbo` files if a gem does not
+  work well when compiled. If you find a gem that does not work when
+  compiled, it would be greatly appreciated if you reported it here or
+  to the MacRuby project itself so that someone can look into the
+  problem.
 
 ```bash
 sudo macgem uncompile nokogiri                        # Uncompile gems based on names you provide
@@ -35,9 +40,13 @@ sudo macgem uncompile --all                           # Uncompile all installed
 sudo macgem uncompile rspec --no-ignore-dependencies  # Also uncompile dependencies
 ```
 
-`auto\_compile`
+`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.
+  If you don't like the idea of calling `compile` each time you
+  install a gem, then you can use `auto_compile` to enable a
+  post-install hook that will automatically compile gems when they are
+  installed. You can call `auto_compile` a second time to turn off the
+  feature.
 
 ```bash
 sudo macgem auto_compile  # gems will compiled when you install them
@@ -51,7 +60,7 @@ sudo macgem auto_compile  # gems will not be compiled when you install them
 * 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`
+  + 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 macruby my_code.rb`
 * `.rbo` files take up more disk space than their `.rb` equivalents
 
 ## Known Issues
@@ -59,7 +68,8 @@ sudo macgem auto_compile  # gems will not be compiled when you install them
 * 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
+  + This issue may be addressed in MacRuby itself in the near future
+  + Alternatively, those gems should be updated so that compiled code can be loaded
 
 ## TODO
 

data/Rakefile

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

data/lib/rubygems-compile/analyzer.rb

@@ -0,0 +1,23 @@
+require 'ripper'
+
+##
+# Uses the ripper parser to analyze ruby code contained in gems
+# and raises warnings if the code has potential issues.
+
+class Gem::Analyzer < Ripper::SexpBuilder
+
+  ##
+  # Raised in any case that the given code might display bad
+  # behaviours that were not intended.
+
+  class Warning < Exception
+  end
+
+  def on_kw token
+    # Related to MacRuby ticket #721
+    if token == '__FILE__'
+      raise Warning, 'The __FILE__ keyword is used in this file'
+    end
+  end
+
+end

data/lib/rubygems-compile/common_methods.rb

@@ -17,6 +17,7 @@ module Gem
     end
 
     def gems_list
+      # @todo Gem.source_index is going away...
       installed_gems = Gem.source_index.all_gems
       if options[:all] then
         installed_gems.map { |_, spec| spec.name }

data/lib/rubygems-compile/compiler.rb

@@ -19,6 +19,7 @@ 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)
+      next if unsafe?(absolute_file_path)
       MacRuby::Compiler.new(
                             bundle: true,
                             output: "#{absolute_file_path}o",
@@ -26,9 +27,21 @@ class Gem::Compiler
                             ).run
     end
   end
-
   alias_method :compile, :call
 
+  ##
+  # Uses the GemAnalyzer class to determine if a given file might have
+  # any potential issues when compiled.
+
+  def unsafe? file
+    Gem::Analyzer.new(File.read(file)).parse
+    false
+  rescue Gem::Analyzer::Warning => e
+    say "WARNING: #{e.message}"
+    say 'Compilation of this file will be skipped'
+    true
+  end
+
   def compilation_message
     slash = @config.really_verbose ? '/' : ''
     "Compiling #{@spec.full_name}#{slash}"

data/lib/rubygems_plugin.rb

@@ -15,6 +15,7 @@ else
   end
 
   require 'rubygems-compile/common_methods'
+  require 'rubygems-compile/analyzer'
   require 'rubygems-compile/compiler'
   require 'rubygems-compile/uncompiler'
   require 'rubygems-compile/commands'

data/test/helper.rb

@@ -2,6 +2,6 @@ require 'rubygems'
 require 'rubygems/command_manager'
 require 'rubygems_plugin'
 
-gem     'minitest-macruby-pride', '>= 2.2.0'
+gem     'minitest', '>= 2.6.1'
 require 'minitest/autorun'
 require 'minitest/pride'

data/test/test_analyzer.rb

@@ -0,0 +1,13 @@
+class TestGemAnalyzer < MiniTest::Unit::TestCase
+
+  def test_finds_usage_of___FILE__
+    assert_raises Gem::Analyzer::Warning do
+      Gem::Analyzer.new("__FILE__").parse
+    end
+
+    assert_block do
+      Gem::Analyzer.new("puts '__FILE__'").parse
+    end
+  end
+
+end

data/test/test_autocompile_command.rb

@@ -4,19 +4,19 @@ class TestAutoCompile < MiniTest::Unit::TestCase
     @command = Gem::Commands::AutoCompileCommand.new
   end
 
-  def test_turn_on
-  end
+  # def test_turn_on
+  # end
 
-  def test_turn_on_when_already_on
-  end
+  # def test_turn_on_when_already_on
+  # end
 
-  def test_turn_off
-  end
+  # def test_turn_off
+  # end
 
-  def test_turn_off_when_already_off
-  end
+  # def test_turn_off_when_already_off
+  # end
 
-  def test_calls_compile_on_each_gem_after_installation
-  end
+  # def test_calls_compile_on_each_gem_after_installation
+  # end
 
 end

data/test/test_common_methods.rb

@@ -0,0 +1,39 @@
+# class CommonMethodsTester
+#   include Gem::CompileMethods
+
+#   class Gem
+#     class << self
+#       def source_index
+#         GemList.new
+#       end
+#     end
+#   end
+
+# end
+
+# class GemList
+#   def all_gems
+#     ['the', 'answer', 'to', 'life', 'the', 'universe', 'and', 'everything']
+#   end
+# end
+
+# class TestCommonMethods < MiniTest::Unit::TestCase
+
+#   def modul
+#     @@modul ||= CommonMethodsTester.new
+#   end
+
+#   def test_execution_list
+#   end
+
+#   def test_gems_list
+#     def modul.options
+#       { all: true }
+#     end
+#     assert_equal GemList.new.all_gems, modul.gems_list
+#   end
+
+#   def test_dependencies_for
+#   end
+
+# end

data/test/test_compile_command.rb

@@ -1,36 +1,32 @@
 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
+  # 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
 
-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
+  # def test_has_an_option_to_compile_all_installed_gems
+  #   # by extension, this is also needed to support nightly build users
+  # end
 
-class TestCompileSpecialCases < TestCompileCommand
-  def test_refuses_to_compile_itself
-    # obvious
-  end
+  # 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
+  # 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
 
-  # 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

@@ -4,13 +4,13 @@ class TestUncompileCommand < MiniTest::Unit::TestCase
     @command = Gem::Commands::UncompileCommand.new
   end
 
-  def test_removes_rbo_files
-  end
+  # def test_removes_rbo_files
+  # end
 
-  def test_leaves_rb_files
-  end
+  # def test_leaves_rb_files
+  # end
 
-  def test_can_uncompile_multiple_gems_at_once
-  end
+  # def test_can_uncompile_multiple_gems_at_once
+  # end
 
 end

metadata

@@ -2,33 +2,33 @@
 name: rubygems-compile
 version: !ruby/object:Gem::Version
   prerelease: 5
-  version: 1.0.0rc2
+  version: 1.0.0rc3
 platform: ruby
 authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-28 00:00:00 -04:00
+date: 2011-10-15 00:00:00 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest-macruby-pride
+  name: minitest
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.6.1
   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.
+        version: 2.6.1
+description: 'A trio of rubygems commands that interface with the MacRuby compiler.
 
 '
 email: mrada@marketcircle.com
@@ -38,7 +38,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.markdown
 files:
-- lib/rubygems-compile/analysis.rb
+- lib/rubygems-compile/analyzer.rb
 - lib/rubygems-compile/commands/autocompile_command.rb
 - lib/rubygems-compile/commands/compile_command.rb
 - lib/rubygems-compile/commands/uncompile_command.rb
@@ -49,7 +49,9 @@ files:
 - lib/rubygems-compile/uncompiler.rb
 - lib/rubygems_plugin.rb
 - test/helper.rb
+- test/test_analyzer.rb
 - test/test_autocompile_command.rb
+- test/test_common_methods.rb
 - test/test_compile_command.rb
 - test/test_uncompile_command.rb
 - Rakefile
@@ -85,10 +87,12 @@ rubyforge_project:
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: A set of rubygems commands that interface with the MacRuby compiler
+summary: A trio of rubygems commands that interface with the MacRuby compiler
 test_files:
 - test/helper.rb
+- test/test_analyzer.rb
 - test/test_autocompile_command.rb
+- test/test_common_methods.rb
 - test/test_compile_command.rb
 - test/test_uncompile_command.rb
 - Rakefile

data/lib/rubygems-compile/analysis.rb

@@ -1,11 +0,0 @@
-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