rake-compiler 0.6.0 → 0.7.0

data/History.txt

@@ -1,4 +1,53 @@
-=== 0.6.x (in Git)
+=== 0.7.0 / 2009-12-08
+
+* Enhancements
+  * Allow generation of JRuby extensions. Thanks to Alex Coles (myabc) for the
+    contribution.
+    This will allow, with proper JDK tools, cross compilation of JRuby gems
+    from MRI.
+
+      Rake::JavaExtensionTask.new('my_java_extension', GEM_SPEC) do |ext|
+        # most of ExtensionTask options can be used
+        # plus, java_compiling:
+        ext.java_compiling do |gem_spec|
+          gem_spec.post_install_message = "This is a native JRuby gem!"
+        end
+      end
+
+    Please note that cross-compiling JRuby gems requires either JRUBY_HOME or
+    JRUBY_PARENT_CLASSPATH environment variables being properly set.
+
+  * Allow alteration of the Gem Specification when cross compiling. Closes GH-3
+    This is useful to indicate a custom requirement message, like DLLs
+    installation or similar.
+
+      Rake::ExtensionTask.new('my_extension', GEM_SPEC) do |ext|
+        ext.cross_compile = true
+        # ...
+        ext.cross_compiling do |gem_spec|
+          gem_spec.post_install_message = "You've installed a binary version of this gem"
+        end
+      end
+
+* Bugfixes
+  * Detect GNU make independently of distribution based naming.
+    Thanks to flori for patches.
+  * Usage of #dup to duplicate gemspec instead of YAML dumping.
+  * No longer support Ruby older than 1.8.6
+  * No longer support RubyGems older than 1.3.5
+  * Force definition of binary directory and executables. Closes GH-11
+  * Workaround path with spaces issues using relative paths. Closes GH-6
+  * Removed gemspec, GitHub gems no more
+
+* Known issues
+  * Usage of rake-compiler under projects with Jeweler requires some tweaks
+    Please read issue GH-73 for Jeweler:
+    http://github.com/technicalpickles/jeweler/issues#issue/73
+
+    For a workaround, look here:
+    http://gist.github.com/251663
+
+=== 0.6.0 / 2009-07-25
 
 * Enhancements
   * Implemented 'fat-binaries' generation for cross compiling

data/README.rdoc

@@ -1,14 +1,14 @@
 = rake-compiler
 
-rake-compiler aims to help Gem developers while dealing with Ruby C
-extensions, simplifying the code and reducing the duplication.
+rake-compiler aims to help Gem developers deal with Ruby extensions, simplifying
+code and reducing duplication.
 
-It follows *convention over configuration* and set an standardized 
-structure to build and package C extensions in your gems.
+It followss *convention over configuration* and sets a standardized structure to
+build and package both C and Java extensions in your gems.
 
-This is the result of experiences dealing with several Gems that required 
-native extensions across platforms and different user configurations 
-where details like portability and clarity of code were lacking.
+This is the result of experiences dealing with several Gems that required native
+extensions across platforms and different user configurations where details like
+portability and clarity of code were lacking.
 
 == An Overview
 
@@ -18,9 +18,12 @@ Let's summarize what rake-compiler provides:
 
 * Painlessly build extensions on different platforms (Linux, OSX and Windows).
 
+* Painlessly build extensions for different Ruby implementations (JRuby,
+  Rubinius and MRI).
+
 * Allow multiple extensions be compiled inside the same gem.
 
-* Mimics RubyGems installation process, so helps as test environment.
+* Mimics RubyGems installation process, so helps as a test environment.
 
 * Simplify cross platform compilation of extensions (target Windows from Linux).
 
@@ -32,13 +35,6 @@ First, you need to install the gem:
 
   $ gem install rake-compiler
 
-Since this package is in constant evolution, you could try installing it
-from GitHub:
-
-  $ gem install luislavena-rake-compiler --source http://gems.github.com
-
-The development gem is usually in pretty good shape actually.
-
 == Now what? (Usage)
 
 Now that you have the gem installed, let's give your project some structure.
@@ -46,11 +42,12 @@ Now that you have the gem installed, let's give your project some structure.
 === Structure
 
 Let's say we want to compile an extension called 'hello_world', so we should
