rake-compiler 0.3.0 → 0.5.0

data/lib/rake/extensiontask.rb

@@ -7,10 +7,10 @@ require 'rake'
 require 'rake/clean'
 require 'rake/tasklib'
 require 'rbconfig'
+require 'yaml'
 
 module Rake
   autoload :GemPackageTask, 'rake/gempackagetask'
-  autoload :YAML, 'yaml'
 
   class ExtensionTask < TaskLib
     attr_accessor :name
@@ -37,7 +37,7 @@ module Rake
       @gem_spec = gem_spec
       @config_script = 'extconf.rb'
       @tmp_dir = 'tmp'
-      @ext_dir = 'ext'
+      @ext_dir = "ext/#{@name}"
       @lib_dir = 'lib'
       @source_pattern = "*.c"
       @config_options = []
@@ -62,8 +62,13 @@ module Rake
       define_native_tasks if @gem_spec && @gem_spec.platform == 'ruby'
 
       # only define cross platform functionality when enabled
-      # FIXME: there is no value for having this on Windows or JRuby
-      define_cross_platform_tasks if @cross_compile
+      return unless @cross_compile
+
+      if cross_platform.is_a?(Array) then
+        cross_platform.each { |platf| define_cross_platform_tasks(platf) }
+      else
+        define_cross_platform_tasks(cross_platform)
+      end
     end
 
     private
@@ -76,7 +81,7 @@ module Rake
 
       # cleanup and clobbering
       CLEAN.include(tmp_path)
-      CLOBBER.include("#{@lib_dir}/#{binary}")
+      CLOBBER.include("#{@lib_dir}/#{binary(platf)}")
       CLOBBER.include("#{@tmp_dir}")
 
       # directories we need
@@ -85,13 +90,13 @@ module Rake
 
       # copy binary from temporary location to final lib
       # tmp/extension_name/extension_name.{so,bundle} => lib/
-      task "copy:#{@name}:#{platf}" => [lib_dir, "#{tmp_path}/#{binary}"] do
-        cp "#{tmp_path}/#{binary}", "#{@lib_dir}/#{binary}"
+      task "copy:#{@name}:#{platf}" => [lib_dir, "#{tmp_path}/#{binary(platf)}"] do
+        cp "#{tmp_path}/#{binary(platf)}", "#{@lib_dir}/#{binary(platf)}"
       end
 
       # binary in temporary folder depends on makefile and source files
       # tmp/extension_name/extension_name.{so,bundle}
-      file "#{tmp_path}/#{binary}" => ["#{tmp_path}/Makefile"] + source_files do
+      file "#{tmp_path}/#{binary(platf)}" => ["#{tmp_path}/Makefile"] + source_files do
         chdir tmp_path do
           sh make
         end
@@ -102,17 +107,30 @@ module Rake
       file "#{tmp_path}/Makefile" => [tmp_path, extconf] do |t|
         options = @config_options.dup
 
+        # include current directory
+        cmd = ['-I.']
+
+        # if fake.rb is present, add to the command line
+        if t.prerequisites.include?("#{tmp_path}/fake.rb") then
+          cmd << '-rfake'
+        end
+
+        # now add the extconf script
+        cmd << File.join(Dir.pwd, extconf)
+
         # rbconfig.rb will be present if we are cross compiling
         if t.prerequisites.include?("#{tmp_path}/rbconfig.rb") then
           options.push(*@cross_config_options)
         end
 
-        parent = Dir.pwd
+        # add options to command
+        cmd.push(*options)
+
         chdir tmp_path do
           # FIXME: Rake is broken for multiple arguments system() calls.
           # Add current directory to the search path of Ruby
           # Also, include additional parameters supplied.
-          ruby ['-I.', File.join(parent, extconf), *options].join(' ')
+          ruby cmd.join(' ')
         end
       end
 
@@ -128,7 +146,7 @@ module Rake
         task "compile:#{@name}"
       end
 
