thermite 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39f322b4da859f7e40da6a34e28af9cece1266d1
-  data.tar.gz: f185a33fa330c7e8e9bd79f3b6e006a8a64dc5f9
+  metadata.gz: 9902385f6d7c70426db6c25fabe306a29034e7fc
+  data.tar.gz: 4618e00a6dfb06afef4ab73675b9f45bdf892b7b
 SHA512:
-  metadata.gz: 27c5e1722048accc76e5cc6f92609aaf1e2a83188d4a19953158fb67d95b0de30333919d8acecf6604f08768ea84379d34878344af462cda96e4999ccd480acd
-  data.tar.gz: 1442ca9c640268a5905ffce5735f23e8b77680253c342ae242ca7e5a633b3d44a29da8f6f051b6fbb9e14eafd3780e1c05992e6755c7eaed75d3d629f9f6c076
+  metadata.gz: 68aa59bb0dc5129afc1cd63d56ccf6e10de7ea30199dddda075edcc2d3320563ab6a0dc73ef86862cbd49e02664e07cc90ce3060ffa115f635124a8c0eddb708
+  data.tar.gz: 0391dce454f1da154121078fb9edf3ffbadecc11294e443a2dbcf09ec2a7a2056e366cf61ec6a54b6ed7e80ed323cd23236b9dfcbc55a0427d211a2270b0c9c2

data/.rubocop.yml

@@ -9,6 +9,7 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Exclude:
   - 'test/**/*'
+  Max: 150
 
 Metrics/LineLength:
   Max: 100

data/.travis.yml

@@ -8,7 +8,9 @@ rvm:
 - 2.2.5
 - 2.3.1
 cache: bundler
-after_success: ci/after_success.py
+after_success:
+- bundle exec codeclimate-test-reporter
+- ci/after_success.py
 env:
   global:
   # TRAVIS_TOKEN

data/CONTRIBUTING.md

@@ -22,7 +22,7 @@ When filing a bug, please include the following information:
 * If it's an error related to Rust, the version of Rust, Cargo, and how you installed it.
 * A detailed list of steps to reproduce the bug. A minimal testcase would be very helpful,
   if possible.
-* If there any any error messages in the console, copying them in the bug summary will be
+* If there are any error messages in the console, copying them in the bug summary will be
   very helpful.
 
 ## Filing Pull Requests

data/Gemfile

@@ -4,7 +4,7 @@
 source 'https://rubygems.org'
 
 group :test do
-  gem 'codeclimate-test-reporter', require: nil
+  gem 'codeclimate-test-reporter', '~> 1.0', require: nil
   gem 'simplecov', require: nil
 end
 

