blackwinter-rake-compiler 0.9.2

data/Rakefile

@@ -0,0 +1,15 @@
+#--
+# Copyright (c) 2008 Luis Lavena
+#
+# This source code is released under the MIT License.
+# See LICENSE file for details
+#++
+
+#
+# NOTE: Keep this file clean.
+# Add your customizations inside tasks directory.
+# Thank You.
+#
+
+# load rakefile extensions (tasks)
+Dir['tasks/*.rake'].sort.each { |f| load f }

data/bin/rake-compiler

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+#--
+# Copyright (c) 2008 Luis Lavena
+#
+# This source code is released under the MIT License.
+# See LICENSE file for details
+#++
+
+begin
+  require 'rake'
+rescue LoadError
+  require 'rubygems'
+  require 'rake'
+end
+
+# Initialize 'rake-compiler' application
+Rake.application.init('rake-compiler')
+
+# Load the already cooked tasks ;-)
+load File.join(File.dirname(__FILE__), %w{.. tasks bin cross-ruby.rake})
+
+# delegate control to Rake
+Rake.application.top_level

data/cucumber.yml

@@ -0,0 +1,4 @@
+default:  --tags ~@java --format progress features
+java:     --tags @java  --format progress features
+all:      --format progress features
+autotest: --format progress features

data/features/compile.feature

@@ -0,0 +1,79 @@
+Feature: Compile C code into Ruby extensions.
+
+  In order to automate compilation process.
+  As a Gem developer.
+  I want rake tasks compile source code for me.
+
+  Scenario: compile single extension
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And 'tmp' folder is deleted
+    When rake task 'compile' is invoked
+    Then rake task 'compile' succeeded
+    And binary extension 'extension_one' do exist in 'lib'
+    And 'tmp' folder is created
+
+  Scenario: compile an extension with extra options
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And 'tmp' folder is deleted
+    When rake task 'compile -- --with-opt-dir=/opt/local' is invoked
+    Then rake task 'compile -- --with-opt-dir=/opt/local' succeeded
+    And output of rake task 'compile -- --with-opt-dir=/opt/local' contains /with-opt-dir/
+
+  Scenario: not recompile unmodified extension
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    And not changed any file since
+    When rake task 'compile' is invoked
+    Then rake task 'compile' succeeded
+    And output of rake task 'compile' do not contain /gcc|cl/
+
+  Scenario: recompile extension when source is modified
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    When touching 'source.c' file of extension 'extension_one'
+    And rake task 'compile' is invoked
+    Then rake task 'compile' succeeded
+    And output of rake task 'compile' contains /extension_one/
+
+  Scenario: compile multiple extensions
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And a extension named 'extension_two'
+    And 'tmp' folder is deleted
+    When rake task 'compile' is invoked
+    Then rake task 'compile' succeeded
+    And binary extension 'extension_one' do exist in 'lib'
+    And binary extension 'extension_two' do exist in 'lib'
+    And 'tmp' folder is created
+
+  Scenario: compile one extension instead of all present
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And a extension named 'extension_two'
+    When rake task 'compile:extension_one' is invoked
+    Then rake task 'compile:extension_one' succeeded
+    And output of rake task 'compile:extension_one' do not contain /extension_two/
+    And binary extension 'extension_one' do exist in 'lib'
+    And binary extension 'extension_two' do not exist in 'lib'
+
+  Scenario: removing temporary files
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    When rake task 'clean' is invoked
+    Then rake task 'clean' succeeded
+    And binary extension 'extension_one' do exist in 'lib'
+    And no left over from 'extension_one' remains in 'tmp'
+
+  Scenario: clobbering binary and temporary files
+    Given a safe project directory
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    When rake task 'clobber' is invoked
+    Then rake task 'clobber' succeeded
+    And binary extension 'extension_one' do not exist in 'lib'
+    And 'tmp' folder do not exist

data/features/cross-compile.feature

