thermite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eebbdde4fa61f1296c77482a2829de788c43af6
-  data.tar.gz: c18fc5b50c72c8a2df3f715a31e2ccdce1e3f0e0
+  metadata.gz: 947e1f3888fa02e99c72dc31814d37588e2e70ab
+  data.tar.gz: 623b3ca4569f631b615af1ae78405e2142b55fa9
 SHA512:
-  metadata.gz: cc80fcb27a298be17c79241672c905f4d45f4eb9de4d660398e16e0bbea81b22edfee06611327436772d828066989d5a7f6d84cda6f16e7b6421f5baf73dd275
-  data.tar.gz: 7405ebd134cc09ae927c4a81aa5790ddfcb9feac862f9de455273d46a1e28b4de5f8acf94fab914e8b10a7af4d31fdb814cece4c32dcc343e339344b267bb1ac
+  metadata.gz: c053764f561253ca63e9bf6fed628a97d7b2afea8819f2cc55039c7ce7f059b86004db47440a95982d24231f6a0752319d864cbfcf3e1b985d1aedbb5ac75523
+  data.tar.gz: 5cbd681ec63085d09863f4c95b3424c046f6fa89e1342c559775005e8ae503f2936a0efe0183a98249c91495e28777cdfbe73235e079df389900c8dca1e98f21

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
-rvm: 2.3.1
+rvm:
+- 2.1.10
+- 2.2.5
+- 2.3.1
 cache: bundler

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to Thermite
+
+Thermite is a part of the Rust ecosystem. As such, all contributions to this project follow the
+[Rust language's code of conduct](https://www.rust-lang.org/conduct.html) where appropriate.
+
+This project is hosted at [GitHub](https://github.com/malept/thermite). Both pull requests and
+issues of many different kinds are accepted.
+
+## Filing Issues
+
+Issues include bugs, questions, feedback, and feature requests. Before you file a new issue, please
+make sure that your issue has not already been filed by someone else.
+
+### Filing Bugs
+
+When filing a bug, please include the following information:
+
+* Operating system and version. If on Linux, please also include the distribution name.
+* System architecture. Examples include: x86-64, x86, and ARMv7.
+* Ruby and Rake versions that run Thermite.
+* The version (and/or git revision) of Thermite.
+* 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
+  very helpful.
+
+## Filing Pull Requests
+
+Here are some things to keep in mind as you file a pull request to fix a bug, add a new feature,
+etc.:
+
+* Travis CI is used to make sure that the project conforms to the coding standards.
+* If your PR changes the behavior of an existing feature, or adds a new feature, please add/edit
+  the RDoc inline documentation (using the Markdown format). You can see what it looks like in the
+  rendered documentation by running `bundle exec rake rdoc`.
+* Please ensure that your changes follow the Rubocop-enforced coding standard, by running
+  `bundle exec rake rubocop`.
+* If you are contributing a nontrivial change, please add an entry to `NEWS.md`. The format is
+  similar to the one described at [Keep a Changelog](http://keepachangelog.com/).
+* Please make sure your commits are rebased onto the latest commit in the master branch, and that
+  you limit/squash the number of commits created to a "feature"-level. For instance:
+
+bad:
+
+```
+commit 1: add foo algorithm
+commit 2: run rustfmt
+commit 3: add test
+commit 4: add docs
+commit 5: add bar
+commit 6: add test + docs
+```
+
+good:
+
+```
+commit 1: add foo algorithm
+commit 2: add bar
+```
+
+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

@@ -0,0 +1,25 @@
+# Changes by Version
+
+## Unreleased
+
+## [0.2.0] - 2016-06-30
+
+### Added
+
+* Config options can be set in `Cargo.toml` (and overrides the options set in the `Thermite::Tasks`
+  constructor)
+
+### Changed
+
+* Git tag formats are configurable via `git_tag_format` - defaults to basic semver format
+
+### Fixed
+
+* Accessing the TOML config file when searching for Rust binaries
+
+## [0.1.0] - 2016-06-28
+
+Initial release.
+
+[0.2.0]: https://github.com/malept/thermite/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/malept/thermite/releases/tag/v0.1.0

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/malept/thermite.svg?branch=master)](https://travis-ci.org/malept/thermite)
 [![Inline docs](http://inch-ci.org/github/malept/thermite.svg?branch=master)](http://inch-ci.org/github/malept/thermite)
+[![Gem](https://img.shields.io/gem/v/thermite.svg?maxAge=300000)](https://rubygems.org/gems/thermite)
 
 Thermite is a Rake-based helper for building and distributing Rust-based Ruby extensions.
 
@@ -23,12 +24,31 @@ Thermite::Tasks.new
 
 Run `rake -T` to view all of the available tasks in the `thermite` namespace.
 
-You can optionally pass arguments to `Thermite::Tasks.new`, which configure the tasks for your
-specific project:
+### Configuration
+
+Task configuration for your project can be set in two ways:
+
+* passing arguments to `Thermite::Tasks.new`
+* adding a `package.metadata.thermite` section to `Cargo.toml`. These settings override the
+  arguments passed to the `Tasks` class. Due to the conflict, it is infeasible for
+  `cargo_project_path` to be set in this way. Example section:
+
+```toml
+[package.metadata.thermite]
+
+github_releases = true
+```
+
+Possible options:
 
 * `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`.
+* `git_tag_format` - when `github_releases` is enabled, a regular expression (expressed as a
+  `String`) that determines which tagged 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.
 * `ruby_project_path` - the top-level directory of the Ruby gem's project. Defaults to the
   current working directory.
 
@@ -50,6 +70,10 @@ According to Wikipedia:
 * A common thermite reaction uses iron oxide and aluminum to produce iron and aluminum oxide:
   Fe<sub>2</sub>O<sub>3</sub> + 2Al → 2Fe + Al<sub>2</sub>O<sub>3</sub>
 
+## [Release Notes](https://github.com/malept/thermite/blob/master/NEWS.md)
+
+## [Contributing](https://github.com/malept/thermite/blob/master/CONTRIBUTING.md)
+
 ## Legal
 
 This gem is licensed under the MIT license.

data/lib/thermite/config.rb

@@ -134,11 +134,45 @@ module Thermite
       ruby_path('lib', shared_library)
     end
 
+    #
+    # The basic semantic versioning format.
+    #
+    DEFAULT_TAG_FORMAT = /^(v\d+\.\d+\.\d+)$/
+
+    #
+    # The format (as a regular expression) that git tags containing Rust binary
+    # tarballs are supposed to match. Defaults to `DEFAULT_TAG_FORMAT`.
+    #
+    def git_tag_format
+      @git_tag_format ||= begin
+        if @options[:git_tag_format]
+          Regexp.new(@options[:git_tag_format])
+        else
+          DEFAULT_TAG_FORMAT
+        end
+      end
+    end
+
     #
     # Parsed TOML object (courtesy of `tomlrb`).
     #
     def toml
       @toml ||= Tomlrb.load_file(rust_path('Cargo.toml'), symbolize_keys: true)
     end
+
+    #
+    # The Thermite-specific config from the TOML file.
+    #
+    def toml_config
+      @toml_config ||= begin
+        # Not using .dig to be Ruby < 2.3 compatible
+        if toml && toml[:package] && toml[:package][:metadata] &&
+           toml[:package][:metadata][:thermite]
+          toml[:package][:metadata][:thermite]
+        else
+          {}
+        end
+      end
+    end
   end
 end

data/lib/thermite/github_release_binary.rb

@@ -42,7 +42,7 @@ module Thermite
     def download_latest_binary_from_github_release
       return false unless options[:github_releases]
       installed_binary = false
-      github_uri = toml[:package][:repository]
+      github_uri = config.toml[:package][:repository]
       each_github_release(github_uri) do |version, download_uri|
         tgz = download_binary_from_github_release(download_uri, version)
         next unless tgz
@@ -63,8 +63,10 @@ module Thermite
     def each_github_release(github_uri)
       releases_uri = "#{github_uri}/releases.atom"
       feed = REXML::Document.new(http_get(releases_uri))
-      REXML::XPath.each(feed, '//entry/title[contains(.,"-rust")]/text()') do |tag|
-        version = tag.to_s.slice(1..-6)
+      REXML::XPath.each(feed, '//entry/title/text()') do |tag|
+        match = config.git_tag_format.match(tag.to_s)
+        next unless match
+        version = match[1]
         download_uri = "#{github_uri}/releases/download/#{tag}/#{config.tarball_filename(version)}"
 
         yield(version, download_uri)

data/lib/thermite/tasks.rb

@@ -54,9 +54,17 @@ module Thermite
     #   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`.
+    # * `git_tag_format` - when `github_releases` is enabled, a regular expression (expressed as a
+    #   `String`) that determines which tagged 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.
     # * `ruby_project_path` - the toplevel directory of the Ruby gem's project. Defaults to the
     #   current working directory.
     #
+    # These values can be overridden by values with the same key name in the
+    # `package.metadata.thermite` section of `Cargo.toml`, if that section exists.
+    #
     attr_reader :options
 
     #
@@ -71,6 +79,7 @@ module Thermite
     def initialize(options = {})
       @options = options
       @config = Config.new(options)
+      @options.merge!(@config.toml_config)
       define_build_task
       define_clean_task
       define_test_task

data/thermite.gemspec

@@ -3,7 +3,7 @@ require 'English'
 
 Gem::Specification.new do |s|
   s.name        = 'thermite'
-  s.version     = '0.1.0'
+  s.version     = '0.2.0'
   s.summary     = 'Rake helpers for Rust+Ruby'
   s.description = 'A Rake-based helper for building and distributing Rust-based Ruby extensions'
 
@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   s.require_paths = %w(lib)
 
+  # Mostly due to tomlrb
+  s.required_ruby_version = '>= 2.0.0'
   s.add_runtime_dependency 'rake', '~> 11'
   s.add_runtime_dependency 'minitar', '~> 0.5'
   s.add_runtime_dependency 'tomlrb', '~> 1.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thermite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -91,8 +91,10 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- NEWS.md
 - README.md
 - Rakefile
 - lib/thermite/cargo.rb
@@ -113,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="