rubygems-precompiled 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 437a696f3109133c285f30281afb05a3a774ab5c
-  data.tar.gz: 1068539b91ba04f83dbd865c24aacbb048a0af00
+  metadata.gz: a0e5cac9e19549ede238139f4fda54ccc3fd8d1c
+  data.tar.gz: 0fc7264556763bd4bc0499324356b26e116abb24
 SHA512:
-  metadata.gz: 72e124fac7166f9528fd155452d89d8aa263db8dd8a859113af2e4c874124b0758afd1ec15a1be0f06c2c675481f5e23d0baf478e5b4960863f7c5807aa70537
-  data.tar.gz: 40ff597a7dbd0190c05aac335ad6cda38c6bf2b01a69d44568a69a1737a70913e88fbeb2123584a92a6e6ed338be3a6fc2188c7c233c7fb1fcbdd505a5357157
+  metadata.gz: a38e2d35832ad3bcbf2a8a09985aa2f26b137b4ec7e83c902c8c2cbe1740623455e317b9ed43a5a21e83f5587b5710c0683ffa6d69b902fc065f6983cf35de7b
+  data.tar.gz: a67172765f91f0cc7f2a93603e62e1130cb36b2847254e8a33b95bdd64e2680b6f9b090d6b3b1c6fe0ef30365ea27b4a06ed2cb304bd0b8d7d22cf5ff8c06609

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 .bundle
 .config

data/.ruby-version

@@ -0,0 +1 @@
+2.1.8

data/README.md

@@ -38,5 +38,16 @@ Install a gem using the cache:
 
     gem install foobar -v '0.1.0'
 
+### Running the tests
 
+There are a couple of simple cucumber specs that exercise the plugin via the current version of rubygems. You can run them via:
+
+    bundle
+    bundle exec cucumber
+
+When doing this, ensure you don't have either the simple_gem or compiled_gem installed locally, as this will inevitably confuse poor rubygems.
+
+#### Fixture gems
+The sources to build the gems used in the test are included in the gem-sources.tar.gz file in the fixtures directory. If you need to change these you will have to extract
+the file modify the sources and re-create the .tar.gz archive, as well as putting the new gems in place in the fixtures directory.
 

data/features/installing_with_cache.feature

@@ -23,6 +23,7 @@ Feature: Installing using a compiled-cache
 
     Then I should see "Hello, world!"
 