@@ -0,0 +1,23 @@
+Feature: Cross-compile C extensions
+
+  In order to avoid bitching from Windows users
+  As a Ruby developer on Linux
+  I want some rake tasks that take away the pain of compilation
+
+  Scenario: compile single extension
+    Given that all my source files are in place
+    And I'm running a POSIX operating system
+    And I've installed cross compile toolchain
+    When rake task 'cross compile' is invoked
+    Then rake task 'cross compile' succeeded
+    And binaries for platform 'i386-mingw32' get generated
+
+  Scenario: compile single extension to multiple versions
+    Given that all my source files are in place
+    And I'm running a POSIX operating system
+    And I've installed cross compile toolchain
+    When rake task 'cross compile RUBY_CC_VERSION=1.8.7:1.9.3:2.0.0' is invoked
+    Then rake task 'cross compile RUBY_CC_VERSION=1.8.7:1.9.3:2.0.0' succeeded
+    And binaries for platform 'i386-mingw32' version '1.8' get copied
+    And binaries for platform 'i386-mingw32' version '1.9' get copied
+    And binaries for platform 'i386-mingw32' version '2.0' get copied

data/features/cross-package-multi.feature

@@ -0,0 +1,15 @@
+Feature: Generate multiple Windows gems from Linux
+
+  In order to keep compatibility with versions of Ruby on Windows
+  As a Gem developer on Linux
+  I want to build binary gems for One-Click Installer (old and new versions)
+
+  Scenario: package multiple gems for Windows
+    Given that my gem source is all in place to target two platforms
+    And I'm running a POSIX operating system
+    And I've installed cross compile toolchain
+    And I've already successfully executed rake task 'cross compile'
+    When rake task 'cross native gem' is invoked
+    Then rake task 'cross native gem' succeeded
+    And gem for platform 'x86-mswin32-60' get generated
+    And gem for platform 'x86-mingw32' get generated

data/features/cross-package.feature

@@ -0,0 +1,14 @@
+Feature: Generate Windows gems from Linux
+
+  In order to keep sanity in the Ruby world
+  As a Gem developer on Linux
+  I want more rake magic that turns monotony into joy.
+
+  Scenario: package a gem for Windows
+    Given that my gem source is all in place
+    And I'm running a POSIX operating system
+    And I've installed cross compile toolchain
+    And I've already successfully executed rake task 'cross compile'
+    When rake task 'cross native gem' is invoked
+    Then rake task 'cross native gem' succeeded
+    And gem for platform 'x86-mingw32' get generated

data/features/java-compile.feature

@@ -0,0 +1,22 @@
+Feature: JCompile Java extensions
+
+  In order to avoid bitching from Enterprise users
+  As a Ruby developer
+  I want some rake tasks that take away the pain of compilation
+
+  @java
+  Scenario: Compile single Java extension (with default Rake)
+    Given that all my Java source files are in place
+    And I've installed the Java Development Kit
+    When rake task 'java compile' is invoked
+    Then rake task 'java compile' succeeded
+    And binaries for platform 'java' get generated
+
+  @java
+  Scenario: Compile single Java extension (with Rake on JRuby)
+    Given that all my Java source files are in place
+    And I've installed the Java Development Kit
+    When I've installed JRuby
+    When rake task 'java compile' is invoked on JRuby
+    Then rake task 'java compile' succeeded
+    And binaries for platform 'java' get generated

data/features/java-no-native-compile.feature

@@ -0,0 +1,33 @@
+Feature: No native or cross compilation on JRuby
+
+  In order to present a good user experience to users of rake-compiler
+  As a user of JRuby
+  I want to be warned that my platform does not provide any support for C Extensions
+  I want to be be informed of this without rake-compiler blowing up in my face
+
+  @java
+  Scenario: Attempting to do a cross compilation while on JRuby (without prerequisites)
+    Given that all my source files are in place
+    And I'm running a POSIX operating system
+    When rake task 'cross compile' is invoked on JRuby
+    Then rake task 'cross compile' should fail
+    And output of rake task 'cross compile' warns
+      """
+      WARNING: You're attempting to (cross-)compile C extensions from a platform
+      (jruby) that does not support native extensions or mkmf.rb.
+      """
+    And output of rake task 'cross compile' contains /Don't know how to build task 'cross'/
+
+  @java
+  Scenario: Attempting to do a cross compilation while on JRuby (even with prerequisites)
+    Given that all my source files are in place
+    And I'm running a POSIX operating system
+    And I've installed cross compile toolchain
+    When rake task 'cross compile' is invoked on JRuby
+    Then rake task 'cross compile' should fail
+    And output of rake task 'cross compile' warns
+      """
+      WARNING: You're attempting to (cross-)compile C extensions from a platform
+      (jruby) that does not support native extensions or mkmf.rb.
+      """
+    And output of rake task 'cross compile' contains /Don't know how to build task 'cross'/