data/NEWS.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## [0.8.0] - 2016-12-05
+
+### Added
+
+* Support for binary download URIs from non-GitHub sources (#17)
+
+### Changed
+
+* Tarballs are installed relative to `ruby_project_path`
+
 ## [0.7.0] - 2016-09-26
 
 ### Added

data/README.md

@@ -14,6 +14,7 @@ Thermite is a Rake-based helper for building and distributing Rust-based Ruby ex
 * Provides wrappers for `cargo` commands.
 * Handles non-standard `cargo` installations via the `CARGO` environment variable.
 * Opt-in to allow users to install pre-compiled Rust extensions hosted on GitHub releases.
+* Opt-in to allow users to install pre-compiled Rust extensions hosted on a third party server.
 * Provides a wrapper for initializing a Rust extension via Fiddle.
 
 ## Usage
@@ -49,7 +50,7 @@ Thermite is a Rake-based helper for building and distributing Rust-based Ruby ex
   end
   ```
 
-Run `rake -T` to view all of the available tasks in the `thermite` namespace.
+Run `rake -T thermite` to view all of the available tasks in the `thermite` namespace.
 
 ### Configuration
 
@@ -68,6 +69,13 @@ github_releases = true
 
 Possible options:
 
+* `binary_uri_format` - if set, the interpolation-formatted string used to construct the download
+  URI for the pre-built native extension. If the environment variable `THERMITE_BINARY_URI_FORMAT`
+  is set, it takes precedence over this option. Either method of setting this option overrides the
+  `github_releases` option.
+  Example: `https://example.com/download/%{version}/%{filename}`. Replacement variables:
+    - `filename` - The value of `Config.tarball_filename`
+    - `version` - the crate version from `Cargo.toml`
 * `cargo_project_path` - the path to the Cargo project. Defaults to the current working directory.
 * `github_releases` - whether to look for Rust binaries via GitHub releases when installing
   the gem, and `cargo` is not found. Defaults to `false`.

data/lib/thermite/config.rb

@@ -58,6 +58,17 @@ module Thermite
       end
     end
 
+    #
+    # The interpolation-formatted string used to construct the download URI for the pre-built
+    # native extension. Can be set via the `THERMITE_BINARY_URI_FORMAT` environment variable, or a
+    # `binary_uri_format` option.
+    #
+    def binary_uri_format
+      @binary_uri_format ||= ENV['THERMITE_BINARY_URI_FORMAT'] ||
+                             @options[:binary_uri_format] ||
+                             false
+    end
+
     #
     # The major and minor version of the Ruby interpreter that's currently running.
     #
@@ -180,6 +191,13 @@ module Thermite
       @toml ||= Tomlrb.load_file(rust_path('Cargo.toml'), symbolize_keys: true)
     end
 
+    #
+    # Alias to the crate version specified in the TOML file.
+    #
+    def crate_version
+      toml[:package][:version]
+    end
+
     #
     # The Thermite-specific config from the TOML file.
     #

data/lib/thermite/custom_binary.rb

@@ -0,0 +1,65 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+#
+# Copyright (c) 2016 Mark Lee and contributors
+#
+# 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.
+
+require 'net/http'
+require 'uri'
+
+module Thermite
+  #
+  # Custom binary URI helpers.
+  #
+  module CustomBinary
+    #
+    # Downloads a Rust binary using a custom URI format, given the target OS and architecture.
+    #
+    # Requires the `binary_uri_format` option to be set. The version of the binary is determined by
+    # the crate version given in `Cargo.toml`.
+    #
+    # Returns whether a binary was found and unpacked.
+    #
+    def download_binary_from_custom_uri
+      return false unless config.binary_uri_format
+
+      version = config.crate_version
+      uri ||= config.binary_uri_format % {
+        filename: config.tarball_filename(version),
+        version: version
+      }
+
+      return false unless (tgz = download_versioned_binary(uri, version))
+
+      debug "Unpacking binary from Cargo version: #{File.basename(uri)}"
+      unpack_tarball(tgz)
+      true
+    end
+
+    private
+
+    def download_versioned_binary(uri, version)
+      unless ENV.key?('THERMITE_TEST')
+        # :nocov:
+        puts "Downloading compiled version (#{version})"
+        # :nocov:
+      end
+
+      http_get(uri)
+    end
+  end
+end

data/lib/thermite/github_release_binary.rb

@@ -40,7 +40,7 @@ module Thermite
     #
     # Returns whether a binary was found and unpacked.
     #
-    def download_binary
+    def download_binary_from_github_release
       return false unless options[:github_releases]
 
       case options[:github_release_type]
@@ -54,10 +54,10 @@ module Thermite
     private
 
     def download_cargo_version_from_github_release
-      version = config.toml[:package][:version]
+      version = config.crate_version
       tag = options.fetch(:git_tag_format, 'v%s') % version
       uri = github_download_uri(tag, version)
-      return unless (tgz = download_binary_from_github_release(uri, version))
+      return false unless (tgz = download_versioned_github_release_binary(uri, version))
 
       debug "Unpacking GitHub release from Cargo version: #{File.basename(uri)}"
       unpack_tarball(tgz)
@@ -71,7 +71,7 @@ module Thermite
     def download_latest_binary_from_github_release
       installed_binary = false
       each_github_release(github_uri) do |version, download_uri|
-        tgz = download_binary_from_github_release(download_uri, version)
+        tgz = download_versioned_github_release_binary(download_uri, version)
         next unless tgz
         debug "Unpacking GitHub release: #{File.basename(download_uri)}"
         unpack_tarball(tgz)
@@ -90,12 +90,6 @@ module Thermite
       "#{github_uri}/releases/download/#{tag}/#{config.tarball_filename(version)}"
     end
 
-    # :nocov:
-    def http_get(uri)
-      Net::HTTP.get(URI(uri))
-    end
-    # :nocov:
-
     def each_github_release(github_uri)
       releases_uri = "#{github_uri}/releases.atom"
       feed = REXML::Document.new(http_get(releases_uri))
@@ -108,20 +102,14 @@ module Thermite
       end
     end
 
-    def download_binary_from_github_release(uri, version)
-      case (response = Net::HTTP.get_response(URI(uri)))
-      when Net::HTTPClientError
-        nil
-      when Net::HTTPServerError
-        raise Net::HTTPServerException.new(response.message, response)
-      else
-        unless ENV.key?('THERMITE_TEST')
-          # :nocov:
-          puts "Downloading latest compiled version (#{version}) from GitHub"
-          # :nocov:
-        end
-        StringIO.new(http_get(response['location']))
+    def download_versioned_github_release_binary(uri, version)
+      unless ENV.key?('THERMITE_TEST')
+        # :nocov:
+        puts "Downloading compiled version (#{version}) from GitHub"
+        # :nocov:
       end
+
+      http_get(uri)
     end
   end
 end

data/lib/thermite/package.rb

@@ -45,15 +45,25 @@ module Thermite
     # working directory.
     #
     def unpack_tarball(tgz)
+      Dir.chdir(config.ruby_toplevel_dir) do
+        each_compressed_file(tgz) do |path, entry|
+          debug "Unpacking file: #{path}"
+          File.open(path, 'wb') do |f|
+            f.write(entry.read)
+          end
+        end
+      end
+    end
+
+    private
+
+    def each_compressed_file(tgz)
       Zlib::GzipReader.wrap(tgz) do |gz|
         Gem::Package::TarReader.new(gz) do |tar|
           tar.each do |entry|
             path = entry.header.name
             next if path.end_with?('/')
-            debug "Unpacking file: #{path}"
-            File.open(path, 'wb') do |f|
-              f.write(entry.read)
-            end
+            yield path, entry
           end
         end
       end

data/lib/thermite/tasks.rb

@@ -22,6 +22,7 @@ require 'fileutils'
 require 'rake/tasklib'
 require 'thermite/cargo'
 require 'thermite/config'
+require 'thermite/custom_binary'
 require 'thermite/github_release_binary'
 require 'thermite/package'
 require 'thermite/util'
@@ -40,6 +41,7 @@ module Thermite
   #
   class Tasks < Rake::TaskLib
     include Thermite::Cargo
+    include Thermite::CustomBinary
     include Thermite::GithubReleaseBinary
     include Thermite::Package
     include Thermite::Util
@@ -52,6 +54,13 @@ module Thermite
     #
     # Possible configuration options for Thermite tasks:
     #
+    # * `binary_uri_format` - if set, the interpolation-formatted string used to construct the
+    #   download URI for the pre-built native extension. If the environment variable
+    #   `THERMITE_BINARY_URI_FORMAT` is set, it takes precedence over this option. Either method of
+    #   setting this option overrides the `github_releases` option.
+    #   Example: `https://example.com/download/%{version}/%{filename}`. Replacement variables:
+    #     - `filename` - The value of {Config#tarball_filename}
+    #     - `version` - the crate version from the `Cargo.toml` file
     # * `cargo_project_path` - the path to the Cargo project. Defaults to the current
     #   working directory.
     # * `github_releases` - whether to look for rust binaries via GitHub releases when installing
@@ -112,7 +121,7 @@ module Thermite
           run_cargo_build(target)
           FileUtils.cp(config.rust_path('target', target, config.shared_library),
                        config.ruby_path('lib'))
-        elsif !download_binary
+        elsif !download_binary_from_custom_uri && !download_binary_from_github_release
           inform_user_about_cargo
         end
       end

data/lib/thermite/util.rb

@@ -18,6 +18,8 @@
 # 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.
 
+require 'net/http'
+
 module Thermite
   #
   # Utility methods
@@ -32,6 +34,27 @@ module Thermite
 
       @debug ||= File.open(config.debug_filename, 'w')
       @debug.write("#{msg}\n")
+      @debug.flush
+    end
+
+    #
+    # Wrapper for a Net::HTTP GET request that handles redirects.
+    #
+    # :nocov:
+    def http_get(uri, retries_left = 10)
+      raise RedirectError, 'Too many redirects' if retries_left.zero?
+
+      case (response = Net::HTTP.get_response(URI(uri)))
+      when Net::HTTPClientError
+        nil
+      when Net::HTTPServerError
+        raise Net::HTTPServerException.new(response.message, response)
+      when Net::HTTPFound, Net::HTTPPermanentRedirect
+        http_get(response['location'], retries_left - 1)
+      else
+        StringIO.new(response.body)
+      end
     end
+    # :nocov:
   end
 end

data/test/lib/thermite/custom_binary_test.rb

@@ -0,0 +1,39 @@
+require 'tmpdir'
+require 'test_helper'
+require 'thermite/custom_binary'
+require 'thermite/util'
+
+module Thermite
+  class CustomBinaryTest < Minitest::Test
+    include Thermite::ModuleTester
+
+    class Tester
+      include Thermite::CustomBinary
+      include Thermite::TestHelper
+      include Thermite::Util
+    end
+
+    def test_no_downloading_when_binary_uri_is_falsey
+      mock_module(binary_uri_format: false)
+      mock_module.expects(:http_get).never
+
+      assert !mock_module.download_binary_from_custom_uri
+    end
+
+    def test_download_binary_from_custom_uri
+      mock_module(binary_uri_format: 'http://example.com/download/%{version}/%{filename}')
+      mock_module.config.stubs(:toml).returns(package: { version: '4.5.6' })
+      Net::HTTP.stubs(:get_response).returns('location' => 'redirect')
+      mock_module.stubs(:http_get).returns('tarball')
+      mock_module.expects(:unpack_tarball).once
+
+      assert mock_module.download_binary_from_custom_uri
+    end
+
+    private
+
+    def described_class
+      Tester
+    end
+  end
+end

data/test/lib/thermite/github_release_binary_test.rb

@@ -18,7 +18,7 @@ module Thermite
       mock_module.expects(:download_latest_binary_from_github_release).never
       mock_module.expects(:download_cargo_version_from_github_release).never
 
-      assert !mock_module.download_binary
+      assert !mock_module.download_binary_from_github_release
     end
 
     def test_github_release_type_defaults_to_cargo
@@ -26,7 +26,7 @@ module Thermite
       mock_module.expects(:download_latest_binary_from_github_release).never
       mock_module.expects(:download_cargo_version_from_github_release).once
 
-      mock_module.download_binary
+      mock_module.download_binary_from_github_release
     end
 
     def test_download_cargo_version_from_github_release
@@ -37,7 +37,7 @@ module Thermite
       mock_module.stubs(:http_get).returns('tarball')
       mock_module.expects(:unpack_tarball).once
 
-      assert mock_module.download_binary
+      assert mock_module.download_binary_from_github_release
     end
 
     def test_download_cargo_version_from_github_release_with_custom_git_tag_format
@@ -48,7 +48,7 @@ module Thermite
       mock_module.stubs(:http_get).returns('tarball')
       mock_module.expects(:unpack_tarball).once
 
-      assert mock_module.download_binary
+      assert mock_module.download_binary_from_github_release
     end
 
     def test_download_cargo_version_from_github_release_with_client_error
@@ -56,7 +56,7 @@ module Thermite
       mock_module.config.stubs(:toml).returns(package: { version: '4.5.6' })
       Net::HTTP.stubs(:get_response).returns(Net::HTTPClientError.new('1.1', 403, 'Forbidden'))
 
-      assert !mock_module.download_binary
+      assert !mock_module.download_binary_from_github_release
     end
 
     def test_download_cargo_version_from_github_release_with_server_error
@@ -66,17 +66,17 @@ module Thermite
       Net::HTTP.stubs(:get_response).returns(server_error)
 
       assert_raises Net::HTTPServerException do
-        mock_module.download_binary
+        mock_module.download_binary_from_github_release
       end
     end
 
     def test_download_latest_binary_from_github_release
       mock_module(github_releases: true, github_release_type: 'latest', git_tag_regex: 'v(.*)-rust')
       stub_releases_atom
-      mock_module.stubs(:download_binary_from_github_release).returns(StringIO.new('tarball'))
+      mock_module.stubs(:download_versioned_github_release_binary).returns(StringIO.new('tarball'))
       mock_module.expects(:unpack_tarball).once
 
-      assert mock_module.download_binary
+      assert mock_module.download_binary_from_github_release
     end
 
     def test_download_latest_binary_from_github_release_no_releases_match_regex
@@ -84,16 +84,16 @@ module Thermite
       stub_releases_atom
       mock_module.expects(:github_download_uri).never
 
-      assert !mock_module.download_binary
+      assert !mock_module.download_binary_from_github_release
     end
 
     def test_download_latest_binary_from_github_release_no_tarball_found
       mock_module(github_releases: true, github_release_type: 'latest', git_tag_regex: 'v(.*)-rust')
       stub_releases_atom
-      mock_module.stubs(:download_binary_from_github_release).returns(nil)
+      mock_module.stubs(:download_versioned_github_release_binary).returns(nil)
       mock_module.expects(:unpack_tarball).never
 
-      assert !mock_module.download_binary
+      assert !mock_module.download_binary_from_github_release
     end
 
     private

data/test/lib/thermite/package_test.rb

@@ -21,15 +21,18 @@ module Thermite
           stub_config(project_dir, extension_path, tgz_filename)
 
           mock_module.build_package
-        end
+          FileUtils.rm_f(extension_path)
 
-        using_install_dir(stub_dir(dir, 'install')) do |install_dir|
-          File.open(tgz_filename, 'rb') do |f|
-            mock_module.unpack_tarball(f)
+          # This simulates having an extension build via `install/Rakefile` instead of the
+          # top-level Rakefile.
+          using_install_dir(stub_dir(dir, 'install')) do
+            assert_file_created(extension_path) do
+              File.open(tgz_filename, 'rb') do |f|
+                mock_module.unpack_tarball(f)
+              end
+            end
+            assert_equal 'some extension', File.read(extension_path)
           end
-          packed_file = File.join(install_dir, 'lib', 'test.txt')
-          assert File.exist?(packed_file), "File '#{packed_file}' does not exist."
-          assert_equal 'some extension', File.read(packed_file)
         end
       end
     end
@@ -87,5 +90,11 @@ module Thermite
         end
       end
     end
+
+    def assert_file_created(filename)
+      refute File.exist?(filename), "File '#{filename}' already exists."
+      yield
+      assert File.exist?(filename), "File '#{filename}' does not exist."
+    end
   end
 end

data/test/test_helper.rb

@@ -1,14 +1,9 @@
-if ENV['CODECLIMATE_REPO_TOKEN']
-  require 'codeclimate-test-reporter'
-  CodeClimate::TestReporter.start
-else
-  require 'simplecov'
-  SimpleCov.start do
-    load_profile 'test_frameworks'
-    add_filter 'lib/thermite/fiddle.rb'
-    add_filter 'lib/thermite/tasks.rb'
-    track_files 'lib/**/*.rb'
-  end
+require 'simplecov'
+SimpleCov.start do
+  load_profile 'test_frameworks'
+  add_filter 'lib/thermite/fiddle.rb'
+  add_filter 'lib/thermite/tasks.rb'
+  track_files 'lib/**/*.rb'
 end
 
 ENV['THERMITE_TEST'] = '1'

data/thermite.gemspec

@@ -3,7 +3,7 @@ require 'English'
 
 Gem::Specification.new do |s|
   s.name        = 'thermite'
-  s.version     = '0.7.0'
+  s.version     = '0.8.0'
   s.summary     = 'Rake helpers for Rust+Ruby'
   s.description = 'A Rake-based helper for building and distributing Rust-based Ruby extensions'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thermite
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Mark Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -128,6 +128,7 @@ files:
 - ci/after_success.py
 - lib/thermite/cargo.rb
 - lib/thermite/config.rb
+- lib/thermite/custom_binary.rb
 - lib/thermite/fiddle.rb
 - lib/thermite/github_release_binary.rb
 - lib/thermite/package.rb
@@ -137,6 +138,7 @@ files:
 - test/fixtures/github/releases.atom
 - test/lib/thermite/cargo_test.rb
 - test/lib/thermite/config_test.rb
+- test/lib/thermite/custom_binary_test.rb
 - test/lib/thermite/github_release_binary_test.rb
 - test/lib/thermite/package_test.rb
 - test/lib/thermite/util_test.rb