-      # Allow segmented compilation by platfrom (open door for 'cross compile')
+      # Allow segmented compilation by platform (open door for 'cross compile')
       task "compile:#{@name}:#{platf}" => ["copy:#{@name}:#{platf}"]
       task "compile:#{platf}" => ["compile:#{@name}:#{platf}"]
 
@@ -136,7 +154,7 @@ module Rake
       # platform matches the indicated one.
       if platf == RUBY_PLATFORM then
         # ensure file is always copied
-        file "#{@lib_dir}/#{binary}" => ["copy:#{name}:#{platf}"]
+        file "#{@lib_dir}/#{binary(platf)}" => ["copy:#{name}:#{platf}"]
 
         task "compile:#{@name}" => ["compile:#{@name}:#{platf}"]
         task "compile" => ["compile:#{platf}"]
@@ -150,12 +168,14 @@ module Rake
       tmp_path = "#{@tmp_dir}/#{platf}/#{@name}"
 
       # create 'native:gem_name' and chain it to 'native' task
-      spec = @gem_spec.dup
-
       unless Rake::Task.task_defined?("native:#{@gem_spec.name}:#{platf}")
         task "native:#{@gem_spec.name}:#{platf}" do |t|
+          # FIXME: truly duplicate the Gem::Specification
+          # workaround the lack of #dup for Gem::Specification
+          spec = Gem::Specification.from_yaml(gem_spec.to_yaml)
+
           # adjust to specified platform
-          spec.platform = platf
+          spec.platform = Gem::Platform.new(platf)
 
           # clear the extensions defined in the specs
           spec.extensions.clear
@@ -173,6 +193,11 @@ module Rake
           # include the files in the gem specification
           spec.files += ext_files
 
+          # Make sure that the required ruby version matches the ruby version
+          # we've used for cross compiling:
+          target_version = RUBY_VERSION =~ /^1.8/ ? '1.8.6' : '1.9.0'
+          spec.required_ruby_version = "~> #{target_version}"
+
           # Generate a package for this gem
           gem_package = Rake::GemPackageTask.new(spec) do |pkg|
             pkg.need_zip = false
@@ -185,7 +210,7 @@ module Rake
       end
 
       # add binaries to the dependency chain
-      task "native:#{@gem_spec.name}:#{platf}" => ["#{tmp_path}/#{binary}"]
+      task "native:#{@gem_spec.name}:#{platf}" => ["#{tmp_path}/#{binary(platf)}"]
 
       # Allow segmented packaging by platfrom (open door for 'cross compile')
       task "native:#{platf}" => ["native:#{@gem_spec.name}:#{platf}"]
@@ -198,9 +223,9 @@ module Rake
       end
     end
 
-    def define_cross_platform_tasks
+    def define_cross_platform_tasks(for_platform)
       config_path = File.expand_path("~/.rake-compiler/config.yml")
-      major_ver = (ENV['RUBY_CC_VERSION'] || RUBY_VERSION).match(/(\d+.\d+)/)[1]
+      ruby_ver = ENV['RUBY_CC_VERSION'] || RUBY_VERSION
 
       # warn the user about the need of configuration to use cross compilation.
       unless File.exist?(config_path)
@@ -211,60 +236,102 @@ module Rake
       config_file = YAML.load_file(config_path)
 
       # tmp_path
-      tmp_path = "#{@tmp_dir}/#{cross_platform}/#{@name}"
+      tmp_path = "#{@tmp_dir}/#{for_platform}/#{@name}"
 
-      unless rbconfig_file = config_file["rbconfig-#{major_ver}"] then
-        fail "no configuration section for this version of Ruby (rbconfig-#{major_ver})"
+      unless rbconfig_file = config_file["rbconfig-#{ruby_ver}"] then
+        warn "no configuration section for specified version of Ruby (rbconfig-#{ruby_ver})"
+        return
       end
 
       # define compilation tasks for cross platfrom!
-      define_compile_tasks(cross_platform)
+      define_compile_tasks(for_platform)
 
-      # chain rbconfig.rb to Makefile generation
-      file "#{tmp_path}/Makefile" => ["#{tmp_path}/rbconfig.rb"]
+      # chain fake.rb and rbconfig.rb to Makefile generation
+      file "#{tmp_path}/Makefile" => ["#{tmp_path}/fake.rb", "#{tmp_path}/rbconfig.rb"]
 
       # copy the file from the cross-ruby location
       file "#{tmp_path}/rbconfig.rb" => [rbconfig_file] do |t|
         cp t.prerequisites.first, t.name
       end
 
+      # genearte fake.rb for different ruby versions
+      file "#{tmp_path}/fake.rb" do |t|
+        File.open(t.name, 'w') do |f|
+          f.write fake_rb(ruby_ver)
+        end
+      end
+
       # now define native tasks for cross compiled files
-      define_native_tasks(cross_platform) if @gem_spec && @gem_spec.platform == 'ruby'
+      define_native_tasks(for_platform) if @gem_spec && @gem_spec.platform == 'ruby'
 
       # create cross task
       task 'cross' do
         # clear compile dependencies
-        Rake::Task['compile'].prerequisites.clear
+        Rake::Task['compile'].prerequisites.reject! { |t| !compiles_cross_platform.include?(t) }
 
         # chain the cross platform ones
-        task 'compile' => ["compile:#{cross_platform}"]
+        task 'compile' => ["compile:#{for_platform}"]
 
         # clear lib/binary dependencies and trigger cross platform ones
-        Rake::Task["#{@lib_dir}/#{binary}"].prerequisites.clear
-        file "#{@lib_dir}/#{binary}" => ["copy:#{@name}:#{cross_platform}"]
+        # check if lib/binary is defined (damn bundle versus so versus dll)
+        if Rake::Task.task_defined?("#{@lib_dir}/#{binary(for_platform)}") then
+          Rake::Task["#{@lib_dir}/#{binary(for_platform)}"].prerequisites.clear
+        end
+
+        # FIXME: targeting multiple platforms copies the file twice
+        file "#{@lib_dir}/#{binary(for_platform)}" => ["copy:#{@name}:#{for_platform}"]
 
         # if everything for native task is in place
         if @gem_spec && @gem_spec.platform == 'ruby' then
-          Rake::Task['native'].prerequisites.clear
-          task 'native' => ["native:#{cross_platform}"]
+          # double check: only cross platform native tasks should be here
+          # FIXME: Sooo brittle
+          Rake::Task['native'].prerequisites.reject! { |t| !natives_cross_platform.include?(t) }
+          task 'native' => ["native:#{for_platform}"]
         end
       end
     end
 
     def extconf
-      "#{@ext_dir}/#{@name}/#{@config_script}"
+      "#{@ext_dir}/#{@config_script}"
     end
 
     def make
       RUBY_PLATFORM =~ /mswin/ ? 'nmake' : 'make'
     end
 
-    def binary
-      "#{@name}.#{RbConfig::CONFIG['DLEXT']}"
+    def binary(platform = nil)
+      ext = case platform
+        when /darwin/
+          'bundle'
+        when /mingw|mswin|linux/
+          'so'
+        else
+          RbConfig::CONFIG['DLEXT']
+      end
+      "#{@name}.#{ext}"
     end
 
     def source_files
-     @source_files ||= FileList["#{@ext_dir}/#{@name}/#{@source_pattern}"]
+     @source_files ||= FileList["#{@ext_dir}/#{@source_pattern}"]
+    end
+
+    def compiles_cross_platform
+      [*@cross_platform].map { |p| "compile:#{p}" }
+    end
+
+    def natives_cross_platform
+      [*@cross_platform].map { |p| "native:#{p}" }
+    end
+
+    def fake_rb(version)
+      <<-FAKE_RB
+        class Object
+          remove_const :RUBY_PLATFORM
+          remove_const :RUBY_VERSION
+          RUBY_PLATFORM = "i386-mingw32"
+          RUBY_VERSION = "#{version}"
+        end
+FAKE_RB
     end
   end
 end

data/spec/lib/rake/extensiontask_spec.rb

