gem-compiler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59169d53e08c6315d2d6dd219c2ca65998cbaf36
-  data.tar.gz: 409e30463beab8bc6704d453cb19b47071c71e5c
+  metadata.gz: 76146eae5124b2c492cddca593c27b5af3595b2b
+  data.tar.gz: c39f906cd91e03f5ffb85019b2a581ed19508c9b
 SHA512:
-  metadata.gz: c9bcc65c52d554ccf58466a524744ef68b0034ceda7dc48c344ad1979ab10c46e644347fcfdeaac4b50d082fbac5d009d71f513e6cd8386c576a2248b7ed646c
-  data.tar.gz: 6bc96ffa4aa473e9a5382af54ba1105da3b4f6c043285fc621c38a1f37e7e0ef859286df01d597d5f087b842b57985a3ad7c04e71e2f2b4eb05841c6a2a50ce9
+  metadata.gz: 75ba4bcbe505d08fc603da2836b6120e46e66bb06c34892356f87777c5eb6d63dbd797d5d92acd2d7c3e10a39c1f6a54eba04d453a4c39cbbf455c7ee0762efa
+  data.tar.gz: 5b697f3f4a943c76ee58b620ffa7d3babb94e4b6af64f8d05cc25c1fde8b479fd495c103114d8ff436481e79651f4928130f9e7604185a8d246e870caf63b302

data/History.md

@@ -1,5 +1,14 @@
 # gem-compiler
 
