rake-compiler 0.3.0 → 0.5.0

data/tasks/bin/cross-ruby.rake

@@ -21,12 +21,22 @@ 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]
 
+# 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}"
 directory "#{USER_HOME}/builds/#{RUBY_CC_VERSION}"
@@ -45,7 +55,7 @@ CLOBBER.include("#{USER_HOME}/config.yml")
 file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}.tar.gz" => ["#{USER_HOME}/sources"] do |t|
   # download the source file using wget or curl
   chdir File.dirname(t.name) do
-    url = "ftp://ftp.ruby-lang.org/pub/ruby/#{MAJOR}/#{File.basename(t.name)}"
+    url = "http://ftp.ruby-lang.org/pub/ruby/#{MAJOR}/#{File.basename(t.name)}"
     sh "wget #{url} || curl -O #{url}"
   end
 end
@@ -82,9 +92,9 @@ file "#{USER_HOME}/sources/#{RUBY_CC_VERSION}/Makefile.in" => ["#{USER_HOME}/sou
 end
 
 task :mingw32 do
-  unless File.exist?('/usr/bin/i586-mingw32msvc-gcc') then
+  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
@@ -101,12 +111,14 @@ 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=i586-mingw32msvc',
     '--target=i386-mingw32',
+    "--host=#{MINGW_HOST}",
     '--build=i686-linux',
-    '--enable-shared'
+    '--enable-shared',
+    '--disable-install-doc',
+    '--without-tk',
+    '--without-tcl'
   ]
 
   chdir File.dirname(t.name) do
@@ -129,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|
@@ -153,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/common.rake

@@ -11,3 +11,6 @@ task :package => [:spec, :features]
 
 # make the release re-generate the gemspec if required
 task :release => [:gemspec]
+
+# publish documentation when doing a release
+task :release => [:publish]

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

@@ -1,17 +1,14 @@
-require 'rake/gempackagetask'
+require 'rubygems/package_task'
 
 GEM_SPEC = Gem::Specification.new do |s|
   # basic information
   s.name        = "rake-compiler"
-  s.version     = "0.3.0"
+  s.version     = "0.5.0"
   s.platform    = Gem::Platform::RUBY
 
   # description and details
   s.summary     = 'Rake-based Ruby C Extension task generator.'
-  s.description = <<-EOF
-    Provide a standard and simplified way to build and package
-    Ruby C extensions using Rake as glue.
-  EOF
+  s.description = "Provide a standard and simplified way to build and package\nRuby C extensions using Rake as glue."
 
   # dependencies
   s.add_dependency  'rake', '>= 0.8.3', '< 0.9'
@@ -39,21 +36,22 @@ GEM_SPEC = Gem::Specification.new do |s|
   # project information
   s.homepage          = 'http://github.com/luislavena/rake-compiler'
   s.rubyforge_project = 'rake-compiler'
+  s.licenses          = ['MIT']
 
   # author and contributors
   s.author      = 'Luis Lavena'
   s.email       = 'luislavena@gmail.com'
 end
 
-gem_package = Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+gem_package = Gem::PackageTask.new(GEM_SPEC) do |pkg|
   pkg.need_tar = false
   pkg.need_zip = false
 end
 
-file 'rake-compiler.gemspec' => ['Rakefile', 'tasks/gem.rake'] do |t|
+file "#{GEM_SPEC.name}.gemspec" => ['Rakefile', 'tasks/gem.rake'] do |t|
   puts "Generating #{t.name}"
   File.open(t.name, 'w') { |f| f.puts GEM_SPEC.to_yaml }
 end
 
 desc "Generate or update the standalone gemspec file for the project"
-task :gemspec => ['rake-compiler.gemspec']
+task :gemspec => ["#{GEM_SPEC.name}.gemspec"]

data/tasks/news.rake

