thermite-ruby3-fork-dont-use 0.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed53eae0c2cb3dd09ac7c8ee028a1c667065073cff21931350c192b4a00f96ac
+  data.tar.gz: a5ed946ee565c0bf3b4bb6262c13bcc4bb2e273ef65cefa2a62ff1c705224921
+SHA512:
+  metadata.gz: 7f7697b9b290b1fc617e384f05d9e3bdf695989780a9084483ff56fb4f150937a77fde711484a3cd660b16aed16178375281cb07d83e7016c32bc9feff82995f
+  data.tar.gz: ab10ac152fcef4eddd137e49b7becb585189702bb5c0d25de25dc66df5d7275e3b61e5977d095d4b35b59f247ffe36b553e90c463dcdad5974b9fa02ce20a3bf

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.yardoc
+Gemfile.lock
+coverage
+doc

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  TargetRubyVersion: 2.7
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/ClassLength:
+  Exclude:
+    - "test/**/*"
+  Max: 150
+
+Metrics/LineLength:
+  Max: 100
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  Max: 20

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/.yardopts

@@ -0,0 +1,2 @@
+--charset utf-8
+--markup markdown

data/CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# 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 are 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
+commit 2: run rubocop
+commit 3: add test
+commit 4: add docs
+commit 5: add bar
+commit 6: add test + docs
+```
+
+good:
+
+```
+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/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :test do
+  gem 'simplecov', require: nil
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+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.

data/NEWS.md

