rake-compiler 0.3.0

data/spec/lib/rake/extensiontask_spec.rb

@@ -0,0 +1,352 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+require 'rake/extensiontask'
+require 'rbconfig'
+
+describe Rake::ExtensionTask do
+  describe '#new' do
+    describe '(basic)' do
+      it 'should raise an error if no name is provided' do
+        lambda {
+          Rake::ExtensionTask.new
+        }.should raise_error(RuntimeError, /Extension name must be provided/)
+      end
+
+      it 'should allow string as extension name assignation' do
+        ext = Rake::ExtensionTask.new('extension_one')
+        ext.name.should == 'extension_one'
+      end
+
+      it 'should allow string as extension name using block assignation' do
+        ext = Rake::ExtensionTask.new do |ext|
+          ext.name = 'extension_two'
+        end
+        ext.name.should == 'extension_two'
+      end
+
+      it 'should return itself for the block' do
+        from_block = nil
+        from_lasgn = Rake::ExtensionTask.new('extension_three') do |ext|
+          from_block = ext
+        end
+        from_block.should == from_lasgn
+      end
+
+      it 'should accept a gem specification as parameter' do
+        spec = mock_gem_spec
+        ext = Rake::ExtensionTask.new('extension_three', spec)
+        ext.gem_spec.should == spec
+      end
+
+      it 'should allow gem specification be defined using block assignation' do
+        spec = mock_gem_spec
+        ext = Rake::ExtensionTask.new('extension_four') do |ext|
+          ext.gem_spec = spec
+        end
+        ext.gem_spec.should == spec
+      end
+
+      it 'should allow forcing of platform' do
+        ext = Rake::ExtensionTask.new('weird_extension') do |ext|
+          ext.platform = 'universal-foo-bar-10.5'
+        end
+        ext.platform.should == 'universal-foo-bar-10.5'
+      end
+    end
+  end
+
+  describe '(defaults)' do
+    before :each do
+      @ext = Rake::ExtensionTask.new('extension_one')
+    end
+
+    it 'should look for extconf script' do
+      @ext.config_script.should == 'extconf.rb'
+    end
+
+    it 'should dump intermediate files to tmp/' 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
+
+    it 'should look for C files pattern (.c)' do
+      @ext.source_pattern.should == "*.c"
+    end
+
+    it 'should have no configuration options preset to delegate' do
+      @ext.config_options.should be_empty
+    end
+
+    it 'should default to current platform' do
+      @ext.platform.should == RUBY_PLATFORM
+    end
+
+    it 'should default to no cross compilation' do
+      @ext.cross_compile.should be_false
+    end
+
+    it 'should have no configuration options for cross compilation' do
+      @ext.cross_config_options.should be_empty
+    end
+
+    it "should have cross platform defined to 'i386-mingw32'" do
+      @ext.cross_platform.should == 'i386-mingw32'
+    end
+  end
+
+  describe '(tasks)' do
+    before :each do
+      Rake.application.clear
+      CLEAN.clear
+      CLOBBER.clear
+    end
+
+    describe '(one extension)' do
+      before :each do
+        Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
+        @ext = Rake::ExtensionTask.new('extension_one')
+        @ext_bin = ext_bin('extension_one')
+        @platform = RUBY_PLATFORM
+      end
+
+      describe 'compile' do
+        it 'should define as task' do
+          Rake::Task.task_defined?('compile').should be_true
+        end
+
+        it "should depend on 'compile:{platform}'" do
+          Rake::Task['compile'].prerequisites.should include("compile:#{@platform}")
+        end
+      end
+
+      describe 'compile:extension_one' do
+        it 'should define as task' do
+          Rake::Task.task_defined?('compile:extension_one').should be_true
+        end
+
+        it "should depend on 'compile:extension_one:{platform}'" do
+          Rake::Task['compile:extension_one'].prerequisites.should include("compile:extension_one:#{@platform}")
+        end
+      end
+
+      describe 'lib/extension_one.{so,bundle}' do
+        it 'should define as task' do
+          Rake::Task.task_defined?("lib/#{@ext_bin}").should be_true
+        end
+
+        it "should depend on 'copy:extension_one:{platform}'" do
+          Rake::Task["lib/#{@ext_bin}"].prerequisites.should include("copy:extension_one:#{@platform}")
+        end
+      end
+
+      describe '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
+
+        it "should depend on 'tmp/{platform}/extension_one/Makefile'" do
+          Rake::Task["tmp/#{@platform}/extension_one/#{@ext_bin}"].prerequisites.should include("tmp/#{@platform}/extension_one/Makefile")
+        end
+
+        it "should depend on 'ext/extension_one/source.c'" do
+          Rake::Task["tmp/#{@platform}/extension_one/#{@ext_bin}"].prerequisites.should include("ext/extension_one/source.c")
+        end
+
+        it "should not depend on 'ext/extension_one/source.h'" do
+          Rake::Task["tmp/#{@platform}/extension_one/#{@ext_bin}"].prerequisites.should_not include("ext/extension_one/source.h")
+        end
+      end
+
+      describe '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
+
+        it "should depend on 'tmp/{platform}/extension_one'" do
+          Rake::Task["tmp/#{@platform}/extension_one/Makefile"].prerequisites.should include("tmp/#{@platform}/extension_one")
+        end
+
+        it "should depend on 'ext/extension_one/extconf.rb'" do
+          Rake::Task["tmp/#{@platform}/extension_one/Makefile"].prerequisites.should include("ext/extension_one/extconf.rb")
+        end
+      end
+
+      describe '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
+        it "should include 'lib/extension_one.{so,bundle}'" do
+          CLOBBER.should include("lib/#{@ext_bin}")
+        end
+
+        it "should include 'tmp'" do
+          CLOBBER.should include('tmp')
+        end
+      end
+    end
+
+    describe '(native tasks)' do
+      before :each do
+        Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
+        @spec = mock_gem_spec
+        @ext_bin = ext_bin('extension_one')
+        @platform = RUBY_PLATFORM
+      end
+
+      describe 'native' do
+        before :each do
+          @spec.stub!(:platform=).and_return('ruby')
+        end
+
+        it 'should define a task for building the supplied gem' do
+          Rake::ExtensionTask.new('extension_one', @spec)
+          Rake::Task.task_defined?('native:my_gem').should be_true
+        end
+
+        it 'should define as task for pure ruby gems' do
+          Rake::Task.task_defined?('native').should be_false
+          Rake::ExtensionTask.new('extension_one', @spec)
+          Rake::Task.task_defined?('native').should be_true
+        end
+
+        it 'should not define a task for already native gems' do
+          @spec.stub!(:platform).and_return('current')
+          Rake::ExtensionTask.new('extension_one', @spec)
+          Rake::Task.task_defined?('native').should be_false
+        end
+
+        it 'should depend on platform specific native tasks' do
+          Rake::ExtensionTask.new('extension_one', @spec)
+          Rake::Task["native"].prerequisites.should include("native:#{@platform}")
+        end
+
+        describe '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}")
+          end
+        end
+      end
+    end
+
+    describe '(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}"]
+      end
+
+      it 'should not generate an error if no rake-compiler configuration exist' do
+        File.should_receive(:exist?).with(@config_file).and_return(false)
+        lambda {
+          Rake::ExtensionTask.new('extension_one') do |ext|
+            ext.cross_compile = true
+          end
+        }.should_not raise_error(RuntimeError)
+      end
+
+      it 'should parse the config file using YAML' do
+        YAML.should_receive(:load_file).with(@config_file).and_return(mock_config_yml)
+        Rake::ExtensionTask.new('extension_one') do |ext|
+          ext.cross_compile = true
+        end
+      end
+
+      it 'should fail 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)
+        YAML.stub!(:load_file).and_return(config)
+        lambda {
+          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
+
+      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')
+        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')
+        end
+      end
+
+      describe "(cross for 'universal-unknown' platform)" do
+        before :each do
+          @ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
+            ext.cross_compile = true
+            ext.cross_platform = 'universal-unknown'
+          end
+        end
+
+        describe '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
+
+          it 'should take rbconfig from rake-compiler configuration' do
+            Rake::Task['tmp/universal-unknown/extension_one/rbconfig.rb'].prerequisites.should include(@config_path)
+          end
+        end
+
+        describe 'compile:universal-unknown' do
+          it "should be defined" do
+            Rake::Task.task_defined?('compile:universal-unknown').should be_true
+          end
+
+          it "should depend on 'compile:extension_one:universal-unknown'" do
+            Rake::Task['compile:universal-unknown'].prerequisites.should include('compile:extension_one:universal-unknown')
+          end
+        end
+
+        describe 'native:universal-unknown' do
+          it "should be defined" do
+            Rake::Task.task_defined?('native:universal-unknown').should be_true
+          end
+
+          it "should depend on 'native:my_gem:universal-unknown'" do
+            Rake::Task['native:universal-unknown'].prerequisites.should include('native:my_gem:universal-unknown')
+          end
+        end
+      end
+    end
+  end
+
+  private
+  def ext_bin(extension_name)
+    "#{extension_name}.#{RbConfig::CONFIG['DLEXT']}"
+  end
+
+  def mock_gem_spec(stubs = {})
+    mock(Gem::Specification, 
+      { :name => 'my_gem', :platform => 'ruby' }.merge(stubs)
+    )
+  end
+
+  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'
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# add lib directory to the search path
+libdir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'rubygems'
+require 'spec'
+
+Spec::Runner.configure do |config|
+end

data/tasks/bin/cross-ruby.rake

@@ -0,0 +1,159 @@
+#--
+# Cross-compile ruby, using Rake
+#
+# This source code is released under the MIT License.
+# See LICENSE file for details
+#++
+
+#
+# This code is inspired and based on notes from the following sites:
+#
+# http://tenderlovemaking.com/2008/11/21/cross-compiling-ruby-gems-for-win32/
+# http://github.com/jbarnette/johnson/tree/master/cross-compile.txt
+# http://eigenclass.org/hiki/cross+compiling+rcovrt
+#
+# This recipe only cleanup the dependency chain and automate it.
+# Also opens the door to usage different ruby versions 
+# for cross-compilation.
+#
+
+require 'rake'
+require 'rake/clean'
+require 'yaml'
+
+USER_HOME = File.expand_path("~/.rake-compiler")
+RUBY_CC_VERSION = "ruby-#{ENV['VERSION'] || '1.8.6-p287'}"
+
+# grab the major "1.8" or "1.9" part of the version number
+MAJOR = RUBY_CC_VERSION.match(/.*-(\d.\d).\d/)[1]
+
+# define a location where sources will be stored
+directory "#{USER_HOME}/sources/#{RUBY_CC_VERSION}"
+directory "#{USER_HOME}/builds/#{RUBY_CC_VERSION}"
+
+# clean intermediate files and folders
+CLEAN.include("#{USER_HOME}/sources/#{RUBY_CC_VERSION}")
+CLEAN.include("#{USER_HOME}/builds/#{RUBY_CC_VERSION}")
+
+# remove the final products and sources
+CLOBBER.include("#{USER_HOME}/sources")
+CLOBBER.include("#{USER_HOME}/builds")
+CLOBBER.include("#{USER_HOME}/ruby/#{RUBY_CC_VERSION}")
+CLOBBER.include("#{USER_HOME}/config.yml")
+
+# ruby source file should be stored there
+file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}.tar.gz" => ["#{USER_HOME}/sources"] do |t|
+  # download the source file using wget or curl
+  chdir File.dirname(t.name) do
+    url = "ftp://ftp.ruby-lang.org/pub/ruby/#{MAJOR}/#{File.basename(t.name)}"
+    sh "wget #{url} || curl -O #{url}"
+  end
+end
+
+# Extract the sources
+file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}" => ["#{USER_HOME}/sources/#{RUBY_CC_VERSION}.tar.gz"] do |t|
+  chdir File.dirname(t.name) do
+    t.prerequisites.each { |f| sh "tar xfz #{File.basename(f)}" }
+  end
+end
+
+# backup makefile.in
+file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in.bak" => ["#{USER_HOME}/sources/#{RUBY_CC_VERSION}"] do |t|
+  cp "#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in", t.name
+end
+
+# correct the makefiles
+file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in" => ["#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in.bak"] do |t|
+  content = File.open(t.name, 'rb') { |f| f.read }
+
+  out = ""
+
+  content.each_line do |line|
+    if line =~ /^\s*ALT_SEPARATOR =/
+      out << "\t\t    ALT_SEPARATOR = \"\\\\\\\\\"; \\\n"
+    else
+      out << line
+    end
+  end
+
+  when_writing("Patching Makefile.in") {
+    File.open(t.name, 'wb') { |f| f.write(out) }
+  }
+end
+
+task :mingw32 do
+  unless File.exist?('/usr/bin/i586-mingw32msvc-gcc') then
+    warn "You need to install mingw32 cross compile functionality to be able to continue."
+    warn "Please refer to your distro documentation about installation."
+    fail
+  end
+end
+
+task :environment do
+  ENV['ac_cv_func_getpgrp_void'] =  'no'
+  ENV['ac_cv_func_setpgrp_void'] = 'yes'
+  ENV['rb_cv_negative_time_t'] = 'no'
+  ENV['ac_cv_func_memcmp_working'] = 'yes'
+  ENV['rb_cv_binary_elf' ] = 'no'
+end
+
+# generate the makefile in a clean build location
+file "#{USER_HOME}/builds/#{RUBY_CC_VERSION}/Makefile" => ["#{USER_HOME}/builds/#{RUBY_CC_VERSION}",
+                                  "#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in"] do |t|
+
+  # set the configure options
+  options = [
+    '--host=i586-mingw32msvc',
+    '--target=i386-mingw32',
+    '--build=i686-linux',
+    '--enable-shared'
+  ]
+
+  chdir File.dirname(t.name) do
+    prefix = File.expand_path("../../ruby/#{RUBY_CC_VERSION}")
+    options << "--prefix=#{prefix}"
+    sh File.expand_path("../../sources/#{RUBY_CC_VERSION}/configure"), *options
+  end
+end
+
+# make
+file "#{USER_HOME}/builds/#{RUBY_CC_VERSION}/ruby.exe" => ["#{USER_HOME}/builds/#{RUBY_CC_VERSION}/Makefile"] do |t|
+  chdir File.dirname(t.prerequisites.first) do
+    sh "make"
+  end
+end
+
+# make install
+file "#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/bin/ruby.exe" => ["#{USER_HOME}/builds/#{RUBY_CC_VERSION}/ruby.exe"] do |t|
+  chdir File.dirname(t.prerequisites.first) do
+    sh "make install"
+  end
+end
+
+# rbconfig.rb location
+file "#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/lib/ruby/#{MAJOR}/i386-mingw32/rbconfig.rb" => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/bin/ruby.exe"]
+
+file :update_config => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/lib/ruby/#{MAJOR}/i386-mingw32/rbconfig.rb"] do |t|
+  config_file = "#{USER_HOME}/config.yml"
+  if File.exist?(config_file) then
+    puts "Updating #{t.name}"
+    config = YAML.load_file(config_file)
+  else
+    puts "Generating #{t.name}"
+    config = {}
+  end
+
+  config["rbconfig-#{MAJOR}"] = File.expand_path(t.prerequisites.first)
+
+  when_writing("Saving changes into #{config_file}") {
+    File.open(config_file, 'w') do |f|
+      f.puts config.to_yaml
+    end
+  }
+end
+
+task :default do
+end
+
+desc "Build #{RUBY_CC_VERSION} suitable for cross-platform development."
+task 'cross-ruby' => [:mingw32, :environment, :update_config]

