luislavena-rake-compiler 0.1.1

data/features/step_definitions/gem.rb

@@ -0,0 +1,25 @@
+Given /^a gem named '(.*)'$/ do |gem_name|
+  generate_gem_task gem_name
+end
+
+Then /^ruby gem for '(.*)' version '(.*)' do exist in '(.*)'$/ do |name, version, folder|
+  File.exist?(gem_file(folder, name, version)).should be_true
+end
+
+Then /^binary gem for '(.*)' version '(.*)' do exist in '(.*)'$/ do |name, version, folder|
+  File.exist?(gem_file_platform(folder, name, version)).should be_true
+end
+
+Then /^a gem for '(.*)' version '(.*)' platform '(.*)' do exist in '(.*)'$/ do |name, version, platform, folder|
+  File.exist?(gem_file_platform(folder, name, version, platform)).should be_true
+end
+
+def gem_file(folder, name, version)
+  "#{folder}/#{name}-#{version}.gem"
+end
+
+def gem_file_platform(folder, name, version, platform = nil)
+  file = "#{folder}/#{name}-#{version}"
+  file << "-" << (platform || Gem::Platform.local.to_s)
+  file << ".gem"
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'cucumber'
+require 'spec'
+require 'fileutils'
+require 'rbconfig'
+
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), '../..'))

data/features/support/file_templates.rb