@@ -0,0 +1,180 @@
+# Changes by Version
+
+## Unreleased
+
+### Changed
+
+## [0.14.0] - 2023-12-21
+
+* Make fork to keep gem usable on Ruby 3+
+* The default `git_tag_regex` conforms more to the semantic versioning 2.0.0 spec (#46)
+
+## [0.13.0] - 2017-10-05
+
+### Added
+
+* Support for building static libraries (#22, #41):
+
+### Fixed
+
+* Always pass `--lib` to `cargo with `link-args` (#40)
+
+## [0.12.1] - 2017-04-06
+
+### Fixed
+
+* Default target directory (when the CARGO_TARGET_DIR is not set)
+
+## [0.12.0] - 2017-04-05
+
+### Added
+
+* Support for CARGO_TARGET_DIR environment variable (#33)
+
+### Fixed
+
+* Cargo executable and arguments with paths using spaces are supported properly
+
+### Changed
+
+* CARGO_TARGET is now CARGO_PROFILE, for less confusion (#35)
+
+## [0.11.1] - 2017-02-04
+
+### Fixed
+
+* Add support for Cargo workspaces to `thermite:clean` and `thermite:test`
+
+## [0.11.0] - 2017-02-03
+
+### Added
+
+* Add support for Cargo workspaces (#30)
+
+## [0.10.0] - 2017-01-22
+
+### Fixed
+
+* Adjust OSX dylib library paths upon installation (#28)
+* Don't use UNIX shell escaping on Windows
+
+### Changed
+
+* `cargo build` has been replaced by `cargo rustc` - non-Windows builds use DLDFLAGS as linker
+  arguments (#27)
+
+## [0.9.0] - 2017-01-18
+
+### Fixed
+
+* The library name is consistent with how Cargo handles hyphens (#19)
+* Raise error if using GitHub Releases & repository not in `Cargo.toml` (#18)
+
+## [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
+
+* Helper module for loading extensions via Fiddle (#13)
+
+## [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
+
+* Unit tests and code coverage (including new development dependencies)
+* CI support on OSX and Windows in addition to Linux
+* Successful CI builds on Linux trigger rusty_blank CI builds on Linux/OSX/Windows
+
+### Changed
+
+* Documentation uses YARD instead of RDoc
+* `unpack_tarball` is a public method
+
+### Fixed
+
+* Documentation for `debug`
+* Windows platform support
+
+## [0.4.0] - 2016-07-12
+
+### Added
+
+* Write debug output to file, if the `THERMITE_DEBUG_FILENAME` environment variable is set
+
+### Changed
+
+* Relaxed rake version requirement
+* Ruby version (major + minor) is considered when generating tarball names
+
+### Fixed
+
+* The library path in the generated tarballs is relative
+
+## [0.3.0] - 2016-07-03
+
+### Added
+
+* `github_release_type`, to add `'cargo'` releases via `Cargo.toml` (default) in addition to the
+  existing `'latest'` functionality
+
+### Changed
+
+* `git_tag_format` option introduced in 0.2.0 renamed to `git_tag_regex` - `git_tag_format` is
+  specific to `github_release_type: 'cargo'`, while `git_tag_regex` is specific to
+  `github_release_type: 'latest'`
+
+## [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.13.0]: https://github.com/malept/thermite/compare/v0.12.1...v0.13.0
+[0.12.1]: https://github.com/malept/thermite/compare/v0.12.0...v0.12.1
+[0.12.0]: https://github.com/malept/thermite/compare/v0.11.1...v0.12.0
+[0.11.1]: https://github.com/malept/thermite/compare/v0.11.0...v0.11.1
+[0.11.0]: https://github.com/malept/thermite/compare/v0.10.0...v0.11.0
+[0.10.0]: https://github.com/malept/thermite/compare/v0.9.0...v0.10.0
+[0.9.0]: https://github.com/malept/thermite/compare/v0.8.0...v0.9.0
+[0.8.0]: https://github.com/malept/thermite/compare/v0.7.0...v0.8.0
+[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
+[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

@@ -0,0 +1,144 @@
+# Thermite
+
+[![Linux/OSX build status](https://travis-ci.org/malept/thermite.svg?branch=master)](https://travis-ci.org/malept/thermite)
+[![Windows build status](https://ci.appveyor.com/api/projects/status/kneo890m3ypoxril?svg=true)](https://ci.appveyor.com/project/malept/thermite)
+[![Code Climate](https://codeclimate.com/github/malept/thermite/badges/gpa.svg)](https://codeclimate.com/github/malept/thermite)
+[![Test coverage](https://codeclimate.com/github/malept/thermite/badges/coverage.svg)](https://codeclimate.com/github/malept/thermite/coverage)
+[![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=30000)](https://rubygems.org/gems/thermite)
+
+Thermite is a Rake-based helper for building and distributing Rust-based Ruby extensions.
+
+## Features
+
+* 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
+
+1. Add the following to your gemspec file:
+
+  ```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 thermite` to view all of the available tasks in the `thermite` namespace.
+
+### 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` or `cargo_workspace_member` to be set in this way. Example section:
+
+```toml
+[package.metadata.thermite]
+
+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 top-level Cargo project. Defaults to the current working
+  directory.
+* `cargo_workspace_member` - if set, the relative path to the Cargo workspace member. Usually used
+  when it is part of a repository containing multiple crates.
+* `github_releases` - whether to look for Rust binaries via GitHub releases when installing
+  the gem, and `cargo` is not found. Defaults to `false`.
+* `github_release_type` - when `github_releases` is `true`, the mode to use to download the Rust
+  binary from GitHub releases. `'cargo'` (the default) uses the version in `Cargo.toml`, along with
+  the `git_tag_format` option (described below) to determine the download URI. `'latest'` takes the
+  latest release matching the `git_tag_regex` option (described below) to determine the download
+  URI.
+* `git_tag_format` - when `github_release_type` is `'cargo'` (the default), the
+  [format string](http://ruby-doc.org/core/String.html#method-i-25) used to determine the tag used
+  in the GitHub download URI. Defaults to `v%s`, where `%s` is the version in `Cargo.toml`.
+* `git_tag_regex` - when `github_releases` is enabled and `github_release_type` is `'latest'`, 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 the [semantic versioning 2.0.0
+  format](https://semver.org/spec/v2.0.0.html). 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.
+* `ruby_extension_dir` - the directory relative to `ruby_project_path` where the extension is
+  located. Defaults to `lib`.
+
+### Example
+
+Using the cliché Rust+Ruby example, the [`rusty_blank`](https://github.com/malept/rusty_blank)
+repository contains an example of using Thermite with [ruru](https://github.com/d-unseductable/ruru)
+to provide a `String.blank?` speedup extension. While the example uses ruru, this gem should be
+usable with any method of integrating Rust and Ruby that you choose.
+
+### Debug / release build
+
+By default Thermite will do a release build of your Rust code. To do a debug build instead,
+set the `CARGO_PROFILE` environment variable to `debug`.
+
+For example, you can run `CARGO_PROFILE=debug rake thermite:build`.
+
+### Troubleshooting
+
+Debug statements can be written to a file specified by the `THERMITE_DEBUG_FILENAME` environment
+variable.
+
+## FAQ
+
+### Why is it named Thermite?
+
+According to Wikipedia:
+
+* The chemical formula for ruby includes Al<sub>2</sub>O<sub>3</sub>, or aluminum oxide.
+* Rust is iron oxide, or Fe<sub>2</sub>O<sub>3</sub>.
+* 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/Rakefile

@@ -0,0 +1,32 @@
+# 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 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'yard'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+YARD::Rake::YardocTask.new
+RuboCop::RakeTask.new
+
+task default: %w[rubocop yard test]

data/lib/thermite/cargo.rb

@@ -0,0 +1,125 @@
+# 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 'mkmf'
+
+module Thermite
+  #
+  # Cargo helpers
+  #
+  module Cargo
+    #
+    # Path to `cargo`. Can be overwritten by using the `CARGO` environment variable.
+    #
+    def cargo
+      @cargo ||= find_executable(ENV.fetch('CARGO', 'cargo'))
+    end
+
+    #
+    # Run `cargo` with the given `args` and return `STDOUT`.
+    #
+    def run_cargo(*args)
+      Dir.chdir(config.rust_toplevel_dir) do
+        sh cargo, *args
+      end
+    end
+
+    #
+    # Only `run_cargo` if it is found in the executable paths.
+    #
+    def run_cargo_if_exists(*args)
+      run_cargo(*args) if cargo
+    end
+
+    #
+    # Run `cargo rustc`, given a target (i.e., `release` [default] or `debug`).
+    #
+    def run_cargo_rustc(target)
+      cargo_args = %w[rustc]
+      cargo_args.push(*cargo_manifest_path_args)
+      cargo_args << '--release' if target == 'release'
+      cargo_args.push(*cargo_rustc_args)
+      run_cargo(*cargo_args)
+    end
+
+    #
+    # If the `cargo_workspace_member` option is set, the `--manifest-path` argument to `cargo`.
+    #
+    def cargo_manifest_path_args
+      return [] unless config.cargo_workspace_member
+
+      manifest = File.join(config.cargo_workspace_member, 'Cargo.toml')
+      ['--manifest-path', manifest]
+    end
+
+    #
+    # 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 not found.
+    #
+    # `require_severity` is the verb that indicates how important Rust is to the library.
+    #
+    def cargo_msg(require_severity)
+      <<~MESSAGE
+        ****
+        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.
+        ****
+      MESSAGE
+    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
+
+    private
+
+    def cargo_rustc_args
+      if config.dynamic_linker_flags == '' || config.target_os == 'mingw32'
+        []
+      else
+        [
+          '--lib',
+          '--',
+          '-C',
+          "link-args=#{config.dynamic_linker_flags}"
+        ]
+      end
+    end
+  end
+end