thermite 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de41ccc420e335d2285e1a8d803e4ce55c669564
-  data.tar.gz: 360be899c1e2c3e5162017de866811e50c7381de
+  metadata.gz: 39f322b4da859f7e40da6a34e28af9cece1266d1
+  data.tar.gz: f185a33fa330c7e8e9bd79f3b6e006a8a64dc5f9
 SHA512:
-  metadata.gz: ada2a16519da8c1fd2361ec8b364bd0e3aaea4c6e750a6a8f877bfcf87275b590203df1bcc2ee33047e17c19fd34501c746667f4cc137361cd4baf39fbaee841
-  data.tar.gz: 3966c01620f0e8d0b214c87c92c5731c5b5d0b164b685d7083a8eebdefe52512c132b1daa4b74251507fac0dfa285497e95a579411c8fd594c3ec9257353370c
+  metadata.gz: 27c5e1722048accc76e5cc6f92609aaf1e2a83188d4a19953158fb67d95b0de30333919d8acecf6604f08768ea84379d34878344af462cda96e4999ccd480acd
+  data.tar.gz: 1442ca9c640268a5905ffce5735f23e8b77680253c342ae242ca7e5a633b3d44a29da8f6f051b6fbb9e14eafd3780e1c05992e6755c7eaed75d3d629f9f6c076

data/NEWS.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## [0.7.0] - 2016-09-26
+
+### Added
+
+* Helper module for loading extensions via Fiddle (#13)
+
 ## [0.6.0] - 2016-09-12
 
 ### Added
@@ -79,6 +85,8 @@
 
 Initial release.
 
+[0.7.0]: https://github.com/malept/thermite/compare/v0.6.0...v0.7.0
+[0.6.0]: https://github.com/malept/thermite/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/malept/thermite/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/malept/thermite/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/malept/thermite/compare/v0.2.0...v0.3.0

data/README.md

@@ -14,16 +14,40 @@ 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.
+* Provides a wrapper for initializing a Rust extension via Fiddle.
 
 ## Usage
 
-1. Add `thermite` as a runtime dependency in your gem.
-2. In your gemspec, add `Rakefile` to the specification's `extensions` list.
-3. In `Rakefile`, add `require 'thermite/tasks'` and then add the tasks to the file by running:
+1. Add the following to your gemspec file:
 
-```ruby
-Thermite::Tasks.new
-```
+  ```ruby
+  spec.extensions << 'ext/Rakefile'
+  spec.add_runtime_dependency 'thermite', '~> 0'
+  ```
+
+2. Create `ext/Rakefile` with the following code, assuming that the Cargo project root is the same
+   as the Ruby project root:
+
+  ```ruby
+  require 'thermite/tasks'
+
+  project_dir = File.dirname(File.dirname(__FILE__))
+  Thermite::Tasks.new(cargo_project_path: project_dir, ruby_project_path: project_dir)
+  task default: %w(thermite:build)
+  ```
+
+3. In `Rakefile`, integrate Thermite into your build-test workflow:
+
+  ```ruby
+  require 'thermite/tasks'
+
+  Thermite::Tasks.new
+
+  desc 'Run Rust & Ruby testsuites'
+  task test: ['thermite:build', 'thermite:test'] do
+    # …
+  end
+  ```
 
 Run `rake -T` to view all of the available tasks in the `thermite` namespace.
 

data/lib/thermite/fiddle.rb

@@ -0,0 +1,46 @@
+# -*- 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 'fiddle'
+require 'thermite/config'
+
+module Thermite
+  #
+  # Fiddle helper functions.
+  #
+  module Fiddle
+    #
+    # Loads a native extension using {Thermite::Config} and the builtin `Fiddle` extension.
+    #
+    # @param init_function_name [String] the name of the native function that initializes
+    #                                    the extension
+    # @param config_options [Hash] {Thermite::Tasks#options options} passed to {Thermite::Config}.
+    #                              Options likely needed to be set:
+    #                              `cargo_project_path`, `ruby_project_path`
+    #
+    def self.load_module(init_function_name, config_options)
+      config = Thermite::Config.new(config_options)
+      library = ::Fiddle.dlopen(config.ruby_extension_path)
+      func = ::Fiddle::Function.new(library[init_function_name],
+                                    [], ::Fiddle::TYPE_VOIDP)
+      func.call
+    end
+  end
+end

data/lib/thermite/github_release_binary.rb

@@ -57,11 +57,11 @@ module Thermite
       version = config.toml[:package][:version]
       tag = options.fetch(:git_tag_format, 'v%s') % version
       uri = github_download_uri(tag, version)
-      if (tgz = download_binary_from_github_release(uri, version))
-        debug "Unpacking GitHub release from Cargo version: #{File.basename(uri)}"
-        unpack_tarball(tgz)
-        true
-      end
+      return unless (tgz = download_binary_from_github_release(uri, version))
+
+      debug "Unpacking GitHub release from Cargo version: #{File.basename(uri)}"
+      unpack_tarball(tgz)
+      true
     end
 
     #

data/lib/thermite/util.rb

@@ -28,10 +28,10 @@ module Thermite
     #
     def debug(msg)
       # Should probably replace with a Logger
-      if config.debug_filename
-        @debug ||= File.open(config.debug_filename, 'w')
-        @debug.write("#{msg}\n")
-      end
+      return unless config.debug_filename
+
+      @debug ||= File.open(config.debug_filename, 'w')
+      @debug.write("#{msg}\n")
     end
   end
 end

data/test/test_helper.rb

@@ -5,6 +5,7 @@ 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

data/thermite.gemspec

@@ -3,7 +3,7 @@ require 'English'
 
 Gem::Specification.new do |s|
   s.name        = 'thermite'
-  s.version     = '0.6.0'
+  s.version     = '0.7.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.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Mark Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-26 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/fiddle.rb
 - lib/thermite/github_release_binary.rb
 - lib/thermite/package.rb
 - lib/thermite/tasks.rb