@@ -0,0 +1,82 @@
+begin
+  gem 'rubyforge', '~> 1.0.1'
+  require 'rubyforge'
+rescue Exception
+  nil
+end
+
+CLEAN.include('email.txt')
+
+if defined?(RubyForge) then
+  if defined?(GEM_SPEC) then
+    desc 'Create news email file and post to RubyForge.'
+    task :announce do |t|
+      ver = ENV['VERSION'] or fail "Must supply VERSION (rake announce 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 homepage? why announce it then?!
+      if GEM_SPEC.homepage == 'TODO' or GEM_SPEC.homepage.nil? then
+        fail "Must define homepage in your gem specification."
+      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.configure
+
+      # 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
+
+      # standard fields
+      subject = "#{GEM_SPEC.name} #{GEM_SPEC.version} Released"
+      title   = "#{GEM_SPEC.name} version #{GEM_SPEC.version} has been released!"
+      body    = "#{notes}\n\nChanges:\n\n#{changes}"
+      urls    = [GEM_SPEC.homepage, "http://rubyforge.org/projects/#{GEM_SPEC.rubyforge_project}"].map { |u| "* <#{u.strip}>" }.join("\n")
+
+      puts "Logging in RubyForge..."
+      rf.login
+
+      puts "Generating email.txt..."
+      File.open("email.txt", "w") do |mail|
+        mail.puts "Subject: [ANN] #{subject}"
+        mail.puts
+        mail.puts title
+        mail.puts 
+        mail.puts urls
+        mail.puts
+        mail.puts body
+      end
+      puts "Created email.txt"
+
+      puts "Posting news for #{GEM_SPEC.name} version #{GEM_SPEC.version}..."
+      rf.post_news GEM_SPEC.rubyforge_project, subject, "#{title}\n\n#{body}"
+      puts "Done."
+    end
+  else
+    warn "no GEM_SPEC is found or defined. 'announce' task cannot work without it."
+  end
+else
+  warn "rubyforge gem is required to generate announces, please install it (gem install rubyforge)."
+end

data/tasks/rdoc.rake

@@ -1,9 +1,15 @@
-require 'rake/rdoctask'
+begin
+  require 'rdoc/task'
+rescue LoadError
+  warn "RDoc 2.4.3+ gem is required, please install it (gem install rdoc)."
+end
 
-Rake::RDocTask.new(:rdoc) do |rd|
-  rd.title    = 'rake-compiler -- Documentation'
-  rd.main     = 'README.rdoc'
-  rd.rdoc_dir = 'doc/api'
-  rd.options << '--main'  << 'README.rdoc' << '--title' << 'rake-compiler -- Documentation'
-  rd.rdoc_files.include %w(README.rdoc LICENSE.txt History.txt lib/**/*.rb)
+if defined?(RDoc) then
+  DOC = RDoc::Task.new(:rdoc) do |rd|
+    rd.title    = 'rake-compiler -- Documentation'
+    rd.main     = 'README.rdoc'
+    rd.rdoc_dir = 'doc/api'
+    rd.options << '--line-numbers' << '--main'  << 'README.rdoc' << '--title' << 'rake-compiler -- Documentation'
+    rd.rdoc_files.include %w(README.rdoc LICENSE.txt History.txt lib/**/*.rb)
+  end
 end

data/tasks/rdoc_publish.rake

@@ -0,0 +1,44 @@
+begin
+  gem 'rubyforge', '~> 1.0.1'
+  require 'rubyforge'
+rescue Exception
+  nil
+end
+
+if defined?(RubyForge) then
+  if defined?(DOC) && defined?(GEM_SPEC) then
+    desc "Publish RDoc to RubyForge"
+    task :publish => [:clobber_rdoc, :rdoc] do
+      config_file = File.expand_path('~/.rubyforge/user-config.yml')
+      fail "You need rubyforge properly configured." unless File.exist?(config_file)
+
+      # 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
+
+      # use YAML to load configuration file
+      config = YAML.load_file(config_file)
+
+      host = "#{config['username']}@rubyforge.org"
+      remote_dir = "/var/www/gforge-projects/#{GEM_SPEC.rubyforge_project}/"
+      local_dir = DOC.rdoc_dir
+
+      # use PuTTY pscp or scp on other platforms
+      ssh_exe = RUBY_PLATFORM =~ /mswin|mingw/ ? 'pscp' : 'scp'
+
+      # construct the command
+      cmd = [ssh_exe]
+      cmd << '-r' << '-q'  # recursive and quiet options
+      cmd << "#{local_dir}/*"
+      cmd << "#{host}:#{remote_dir}"
+
+      puts "Publishing RDocs to RubyForge..."
+      sh cmd.join(' ')
+    end
+  else
+    warn "You need a GEM_SPEC and DOC rdoc definitions present. task publish not defined."
+  end
+else
+  warn "rubyforge gem is required to generate releases, please install it (gem install rubyforge)."
+end

