rake-compiler 0.3.1 → 0.4.0

data/History.txt

@@ -1,45 +1,70 @@
-=== 0.3.1 / 2009-01-09
+== 0.4.0  2009-04-03
 
-* 2 Minor Enhancements:
+=== Enhancements
+
+  * Bended the convention for extension folder.
+    Defining <tt>ext_dir</tt> for custom extension location.
+
+    Rake::ExtensionTask.new('my_extension') do |ext|
+      ext.ext_dir = 'custom/location'         # look into custom/location
+    end                                       # instead of ext/my_extension
+
+  * Better detection of mingw target across Linux/OSX.
+    Exposed it as Rake::ExtensionCompiler
+
+  * Display list of available tasks when calling rake-compiler script
+
+  * Track Ruby full versioning (x.y.z).
+    This will help the compilation of extensions targetting 1.8.6/7 and 1.9.1
+
+=== Bugfixes
+
+  * Better output of Rake development tasks (Thanks to Luis Parravicini).
+  * Proper usage of Gem::Platform for native gems (Thanks to Dirkjan Bussink).
+  * Don't use autoload for YAML (present problems with Ruby 1.9.1).
+
+== 0.3.1 / 2009-01-09
+
+=== Enhancements
 
   * Download cross-ruby source code using HTTP instead of FTP.
   * Disabled Tcl/Tk extension building on cross-ruby (helps with 1.9).
 
-* 3 Bug fixes:
+=== Bugfixes
 
   * Workaround bug introduced by lack of Gem::Specification cloning. Fixes DM LH #757.
   * Use proper binary extension on OSX (reported by Dirkjan Bussink).
   * Ensure lib/binary task is defined prior clear of requisites.
 
-=== 0.3.0 / 2008-12-07
+== 0.3.0 / 2008-12-07
 
-* 1 Major Enhancement:
+=== New features
 
   * Let you specify the Ruby version used for cross compilation instead 
     of default one.
 
       rake cross compile RUBY_CC_VERSION=1.8
 
-* 2 Minor Enhancements:
+=== Enhancements
 
   * Properly update rake-compiler configuration when new version is installed.
   * Automated release process to RubyForge, yay!
 
-* 1 Bug fix:
+=== Bugfixes
 
   * Corrected documentation to reflect the available options
 
-=== 0.2.1 / 2008-11-30
+== 0.2.1 / 2008-11-30
 
-* 2 Major Enhancements:
+=== New features
 
   * Allow cross compilation (cross compile) using mingw32 on Linux or OSX.
   * Allow packaging of gems for Windows on Linux or OSX.
 
-* 1 Minor Enhancement:
+=== Enhancements
 
   * Made generation of extensions safe and target folders per-platform
 
-* 1 Bug Fix:
+=== Bugfixes
 
   * Ensure binaries for the specific platform are copied before packaging.

data/lib/rake/extensioncompiler.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+#
+# HACK: Lousy API design, sue me. At least works ;-)
+#
+# Define a series of helpers to aid in search and usage of MinGW (GCC) Compiler
+# by gem developer/creators.
+#
+
+module Rake
+  module ExtensionCompiler
+    # return the host portion from the installed MinGW
+    def self.mingw_host
+      return @mingw_host if @mingw_host
+
+      # the mingw_gcc_executable is helpful here
+      if target = mingw_gcc_executable then
+        # we only care for the filename
+        target = File.basename(target)
+
+        # now strip the extension (if present)
+        target.sub!(File.extname(target), '')
+
+        # get rid of '-gcc' portion too ;-)
+        target.sub!('-gcc', '')
+      end
+
+      raise "No MinGW tools or unknown setup platform?" unless target
+
+      @mingw_host = target
+    end
+
+    # return the first compiler found that includes both mingw and gcc conditions
+    # (this assumes you have one installed)
+    def self.mingw_gcc_executable
+      return @mingw_gcc_executable if @mingw_gcc_executable
+
+      # grab the paths defined in the environment
+      paths = ENV['PATH'].split(File::PATH_SEPARATOR)
+
+      # the pattern to look into (captures *nix and windows executables)
+      pattern = "*mingw*gcc{,.*}"
+
+      @mingw_gcc_executable = paths.find do |path|
+        # cleanup paths before globbing
+        gcc = Dir.glob("#{File.expand_path(path)}/#{pattern}").first
+        break gcc if gcc
+      end
+
+      @mingw_gcc_executable
+    end
+  end
+end

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 = []
@@ -102,17 +102,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 +141,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}"]
 