data/features/java-package.feature

@@ -0,0 +1,24 @@
+Feature: Generate JRuby gems from JRuby or MRI
+
+  In order to keep sanity in the Ruby world
+  As a Gem developer who used to do J2EE development
+  I want more rake magic that turns monotony into joy.
+
+  @java
+  Scenario: package a gem for Java (with default Rake)
+    Given that my JRuby gem source is all in place
+    And I've installed the Java Development Kit
+    And I've already successfully executed rake task 'java compile'
+    When rake task 'java gem' is invoked
+    Then rake task 'java gem' succeeded
+    And gem for platform 'java' get generated
+
+  @java
+  Scenario: package a gem for Java (with Rake on JRuby)
+    Given that my JRuby gem source is all in place
+    And I've installed the Java Development Kit
+    And I've installed JRuby
+    And I've already successfully executed rake task 'java compile' on JRuby
+    When rake task 'java gem' is invoked
+    Then rake task 'java gem' succeeded
+    And gem for platform 'java' get generated

data/features/package.feature

@@ -0,0 +1,40 @@
+Feature: Distribute native extension with gems
+
+  In order to avoid compiler toolchain requirement during installation
+  As a Gem developer.
+  I want rake tasks generate platform specific gems for me
+
+  Scenario: generate pure ruby gem
+    Given a safe project directory
+    And a gem named 'my_project'
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    And 'pkg' folder is deleted
+    When rake task 'gem' is invoked
+    Then rake task 'gem' succeeded
+    And 'pkg' folder is created
+    And ruby gem for 'my_project' version '0.1.0' do exist in 'pkg'
+
+  Scenario: generate native gem
+    Given a safe project directory
+    And a gem named 'my_project'
+    And a extension named 'extension_one'
+    And I've already successfully executed rake task 'compile'
+    And 'pkg' folder is deleted
+    When rake task 'native gem' is invoked
+    Then rake task 'native gem' succeeded
+    And 'pkg' folder is created
+    And ruby gem for 'my_project' version '0.1.0' do exist in 'pkg'
+    And binary gem for 'my_project' version '0.1.0' do exist in 'pkg'
+
+  Scenario: generate forced native gem
+    Given a safe project directory
+    And a gem named 'my_project'
+    And a extension 'extension_one' with forced platform 'universal-unknown'
+    And I've already successfully executed rake task 'compile'
+    And 'pkg' folder is deleted
+    When rake task 'native:universal-unknown gem' is invoked
+    Then rake task 'native:universal-unknown gem' succeeded
+    And 'pkg' folder is created
+    And ruby gem for 'my_project' version '0.1.0' do exist in 'pkg'
+    And a gem for 'my_project' version '0.1.0' platform 'universal-unknown' do exist in 'pkg'

data/features/step_definitions/compilation.rb

@@ -0,0 +1,70 @@
+Given /^a extension named '(.*)'$/ do |extension_name|
+  generate_extension_task_for extension_name
+  generate_source_code_for extension_name
+end
+
+Given /^a extension cross-compilable '(.*)'$/ do |extension_name|
+  generate_cross_compile_extension_task_for extension_name
+  generate_source_code_for extension_name
+end
+
+Given /^a extension Java-compilable '(.*)'$/ do |extension_name|
+  generate_java_compile_extension_task_for extension_name
+  generate_java_source_code_for extension_name
+end
+
+Given /^a extension '(.*)' multi cross\-compilable$/ do |extension_name|
+  generate_multi_cross_compile_extension_task_for extension_name
+  generate_source_code_for extension_name
+end
+
+Given /^a extension '(.*)' with forced platform '(.*)'$/ do |extension_name, forced_platform|
+  generate_extension_task_for extension_name, forced_platform
+  generate_source_code_for extension_name
+end
+
+Given /^that all my source files are in place$/ do
+  step "a safe project directory"
+  step "a extension cross-compilable 'extension_one'"
+end
+
+Given /^that all my Java source files are in place$/ do
+  step "a safe project directory"
+  step "a extension Java-compilable 'extension_one'"
+end
+
+Given /^that my gem source is all in place$/ do
+  step "a safe project directory"
+  step "a gem named 'gem_abc'"
+  step "a extension cross-compilable 'extension_one'"
+end
+
+Given /^that my JRuby gem source is all in place$/ do
+  step "a safe project directory"
+  step "a gem named 'gem_abc'"
+  step "a extension Java-compilable 'extension_one'"
+end
+
+Given /^that my gem source is all in place to target two platforms$/ do
+  step "a safe project directory"
+  step "a gem named 'gem_abc'"
+  step "a extension 'extension_one' multi cross-compilable"
+end
+
+Given /^not changed any file since$/ do
+  # don't do anything, that's the purpose of this step!
+end
+
+When /^touching '(.*)' file of extension '(.*)'$/ do |file, extension_name|
+  Kernel.sleep 1
+  FileUtils.touch "ext/#{extension_name}/#{file}"
+end
+
+Then /^binary extension '(.*)' (do|do not) exist in '(.*)'$/ do |extension_name, condition, folder|
+  ext_for_platform = File.join(folder, "#{extension_name}.#{RbConfig::CONFIG['DLEXT']}")
+  if condition == 'do'
+    File.exist?(ext_for_platform).should be_true
+  else
+    File.exist?(ext_for_platform).should be_false
+  end
+end