data/tasks/common.rake

@@ -0,0 +1,13 @@
+require 'rake/clean'
+
+# common pattern cleanup
+CLEAN.include('tmp')
+
+# set default task
+task :default => [:spec, :features]
+
+# make packing depend on success of running specs and features
+task :package => [:spec, :features]
+
+# make the release re-generate the gemspec if required
+task :release => [:gemspec]

data/tasks/cucumber.rake

@@ -0,0 +1,14 @@
+begin
+  gem 'cucumber', '~> 0.1.8'
+  require 'cucumber/rake/task'
+rescue Exception
+  nil
+end
+
+if defined?(Cucumber)
+  Cucumber::Rake::Task.new do |t|
+    t.cucumber_opts = "--format pretty --no-source"
+  end
+else
+  warn "Cucumber gem is required, please install it. (gem install cucumber)"
+end

data/tasks/gem.rake

@@ -0,0 +1,59 @@
+require 'rake/gempackagetask'
+
+GEM_SPEC = Gem::Specification.new do |s|
+  # basic information
+  s.name        = "rake-compiler"
+  s.version     = "0.3.0"
+  s.platform    = Gem::Platform::RUBY
+
+  # description and details
+  s.summary     = 'Rake-based Ruby C Extension task generator.'
+  s.description = <<-EOF
+    Provide a standard and simplified way to build and package
+    Ruby C extensions using Rake as glue.
+  EOF
+
+  # dependencies
+  s.add_dependency  'rake', '>= 0.8.3', '< 0.9'
+
+  # development dependencies
+  #s.add_development_dependency 'rspec', '~> 1.1.9'
+  #s.add_development_dependency 'rcov', '~> 0.8.1'
+  #s.add_development_dependency 'cucumber', '~> 0.1.8'
+
+  # components, files and paths
+  s.files = FileList["features/**/*.{feature,rb}", "bin/rake-compiler",
+                      "lib/**/*.rb", "spec/**/*.rb", "tasks/**/*.rake",
+                      "Rakefile", "*.{rdoc,txt,yml}"]
+
+  s.executables = ['rake-compiler']
+
+  s.require_path = 'lib'
+
+  # documentation
+  s.has_rdoc = true
+  s.rdoc_options << '--main'  << 'README.rdoc' << '--title' << 'rake-compiler -- Documentation'
+
+  s.extra_rdoc_files = %w(README.rdoc LICENSE.txt History.txt)
+
+  # project information
+  s.homepage          = 'http://github.com/luislavena/rake-compiler'
+  s.rubyforge_project = 'rake-compiler'
+
+  # author and contributors
+  s.author      = 'Luis Lavena'
+  s.email       = 'luislavena@gmail.com'
+end
+
+gem_package = Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_tar = false
+  pkg.need_zip = false
+end
+
+file 'rake-compiler.gemspec' => ['Rakefile', 'tasks/gem.rake'] do |t|
+  puts "Generating #{t.name}"
+  File.open(t.name, 'w') { |f| f.puts GEM_SPEC.to_yaml }
+end
+
+desc "Generate or update the standalone gemspec file for the project"
+task :gemspec => ['rake-compiler.gemspec']

data/tasks/rdoc.rake

@@ -0,0 +1,9 @@
+require 'rake/rdoctask'
+
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.title    = 'rake-compiler -- Documentation'
+  rd.main     = 'README.rdoc'
+  rd.rdoc_dir = 'doc/api'
+  rd.options << '--main'  << 'README.rdoc' << '--title' << 'rake-compiler -- Documentation'
+  rd.rdoc_files.include %w(README.rdoc LICENSE.txt History.txt lib/**/*.rb)
+end