data/tasks/release.rake

@@ -7,6 +7,7 @@ end
 
 if defined?(RubyForge) then
   if defined?(GEM_SPEC) then
+    desc 'Package and upload to RubyForge'
     task :release => [:clobber, :package] do |t|
       ver = ENV['VERSION'] or fail "Must supply VERSION (rake release VERSION=x.y.z)."
 
@@ -35,7 +36,7 @@ if defined?(RubyForge) then
       # read changes
       changes = begin
                   h = File.read("History.txt")
-                  h.split(/^(==.*)/)[1..2].join.strip
+                  h.split(/^(===+ .*)/)[1..2].join.strip
                 rescue
                   warn "Missing History.txt"
                   ''
@@ -50,12 +51,6 @@ if defined?(RubyForge) then
       # 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?
 

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.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Luis Lavena
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-07 00:00:00 -05:00
+date: 2009-04-25 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0.9"
     version: 
-description: Provide a standard and simplified way to build and package Ruby C extensions using Rake as glue.
+description: |-
+  Provide a standard and simplified way to build and package
+  Ruby C extensions using Rake as glue.
 email: luislavena@gmail.com
 executables: 
 - rake-compiler
@@ -38,6 +40,7 @@ extra_rdoc_files:
 files: 
 - features/compile.feature
 - features/cross-compile.feature
+- features/cross-package-multi.feature
 - features/cross-package.feature
 - features/package.feature
 - features/step_definitions/compilation.rb
@@ -46,17 +49,21 @@ files:
 - features/step_definitions/folders.rb
 - features/step_definitions/gem.rb
 - features/support/env.rb
-- features/support/file_templates.rb
-- features/support/generators.rb
+- features/support/file_template_helpers.rb
+- features/support/generator_helpers.rb
 - bin/rake-compiler
+- lib/rake/extensioncompiler.rb
 - lib/rake/extensiontask.rb
 - spec/lib/rake/extensiontask_spec.rb
 - spec/spec_helper.rb
+- spec/support/capture_output_helper.rb
 - tasks/bin/cross-ruby.rake
 - tasks/common.rake
 - tasks/cucumber.rake
 - tasks/gem.rake
+- tasks/news.rake
 - tasks/rdoc.rake
+- tasks/rdoc_publish.rake
 - tasks/release.rake
 - tasks/rspec.rake
 - Rakefile
@@ -66,6 +73,8 @@ files:
 - cucumber.yml
 has_rdoc: true
 homepage: http://github.com/luislavena/rake-compiler
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: 
 - --main
@@ -89,9 +98,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rake-compiler
-rubygems_version: 1.3.0
+rubygems_version: 1.3.2
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Rake-based Ruby C Extension task generator.
 test_files: []
 

data/features/support/generators.rb

@@ -1,77 +0,0 @@
-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_cross_compile_extension_task_for(extension_name)
-  # create folder structure
-  FileUtils.mkdir_p "ext/#{extension_name}"
-
-  return if File.exist?("tasks/#{extension_name}.rake")
-
-  # create specific extension rakefile
-  # Building a gem?
-  if File.exist?("tasks/gem.rake") then
-    File.open("tasks/gem.rake", 'a+') do |ext_in_gem|
-      ext_in_gem.puts template_rake_extension_cross_compile(extension_name, true)
-    end
-  else
-    File.open("tasks/#{extension_name}.rake", 'w') do |ext_rake|
-      ext_rake.puts template_rake_extension_cross_compile(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