-organize the code and folders that will help rake-compiler do it's job:
+organize the code and folders that will help rake-compiler do its job:
 
     |-- ext
     |   `-- hello_world
     |       |-- extconf.rb
+    |       |-- HelloWorldService.java
     |       `-- hello_world.c
     |-- lib
     `-- Rakefile
@@ -63,20 +60,28 @@ to find code and also contribute back to your project more easily.
 So now it's time to introduce the code to compile our extension:
 
     # File: Rakefile
-    
+
     require 'rake/extensiontask'
-    
+
     Rake::ExtensionTask.new('hello_world')
 
 Ok, that's it. No other line of code.
 
+If we wanted to do the same for a JRuby extension (written in Java):
+
+    # File: Rakefile
+
+    require 'rake/javaextensiontask'
+
+    Rake::JavaExtensionTask.new('hello_world')
+
 === Compile process
 
 Those *two* lines of code automatically added the needed rake tasks to build
-the hello_world extension:
+the hello_world extension. Running Rake on 1.8.x/1.9 (MRI):
 
   $ rake -T
-  (in /home/user/my_extesion)
+  (in /home/user/my_extension)
   rake compile                # Compile the extension(s)
   rake compile:hello_world    # Compile just the hello_world extension
 
@@ -91,6 +96,10 @@ NOTE: Please be aware that building C extensions requires the proper
 development environment for your Platform, which includes libraries, headers
 and build tools. Check your distro / vendor documentation on how to install it.
 
+NOTE: Building Java extensions requires the <tt>javac</tt>, part of the Java
+Development Kit (JDK). This should be included by default on Mac OS X, and
+downloadable from http://java.sun.com for other operating systems.
+
 === Generate native gems
 
 A common usage scenario of rake-compiler is generate native gems that bundles
@@ -141,6 +150,23 @@ Plus, you have the functionality to build native versions of the gem:
 
 You get two gems for the price of one.
 
+And the same for JRuby extensions:
+
+  # rake java gem
+  (... compilation output ...)
+  mkdir -p pkg
+    Successfully built RubyGem
+    Name: my_gem
+    Version: 0.1.0
+    File: my_gem-0.1.0.gem
+  mv my_gem-0.1.0.gem pkg/my_gem-0.1.0.gem
+    Successfully built RubyGem
+    Name: my_gem
+    Version: 0.1.0
+    File: my_gem-0.1.0-java.gem
+  mv my_gem-0.1.0-java.gem pkg/my_gem-0.1.0-java.gem
+
+
 === What about breaking the standards? (Customization)
 
 In case you want to bend the convention established, rake-compiler let you
@@ -163,7 +189,7 @@ personalize several settings for <tt>Rake::ExtensionTask</tt>:
 rake-compiler provides now an standardized way to generate, from Linux or OSX
 both extensions and gem binaries for Windows!
 
-It takes advantages from GCC host/target to build binaries (for target) on 
+It takes advantages from GCC host/target to build binaries (for target) on
 different OS (hosts).
 
 === How I enjoy this?
@@ -171,16 +197,19 @@ different OS (hosts).
 Besides having the development tool chain installed (GCC), you should install
 also <tt>mingw32</tt> cross compilation package.
 
-This depends on your operating system distribution, a simple 
-<tt>apt-get install mingw32</tt> will be enough.
+Installation depends will depend on your operating system/distribution. On
+Ubuntu and Debian machines, a simple <tt>apt-get install mingw32</tt> will be
+enough.
 
-Please check OSX documentation about installing mingw32 from macports.
+On OSX, mingw32 is available via MacPorts: <tt>port install i386-mingw32-gcc</tt>
+(ensure you update your ports tree before hand as <tt>mingw32</tt> has been
+been broken).
 
 === I have my tool-chain, now what?
 
 You need to build Ruby for Windows.
 
-Relax, no need to freak out. rake-compiler do it for you:
+Relax, no need to freak out! Let rake-compiler do it for you:
 
   rake-compiler cross-ruby
 
@@ -201,6 +230,11 @@ Now, you only need to use additional options in your extension definition:
       ext.cross_platform = 'i386-mswin32'     # forces the Windows platform instead of the default one
                                               # configure options only for cross compile
       ext.cross_config_options << '--with-something'
+
+      # perform alterations on the gemspec when cross compiling
+      ext.cross_compiling do |gem_spec|
+        gem_spec.post_install_message = "You installed the binary version of this gem!"
+      end
     end
 
 By default, cross compilation targets 'i386-mingw32' which is default GCC platform
@@ -257,12 +291,6 @@ Blog:      http://blog.mmediasys.com
 RubyForge: http://rubyforge.org/projects/rake-compiler
 GitHub:    http://github.com/luislavena/rake-compiler
 
-=== Some of the desired features
-
-* <tt>Rake::JavaJarTask</tt> to generate <tt>jar</tt> packages and gems for JRuby.
-
-  $ rake java gem
-
 == Disclaimer
 
 If you have any trouble, don't hesitate to contact the author. As always,

data/cucumber.yml

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

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/step_definitions/compilation.rb

@@ -8,6 +8,11 @@ Given /^a extension cross-compilable '(.*)'$/ do |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
@@ -23,12 +28,23 @@ Given /^that all my source files are in place$/ do
   Given "a extension cross-compilable 'extension_one'"
 end
 
+Given /^that all my Java source files are in place$/ do
+  Given "a safe project directory"
+  Given "a extension Java-compilable 'extension_one'"
+end
+
 Given /^that my gem source is all in place$/ do
   Given "a safe project directory"
   Given "a gem named 'gem_abc'"
   Given "a extension cross-compilable 'extension_one'"
 end
 
+Given /^that my JRuby gem source is all in place$/ do
+  Given "a safe project directory"
+  Given "a gem named 'gem_abc'"
+  Given "a extension Java-compilable 'extension_one'"
+end
+
 Given /^that my gem source is all in place to target two platforms$/ do
   Given "a safe project directory"
   Given "a gem named 'gem_abc'"

data/features/step_definitions/cross_compilation.rb

@@ -1,19 +1,12 @@
 # Naive way of looking into platforms, please include others like FreeBSD?
 Given %r{^I'm running a POSIX operating system$} do
-  unless RUBY_PLATFORM =~ /linux|darwin/ then
+  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
-  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
-  pending "Cannot locate suitable compiler in the PATH." unless compiler
+  pending 'Cannot locate suitable compiler in the PATH.' unless search_path(%w(i586-mingw32msvc-gcc i386-mingw32-gcc))
 end
 
 Then /^binaries for platform '(.*)' get generated$/ do |platform|

data/features/step_definitions/execution.rb

@@ -1,15 +1,25 @@
-Given %r{^I've already successfully executed rake task '(.*)'$} do |task_name|
-  emptyness = `rake #{task_name} 2>&1`
+# 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$/ do |task_name|
+When /^rake task '(.*)' is invoked(| on JRuby)$/ do |task_name, on_jruby|
   @output ||= {}
   @result ||= {}