+## 0.5.0 (2016-04-24)
+
+- Drop support for any Ruby version prior to 2.0.0
+- Workaround shortname directories on Windows. Thanks to @mbland (#17 & #19)
+- Validate both Ruby and RubyGems versions defined in gemspec
+- Ensure any RubyGems' `pre_install` hooks are run at extension compilation (#18)
+- Lock compile gems to Ruby's ABI version which can be disabled using
+  `--no-abi-lock` option (#11)
+
 ## 0.4.0 (2015-07-18)
 
 - Introduce `--prune` option to cleanup gemspecs. Thanks to @androbtech [#13]

data/README.md

@@ -2,10 +2,10 @@
 
 A RubyGems plugin that generates binary (pre-compiled) gems.
 
-[![Gem Version](https://badge.fury.io/rb/gem-compiler.svg)](http://badge.fury.io/rb/gem-compiler)
-[![Travis status](https://travis-ci.org/luislavena/gem-compiler.svg?branch=master)](https://travis-ci.org/luislavena/gem-compiler)
-[![AppVeyor status](https://ci.appveyor.com/api/projects/status/2mo41n9ltsoe3rn1/branch/master?svg=true)](https://ci.appveyor.com/project/luislavena/gem-compiler/branch/master)
-[![Code Climate](http://img.shields.io/codeclimate/github/luislavena/gem-compiler.svg)](https://codeclimate.com/github/luislavena/gem-compiler)
+[![Gem Version](https://img.shields.io/gem/v/gem-compiler.svg)](https://rubygems.org/gems/gem-compiler)
+[![Travis status](https://img.shields.io/travis/luislavena/gem-compiler/master.svg)](https://travis-ci.org/luislavena/gem-compiler)
+[![AppVeyor status](https://img.shields.io/appveyor/ci/luislavena/gem-compiler/master.svg)](https://ci.appveyor.com/project/luislavena/gem-compiler)
+[![Code Climate](https://img.shields.io/codeclimate/github/luislavena/gem-compiler.svg)](https://codeclimate.com/github/luislavena/gem-compiler)
 
 - [home](https://github.com/luislavena/gem-compiler)
 - [bugs](https://github.com/luislavena/gem-compiler/issues)
@@ -94,6 +94,23 @@ process:
     Successfully installed nokogiri-1.6.6.2-x86_64-darwin-12
     1 gem installed
 
+#### Restrictions of binaries
+
+Gems compiled with `gem-compiler` will be lock to the version of Ruby used
+to compile them.
+
+This means that a gem compiled under Ruby 2.2 could only be installed under
+Ruby 2.2.
+
+You can disable this by using `--no-abi-lock` option during compilation:
+
+    $ gem compile yajl-ruby-1.1.0.gem --no-abi-lock
+
+**Warning**: this is not recommended since different versions of Ruby might
+expose different options on the API. The binary might be expecting specific
+features not present in the version of Ruby you're installing the binary gem
+into.
+
 ### Compiling from Rake
 
 Most of the times, as gem developer, you would like to generate both kind of
@@ -160,20 +177,6 @@ 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](LICENSE)

data/lib/rubygems/commands/compile_command.rb

@@ -8,6 +8,10 @@ class Gem::Commands::CompileCommand < Gem::Command
     add_option "--prune", "Clean non-existing files during re-packaging" do |value, options|
       options[:prune] = true
     end
+
+    add_option "-N", "--no-abi-lock", "Do not lock compiled Gem to Ruby's ABI" do |value, options|
+      options[:no_abi_lock] = true
+    end
   end
 
   def arguments

data/lib/rubygems/compiler.rb

@@ -26,18 +26,24 @@ class Gem::Compiler
   def compile
     unpack
 
-    # build extensions
-    installer.build_extensions
-
-    # determine build artifacts from require_paths
-    dlext    = RbConfig::CONFIG["DLEXT"]
-    lib_dirs = installer.spec.require_paths.join(",")
+    build_extensions
 
-    artifacts = Dir.glob("#{target_dir}/{#{lib_dirs}}/**/*.#{dlext}")
+    artifacts = collect_artifacts
 
     # build a new gemspec from the original one
     gemspec = installer.spec.dup
 
+    adjust_gemspec_files gemspec, artifacts
+
+    # generate new gem and return new path to it
+    repackage gemspec
+  ensure
+    cleanup
+  end
+
+  private
+
+  def adjust_gemspec_files(gemspec, artifacts)
     # remove any non-existing files
     if @options[:prune]
       gemspec.files.reject! { |f| !File.exist?("#{target_dir}/#{f}") }
@@ -46,45 +52,35 @@ class Gem::Compiler
     # add discovered artifacts
     artifacts.each do |path|
       # path needs to be relative to target_dir
-      file = path.gsub("#{target_dir}/", "")
+      file = path.sub("#{target_dir}/", "")
 
       debug "Adding '#{file}' to gemspec"
       gemspec.files.push file
     end
+  end
 
-    # clear out extensions from gemspec
-    gemspec.extensions.clear
-
-    # adjust platform
-    gemspec.platform = Gem::Platform::CURRENT
-
-    # build new gem
-    output_gem = nil
+  def build_extensions
+    # run pre_install hooks
 
-    Dir.chdir target_dir do
-      output_gem = if defined?(Gem::Builder)
-        Gem::Builder.new(gemspec).build
-      else
-        Gem::Package.build(gemspec)
-      end
+    if installer.respond_to?(:run_pre_install_hooks)
+      installer.run_pre_install_hooks
     end
 
-    unless output_gem
-      raise CompilerError,
-            "There was a problem building the gem."
-    end
+    installer.build_extensions
+  end
 
-    # move the built gem to the original output directory
-    FileUtils.mv File.join(target_dir, output_gem), @output_dir
+  def cleanup
+    FileUtils.rm_rf tmp_dir
+  end
 
-    cleanup
+  def collect_artifacts
+    # determine build artifacts from require_paths
+    dlext    = RbConfig::CONFIG["DLEXT"]
+    lib_dirs = installer.spec.require_paths.join(",")
 
-    # return the path of the gem
-    output_gem
+    Dir.glob("#{target_dir}/{#{lib_dirs}}/**/*.#{dlext}")
   end
 
-  private
-
   def info(msg)
     say msg if Gem.configuration.verbose
   end
@@ -104,6 +100,16 @@ class Gem::Compiler
       installer.spec.extension_dir = File.join(@target_dir, "lib")
     end
 
+    # Ensure Ruby version is met
+    if installer.respond_to?(:ensure_required_ruby_version_met)
+      installer.ensure_required_ruby_version_met
+    end
+
+    # Check version of RubyGems (just in case)
+    if installer.respond_to?(:ensure_required_rubygems_version_met)
+      installer.ensure_required_rubygems_version_met
+    end
+
     # Hmm, gem already compiled?
     if installer.spec.platform != Gem::Platform::RUBY
       raise CompilerError,
@@ -119,8 +125,44 @@ class Gem::Compiler
     @installer = installer
   end
 
+  def repackage(gemspec)
+    # clear out extensions from gemspec
+    gemspec.extensions.clear
+
+    # adjust platform
+    gemspec.platform = Gem::Platform::CURRENT
+
+    # adjust version of Ruby
+    unless @options[:no_abi_lock]
+      ruby_abi = RbConfig::CONFIG["ruby_version"]
+      gemspec.required_ruby_version = "~> #{ruby_abi}"
+    end
+
+    # build new gem
+    output_gem = nil
+
+    Dir.chdir target_dir do
+      output_gem = if defined?(Gem::Builder)
+        Gem::Builder.new(gemspec).build
+      else
+        Gem::Package.build(gemspec)
+      end
+    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
+
+    # return the path of the gem
+    output_gem
+  end
+
   def tmp_dir
-    @tmp_dir ||= Dir.mktmpdir
+    @tmp_dir ||= Dir.glob(Dir.mktmpdir).first
   end
 
   def unpack
@@ -132,8 +174,4 @@ class Gem::Compiler
     info "Unpacking gem: '#{basename}' in temporary directory..."
     installer.unpack(@target_dir)
   end
-
-  def cleanup
-    FileUtils.rm_rf tmp_dir
-  end
 end

data/lib/rubygems/compiler/version.rb

@@ -2,6 +2,6 @@
 
 module Gem
   class Compiler
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/test/rubygems/test_gem_compiler.rb

@@ -38,6 +38,60 @@ class TestGemCompiler < Gem::TestCase
     assert_equal "The gem file seems to be compiled already.", e.message
   end
 
+  def test_compile_pre_install_hooks
+    util_reset_arch
+
+    artifact = "foo.#{RbConfig::CONFIG["DLEXT"]}"
+
+    gem_file = util_bake_gem("foo") { |s|
+      util_fake_extension s, "foo", util_custom_configure(artifact)
+    }
+
+    hook_run = false
+
+    Gem.pre_install do |installer|
+      hook_run = true
+      true
+    end
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    use_ui @ui do
+      compiler.compile
+    end
+
+    assert hook_run, "pre_install hook not run"
+  end
+
+  def test_compile_required_ruby
+    gem_file = util_bake_gem("old_required") { |s| s.required_ruby_version = "= 1.4.6" }
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    e = assert_raises Gem::InstallError do
+      use_ui @ui do
+        compiler.compile
+      end
+    end
+
+    assert_equal "old_required requires Ruby version = 1.4.6.", e.message
+  end
+
+  def test_compile_required_rubygems
+    gem_file = util_bake_gem("old_rubygems") { |s| s.required_rubygems_version = "< 0" }
+
+    compiler = Gem::Compiler.new(gem_file, :output => @output_dir)
+
+    e = assert_raises Gem::InstallError do
+      use_ui @ui do
+        compiler.compile
+      end
+    end
+
+    assert_equal "old_rubygems requires RubyGems version < 0. " +
+      "Try 'gem update --system' to update RubyGems itself.", e.message
+  end
+
   def test_compile_succeed
     util_set_arch "i386-mingw32"
 
@@ -109,6 +163,112 @@ class TestGemCompiler < Gem::TestCase
     assert_includes spec.files, "lib/#{artifact}"
   end
 
+  # We need to check that tempdir paths that contain spaces as are handled
+  # properly on Windows. In some cases, Dir.tmpdir may returned shortened
+  # versions of these components, e.g.  "C:/Users/JOHNDO~1/AppData/Local/Temp"
+  # for "C:/Users/John Doe/AppData/Local/Temp".
+  def test_compile_bundle_artifacts_path_with_spaces
+    skip("only necessary to test on Windows") unless Gem.win_platform?
+    old_tempdir = @tempdir
+    old_output_dir = @output_dir
+
+    old_tmp = ENV["TMP"]
+    old_temp = ENV["TEMP"]
+    old_tmpdir = ENV["TMPDIR"]
+
+    # We want to make sure Dir.tmpdir returns the path containing "DIRWIT~1"
+    # so that we're testing whether the compiler expands the path properly. To
+    # do this, "dir with spaces" must not be the last path component.
+    #
+    # This is because Dir.tmpdir calls File.expand_path on ENV[TMPDIR] (or
+    # ENV[TEMP], etc.). When "DIRWIT~1" is the last component,
+    # File.expand_path will expand this to "dir with spaces". When it's not
+    # the last component, it will leave "DIRWIT~1" as-is.
+    @tempdir = File.join(@tempdir, "dir with spaces", "tmp")
+    FileUtils.mkdir_p(@tempdir)
+    @tempdir = File.join(old_tempdir, "DIRWIT~1", "tmp")
+
+    @output_dir = File.join(@tempdir, "output")
+    FileUtils.mkdir_p(@output_dir)
+
+    ["TMP", "TEMP", "TMPDIR"].each { |varname| ENV[varname] = @tempdir }
+
+    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}"
+  ensure
+    if Gem.win_platform?
+      FileUtils.rm_rf @tempdir
+
+      ENV["TMP"] = old_tmp
+      ENV["TEMP"] = old_temp
+      ENV["TMPDIR"] = old_tmpdir
+
+      @tempdir = old_tempdir
+      @output_dir = old_output_dir
+    end
+  end
+
+  def test_compile_lock_ruby_abi
+    util_reset_arch
+
+    ruby_abi = RbConfig::CONFIG["ruby_version"]
+    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
+
+    spec = util_read_spec File.join(@output_dir, output_gem)
+
+    assert_equal spec.required_ruby_version, Gem::Requirement.new("~> #{ruby_abi}")
+  end
+
+  def test_compile_no_lock_ruby_abi
+    util_reset_arch
+
+    ruby_abi = RbConfig::CONFIG["ruby_version"]
+    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, :no_abi_lock => true)
+    output_gem = nil
+
+    use_ui @ui do
+      output_gem = compiler.compile
+    end
+
+    spec = util_read_spec File.join(@output_dir, output_gem)
+
+    assert_equal spec.required_ruby_version, Gem::Requirement.new(">= 0")
+  end
+
   ##
   # Reset RubyGems platform to original one. Useful when testing platform
   # specific features (like compiled extensions)

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: gem-compiler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Luis Lavena
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-19 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.8'
 description: |
   A RubyGems plugin that helps generates binary gems from already existing
   ones without altering the original source code. It compiles Ruby C
@@ -47,12 +47,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - History.md
+- README.md
 - Rakefile
 - lib/rubygems/commands/compile_command.rb
-- lib/rubygems/compiler/version.rb
 - lib/rubygems/compiler.rb
+- lib/rubygems/compiler/version.rb
 - lib/rubygems_plugin.rb
 - test/rubygems/test_gem_commands_compile_command.rb
 - test/rubygems/test_gem_compiler.rb
@@ -66,17 +66,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.8.24
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A RubyGems plugin that generates binary gems.