@@ -4,8 +4,8 @@ require 'rake/extensiontask'
 require 'rbconfig'
 
 describe Rake::ExtensionTask do
-  describe '#new' do
-    describe '(basic)' do
+  context '#new' do
+    context '(basic)' do
       it 'should raise an error if no name is provided' do
         lambda {
           Rake::ExtensionTask.new
@@ -55,7 +55,7 @@ describe Rake::ExtensionTask do
     end
   end
 
-  describe '(defaults)' do
+  context '(defaults)' do
     before :each do
       @ext = Rake::ExtensionTask.new('extension_one')
     end
@@ -68,10 +68,6 @@ describe Rake::ExtensionTask do
       @ext.tmp_dir.should == 'tmp'
     end
 
-    it 'should look for extension inside ext/' do
-      @ext.ext_dir.should == 'ext'
-    end
-
     it 'should copy build extension into lib/' do
       @ext.lib_dir.should == 'lib'
     end
@@ -101,14 +97,14 @@ describe Rake::ExtensionTask do
     end
   end
 
-  describe '(tasks)' do
+  context '(tasks)' do
     before :each do
       Rake.application.clear
       CLEAN.clear
       CLOBBER.clear
     end
 
-    describe '(one extension)' do
+    context '(one extension)' do
       before :each do
         Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
         @ext = Rake::ExtensionTask.new('extension_one')
@@ -116,7 +112,7 @@ describe Rake::ExtensionTask do
         @platform = RUBY_PLATFORM
       end
 
-      describe 'compile' do
+      context 'compile' do
         it 'should define as task' do
           Rake::Task.task_defined?('compile').should be_true
         end
@@ -126,7 +122,7 @@ describe Rake::ExtensionTask do
         end
       end
 
-      describe 'compile:extension_one' do
+      context 'compile:extension_one' do
         it 'should define as task' do
           Rake::Task.task_defined?('compile:extension_one').should be_true
         end
@@ -136,7 +132,7 @@ describe Rake::ExtensionTask do
         end
       end
 
-      describe 'lib/extension_one.{so,bundle}' do
+      context 'lib/extension_one.{so,bundle}' do
         it 'should define as task' do
           Rake::Task.task_defined?("lib/#{@ext_bin}").should be_true
         end
@@ -146,7 +142,7 @@ describe Rake::ExtensionTask do
         end
       end
 
-      describe 'tmp/{platform}/extension_one/extension_one.{so,bundle}' do
+      context 'tmp/{platform}/extension_one/extension_one.{so,bundle}' do
         it 'should define as task' do
           Rake::Task.task_defined?("tmp/#{@platform}/extension_one/#{@ext_bin}").should be_true
         end
@@ -164,7 +160,7 @@ describe Rake::ExtensionTask do
         end
       end
 
-      describe 'tmp/{platform}/extension_one/Makefile' do
+      context 'tmp/{platform}/extension_one/Makefile' do
         it 'should define as task' do
           Rake::Task.task_defined?("tmp/#{@platform}/extension_one/Makefile").should be_true
         end
@@ -178,13 +174,13 @@ describe Rake::ExtensionTask do
         end
       end
 
-      describe 'clean' do
+      context 'clean' do
         it "should include 'tmp/{platform}/extension_one' in the pattern" do
           CLEAN.should include("tmp/#{@platform}/extension_one")
         end
       end
 
-      describe 'clobber' do
+      context 'clobber' do
         it "should include 'lib/extension_one.{so,bundle}'" do
           CLOBBER.should include("lib/#{@ext_bin}")
         end
@@ -195,7 +191,24 @@ describe Rake::ExtensionTask do
       end
     end
 
-    describe '(native tasks)' do
+    context '(extension in custom location)' do
+      before :each do
+        Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
+        @ext = Rake::ExtensionTask.new('extension_one') do |ext|
+          ext.ext_dir = 'custom/ext/foo'
+        end
+        @ext_bin = ext_bin('extension_one')
+        @platform = RUBY_PLATFORM
+      end
+
+      context 'tmp/{platform}/extension_one/Makefile' do
+        it "should depend on 'custom/ext/foo/extconf.rb'" do
+          Rake::Task["tmp/#{@platform}/extension_one/Makefile"].prerequisites.should include("custom/ext/foo/extconf.rb")
+        end
+      end
+    end
+
+    context '(native tasks)' do
       before :each do
         Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
         @spec = mock_gem_spec
@@ -203,7 +216,7 @@ describe Rake::ExtensionTask do
         @platform = RUBY_PLATFORM
       end
 
-      describe 'native' do
+      context 'native' do
         before :each do
           @spec.stub!(:platform=).and_return('ruby')
         end
@@ -230,7 +243,7 @@ describe Rake::ExtensionTask do
           Rake::Task["native"].prerequisites.should include("native:#{@platform}")
         end
 
-        describe 'native:my_gem:{platform}' do
+        context 'native:my_gem:{platform}' do
           it 'should depend on binary extension' do
             Rake::ExtensionTask.new('extension_one', @spec)
             Rake::Task["native:my_gem:#{@platform}"].prerequisites.should include("tmp/#{@platform}/extension_one/#{@ext_bin}")
@@ -239,24 +252,29 @@ describe Rake::ExtensionTask do
       end
     end
 
-    describe '(cross platform tasks)' do
+    context '(cross platform tasks)' do
       before :each do
         File.stub!(:exist?).and_return(true)
         YAML.stub!(:load_file).and_return(mock_config_yml)
         Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
         @spec = mock_gem_spec
         @config_file = File.expand_path("~/.rake-compiler/config.yml")
-        @major_ver = RUBY_VERSION.match(/(\d+.\d+)/)[1]
-        @config_path = mock_config_yml["rbconfig-#{@major_ver}"]
+        @ruby_ver = RUBY_VERSION
+        @config_path = mock_config_yml["rbconfig-#{@ruby_ver}"]
+
+        File.stub!(:open).and_yield(mock_fake_rb)
       end
 
-      it 'should not generate an error if no rake-compiler configuration exist' do
+      it 'should warn if no rake-compiler configuration exist' do
         File.should_receive(:exist?).with(@config_file).and_return(false)
-        lambda {
+
+        out, err = capture_output do
           Rake::ExtensionTask.new('extension_one') do |ext|
             ext.cross_compile = true
           end
-        }.should_not raise_error(RuntimeError)
+        end
+
+        err.should match(/rake-compiler must be configured first to enable cross-compilation/)
       end
 
       it 'should parse the config file using YAML' do
@@ -266,32 +284,34 @@ describe Rake::ExtensionTask do
         end
       end
 
-      it 'should fail if no section of config file defines running version of ruby' do
+      it 'should warn if no section of config file defines running version of ruby' do
         config = mock(Hash)
-        config.should_receive(:[]).with("rbconfig-#{@major_ver}").and_return(nil)
+        config.should_receive(:[]).with("rbconfig-#{@ruby_ver}").and_return(nil)
         YAML.stub!(:load_file).and_return(config)
-        lambda {
+        out, err = capture_output do
           Rake::ExtensionTask.new('extension_one') do |ext|
             ext.cross_compile = true
           end
-        }.should raise_error(RuntimeError, /no configuration section for this version of Ruby/)
+        end
+        err.should match(/no configuration section for specified version of Ruby/)
       end
 
       it 'should allow usage of RUBY_CC_VERSION to indicate a different version of ruby' do
         config = mock(Hash)
-        config.should_receive(:[]).with("rbconfig-2.0").and_return('/path/to/ruby/2.0/rbconfig.rb')
+        config.should_receive(:[]).with("rbconfig-1.9.1").and_return('/path/to/ruby/1.9.1/rbconfig.rb')
         YAML.stub!(:load_file).and_return(config)
-        begin
-          ENV['RUBY_CC_VERSION'] = '2.0'
-          Rake::ExtensionTask.new('extension_one') do |ext|
-            ext.cross_compile = true
-          end
-        ensure
-          ENV.delete('RUBY_CC_VERSION')
+
+        ENV['RUBY_CC_VERSION'] = '1.9.1'
+        Rake::ExtensionTask.new('extension_one') do |ext|
+          ext.cross_compile = true
         end
       end
 
-      describe "(cross for 'universal-unknown' platform)" do
+      after :each do
+        ENV.delete('RUBY_CC_VERSION')
+      end
+
+      context "(cross for 'universal-unknown' platform)" do
         before :each do
           @ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
             ext.cross_compile = true
@@ -299,7 +319,13 @@ describe Rake::ExtensionTask do
           end
         end
 
-        describe 'rbconfig' do
+        context 'fake' do
+          it 'should chain fake task to Makefile generation' do
+            Rake::Task['tmp/universal-unknown/extension_one/Makefile'].prerequisites.should include('tmp/universal-unknown/extension_one/fake.rb')
+          end
+        end
+
+        context 'rbconfig' do
           it 'should chain rbconfig tasks to Makefile generation' do
             Rake::Task['tmp/universal-unknown/extension_one/Makefile'].prerequisites.should include('tmp/universal-unknown/extension_one/rbconfig.rb')
           end
@@ -309,7 +335,7 @@ describe Rake::ExtensionTask do
           end
         end
 
-        describe 'compile:universal-unknown' do
+        context 'compile:universal-unknown' do
           it "should be defined" do
             Rake::Task.task_defined?('compile:universal-unknown').should be_true
           end
@@ -319,7 +345,7 @@ describe Rake::ExtensionTask do
           end
         end
 
-        describe 'native:universal-unknown' do
+        context 'native:universal-unknown' do
           it "should be defined" do
             Rake::Task.task_defined?('native:universal-unknown').should be_true
           end
@@ -329,6 +355,18 @@ describe Rake::ExtensionTask do
           end
         end
       end
+
+      context '(cross for multiple platforms)' do
+        it 'should define task for each supplied platform' do
+          @ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
+            ext.cross_compile = true
+            ext.cross_platform = ['universal-known', 'universal-unknown']
+          end
+
+          Rake::Task.should have_defined('compile:universal-known')
+          Rake::Task.should have_defined('compile:universal-unknown')
+        end
+      end
     end
   end
 
@@ -345,8 +383,13 @@ describe Rake::ExtensionTask do
 
   def mock_config_yml
     {
-      'rbconfig-1.8' => '/some/path/version/1.8/to/rbconfig.rb',
-      'rbconfig-1.9' => '/some/path/version/1.9/to/rbconfig.rb'
+      'rbconfig-1.8.6' => '/some/path/version/1.8/to/rbconfig.rb',
+      'rbconfig-1.9.1' => '/some/path/version/1.9.1/to/rbconfig.rb',
+      'rbconfig-3.0.0' => '/some/fake/version/3.0.0/to/rbconfig.rb'
     }
   end
+
+  def mock_fake_rb
+    mock(File, :write => 45)
+  end
 end

data/spec/spec_helper.rb

@@ -5,5 +5,11 @@ $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 require 'rubygems'
 require 'spec'
 
+# Console redirection helper
+require File.expand_path(File.join(File.dirname(__FILE__), 'support/capture_output_helper'))
+
 Spec::Runner.configure do |config|
+  config.predicate_matchers[:have_defined] = :task_defined?
+
+  include CaptureOutputHelper
 end

data/spec/support/capture_output_helper.rb

@@ -0,0 +1,22 @@
+module CaptureOutputHelper
+  def capture_output(&block)
+    old_stdout = $stdout
+    old_stderr = $stderr
+
+    stream_out = StringIO.new
+    stream_err = StringIO.new
+
+    begin
+      $stdout = stream_out
+      $stderr = stream_err
+      yield
+    ensure
+      $stdout = old_stdout
+      $stderr = old_stderr
+    end
+    stream_out.rewind
+    stream_err.rewind
+
+    [stream_out.read, stream_err.read]
+  end
+end