@@ -0,0 +1,75 @@
+def template_rakefile
+<<-EOF
+# add rake-compiler lib dir to the LOAD_PATH
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '../..', 'lib'))
+
+require 'rubygems'
+require 'rake'
+
+# load rakefile extensions (tasks)
+Dir['tasks/*.rake'].each { |f| import f }
+EOF
+end
+
+def template_rake_gemspec(gem_name)
+<<-EOF
+require 'rake/gempackagetask'
+SPEC = Gem::Specification.new do |s|
+  s.name = "#{gem_name}"
+  s.version = "0.1.0"
+  s.summary = "#{gem_name} test gem for rake-compiler"
+
+  s.has_rdoc = true
+
+  s.homepage = 'http://github.com/luislavena/rake-compiler'
+  s.rubyforge_project = 'TODO'
+
+  s.authors = ["Luis Lavena"]
+  s.email = ["luislavena@gmail.com"]
+end
+
+gem_package = Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
+EOF
+end
+
+def template_rake_extension(extension_name, gem_spec = nil)
+<<-EOF
+require 'rake/extensiontask'
+Rake::ExtensionTask.new("#{extension_name}"#{', SPEC' if gem_spec})
+EOF
+end
+
+def template_rake_extension_with_platform(extension_name, platform)
+<<-EOF
+require 'rake/extensiontask'
+Rake::ExtensionTask.new("#{extension_name}", SPEC) do |ext|
+  ext.platform = "#{platform}"
+end
+EOF
+end
+
+def template_extconf(extension_name)
+<<-EOF
+require 'mkmf'
+create_makefile("#{extension_name}")
+EOF
+end
+
+def template_source_c(extension_name)
+<<-EOF
+#include "source.h"
+void Init_#{extension_name}()
+{
+  printf("source.c of extension #{extension_name}\\n");
+}
+EOF
+end
+
+def template_source_h
+<<-EOF
+#include "ruby.h"
+EOF
+end

data/features/support/generators.rb

@@ -0,0 +1,58 @@
+def generate_scaffold_structure
+  # create folder structure
+  FileUtils.mkdir_p "lib"
+  FileUtils.mkdir_p "tasks"
+  FileUtils.mkdir_p "tmp"
+
+  # create Rakefile loader
+  File.open("Rakefile", 'w') do |rakefile|
+    rakefile.puts template_rakefile.strip
+  end
+end
+
+def generate_gem_task(gem_name)
+  # create generic gem task
+  File.open("tasks/gem.rake", 'w') do |gem_rake|
+    gem_rake.puts template_rake_gemspec(gem_name)
+  end
+end
+
+def generate_extension_task_for(extension_name, platform = nil)
+  # create folder structure
+  FileUtils.mkdir_p "ext/#{extension_name}"
+
+  return if File.exist?("tasks/#{extension_name}.rake")
+
+  # Building a gem?
+  if File.exist?("tasks/gem.rake") then
+    File.open("tasks/gem.rake", 'a+') do |ext_in_gem|
+      if platform
+        ext_in_gem.puts template_rake_extension_with_platform(extension_name, platform)
+      else
+        ext_in_gem.puts template_rake_extension(extension_name, true)
+      end
+    end
+  else
+    # create specific extension rakefile
+    File.open("tasks/#{extension_name}.rake", 'w') do |ext_rake|
+      ext_rake.puts template_rake_extension(extension_name)
+    end
+  end
+end
+
+def generate_source_code_for(extension_name)
+  # source C file
+  File.open("ext/#{extension_name}/source.c", 'w') do |c|
+    c.puts template_source_c(extension_name)
+  end
+
+  # header H file
+  File.open("ext/#{extension_name}/source.h", 'w') do |h|
+    h.puts template_source_h
+  end
+
+  # extconf.rb file
+  File.open("ext/#{extension_name}/extconf.rb", 'w') do |ext|
+    ext.puts template_extconf(extension_name)
+  end
+end

data/lib/rake/extensiontask.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+
+# Define a series of tasks to aid in the compilation of C extensions for
+# gem developer/creators.
+
+require 'rake'
+require 'rake/clean'
+require 'rake/tasklib'
+require 'rbconfig'
+
+module Rake
+  class ExtensionTask < TaskLib
+    attr_accessor :name
+    attr_accessor :gem_spec
+    attr_accessor :config_script
+    attr_accessor :tmp_dir
+    attr_accessor :ext_dir
+    attr_accessor :lib_dir
+    attr_accessor :platform
+    attr_accessor :additional_options
+    attr_accessor :source_pattern
+
+    def initialize(name = nil, gem_spec = nil)
+      init(name, gem_spec)
+      yield self if block_given?
+      define
+    end
+
+    def init(name = nil, gem_spec = nil)
+      @name = name
+      @gem_spec = gem_spec
+      @config_script = 'extconf.rb'
+      @tmp_dir = 'tmp'
+      @ext_dir = 'ext'
+      @lib_dir = 'lib'
+      @source_pattern = "*.c"
+      @additional_options = []
+    end
+
+    def platform
+      @platform ||= RUBY_PLATFORM
+    end
+
+    def define
+      fail "Extension name must be provided." if @name.nil?
+
+      define_compile_tasks
+      define_native_tasks if @gem_spec
+    end
+
+    private
+    def define_compile_tasks
+      # directories we need
+      directory tmp_path
+      directory @lib_dir
+
+      # platform specific temp folder should be on the cleaning
+      CLEAN.include(tmp_path)
+
+      # makefile depends of tmp_dir and config_script
+      # tmp/extension_name/Makefile
+      file makefile => [tmp_path, extconf] do
+        parent = Dir.pwd
+        Dir.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), *@additional_options].join(' ')
+        end
+      end
+
+      # binary in temporary folder depends on makefile and source files
+      # tmp/extension_name/extension_name.{so,bundle}
+      file tmp_binary => [makefile] + source_files do
+        Dir.chdir tmp_path do
+          sh make
+        end
+      end
+
+      # copy binary from temporary location to final lib
+      # tmp/extension_name/extension_name.{so,bundle} => lib/
+      file lib_binary => [lib_path, tmp_binary] do
+        cp tmp_binary, lib_binary
+      end
+
+      # clobbering should remove the binaries from lib_path
+      CLOBBER.include(lib_binary)
+
+      # we should also clobber the tmp folder
+      CLOBBER.include(@tmp_dir)
+
+      desc "Compile just the #{@name} extension"
+      task "compile:#{@name}" => [lib_binary]
+
+      desc "Compile the extension(s)" unless Rake::Task.task_defined?('compile')
+      task "compile" => ["compile:#{@name}"]
+    end
+
+    def define_native_tasks
+      # only gems with 'ruby' platforms are allowed to define native tasks
+      return unless @gem_spec.platform == 'ruby'
+
+      require 'rake/gempackagetask' unless defined?(Rake::GemPackageTask)
+
+      # create 'native:gem_name' and chain it to 'native' task
+      native_task_for(@gem_spec)
+
+      # hook the binary to the prerequisites for this task
+      task native_task_gem => [lib_binary]
+    end
+
+    def makefile
+      "#{tmp_path}/Makefile"
+    end
+
+    def extconf
+      "#{ext_path}/#{@config_script}"
+    end
+
+    def tmp_path
+      File.join(@tmp_dir, platform, @name)
+    end
+
+    def ext_path
+      File.join(@ext_dir, @name)
+    end
+
+    def lib_path
+      @lib_dir
+    end
+
+    def make
+      RUBY_PLATFORM =~ /mswin/ ? 'nmake' : 'make'
+    end
+
+    def binary
+      "#{@name}.#{RbConfig::CONFIG['DLEXT']}"
+    end
+
+    def source_files
+     @source_files ||= FileList["#{ext_path}/#{@source_pattern}"]
+    end
+
+    def tmp_binary
+      "#{tmp_path}/#{binary}"
+    end
+
+    def lib_binary
+      "#{lib_path}/#{binary}"
+    end
+
+    def native_task_gem
+      "native:#{@gem_spec.name}"
+    end
+
+    def native_task_for(gem_spec)
+      return if Rake::Task.task_defined?(native_task_gem)
+
+      spec = gem_spec.dup
+
+      task native_task_gem do |t|
+        # adjust to current platform
+        spec.platform = (@platform || Gem::Platform::CURRENT)
+
+        # clear the extensions defined in the specs
+        spec.extensions.clear
+
+        # add the binary dependencies of this task
+        spec.files += t.prerequisites
+
+        # Generate a package for this gem
+        gem_package = Rake::GemPackageTask.new(spec) do |pkg|
+          pkg.need_zip = false
+          pkg.need_tar = false
+        end
+      end
+
+      # add this native task to the list
+      task "native" => [native_task_gem]
+    end
+  end
+end