+  # this works in reality but the test is dodgy on ruby 2. Needs investment in time to fix
   Scenario: Installing a compiled gem with a cache hit
     Given I use the gem configuration option
       """

data/features/precompiling_gems.feature

@@ -4,7 +4,7 @@ Feature: Pre-compiling gems
     Given I have changed to a temporary directory containing "spec/fixtures/*.gem"
 
   Scenario: Input validation
-    When I run the command "gem precompile"
+    When I run the command "gem precompile" ignoring the exit code
     Then I should see "Please specify a gem file on the command line, e.g. gem precompile foo-0.1.0.gem"
     And the command should not return a success status code
 
@@ -20,11 +20,25 @@ Feature: Pre-compiling gems
     Then I should see "Compiling 'compiled-gem'..."
     And the command should return a success status code
 
+  Scenario: Pre-compiling a single compiled gem with the --noclean options
+    When I run the command "gem precompile --noclean compiled-gem.gem"
+
+    Then I should see "Leaving"
+    And the command should leave behind temporary directories
+    And the command should return a success status code
+
+  Scenario: Pre-compiling a single compiled gem with --build-config
+    When I run the command "gem precompile --verbose --build-config='--foo --bar' compiled-gem.gem"
+
+    Then I should see "build-args --foo --bar"
+    And the command should return a success status code
+
   Scenario: Pre-compiling multiple gems
     When I run the command "gem precompile *.gem"
 
     Then I should see "The gem 'simple-gem' doesn't contain a compiled extension"
-    And I should see "Compiling 'compiled-gem'... done."
+    And I should see "Compiling 'compiled-gem'..."
+    And I should see "done."
     And the command should return a success status code
 
   Scenario: Creating the flat output files

data/features/steps/command_steps.rb

@@ -17,7 +17,8 @@ After do
 end
 
 def execute(command)
-    @last_stderr, @last_stdout = "", ""
+  $stderr.puts "Executing '#{command}'"
+  @last_stderr, @last_stdout = "", ""
 
   stderr_r, stderr_w, stdout_r, stdout_w = [IO.pipe, IO.pipe].flatten
   @command_env ||= {}
@@ -30,13 +31,18 @@ def execute(command)
   @last_status = status.exitstatus
   @last_stderr += stderr_r.read until stderr_r.eof?
   @last_stdout += stdout_r.read until stdout_r.eof?
+
+  puts @last_stderr
 end
 
-When /^I (?:run the command|execute) "(.*?)"$/ do |command|
+When /^I (?:run the command|execute) "(.*?)"( ignoring the exit code)?$/ do |command,ignore_exit_code|
   execute(command)
+  raise RuntimeError, "Command '#{command}' exited with non-zero exit status" unless ignore_exit_code or @last_status == 0
+
 end
 When /^I (?:run the command|execute)$/ do |command|
     execute(command)
+    raise RuntimeError, "Command '#{command}' exited with non-zero exit status" unless @last_status == 0
 end
 
 Then /^I should( not)? see "(.*?)"( on (stdout|stderr))?$/ do |invert, expect, any, channel|
@@ -55,6 +61,15 @@ Then /^I should( not)? see "(.*?)"( on (stdout|stderr))?$/ do |invert, expect, a
   end
 end
 
+Then /^the command should leave behind temporary directories/ do
+  data = @last_stdout + @last_stderr
+  data.each_line do |l|
+    if m = l.match(/Leaving (.*) in place/)
+      expect(Dir.exists?(m[1])).to be_true
+    end
+  end
+end
+
 Then /^the command should( not)? return a success status code$/ do |invert|
   if invert
     @last_status.should_not == 0

data/lib/rubygems/commands/precompile_command.rb

@@ -1,4 +1,5 @@
 require "rubygems/command"
+require "shellwords"
 
 class Gem::Commands::PrecompileCommand < Gem::Command
   def initialize
@@ -11,6 +12,14 @@ class Gem::Commands::PrecompileCommand < Gem::Command
     add_option('-a','--arch-dirs','Adds the architecture sub-folders to the output directory before writing') do |arch, options|
       options[:arch] = true
     end
+
+    add_option('-n','--noclean','do not clean up tempdirs, leaves temp dirs in place etc for inspection and debugging') do |noclean, options|
+      options[:debug] = true
+    end
+
+    add_option('-b','--build-config=CONFIG','commands to pass to the build i.e the run of extconf.rb') do |config, options|
+      options[:build_config] = Shellwords.split(config)
+    end
   end
 
   def arguments
@@ -34,7 +43,7 @@ class Gem::Commands::PrecompileCommand < Gem::Command
     gemfiles.each do |gemfile|
       compiler = Gem::Precompiler.new(gemfile, options)
       if compiler.has_extension?
-        $stderr.puts "Compiling '#{compiler.gem_name}'... "
+        $stderr.write "Compiling '#{compiler.gem_name}'... "
         compiler.compile
         $stderr.puts "done."
       else
@@ -42,4 +51,4 @@ class Gem::Commands::PrecompileCommand < Gem::Command
       end
     end
   end
-end
+end

data/lib/rubygems/precompiled.rb

@@ -8,7 +8,12 @@ require 'net/http'
 require 'uri'
 require 'tempfile'
 
-class Gem::Installer
+module Precompiled
+
+  def self.included(base)
+    base.send(:alias_method, :build_extensions_without_cache, :build_extensions)
+    base.send(:alias_method, :build_extensions, :build_extensions_with_cache)
+  end
 
   class BaseCache
     def initialize(root_uri)
@@ -69,7 +74,7 @@ class Gem::Installer
     'http' => HttpCache
   }.freeze
 
-  # Private: A list of precompiled cache root URLs loaded from the rubyges configuration file
+  # Private: A list of precompiled cache root URLs loaded from the rubygems configuration file
   #
   # Returns Array of BaseCache subclasses
   def self.precompiled_caches
@@ -80,27 +85,28 @@ class Gem::Installer
   end
 
   def build_extensions_with_cache
-    cache = Gem::Installer.precompiled_caches.find { |cache| cache.contains?(@spec) }
+    cache = Precompiled.precompiled_caches.find { |cache| cache.contains?(@spec) }
 
     if cache
-      puts "Loading native extension from cache"
+      $stderr.puts "Loading native extension from cache"
       cache.retrieve(@spec) do |path|
-        overlay_tarball(path)
+        if @spec.respond_to?(:extension_dir)
+          overlay_tarball(path, @spec.extension_dir)
+        else
+          overlay_tarball(path, @gem_dir)
+        end
       end
     else
       build_extensions_without_cache
     end
   end
 
-  alias_method :build_extensions_without_cache, :build_extensions
-  alias_method :build_extensions, :build_extensions_with_cache
-
   # Private: Extracts a .tar.gz file on-top of the gem's installation directory
-  def overlay_tarball(tarball)
+  def overlay_tarball(tarball, target_root)
     Zlib::GzipReader.open(tarball) do |gzip_io|
       Gem::Package::TarReader.new(gzip_io) do |tar|
         tar.each do |entry|
-          target_path = File.join(gem_dir, entry.full_name)
+          target_path = File.join(target_root, entry.full_name)
           if entry.directory?
             FileUtils.mkdir_p(target_path)
           elsif entry.file?
@@ -111,8 +117,10 @@ class Gem::Installer
           end
           entry.close
         end
-      end
+       end
     end
   end
 
-end
+end
+
+Gem::Installer.send(:include, Precompiled)

data/lib/rubygems/precompiled/version.rb

@@ -1,5 +1,5 @@
 module Rubygems
   module Precompiled
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/rubygems/precompiler.rb

@@ -6,38 +6,80 @@ require 'rubygems/package/tar_writer'
 require 'zlib'
 require 'pathname'
 
+
 class Gem::Precompiler
   include FileUtils
 
   def initialize(gemfile, opts = {})
-    @installer = Gem::Installer.new(gemfile, opts.dup.merge(:unpack => true))
+    @installer = Gem::Installer.new(gemfile, opts.dup.merge(:unpack => true, :build_args => opts.fetch(:build_config,[])))
+    @spec = @installer.spec
+
     @target_dir = opts.fetch(:output, Dir.pwd)
     @target_dir = File.join(@target_dir, arch_string) if opts.fetch(:arch, false)
+    @debug = opts.fetch(:debug, false)
     @options = opts
+
+    # This writes out a build_info file that the extension builder will process to set the
+    # build configuration. We use the write_build_info_file method which should work on ruby 2+
+    # on ruby  < 1.9.3 we don't support setting of build options. 1.9.3 is EOL.
+    # However most simple gems that do not require build time config will still work.
+    return if opts.fetch(:build_config,[]).empty?
+
+    if Gem::Installer.method_defined?(:write_build_info_file)
+      @installer.write_build_info_file
+    else
+      puts("Older version of rubygems, rubygems-precompiled does not support build options on this rubygems release (pull req welcome)")
+      puts("Try again without build configuration")
+      exit(1)
+    end
+  end
+
+  # Private: Extracts the gem files into the specified path
+  #
+  def extract_files_into(dir)
+    @installer.unpack(dir)
   end
 
-  # Public: Returns the name of hte gem
+  # Public: Returns the name of the gem
   #
   # Returns a string
   def gem_name
-    @installer.spec.name
+    @spec.name
+  end
+
+  # Public: Returns the version string of the gem
+  #
+  # Returns a Gem::Version
+  def gem_version
+    @spec.version
+  end
+
+  # Public: Returns the relative require-paths specified by the gem
+  #
+  # Returns an array of strings
+  def gem_require_paths
+    @spec.require_paths
   end
 
   # Public: Does the gem actually have any compiled extensions?
   #
   # Returns boolean - true if the gem has a c-extension that needs building
   def has_extension?
-    !@installer.spec.extensions.empty?
+    !@spec.extensions.empty?
   end
 
   # Private: Yield the path to a temporary directory that will get deleted when
-  # the block returns
+  # the block returns, unless debug option was used on the cli
   #
   def tempdir
     temp_dir = Dir.mktmpdir
     yield temp_dir
   ensure
-    rm_rf temp_dir
+    if @debug
+      puts("\nLeaving #{temp_dir} in place")
+    else
+      rm_rf temp_dir
+    end
   end
 
   # Private: Return a string that uniquely keys this machines ruby version and architecture
@@ -51,31 +93,61 @@ class Gem::Precompiler
   #
   # Returns a string
   def output_path
-    File.join(*[@target_dir, "#{@installer.spec.name}-#{@installer.spec.version}.tar.gz"].compact)
+    File.join(*[@target_dir, "#{gem_name}-#{gem_version.to_s}.tar.gz"].compact)
   end
 
-  # Private: Return a list fo build-products in a given directory
+  # Private: Calls the code necessary to build all the extensions
+  # into a specified install root
   #
-  # Returns an array of paths
-  def build_products(installer, path)
-    dlext = RbConfig::CONFIG["DLEXT"]
-    lib_dirs = installer.spec.require_paths.join(',')
-    Dir.glob("#{path}/{#{lib_dirs}}/**/*.#{dlext}")
+  # Returns a list of files beneath that root making up the build
+  # products of the extensions
+  #
+  def build_extensions(install_root)
+    if @spec.respond_to?(:extension_dir=)
+      tempdir do |workroot|
+        extract_files_into(workroot)
+
+        # override the full_gem_path function so we can return
+        # the directory we want. Otherwise by default the build process will
+        # look for the gem installed in the usual place won't find it and will then
+        # bail
+        class <<@spec
+          attr_accessor :workroot
+          def full_gem_path
+            return workroot
+          end
+        end
+        @spec.workroot = workroot
+
+        @spec.extension_dir = install_root
+        @spec.installed_by_version = Gem::VERSION
+        @spec.build_extensions
+        Dir.glob(File.join(install_root, "**", "*"))
+      end
+    else
+      extract_files_into(install_root)
+      @installer.build_extensions
+
+      dlext = RbConfig::CONFIG["DLEXT"]
+      lib_dirs = gem_require_paths.join(',')
+      Dir.glob("#{install_root}/{#{lib_dirs}}/**/*.#{dlext}")
+    end
   end
 
+
   # Public: Compile
   #
+  # This compiles into a temporary file, then moves into place. Otherwise we potentially confuse
+  # the gem installer with partial files!
   #
   def compile
-    FileUtils.mkdir_p(@target_dir)
-
+    temp_output = Tempfile.new('partial-output')
     tempdir do |path|
-      @installer.unpack(path)
-      @installer.build_extensions
 
-      targz_file(output_path) do |tar_writer|
+      targz_file(temp_output) do |tar_writer|
 
-        build_products(@installer, path).each do |product_path|
+        build_extensions(path).each do |product_path|
+          next if File.directory?(product_path)
           product_path = Pathname.new(product_path)
           relative_path = product_path.relative_path_from(Pathname.new(path))
 
@@ -94,6 +166,9 @@ class Gem::Precompiler
 
       end
     end
+
+    FileUtils.mkdir_p(@target_dir)
+    FileUtils.mv(temp_output.path, output_path)
   end
 
   # Private: Yield a reference to a TarWriter that writes to

data/lib/rubygems_plugin.rb

@@ -2,3 +2,4 @@ require 'rubygems/precompiled'
 require 'rubygems/command_manager'
 
 Gem::CommandManager.instance.register_command :precompile
+

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-precompiled
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Thomas Haggett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: RubyGems plugin to allow a gem's compiled extension to be pre-built and
@@ -74,7 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,7 +91,9 @@ files:
 - lib/rubygems/precompiler.rb
 - lib/rubygems_plugin.rb
 - rubygems-precompiled.gemspec
+- spec/fixtures/compiled-gem.gem
 - spec/fixtures/gem-sources.tar.gz
+- spec/fixtures/simple-gem.gem
 homepage: https://github.com/joshado/rubygems-precompiled
 licenses:
 - MIT
@@ -101,17 +104,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: RubyGems plugin to allow a gem's compiled extension to be pre-built and cached
@@ -121,4 +124,6 @@ test_files:
 - features/steps/command_steps.rb
 - features/steps/file_steps.rb
 - features/steps/rubygem_steps.rb
+- spec/fixtures/compiled-gem.gem
 - spec/fixtures/gem-sources.tar.gz
+- spec/fixtures/simple-gem.gem