data/features/step_definitions/cross_compilation.rb

@@ -0,0 +1,27 @@
+# Naive way of looking into platforms, please include others like FreeBSD?
+Given %r{^I'm running a POSIX operating system$} do
+  unless RbConfig::CONFIG['host_os'] =~ /linux|darwin/ then
+    raise Cucumber::Pending.new("You need a POSIX operating system, no cheating ;-)")
+  end
+end
+
+Given %r{^I've installed cross compile toolchain$} do
+  unless search_path(%w(i586-mingw32msvc-gcc i386-mingw32-gcc i686-w64-mingw32-gcc))
+    pending 'Cannot locate suitable compiler in the PATH.'
+  end
+end
+
+Then /^binaries for platform '(.*)' get generated$/ do |platform|
+  ext = binary_extension(platform)
+
+  ext_for_platform = Dir.glob("tmp/#{platform}/**/*.#{ext}")
+  ext_for_platform.should_not be_empty
+end
+
+Then /^binaries for platform '(.*)' version '(.*)' get copied$/ do |platform, version|
+  lib_path = "lib/#{version}"
+  ext = binary_extension(platform)
+
+  ext_for_platform = Dir.glob("#{lib_path}/*.#{ext}")
+  ext_for_platform.should_not be_empty
+end

data/features/step_definitions/execution.rb

@@ -0,0 +1,52 @@
+# FIXME: Make the Transform work
+#
+# Transform /^| on JRuby$/ do |step_arg|
+#  / on JRuby/.match(step_arg) != nil
+# end
+
+Given %r{^I've already successfully executed rake task '(.*)'(| on JRuby)$} do |task_name, on_jruby|
+  rake_cmd = "rake #{task_name}"
+  rake_cmd = 'jruby -S ' << rake_cmd if on_jruby == ' on JRuby'
+  emptyness = `#{rake_cmd} 2>&1`
+  unless $?.success?
+    warn emptyness
+    raise "rake failed with #{$?.exitstatus}"
+  end
+end
+
+When /^rake task '(.*)' is invoked(| on JRuby)$/ do |task_name, on_jruby|
+  @output ||= {}
+  @result ||= {}
+  rake_cmd = "rake #{task_name}"
+  rake_cmd = 'jruby -S ' << rake_cmd if on_jruby == ' on JRuby'
+  @output[task_name] = `#{rake_cmd} 2>&1`
+  @result[task_name] = $?.success?
+end
+
+Then /^rake task '(.*)' succeeded$/ do |task_name|
+  if @result.nil? || !@result.include?(task_name) then
+    raise "The task #{task_name} should be invoked first."
+  else
+    @result[task_name].should be_true
+  end
+end
+
+Then /^rake task '(.*)' should fail$/ do |task_name|
+  if @result.nil? || !@result.include?(task_name) then
+    raise "The task #{task_name} should be invoked first."
+  else
+    @result[task_name].should be_false
+  end
+end
+
+Then /^output of rake task '(.*)' (contains|do not contain) \/(.*)\/$/ do |task_name, condition, regex|
+  if condition == 'contains' then
+    @output[task_name].should match(%r(#{regex}))
+  else
+    @output[task_name].should_not match(%r(#{regex}))
+  end
+end
+
+Then /^output of rake task '(.*)' warns$/ do |task_name, warning|
+  @output[task_name].should include(warning)
+end