@@ -157,7 +170,7 @@ module Rake
           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
@@ -202,7 +215,7 @@ module Rake
 
     def define_cross_platform_tasks
       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)
@@ -215,21 +228,28 @@ module Rake
       # tmp_path
       tmp_path = "#{@tmp_dir}/#{cross_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
+        fail "no configuration section for specified version of Ruby (rbconfig-#{ruby_ver})"
       end
 
       # define compilation tasks for cross platfrom!
       define_compile_tasks(cross_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'
 
@@ -257,7 +277,7 @@ module Rake
     end
 
     def extconf
-      "#{@ext_dir}/#{@name}/#{@config_script}"
+      "#{@ext_dir}/#{@config_script}"
     end
 
     def make
@@ -277,7 +297,18 @@ module Rake
     end
 
     def source_files
-     @source_files ||= FileList["#{@ext_dir}/#{@name}/#{@source_pattern}"]
+     @source_files ||= FileList["#{@ext_dir}/#{@source_pattern}"]
+    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

@@ -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
@@ -195,6 +191,23 @@ describe Rake::ExtensionTask do
       end
     end
 
+    describe '(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
+
+      describe '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
+
     describe '(native tasks)' do
       before :each do
         Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"])
@@ -246,8 +259,10 @@ describe Rake::ExtensionTask do
         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
@@ -268,29 +283,30 @@ describe Rake::ExtensionTask do
 
       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)
+        config.should_receive(:[]).with("rbconfig-#{@ruby_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/)
+        }.should raise_error(RuntimeError, /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
 
+      after :each do
+        ENV.delete('RUBY_CC_VERSION')
+      end
+
       describe "(cross for 'universal-unknown' platform)" do
         before :each do
           @ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
@@ -299,6 +315,12 @@ describe Rake::ExtensionTask do
           end
         end
 
+        describe '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
+
         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')
@@ -345,8 +367,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/tasks/bin/cross-ruby.rake

@@ -21,23 +21,21 @@ require 'rake'
 require 'rake/clean'
 require 'yaml'
 
+# load compiler helpers
+# 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 'rake/extensioncompiler'
+
 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]
 
-# Sorry!
-# On some systems (linux) you get i586 targets, on others i386 targets, at 
-# present, I only know to search for them.
-compilers = %w(i586-mingw32msvc-gcc i386-mingw32-gcc)
-paths = ENV['PATH'].split(File::PATH_SEPARATOR)
-compiler = compilers.find do |comp|
-  paths.find do |path|
-    File.exist? File.join(path, comp)
-  end
-end
-MINGW_HOST = compiler[0..-5]
+# Use Rake::ExtensionCompiler helpers to find the proper host
+MINGW_HOST = Rake::ExtensionCompiler.mingw_host
 
 # define a location where sources will be stored
 directory "#{USER_HOME}/sources/#{RUBY_CC_VERSION}"
@@ -96,7 +94,7 @@ end
 task :mingw32 do
   unless MINGW_HOST then
     warn "You need to install mingw32 cross compile functionality to be able to continue."
-    warn "Please refer to your distro documentation about installation."
+    warn "Please refer to your distribution/package manager documentation about installation."
     fail
   end
 end
@@ -113,10 +111,9 @@ end
 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=#{MINGW_HOST}",
     '--target=i386-mingw32',
