luislavena-rake-compiler 0.2.1 → 0.3.0

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.3.0 / 2008-12-07
+
+* 1 Major Enhancement:
+
+  * 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:
+
+  * Properly update rake-compiler configuration when new version is installed.
+  * Automated release process to RubyForge, yay!
+
+* 1 Bug fix:
+
+  * Corrected documentation to reflect the available options
+
 === 0.2.1 / 2008-11-30
 
 * 2 Major Enhancements:

data/README.rdoc

@@ -10,7 +10,6 @@ This is the result of expriences 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
 
 Let's summarize what rake-compiler provides:
@@ -23,6 +22,7 @@ Let's summarize what rake-compiler provides:
 
 * Mimics RubyGems installation process, so helps as test environment.
 
+* Simplify cross platform compilation of extensions (target Windows from Linux).
 
 == I'm sold! show me how to use it! (Installation)
 
@@ -39,12 +39,10 @@ from GitHub:
 
 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.
 
-
 === Structure
 
 Let's say we want to compile an extension called 'hello_world', so we should
@@ -60,7 +58,6 @@ organize the code and folders that will help rake-compiler do it's job:
 TIP: Having a consistent folder structure will help developers and newcomers
 to find code and also contribute back to your project more easily.
 
-
 === Adding the code
 
 So now it's time to introduce the code to compile our extension:
@@ -73,7 +70,6 @@ So now it's time to introduce the code to compile our extension:
 
 Ok, that's it. No other line of code.
 
-
 === Compile process
 
 Those *two* lines of code automatically added the needed rake tasks to build
@@ -162,7 +158,6 @@ personalize several settings for <tt>Rake::ExtensionTask</tt>:
                                               # will be used to based on.
     end
 
-
 == Future is now: Cross compilation
 
 rake-compiler provides now an standarized way to generate, from Linux or OSX
@@ -171,7 +166,6 @@ both extensions and gem binaries for Windows!
 It takes advantages from GCC host/target to build binaries (for target) on 
 different OS (hosts).
 
-
 === How I enjoy this?
 
 Besides having the development tool chain installed (GCC), you should install
@@ -182,7 +176,6 @@ will be enough.
 
 Please check OSX documentation about installing mingw32 from macports.
 
-
 === I have my toolchain, now what?
 
 You need to build Ruby for Windows.
@@ -222,12 +215,21 @@ Compiles keeps being simple:
 
   rake cross compile
 
-And now, build your gems for Windows is just 4 more letters:
+And now, build your gems for Windows is just 5 more letters:
 
   rake cross native gem
 
 And you're done, yeah.
 
+=== Take it even further
+
+You can specify against with version of Ruby you want to build the extension:
+
+  rake cross compile RUBY_CC_VERSION=1.8
+
+If you installed <tt>1.9.1</tt>, you can do:
+
+  rake cross compile RUBY_CC_VERSION=1.9
 
 == Future
 
@@ -237,16 +239,15 @@ development of it! (and contributions too!)
 You can find more information about rake-compiler:
 
 Blog:      http://blog.mmediasys.com
+RubyForge: http://rubyforge.org/projects/rake-compiler
 GitHub:    http://github.com/luislavena/rake-compiler
 
-
-=== Some of the features already underworks
+=== 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/features/step_definitions/cross_compilation.rb

@@ -1,6 +1,7 @@
 # Naive way of looking into platforms, please include others like FreeBSD?