-  @output[task_name] = `rake #{task_name} 2>&1`
+  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
 
@@ -21,6 +31,14 @@ Then /^rake task '(.*)' succeeded$/ do |task_name|
   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}))
@@ -28,3 +46,7 @@ Then /^output of rake task '(.*)' (contains|do not contain) \/(.*)\/$/ do |task_
     @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

data/features/step_definitions/gem.rb

@@ -12,6 +12,12 @@ 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
+
+  # unpack the Gem and check what's inside!
+  `gem unpack #{gem_file_platform(folder, name, version, platform)} --target tmp`
+  unpacked_gem_dir = unpacked_gem_dir_platform('tmp', name, version, platform)
+  File.exist?(unpacked_gem_dir).should be_true
+  Dir.glob(unpacked_gem_dir << "/lib/*.#{binary_extension(platform)}").should_not be_empty
 end
 
 Then /^gem for platform '(.*)' get generated$/ do |platform|
@@ -28,3 +34,9 @@ def gem_file_platform(folder, name, version, platform = nil)
   file << ".gem"
   file
 end
+
+def unpacked_gem_dir_platform(folder, name, version, platform = nil)
+  file = "#{folder}/#{name}-#{version}"
+  file << "-" << (platform || Gem::Platform.new(RUBY_PLATFORM).to_s)
+  file
+end