data/spec/lib/rake/extensiontask_spec.rb

@@ -0,0 +1,245 @@
+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 additional options preset to delegate' do
+      @ext.additional_options.should be_empty
+    end
+
+    it 'should default to current platform' do
+      @ext.platform.should == RUBY_PLATFORM
+    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:extension_one'" do
+          Rake::Task['compile'].prerequisites.should include('compile:extension_one')
+        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 'lib/extension_one.{so,bundle}'" do
+          Rake::Task['compile:extension_one'].prerequisites.should include("lib/#{@ext_bin}")
+        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 'lib'" do
+          Rake::Task["lib/#{@ext_bin}"].prerequisites.should include("lib")
+        end
+
+        it "should depend on 'tmp/extension_one.{so,bundle}'" do
+          Rake::Task["lib/#{@ext_bin}"].prerequisites.should include("tmp/#{@platform}/extension_one/#{@ext_bin}")
+        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')
+      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 gem specific native tasks' do
+          Rake::ExtensionTask.new('extension_one', @spec)
+          Rake::Task["native"].prerequisites.should include("native:my_gem")
+        end
+
+        describe 'native:my_gem' do
+          it 'should depend on binary extension' do
+            Rake::ExtensionTask.new('extension_one', @spec)
+            Rake::Task["native:my_gem"].prerequisites.should include("lib/#{@ext_bin}")
+          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
+
+end