gem-compiler 0.1.1 → 0.2.0

data/.gemtest

@@ -0,0 +1 @@
+ 

data/History.md

@@ -0,0 +1,14 @@
+# gem-compiler
+
+## 0.2.0 (2013-04-28)
+
+- Support RubyGems 2.0.0 thanks to @mgoggin [#6]
+
+## 0.1.1 (2012-05-07)
+
+- Loose requirements to allow installation on Ruby 1.8.7 or greater. You
+  still need RubyGems 1.8.24
+
+## 0.1.0 (2012-05-06)
+
+- Initial public release, extracted from internal project.

data/README.md

@@ -1,20 +1,24 @@
 # gem-compiler
 
-A RubyGems plugin that generates binary pre-compiled gems.
+A RubyGems plugin that generates binary (pre-compiled) gems.
+
+[![Gem Version](https://badge.fury.io/rb/gem-compiler.png)](http://badge.fury.io/rb/gem-compiler)
+[![Build Status](https://travis-ci.org/luislavena/gem-compiler.png?branch=master)](https://travis-ci.org/luislavena/gem-compiler)
+[![Code Climate](https://codeclimate.com/github/luislavena/gem-compiler.png)](https://codeclimate.com/github/luislavena/gem-compiler)
 
 - [home](https://github.com/luislavena/gem-compiler)
 - [bugs](https://github.com/luislavena/gem-compiler/issues)
 
 ## Description
 
-`gem-compiler` is a RubyGems plugin that helps generates binary pre-compiled
-gems from already existing ones without altering the original gem source
-code. It is aimed at the pre-compilation of Ruby C extensions.
+`gem-compiler` is a RubyGems plugin that helps generates binary gems from
+already existing ones without altering the original source code. It compiles
+Ruby C extensions and bundles the result into a new gem.
 
 It uses an *outside-in* approach and leverages on existing RubyGems code to
 do it.
 
-The result of the compilation is a gem built for your current platform,
+The result of the compilation is a binary gem built for your current platform,
 skipping the need of a compiler toolchain when installing it.
 
 ## Installation
@@ -26,15 +30,11 @@ To install gem-compiler you need to use RubyGems:
 Which will fetch and install the plugin. After that the `compile` command
 will be available through `gem`.
 
-## Features
-
-gem-compiler is a one trick pony. It adds a single command `compile` to
-RubyGems.
-
-Using that command, you can generate a binary from an existing gem.
-
 ## Usage
 
+As requirement, gem-compiler can only compile local gems, either one you have
+generated from your projects or previously downloaded.
+
 ### Fetching a gem
 
 If you don't have the gem locally, you can use `fetch` to retrieve it first:
@@ -43,8 +43,8 @@ If you don't have the gem locally, you can use `fetch` to retrieve it first:
     Fetching: yajl-ruby-1.1.0.gem (100%)
     Downloaded yajl-ruby-1.1.0
 
-Please note that I was specific about which gem to fetch. This will avoid
-RubyGems attempt to download any existing pre-compiled gem for my current
+Please note that I was explicit about which platform to fetch. This will
+avoid RubyGems attempt to download any existing binary gem for my current
 platform.
 
 ### Compiling a gem
@@ -54,7 +54,7 @@ You need to tell RubyGems the filename of the gem you want to compile:
     $ gem compile yajl-ruby-1.1.0.gem
 
 The above command will unpack, compile any existing extensions found and
-generate a pre-compiled binary:
+repackage everything as a binary gem:
 
     Unpacking gem: 'yajl-ruby-1.1.0' in temporary directory...
     Building native extensions.  This could take a while...
@@ -63,8 +63,7 @@ generate a pre-compiled binary:
       Version: 1.1.0
       File: yajl-ruby-1.1.0-x86-mingw32.gem
 
-You can now simply install the pre-compiled gem and it will not trigger any
-build process:
+This new gem do not require a compiler, as shown when locally installed:
 
     C:\> gem install --local yajl-ruby-1.1.0-x86-mingw32.gem
     Successfully installed yajl-ruby-1.1.0-x86-mingw32
@@ -72,7 +71,7 @@ build process:
 
 ### Compiling from Rake
 
-Most of the times, as gem developer, you would like to genrate both kind of
+Most of the times, as gem developer, you would like to generate both kind of
 gems at once. For that purpose, you can add a task for Rake similar to the
 one below:
 
@@ -83,8 +82,8 @@ task "gem:native" => ["gem"] do
 end
 ```
 
-Of course, that assumes you have a task `gem` that generates the gem needed
-by this task.
+Of course, that assumes you have a task `gem` that generates the base gem
+required.
 
 ## Requirements
 
@@ -107,8 +106,8 @@ right one.
 ### If you're using Windows
 
 For those using RubyInstaller-based builds, you will need to download the
-DevKit from our [downloads page](http://rubyinstaller.org/downloads) and
-follow the [installation instructions](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
+DevKit from their [downloads page](http://rubyinstaller.org/downloads)
+and follow the [installation instructions](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
 
 To be sure your installation of Ruby is based on RubyInstaller, execute at
 the command prompt:
@@ -141,13 +140,13 @@ projects by snapping your fingers :wink:
 The following are the list of features I would like to implement at some
 point:
 
-* Cross compile gems to any platform that Ruby can run
+- Cross compile gems to any platform that Ruby can run
 (e.g. from Linux/OSX to Windows, x86 to x64, x86 Linux to ARM Linux, etc)
 
-* Create multiple gems from the same build
+- Create multiple gems from the same build
 (e.g. target both x86-mswin32-60 and x86-mingw32)
 
-* Ability to build fat-binaries targeting both Ruby 1.8 and 1.9.x,
+- Ability to build fat-binaries targeting both Ruby 1.8 and 1.9.x,
 placing automatic stubs to handle extension loading.
 
 ## License
@@ -155,7 +154,7 @@ placing automatic stubs to handle extension loading.
 (The MIT License)
 
     Copyright (c) Luis Lavena
-    
+
     Permission is hereby granted, free of charge, to any person obtaining
     a copy of this software and associated documentation files (the
     'Software'), to deal in the Software without restriction, including
@@ -163,10 +162,10 @@ placing automatic stubs to handle extension loading.
     distribute, sublicense, and/or sell copies of the Software, and to
     permit persons to whom the Software is furnished to do so, subject to
     the following conditions:
-    
+
     The above copyright notice and this permission notice shall be
     included in all copies or substantial portions of the Software.
-    
+
     THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

data/lib/rubygems/commands/compile_command.rb

@@ -20,12 +20,12 @@ class Gem::Commands::CompileCommand < Gem::Command
     # no gem, no binary
     unless gemfile
       raise Gem::CommandLineError,
-            "Please specify a gem file on the command line (e.g. #{program_name} foo-0.1.0.gem"
+            "Please specify a gem file on the command line (e.g. #{program_name} foo-0.1.0.gem)"
     end
 
     require "rubygems/compiler"
 
-    compiler = Gem::Compiler.new(gemfile, options[:output])
+    compiler = Gem::Compiler.new(gemfile, options)
     compiler.compile
   end
 end

data/lib/rubygems/compiler.rb

@@ -1,7 +1,13 @@
 require "rbconfig"
 require "tmpdir"
 require "rubygems/installer"
-require "rubygems/builder"
+
+unless Gem::VERSION >= "2.0.0"
+  require "rubygems/builder"
+else
+  require "rubygems/package"
+end
+
 require "fileutils"
 
 class Gem::Compiler
@@ -10,34 +16,16 @@ class Gem::Compiler
   # raise when there is a error
   class CompilerError < Gem::InstallError; end
 
-  def initialize(gemfile, output_dir)
+  attr_reader :tmp_dir, :target_dir, :options
+
+  def initialize(gemfile, _options = {})
     @gemfile    = gemfile
-    @output_dir = output_dir
+    @output_dir = _options.delete(:output)
+    @options    = _options
   end
 
   def compile
-    installer = Gem::Installer.new(@gemfile, :unpack => true)
-
-    # Hmm, gem already compiled?
-    if installer.spec.platform != Gem::Platform::RUBY
-      raise CompilerError,
-            "The gem file seems to be compiled already."
-    end
-
-    # Hmm, no extensions?
-    if installer.spec.extensions.empty?
-      raise CompilerError,
-            "There are no extensions to build on this gem file."
-    end
-
-    tmpdir     = Dir.mktmpdir
-    basename   = File.basename(@gemfile, '.gem')
-    target_dir = File.join(tmpdir, basename)
-
-    # unpack gem sources into target_dir
-    # We need the basename to keep the unpack happy
-    say "Unpacking gem: '#{basename}' in temporary directory..." if Gem.configuration.verbose
-    installer.unpack(target_dir)
+    unpack
 
     # build extensions
     installer.build_extensions
@@ -56,7 +44,7 @@ class Gem::Compiler
       # path needs to be relative to target_dir
       file = path.gsub("#{target_dir}/", "")
 
-      say "Adding '#{file}' to gemspec" if Gem.configuration.really_verbose
+      debug "Adding '#{file}' to gemspec"
       gemspec.files.push file
     end
 
@@ -70,8 +58,11 @@ class Gem::Compiler
     output_gem = nil
 
     Dir.chdir target_dir do
-      builder = Gem::Builder.new(gemspec)
-      output_gem = builder.build
+      output_gem = if defined?(Gem::Builder)
+        Gem::Builder.new(gemspec).build
+      else
+        Gem::Package.build(gemspec)
+      end
     end
 
     unless output_gem
@@ -82,10 +73,57 @@ class Gem::Compiler
     # move the built gem to the original output directory
     FileUtils.mv File.join(target_dir, output_gem), @output_dir
 
-    # cleanup
-    FileUtils.rm_rf tmpdir
+    cleanup
 
     # return the path of the gem
     output_gem
   end
+
+  private
+
+  def info(msg)
+    say msg if Gem.configuration.verbose
+  end
+
+  def debug(msg)
+    say msg if Gem.configuration.really_verbose
+  end
+
+  def installer
+    return @installer if @installer
+
+    @installer = Gem::Installer.new(@gemfile, options.dup.merge(:unpack => true))
+
+    # Hmm, gem already compiled?
+    if @installer.spec.platform != Gem::Platform::RUBY
+      raise CompilerError,
+            "The gem file seems to be compiled already."
+    end
+
+    # Hmm, no extensions?
+    if @installer.spec.extensions.empty?
+      raise CompilerError,
+            "There are no extensions to build on this gem file."
+    end
+
+    @installer
+  end
+
+  def tmp_dir
+    @tmp_dir ||= Dir.mktmpdir
+  end
+
+  def unpack
+    basename    = File.basename(@gemfile, '.gem')
+    @target_dir = File.join(tmp_dir, basename)
+
+    # unpack gem sources into target_dir
+    # We need the basename to keep the unpack happy
+    info "Unpacking gem: '#{basename}' in temporary directory..."
+    installer.unpack(@target_dir)
+  end
+
+  def cleanup
+    FileUtils.rm_rf tmp_dir
+  end
 end

data/rakefile.rb

@@ -3,15 +3,15 @@ require "rubygems/package_task"
 gemspec = Gem::Specification.new do |s|
   # basic
   s.name     = "gem-compiler"
-  s.version  = "0.1.1"
+  s.version  = "0.2.0"
   s.platform = Gem::Platform::RUBY
 
   # description
-  s.summary     = "A RubyGems plugin that generates binary pre-compiled gems."
+  s.summary     = "A RubyGems plugin that generates binary gems."
   s.description = <<-EOF
-A RubyGems plugin that helps generates binary pre-compiled gems from
-already existing ones without altering the original gem source code.
-It is aimed at the pre-compilation of Ruby C extensions.
+A RubyGems plugin that helps generates binary gems from already existing
+ones without altering the original source code. It compiles Ruby C
+extensions and bundles the result into a new gem.
 EOF
 
   # project info
@@ -24,9 +24,35 @@ EOF
   s.required_ruby_version     = ">= 1.8.7"
   s.required_rubygems_version = ">= 1.8.24"
 
+  # development dependencies
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+  s.add_development_dependency 'minitest', '~> 3.2'
+
   # boring part
-  s.files = FileList["README.md", "rakefile.rb", "lib/**/*.rb"]
+  s.files = FileList["README.md", "History.md", "rakefile.rb",
+                      "lib/**/*.rb", "test/**/test*.rb", ".gemtest"]
 end
 
 Gem::PackageTask.new(gemspec) do |pkg|
 end
+
+desc "Run tests"
+task :test do
+  lib_dirs = ["lib", "test"].join(File::PATH_SEPARATOR)
+  test_files = FileList["test/**/test*.rb"].gsub("test/", "")
+
+  puts "Ruby #{RUBY_VERSION}"
+  puts "RubyGems #{Gem::VERSION}"
+
+  ruby "-I#{lib_dirs} -e \"ARGV.each { |f| require f }\" #{test_files}"
+end
+
+desc "Sets up the test environment"
+task :setup do
+  if ENV["USE_RUBYGEMS"]
+    sh "gem update -q --system #{ENV["USE_RUBYGEMS"]}"
+    puts "Using RubyGems #{`gem --version`}"
+  end
+end
+
+task :default => [:test]

data/test/rubygems/test_gem_commands_compile_command.rb

@@ -0,0 +1,22 @@
+require "rubygems/test_case"
+require "rubygems/commands/compile_command"
+
+class TestGemCommandsCompileCommand < Gem::TestCase
+  def setup
+    super
+
+    @cmd = Gem::Commands::CompileCommand.new
+  end
+
+  def test_execute_no_gem
+    @cmd.options[:args] = []
+
+    e = assert_raises Gem::CommandLineError do
+      use_ui @ui do
+        @cmd.execute
+      end
+    end
+
+    assert_match /Please specify a gem file on the command line/, e.message
+  end
+end

data/test/rubygems/test_gem_compiler.rb

@@ -0,0 +1,160 @@
+require "rubygems/test_case"
+require "rubygems/compiler"
+
+class TestGemCompiler < Gem::TestCase
+  def setup
+    super
+
+    @output_dir = File.join @tempdir, 'output'
+    FileUtils.mkdir_p @output_dir
+  end
+
+  def test_compile_no_extensions
+    gem_file = util_bake_gem
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    e = assert_raises Gem::Compiler::CompilerError do
+      use_ui @ui do
+        compiler.compile
+      end
+    end
+
+    assert_equal "There are no extensions to build on this gem file.",
+                  e.message
+  end
+
+  def test_compile_non_ruby
+    gem_file = util_bake_gem { |s| s.platform = Gem::Platform::CURRENT }
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    e = assert_raises Gem::Compiler::CompilerError do
+      use_ui @ui do
+        compiler.compile
+      end
+    end
+
+    assert_equal "The gem file seems to be compiled already.", e.message
+  end
+
+  def test_compile_succeed
+    util_set_arch "i386-mingw32"
+
+    gem_file = util_bake_gem { |spec|
+      util_fake_extension spec
+    }
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    use_ui @ui do
+      compiler.compile
+    end
+
+    out = @ui.output.split "\n"
+
+    assert_match %r|Unpacking gem: 'a-1' in temporary directory...|,
+                  out.shift
+
+    assert_path_exists File.join(@output_dir, "a-1-x86-mingw32.gem")
+  end
+
+  def test_compile_bundle_artifacts
+    util_reset_arch
+
+    artifact = "foo.#{RbConfig::CONFIG["DLEXT"]}"
+
+    gem_file = util_bake_gem("foo") { |s|
+      util_fake_extension s, "foo", util_custom_configure(artifact)
+    }
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+    output_gem = nil
+
+    use_ui @ui do
+      output_gem = compiler.compile
+    end
+
+    assert_path_exists File.join(@output_dir, output_gem)
+    spec = util_read_spec File.join(@output_dir, output_gem)
+
+    assert_includes spec.files, "lib/#{artifact}"
+  end
+
+  ##
+  # Reset RubyGems platform to original one. Useful when testing platform
+  # specific features (like compiled extensions)
+
+  def util_reset_arch
+    util_set_arch @orig_arch
+  end
+
+  ##
+  # Create a real gem and return the path to it.
+
+  def util_bake_gem(name = "a", *extra, &block)
+    files = ["lib/#{name}.rb"].concat(extra)
+
+    spec = new_spec name, "1", nil, files, &block
+
+    File.join @tempdir, "gems", "#{spec.full_name}.gem"
+  end
+
+  ##
+  # Add a fake extension to provided spec and accept an optional script.
+  # Default to no-op if none is provided.
+
+  def util_fake_extension(spec, name = "a", script = nil)
+    mkrf_conf = File.join("ext", name, "mkrf_conf.rb")
+
+    spec.extensions << mkrf_conf
+
+    dir = spec.gem_dir
+    FileUtils.mkdir_p dir
+
+    Dir.chdir dir do
+      FileUtils.mkdir_p File.dirname(mkrf_conf)
+      File.open mkrf_conf, "w" do |f|
+        if script
+          f.write script
+        else
+          f.write <<-EOF
+            File.open 'Rakefile', 'w' do |rf| rf.puts "task :default" end
+          EOF
+        end
+      end
+    end
+  end
+
+  ##
+  # Constructor of custom configure script to be used with
+  # +util_fake_extension+
+  #
+  # Provided +target+ will be used to fake an empty file at default task
+
+  def util_custom_configure(target)
+    <<-EO_MKRF
+      File.open("Rakefile", "w") do |f|
+        f.puts <<-EOF
+          task :default do
+            lib_dir = ENV["RUBYARCHDIR"] || ENV["RUBYLIBDIR"]
+            touch File.join(lib_dir, #{target.inspect})
+          end
+        EOF
+      end
+    EO_MKRF
+  end
+
+  ##
+  # Return the metadata (spec) from the supplied filename. IO from filename
+  # is closed automatically
+
+  def util_read_spec(filename)
+    unless Gem::VERSION >= "2.0.0"
+      io = File.open(filename, "rb")
+      Gem::Package.open(io, "r") { |x| x.metadata }
+    else
+      Gem::Package.new(filename).spec
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-compiler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,45 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
-dependencies: []
-description: ! 'A RubyGems plugin that helps generates binary pre-compiled gems from
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ! 'A RubyGems plugin that helps generates binary gems from already existing
 
-  already existing ones without altering the original gem source code.
+  ones without altering the original source code. It compiles Ruby C
 
-  It is aimed at the pre-compilation of Ruby C extensions.
+  extensions and bundles the result into a new gem.
 
 '
 email: luislavena@gmail.com
@@ -24,10 +56,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- History.md
 - rakefile.rb
 - lib/rubygems/commands/compile_command.rb
 - lib/rubygems/compiler.rb
 - lib/rubygems_plugin.rb
+- test/rubygems/test_gem_commands_compile_command.rb
+- test/rubygems/test_gem_compiler.rb
+- .gemtest
 homepage: https://github.com/luislavena/gem-compiler
 licenses:
 - MIT
@@ -49,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.24
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: A RubyGems plugin that generates binary pre-compiled gems.
+summary: A RubyGems plugin that generates binary gems.
 test_files: []