-if RUBY_PLATFORM =~ /linux|darwin/
-  Given %r{^I'm running a POSIX operating system$} do
+Given %r{^I'm running a POSIX operating system$} do
+  unless RUBY_PLATFORM =~ /linux|darwin/ then
+    raise Cucumber::Pending.new("You need a POSIX operating system, no cheating ;-)")
   end
 end
 

data/lib/rake/extensiontask.rb

@@ -200,7 +200,7 @@ module Rake
 
     def define_cross_platform_tasks
       config_path = File.expand_path("~/.rake-compiler/config.yml")
-      major_ver = RUBY_VERSION.match(/(\d+.\d+)/)[1]
+      major_ver = (ENV['RUBY_CC_VERSION'] || RUBY_VERSION).match(/(\d+.\d+)/)[1]
 
       # warn the user about the need of configuration to use cross compilation.
       unless File.exist?(config_path)

data/spec/lib/rake/extensiontask_spec.rb

@@ -277,6 +277,20 @@ describe Rake::ExtensionTask do
         }.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|

data/tasks/bin/cross-ruby.rake

@@ -133,10 +133,11 @@ 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 "#{USER_HOME}/config.yml" => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/lib/ruby/#{MAJOR}/i386-mingw32/rbconfig.rb"] do |t|
-  if File.exist?(t.name) then
+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(t.name)
+    config = YAML.load_file(config_file)
   else
     puts "Generating #{t.name}"
     config = {}
@@ -144,8 +145,8 @@ file "#{USER_HOME}/config.yml" => ["#{USER_HOME}/ruby/#{RUBY_CC_VERSION}/lib/rub
 
   config["rbconfig-#{MAJOR}"] = File.expand_path(t.prerequisites.first)
 
-  when_writing("Saving changes into #{t.name}") {
-    File.open(t.name, 'w') do |f|
+  when_writing("Saving changes into #{config_file}") {
+    File.open(config_file, 'w') do |f|
       f.puts config.to_yaml
     end
   }
@@ -155,4 +156,4 @@ task :default do
 end
 
 desc "Build #{RUBY_CC_VERSION} suitable for cross-platform development."
-task 'cross-ruby' => [:mingw32, :environment, "#{USER_HOME}/config.yml"]
+task 'cross-ruby' => [:mingw32, :environment, :update_config]

data/tasks/common.rake

@@ -5,3 +5,9 @@ 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/{rubygems.rake → gem.rake}

@@ -1,9 +1,9 @@
 require 'rake/gempackagetask'
 
-spec = Gem::Specification.new do |s|
+GEM_SPEC = Gem::Specification.new do |s|
   # basic information
   s.name        = "rake-compiler"
-  s.version     = "0.2.1"
+  s.version     = "0.3.0"
   s.platform    = Gem::Platform::RUBY
 
   # description and details
@@ -37,22 +37,22 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = %w(README.rdoc LICENSE.txt History.txt)
 
   # project information
-  s.homepage    = 'http://github.com/luislavena/rake-compiler'
-  s.rubyforge_project = 'TODO'
+  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(spec) do |pkg|
+gem_package = Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
   pkg.need_tar = false
   pkg.need_zip = false
 end
 
-file 'rake-compiler.gemspec' => ['Rakefile', 'tasks/rubygems.rake'] do |t|
+file 'rake-compiler.gemspec' => ['Rakefile', 'tasks/gem.rake'] do |t|
   puts "Generating #{t.name}"
-  File.open(t.name, 'w') { |f| f.puts spec.to_yaml }
+  File.open(t.name, 'w') { |f| f.puts GEM_SPEC.to_yaml }
 end
 
 desc "Generate or update the standalone gemspec file for the project"

data/tasks/release.rake

@@ -0,0 +1,79 @@
+begin
+  gem 'rubyforge', '~> 1.0.1'
+  require 'rubyforge'
+rescue Exception
+  nil
+end
+
+if defined?(RubyForge) then
+  if defined?(GEM_SPEC) then
+    task :release => [:clean, :package] do |t|
+      ver = ENV['VERSION'] or fail "Must supply VERSION (rake release VERSION=x.y.z)."
+
+      # compare versions to avoid mistakes
+      unless ver == GEM_SPEC.version.to_s then
+        fail "Version mismatch (supplied and specification versions differ)."
+      end
+
+      # no rubyforge project? no release for you!
+      if GEM_SPEC.rubyforge_project == 'TODO' or GEM_SPEC.rubyforge_project.nil? then
+        fail "Must define rubyforge_project in your gem specification."
+      end
+
+      # instantiate a RubyForge object
+      rf = RubyForge.new
+
+      # read project info and overview
+      notes = begin
+                r = File.read("README.rdoc")
+                r.split(/^(=+ .*)/)[1..4].join.strip
+              rescue
+                warn "Missing README.rdoc"
+                ''
+              end
+
+      # read changes
+      changes = begin
+                  h = File.read("History.txt")
+                  h.split(/^(==.*)/)[1..2].join.strip
+                rescue
+                  warn "Missing History.txt"
+                  ''
+                end
+
+      # build the configuration for the release
+      config = Hash.new
+      config["release_notes"] = notes
+      config["release_changes"] = changes
+      config["preformatted"] = true
+
+      # prepare configuration
+      rf.configure config
+
+      # ensure this was not released before
+      releases = rf.autoconfig['release_ids']
+      if releases.has_key?(GEM_SPEC.name) and releases[GEM_SPEC.name][GEM_SPEC.version] then
+        fail "Release #{GEM_SPEC.version} already exist. Unable to release."
+      end
+
+      files = FileList["pkg/#{GEM_SPEC.name}-#{GEM_SPEC.version}*.*"].to_a
+      fail "No files found for the release." if files.empty?
+
+      puts "Logging in RubyForge..."
+      rf.login
+
+      puts "Files to upload:"
+      files.each do |f|
+        puts "  * #{f}"
+      end
+
+      puts "Releasing #{GEM_SPEC.name} version #{GEM_SPEC.version}..."
+      #rf.add_release GEM_SPEC.rubyforge_project, GEM_SPEC.name, GEM_SPEC.version, *files
+      puts "Done."
+    end
+  else
+    warn "no GEM_SPEC is found or defined. 'release' task cannot work without it."
+  end
+else
+  warn "rubyforge gem is required to generate releases, please install it (gem install rubyforge)."
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: luislavena-rake-compiler
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Luis Lavena
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-29 21:00:00 -08:00
+date: 2008-12-06 21:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,9 +55,10 @@ files:
 - tasks/bin/cross-ruby.rake
 - tasks/common.rake
 - tasks/cucumber.rake
+- tasks/gem.rake
 - tasks/rdoc.rake
+- tasks/release.rake
 - tasks/rspec.rake
-- tasks/rubygems.rake
 - Rakefile
 - README.rdoc
 - History.txt
@@ -87,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: TODO
+rubyforge_project: rake-compiler
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2