+    "--host=#{MINGW_HOST}",
     '--build=i686-linux',
     '--enable-shared',
     '--disable-install-doc',
@@ -144,21 +141,26 @@ file "#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/bin/ruby.exe" => ["#{USER_HOME}/build
     sh "make install"
   end
 end
+task :install => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/bin/ruby.exe"]
 
-# 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|
+desc "Update rake-compiler list of installed Ruby versions"
+task 'update-config' do
   config_file = "#{USER_HOME}/config.yml"
   if File.exist?(config_file) then
-    puts "Updating #{t.name}"
+    puts "Updating #{config_file}"
     config = YAML.load_file(config_file)
   else
-    puts "Generating #{t.name}"
+    puts "Generating #{config_file}"
     config = {}
   end
 
-  config["rbconfig-#{MAJOR}"] = File.expand_path(t.prerequisites.first)
+  files = Dir.glob("#{USER_HOME}/ruby/**/rbconfig.rb").sort
+
+  files.each do |rbconfig|
+    version = rbconfig.match(/.*-(\d.\d.\d)/)[1]
+    config["rbconfig-#{version}"] = rbconfig
+    puts "Found Ruby version #{version} (#{rbconfig})"
+  end
 
   when_writing("Saving changes into #{config_file}") {
     File.open(config_file, 'w') do |f|
@@ -168,7 +170,10 @@ file :update_config => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/lib/ruby/#{MAJOR}/
 end
 
 task :default do
+  # Force the display of the available tasks when no option is given
+  Rake.application.options.show_task_pattern = //
+  Rake.application.display_tasks_and_comments
 end
 
 desc "Build #{RUBY_CC_VERSION} suitable for cross-platform development."
-task 'cross-ruby' => [:mingw32, :environment, :update_config]
+task 'cross-ruby' => [:mingw32, :environment, :install, 'update-config']

data/tasks/cucumber.rake

@@ -1,5 +1,5 @@
 begin
-  gem 'cucumber', '~> 0.1.8'
+  gem 'cucumber'
   require 'cucumber/rake/task'
 rescue Exception
   nil
@@ -12,3 +12,4 @@ if defined?(Cucumber)
 else
   warn "Cucumber gem is required, please install it. (gem install cucumber)"
 end
+

data/tasks/gem.rake

@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
 GEM_SPEC = Gem::Specification.new do |s|
   # basic information
   s.name        = "rake-compiler"
-  s.version     = "0.3.1"
+  s.version     = "0.4.0"
   s.platform    = Gem::Platform::RUBY
 
   # description and details

data/tasks/rspec.rake

@@ -1,10 +1,14 @@
 begin
-  gem 'rspec', '~> 1.1.9'
-  gem 'rcov', '~> 0.8.1'
   require 'spec/rake/spectask'
-  require 'rcov'
-rescue Exception
-  nil
+
+  begin
+    require 'rcov'
+  rescue LoadError
+    warn "RCov gem is required, please install it (gem install rcov)."
+  end
+
+rescue LoadError
+  warn "RSpec gem is required, please install it (gem install rspec)."
 end
 
 if defined?(Spec)
@@ -25,9 +29,6 @@ if defined?(Spec)
         t.rcov_opts   = ["--exclude", "spec/*,features/*,gems/*"]
       end
     end
-  else
-    warn "RCov gem is required, please install it (gem install rcov)."
   end
-else
-  warn "RSpec gem is required, please install it (gem install rspec)."
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rake-compiler
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Luis Lavena
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 -02:00
+date: 2009-04-04 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,7 @@ files:
 - features/support/file_templates.rb
 - features/support/generators.rb
 - bin/rake-compiler
+- lib/rake/extensioncompiler.rb
 - lib/rake/extensiontask.rb
 - spec/lib/rake/extensiontask_spec.rb
 - spec/spec_helper.rb
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rake-compiler
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Rake-based Ruby C Extension task generator.