thermite 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4298855469a6d6a12e9dd7d33df5a95cfe8b4c9f
-  data.tar.gz: e793be7663705a076bdcfb81bc4157d4ba10466b
+  metadata.gz: de41ccc420e335d2285e1a8d803e4ce55c669564
+  data.tar.gz: 360be899c1e2c3e5162017de866811e50c7381de
 SHA512:
-  metadata.gz: d6fe53f8a54d8617d1578cf71619687734d447bd42ec2a37fdde84bc1b2eaf17045232f30d71fc5f47d9ece3ebab95dbfc79ddae22407421ed43e267c7a93832
-  data.tar.gz: 8475eaa3cfc6a52aaaf2fef3eb514a79f8a02f56e2c95ba6f3c7f8f8d6f8a557a43837c8cd0b34c41800eeb102a342631d86513ef48f3c332ac4ceb9f229ea43
+  metadata.gz: ada2a16519da8c1fd2361ec8b364bd0e3aaea4c6e750a6a8f877bfcf87275b590203df1bcc2ee33047e17c19fd34501c746667f4cc137361cd4baf39fbaee841
+  data.tar.gz: 3966c01620f0e8d0b214c87c92c5731c5b5d0b164b685d7083a8eebdefe52512c132b1daa4b74251507fac0dfa285497e95a579411c8fd594c3ec9257353370c

data/.appveyor.yml

@@ -24,4 +24,4 @@ install:
   - bundle install
 build: false
 test_script:
-  - bundle exec rake
+  - bundle exec rake test

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  Exclude:
+  - 'vendor/**/*'
+  TargetRubyVersion: 2.1
+
 Metrics/AbcSize:
   Max: 20
 

data/CONTRIBUTING.md

@@ -44,8 +44,8 @@ etc.:
 bad:
 
 ```
-commit 1: add foo algorithm
-commit 2: run rustfmt
+commit 1: add foo
+commit 2: run rubocop
 commit 3: add test
 commit 4: add docs
 commit 5: add bar
@@ -55,9 +55,13 @@ commit 6: add test + docs
 good:
 
 ```
-commit 1: add foo algorithm
+commit 1: add foo
 commit 2: add bar
 ```
 
+Squashing commits during discussion of the pull request is almost always unnecessary, and makes it
+more difficult for both the submitters and reviewers to understand what changed in between comments.
+However, rebasing is encouraged when practical, particularly when there's a merge conflict.
+
 If you are continuing the work of another person's PR and need to rebase/squash, please retain the
 attribution of the original author(s) and continue the work in subsequent commits.

data/NEWS.md

@@ -2,6 +2,18 @@
 
 ## Unreleased
 
+## [0.6.0] - 2016-09-12
+
+### Added
+
+* `optional_rust_extension` option - prints a warning to STDERR instead of raising an exception, if
+  Cargo is unavailable and `github_releases` is either disabled or unavailable. Useful for projects
+  where either fallback code exists, or a native extension is desirable but not required. (#4, #6)
+
+### Fixed
+
+* `cargo` was not being run in the context of the rust project toplevel directory (#7, #8)
+
 ## [0.5.0] - 2016-07-18
 
 ### Added

data/README.md

@@ -60,6 +60,10 @@ Possible options:
   precompiled Rust tarballs. One group must be specified that indicates the version number to be
   used in the tarball filename. Defaults to `vN.N.N`, where `N` is any n-digit number. In this case,
   the group is around the entire expression.
+* `optional_rust_extension` - prints a warning to STDERR instead of raising an exception, if Cargo
+  is unavailable and `github_releases` is either disabled or unavailable. Useful for projects where
+  either fallback code exists, or a native extension is desirable but not required. Defaults
+  to `false`.
 * `ruby_project_path` - the top-level directory of the Ruby gem's project. Defaults to the
   current working directory.
 

data/lib/thermite/cargo.rb

@@ -37,7 +37,9 @@ module Thermite
     # Run `cargo` with the given `args` and return `STDOUT`.
     #
     def run_cargo(*args)
-      sh "#{cargo} #{Shellwords.join(args)}"
+      Dir.chdir(config.rust_toplevel_dir) do
+        sh "#{cargo} #{Shellwords.join(args)}"
+      end
     end
 
     #
@@ -56,18 +58,43 @@ module Thermite
       run_cargo(*cargo_args)
     end
 
-    # :nocov:
+    #
+    # Inform the user about cargo if it doesn't exist.
+    #
+    # If `optional_rust_extension` is true, print message to STDERR. Otherwise, raise an exception.
+    #
+    def inform_user_about_cargo
+      raise cargo_required_msg unless options[:optional_rust_extension]
+
+      $stderr.write(cargo_recommended_msg)
+    end
 
     #
-    # Message used when cargo is required but not found.
+    # Message used when cargo is not found.
     #
-    def cargo_required_msg
+    # `require_severity` is the verb that indicates how important Rust is to the library.
+    #
+    def cargo_msg(require_severity)
       <<EOM
 ****
-Rust's Cargo is required to build this extension. Please install Rust and put
-it in the PATH, or set the CARGO environment variable appropriately.
+Rust's Cargo is #{require_severity} to build this extension. Please install
+Rust and put it in the PATH, or set the CARGO environment variable appropriately.
 ****
 EOM
     end
+
+    #
+    # Message used when cargo is required but not found.
+    #
+    def cargo_required_msg
+      cargo_msg('required')
+    end
+
+    #
+    # Message used when cargo is recommended but not found.
+    #
+    def cargo_recommended_msg
+      cargo_msg('recommended (but not required)')
+    end
   end
 end

data/lib/thermite/tasks.rb

@@ -70,6 +70,10 @@ module Thermite
     #   releases to look for precompiled Rust tarballs. One group must be specified that indicates
     #   the version number to be used in the tarball filename. Defaults to `vN.N.N`, where `N` is
     #   any n-digit number. In this case, the group is around the entire expression.
+    # * `optional_rust_extension` - prints a warning to STDERR instead of raising an exception, if
+    #   Cargo is unavailable and `github_releases` is either disabled or unavailable. Useful for
+    #   projects where either fallback code exists, or a native extension is desirable but not
+    #   required. Defaults to `false`.
     # * `ruby_project_path` - the toplevel directory of the Ruby gem's project. Defaults to the
     #   current working directory.
     #
@@ -109,7 +113,7 @@ module Thermite
           FileUtils.cp(config.rust_path('target', target, config.shared_library),
                        config.ruby_path('lib'))
         elsif !download_binary
-          raise cargo_required_msg
+          inform_user_about_cargo
         end
       end
     end

data/test/lib/thermite/cargo_test.rb

@@ -32,6 +32,24 @@ module Thermite
       mock_module.run_cargo_build('release')
     end
 
+    def test_inform_user_about_cargo_exception
+      _, err = capture_io do
+        assert_raises RuntimeError do
+          mock_module(optional_rust_extension: false).inform_user_about_cargo
+        end
+      end
+
+      assert_equal '', err
+    end
+
+    def test_inform_user_about_cargo_warning
+      _, err = capture_io do
+        mock_module(optional_rust_extension: true).inform_user_about_cargo
+      end
+
+      assert_equal mock_module.cargo_recommended_msg, err
+    end
+
     def described_class
       Tester
     end

data/thermite.gemspec

@@ -3,7 +3,7 @@ require 'English'
 
 Gem::Specification.new do |s|
   s.name        = 'thermite'
-  s.version     = '0.5.0'
+  s.version     = '0.6.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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mark Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake