gem-compiler 0.1.0

data/README.md

@@ -0,0 +1,176 @@
+# gem-compiler
+
+A RubyGems plugin that generates binary pre-compiled gems.
+
+- [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.
+
+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,
+skipping the need of a compiler toolchain when installing it.
+
+## Installation
+
+To install gem-compiler you need to use RubyGems:
+
+    $ gem install gem-compiler
+
+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
+
+### Fetching a gem
+
+If you don't have the gem locally, you can use `fetch` to retrieve it first:
+
+    $ gem fetch yajl-ruby --platform=ruby
+    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
+platform.
+
+### Compiling a gem
+
+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:
+
+    Unpacking gem: 'yajl-ruby-1.1.0' in temporary directory...
+    Building native extensions.  This could take a while...
+      Successfully built RubyGem
+      Name: yajl-ruby
+      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:
+
+    C:\> gem install --local yajl-ruby-1.1.0-x86-mingw32.gem
+    Successfully installed yajl-ruby-1.1.0-x86-mingw32
+    1 gem installed
+
+### Compiling from Rake
+
+Most of the times, as gem developer, you would like to genrate both kind of
+gems at once. For that purpose, you can add a task for Rake similar to the
+one below:
+
+```ruby
+desc "Generate a pre-compiled native gem"
+task "gem:native" => ["gem"] do
+  sh "gem compile #{gem_file}"
+end
+```
+
+Of couse, that assusems you have a task `gem` that generates the gem needed
+by this task.
+
+## Requirements
+
+### Ruby and RubyGems
+
+It's assumed you have Ruby and RubyGems installed. gem-compiler requires
+RubyGems 1.8.x to properly work.
+
+If you don't have RubyGems 1.8.x, you can upgrade by running:
+
+    $ gem update --system
+
+### A compiler
+
+In order to compile a gem, you need a compiler toolchain installed. Depending
+on your Operating System you will have one already installed or will require
+additional steps to do it. Check your OS documentation about getting the
+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).
+
+To be sure your installation of Ruby is based on RubyInstaller, execute at
+the command prompt:
+
+    C:\> ruby --version
+
+And from the output:
+
+    tcs-ruby 1.9.3p196 (2012-04-21, TCS patched 2012-04-21) [i386-mingw32]
+
+If you see `mingw32`, that means you're using a RubyInstaller build
+(MinGW based).
+
+## Differences with rake-compiler
+
+[rake-compiler](https://github.com/luislavena/rake-compiler) has provided to
+Ruby library authors a *tool* for compiling extensions and generating binary
+gems of their libraries.
+
+You can consider rake-compiler's approach be an *inside-out* process. To do
+its magic, it requires library authors to modify their source code, adjust
+some structure and learn a series of commands.
+
+While the ideal scenario is using a tool like rake-compiler that endorses
+*convention over configuration*, is not humanly possible change all the
+projects by snapping your fingers :wink:
+
+## What is missing
+
+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
+(e.g. from Linux/OSX to Windows, x86 to x64, x86 Linux to ARM Linux, etc)
+
+* 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,
+placing automatic stubs to handle extension loading.
+
+## License
+
+(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
+    without limitation the rights to use, copy, modify, merge, publish,
+    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.
+    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/rubygems/commands/compile_command.rb

@@ -0,0 +1,31 @@
+require "rubygems/command"
+
+class Gem::Commands::CompileCommand < Gem::Command
+  def initialize
+    super "compile", "Create binary pre-compiled gem",
+      :output => Dir.pwd
+  end
+
+  def arguments
+    "GEMFILE       path to the gem file to compile"
+  end
+
+  def usage
+    "#{program_name} GEMFILE"
+  end
+
+  def execute
+    gemfile = options[:args].shift
+
+    # 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"
+    end
+
+    require "rubygems/compiler"
+
+    compiler = Gem::Compiler.new(gemfile, options[:output])
+    compiler.compile
+  end
+end

data/lib/rubygems/compiler.rb

@@ -0,0 +1,91 @@
+require "rbconfig"
+require "tmpdir"
+require "rubygems/installer"
+require "rubygems/builder"
+require "fileutils"
+
+class Gem::Compiler
+  include Gem::UserInteraction
+
+  # raise when there is a error
+  class CompilerError < Gem::InstallError; end
+
+  def initialize(gemfile, output_dir)
+    @gemfile    = gemfile
+    @output_dir = output_dir
+  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)
+
+    # build extensions
+    installer.build_extensions
+
+    # determine build artifacts from require_paths
+    dlext    = RbConfig::CONFIG["DLEXT"]
+    lib_dirs = installer.spec.require_paths.join(",")
+
+    artifacts = Dir.glob("#{target_dir}/{#{lib_dirs}}/**/*.#{dlext}")
+
+    # build a new gemspec from the original one
+    gemspec = installer.spec.dup
+
+    # add discovered artifacts
+    artifacts.each do |path|
+      # path needs to be relative to target_dir
+      file = path.gsub("#{target_dir}/", "")
+
+      say "Adding '#{file}' to gemspec" if Gem.configuration.really_verbose
+      gemspec.files.push file
+    end
+
+    # clear out extensions from gemspec
+    gemspec.extensions.clear
+
+    # adjust platform
+    gemspec.platform = Gem::Platform::CURRENT
+
+    # build new gem
+    output_gem = nil
+
+    Dir.chdir target_dir do
+      builder = Gem::Builder.new(gemspec)
+      output_gem = builder.build
+    end
+
+    unless output_gem
+      raise CompilerError,
+            "There was a problem building the gem."
+    end
+
+    # move the built gem to the original output directory
+    FileUtils.mv File.join(target_dir, output_gem), @output_dir
+
+    # cleanup
+    FileUtils.rm_rf tmpdir
+
+    # return the path of the gem
+    output_gem
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,2 @@
+require "rubygems/command_manager"
+Gem::CommandManager.instance.register_command :compile

data/rakefile.rb

@@ -0,0 +1,32 @@
+require "rubygems/package_task"
+
+gemspec = Gem::Specification.new do |s|
+  # basic
+  s.name     = "gem-compiler"
+  s.version  = "0.1.0"
+  s.platform = Gem::Platform::RUBY
+
+  # description
+  s.summary     = "A RubyGems plugin that generates binary pre-compiled 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.
+EOF
+
+  # project info
+  s.homepage = "https://github.com/luislavena/gem-compiler"
+  s.licenses = ["MIT"]
+  s.author   = "Luis Lavena"
+  s.email    = "luislavena@gmail.com"
+
+  # requirements
+  s.required_ruby_version     = ">= 1.9.3"
+  s.required_rubygems_version = ">= 1.8.24"
+
+  # boring part
+  s.files = FileList["README.md", "rakefile.rb", "lib/**/*.rb"]
+end
+
+Gem::PackageTask.new(gemspec) do |pkg|
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: gem-compiler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Luis Lavena
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-06 00:00:00.000000000 Z
+dependencies: []
+description: ! '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.
+
+'
+email: luislavena@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- rakefile.rb
+- lib/rubygems/commands/compile_command.rb
+- lib/rubygems/compiler.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/luislavena/gem-compiler
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.24
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A RubyGems plugin that generates binary pre-compiled gems.
+test_files: []