mini_portile2 2.4.0 → 2.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6db14d6088d4c74bbc5d10fa15a32af4ba33beb9eb524be48015116e605cd2b
-  data.tar.gz: f4b26f092c63df9cef6b0ef229285cc702c815ccdbf2a61d0a3c9567ba036b76
+  metadata.gz: 8f53843a25ac2651fd9970c34a44edf44de0904f99d9e63eadb3802f8dcd59bc
+  data.tar.gz: 075527f5c56f12de2ba5e3dfd72965a0093f62558eabb02571be5aee61cbe9f5
 SHA512:
-  metadata.gz: 345a62f6f547189901abafa3d7fd2d48b0b600a2c8a3863151a42a5460ab2ea1f2168785cf0eeabaa1075d1c8e35559d9d3b69b8399ea79907988eabf2af4787
-  data.tar.gz: 6b0a083c6044ffa76427338a11719fc71d1673dea51b21fc2533fdab216ebff5f9e45eb8a96edd0edf930b439ae7e58c2baa70cbdf659d53713539512f7e6b3a
+  metadata.gz: 0e251640701cf8ea166e1ce6725b8e7bf3d3dbf20a659a6b90ffe127667a80f908fab5b7f816f8a766edd4166464d5375c53a3c31c862a4a7a04e0e87929127d
+  data.tar.gz: 1d540e216342ef799de2188935d6de440b865606a244dd7ca6a27146a259bf5a1211c53b49668eee668187770e5e030d06508b4605779c4366999dcf831cc2b3

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: flavorjones
+tidelift: rubygems/mini_portile2

data/.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: Continuous Integration
+concurrency:
+  group: "${{github.workflow}}-${{github.ref}}"
+  cancel-in-progress: true
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - v*.*.x
+    tags:
+      - v*.*.*
+  pull_request:
+    types: [opened, synchronize]
+    branches:
+      - "*"
+  schedule:
+    - cron: "0 8 * * 5" # At 08:00 on Friday # https://crontab.guru/#0_8_*_*_5
+
+jobs:
+  test-unit:
+    env:
+      MAKEFLAGS: -j2
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "3.1", "3.2", "head"]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: configure git crlf on windows
+        if: matrix.platform == 'windows-latest'
+        run: |
+          git config --system core.autocrlf false
+          git config --system core.eol lf
+      - uses: actions/checkout@v3
+      - uses: MSP-Greg/setup-ruby-pkgs@v1
+        with:
+          apt-get: _update_ build-essential cmake
+          mingw: _upgrade_ cmake
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake test:unit
+
+  test-examples:
+    env:
+      MAKEFLAGS: -j2
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: [ubuntu-latest, windows-latest, macos-latest]
+        ruby: ["3.1"]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: configure git crlf on windows
+        if: matrix.platform == 'windows-latest'
+        run: |
+          git config --system core.autocrlf false
+          git config --system core.eol lf
+      - uses: actions/checkout@v3
+      - uses: MSP-Greg/setup-ruby-pkgs@v1
+        with:
+          apt-get: _update_ build-essential cmake
+          mingw: _upgrade_ cmake
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - uses: actions/cache@v3
+        with:
+          path: examples/ports/archives
+          key: examples-${{ hashFiles('examples/Rakefile') }}
+      - run: bundle exec rake test:examples
+
+  fedora: # see https://github.com/flavorjones/mini_portile/issues/118
+    runs-on: ubuntu-latest
+    container:
+      image: fedora:35
+    steps:
+      - run: |
+          dnf group install -y "C Development Tools and Libraries"
+          dnf install -y ruby ruby-devel libyaml-devel git-all patch cmake xz
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: examples/ports/archives
+          key: examples-${{ hashFiles('examples/Rakefile') }}
+      - run: bundle install
+      - run: bundle exec rake test:unit
+      - run: bundle exec rake test:examples

data/.gitignore

@@ -1,7 +1,6 @@
-pkg
-tmp
-Gemfile.lock
 .bundle
+Gemfile.lock
+pkg
 ports
-concourse/private.yml
-concourse/mini_portile.final.yml
+tmp
+mkmf.log

data/CHANGELOG.md

@@ -1,3 +1,120 @@
+## mini_portile changelog
+
+### 2.8.5 / 2023-10-22
+
+#### Added
+
+- New methods `#lib_path` and `#include_path` which point at the installed directories under `ports`. (by @flavorjones)
+- Add config param for CMAKE_BUILD_TYPE, which now defaults to `Release`. (#136 by @Watson1978)
+
+#### Experimental
+
+Introduce experimental support for `MiniPortile#mkmf_config` which sets up MakeMakefile variables to properly link against the recipe. This should make it easier for C extensions to package third-party libraries. (by @flavorjones)
+
+- With no arguments, will set up just `$INCFLAGS`, `$libs`, and `$LIBPATH`.
+- Optionally, if provided a pkg-config file, will use that config to more precisely set `$INCFLAGS`, `$libs`, `$LIBPATH`, and `$CFLAGS`/`$CXXFLAGS`.
+- Optionally, if provided the name of a static archive, will rewrite linker flags to ensure correct linkage.
+
+Note that the behavior may change slightly before official support is announced. Please comment on [#118](https://github.com/flavorjones/mini_portile/issues/118) if you have feedback.
+
+
+### 2.8.4 / 2023-07-18
+
+- cmake: set CMAKE compile flags to configure cross-compilation similarly to `autotools` `--host` flag: `SYSTEM_NAME`, `SYSTEM_PROCESSOR`, `C_COMPILER`, and `CXX_COMPILER`. [#130] (Thanks, @stanhu!)
+
+
+### 2.8.3 / 2023-07-18
+
+#### Fixed
+
+- cmake: only use MSYS/NMake generators when available. [#129] (Thanks, @stanhu!)
+
+
+### 2.8.2 / 2023-04-30
+
+#### Fixed
+
+- Ensure that the `source_directory` option will work when given a Windows path to an autoconf directory. [#126]
+
+
+### 2.8.1 / 2022-12-24
+
+#### Fixed
+
+- Support applying patches via `git apply` even when the working directory resembles a git directory. [#119] (Thanks, @h0tw1r3!)
+
+
+### 2.8.0 / 2022-02-20
+
+#### Added
+
+- Support xz-compressed archives (recognized by an `.xz` file extension).
+- When downloading a source archive, default open_timeout and read_timeout to 10 seconds, but allow configuration via open_timeout and read_timeout config parameters.
+
+
+### 2.7.1 / 2021-10-20
+
+#### Packaging
+
+A test artifact that has been included in the gem was being flagged by some users' security scanners because it wasn't a real tarball. That artifact has been updated to be a real tarball. [#108]
+
+
+### 2.7.0 / 2021-08-31
+
+#### Added
+
+The commands used for "make", "compile", and "cmake" are configurable via keyword arguments. [#107] (Thanks, @cosmo0920!)
+
+
+### 2.6.1 / 2021-05-31
+
+#### Dependencies
+
+Make `net-ftp` an optional dependency, since requiring it as a hard dependency in v2.5.2 caused warnings to be emitted by Ruby 2.7 and earlier. A warning message is emitted if FTP functionality is called and `net-ftp` isn't available; this should only happen in Ruby 3.1 and later.
+
+
+### 2.5.3 / 2021-05-31
+
+#### Dependencies
+
+Make `net-ftp` an optional dependency, since requiring it as a hard dependency in v2.5.2 caused warnings to be emitted by Ruby 2.7 and earlier. A warning message is emitted if FTP functionality is called and `net-ftp` isn't available; this should only happen in Ruby 3.1 and later.
+
+
+### 2.6.0 / 2021-05-31
+
+### Added
+
+Recipes may build against a local directory by specifying `source_directory` instead of `files`. In
+particular, this may be useful for debugging problems with the upstream dependency (e.g., use `git
+bisect` in a local clone) or for continuous integration with upstream HEAD.
+
+
+### 2.5.2 / 2021-05-28
+
+#### Dependencies
+
+Add `net-ftp` as an explicit dependency to accommodate the upcoming Ruby 3.1 changes that move this and other gems out of the "default" gem set and into the "bundled" gem set. See https://bugs.ruby-lang.org/issues/17873 [#101]
+
+
+### 2.5.1 / 2021-04-28
+
+#### Dependencies
+
+This release ends support for ruby < 2.3.0. If you're on 2.2.x or earlier, we strongly suggest that you find the time to upgrade, because [official support for Ruby 2.2 ended on 2018-03-31](https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/).
+
+#### Enhancements
+
+* `MiniPortile.execute` now takes an optional `:env` hash, which is merged into the environment variables for the subprocess. Likely this is only useful for specialized use cases. [#99]
+* Experimental support for cmake-based projects extended to Windows. (Thanks, @larskanis!)
+
+
+### 2.5.0 / 2020-02-24
+
+#### Enhancements
+
+* When verifying GPG signatures, remove all imported pubkeys from keyring [#90] (Thanks, @hanazuki!)
+    
+
 ### 2.4.0 / 2018-12-02
 
 #### Enhancements

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "net-ftp" if Gem::Requirement.new("> 3.1.0.dev").satisfied_by?(Gem::Version.new(RUBY_VERSION))
+
 # Specify your gem's dependencies in mini_portile2.gemspec
 gemspec

data/README.md

@@ -5,8 +5,8 @@ renamed to `mini_portile2`. For mini_portile versions 0.6.x and
 previous, please visit
 [the v0.6.x branch](https://github.com/flavorjones/mini_portile/tree/v0.6.x).
 
-[![travis status](https://travis-ci.org/flavorjones/mini_portile.svg?branch=master)](https://travis-ci.org/flavorjones/mini_portile?branch=master)
-[![appveyor status](https://ci.appveyor.com/api/projects/status/509669xx1qlhqqab/branch/master?svg=true)](https://ci.appveyor.com/project/flavorjones/mini-portile/branch/master)
+[![Continuous Integration](https://github.com/flavorjones/mini_portile/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/flavorjones/mini_portile/actions/workflows/ci.yml)
+[![Tidelift dependencies](https://tidelift.com/badges/package/rubygems/mini_portile2)](https://tidelift.com/subscription/pkg/rubygems-mini.portile2?utm_source=undefined&utm_medium=referral&utm_campaign=readme)
 
 * Documentation: http://www.rubydoc.info/github/flavorjones/mini_portile
 * Source Code: https://github.com/flavorjones/mini_portile
@@ -83,11 +83,95 @@ library into a namespaced structure.
 `#activate` ensures GCC will find this library and prefer it over a
 system-wide installation.
 
+Some keyword arguments can be passed to the constructor to configure the commands used:
+
+#### `gcc_command`
+
+The compiler command that is used is configurable, and in order of preference will use:
+
+- the `CC` environment variable (if present)
+- the `gcc_command` value passed in to the constructor
+- `RbConfig::CONFIG["CC"]`
+- `"gcc"`
+
+You can pass it in like so:
+
+``` ruby
+MiniPortile.new("libiconv", "1.13.1", gcc_command: "cc")
+```
+
+#### `make_command`
+
+The configuration/make command that is used is configurable, and in order of preference will use:
+
+- the `MAKE` environment variable (if present)
+- the `make_command` value passed in to the constructor
+- the `make` environment variable (if present)
+- `"make"`
+
+You can pass it in like so:
+
+``` ruby
+MiniPortile.new("libiconv", "1.13.1", make_command: "nmake")
+```
+
+#### `open_timeout`, `read_timeout`
+
+By default, when downloading source archives, MiniPortile will use a timeout value of 10
+seconds. This can be overridden by passing a different value (in seconds):
+
+``` ruby
+MiniPortile.new("libiconv", "1.13.1", open_timeout: 99, read_timeout: 2)
+```
+
 
 ### How to use (for cmake projects)
 
 Same as above, but instead of `MiniPortile.new`, call `MiniPortileCMake.new`.
 
+#### `make_command`
+
+This is configurable as above, except for Windows systems where it's hardcoded to `"nmake"`.
+
+#### `cmake_command`
+
+The cmake command used is configurable, and in order of preference will use:
+
+- the `CMAKE` environment variable (if present)
+- the `:cmake_command` keyword argument passed into the constructor
+- `"cmake"` (the default)
+
+You can pass it in like so:
+
+``` ruby
+MiniPortileCMake.new("libfoobar", "1.3.5", cmake_command: "cmake3")
+```
+
+#### `cmake_build_type`
+
+The cmake build type is configurable as of v2.8.5, and in order of preference will use:
+
+- the `CMAKE_BUILD_TYPE` environment variable (if present)
+- the `:cmake_build_type` keyword argument passed into the constructor
+- `"Release"` (the default)
+
+You can pass it in like so:
+
+``` ruby
+MiniPortileCMake.new("libfoobar", "1.3.5", cmake_build_type: "Debug")
+```
+
+### Local source directories
+
+Instead of downloading a remote file, you can also point mini_portile2 at a local source
+directory. In particular, this may be useful for testing or debugging:
+
+``` ruby
+gem "mini_portile2", "~> 2.0.0" # NECESSARY if used in extconf.rb. see below.
+require "mini_portile2"
+recipe = MiniPortile.new("libiconv", "1.13.1")
+recipe.source_directory = "/path/to/local/source/for/library-1.2.3"
+```
 
 ### Directory Structure Conventions
 
@@ -240,6 +324,22 @@ toolchain. This has been tested against Ubuntu, OSX and even Windows
 (RubyInstaller with DevKit)
 
 
+## Support
+
+The bug tracker is available here:
+
+* https://github.com/flavorjones/mini_portile/issues
+
+Consider subscribing to [Tidelift][tidelift] which provides license assurances and timely security notifications for your open source dependencies, including Loofah. [Tidelift][tidelift] subscriptions also help the Loofah maintainers fund our [automated testing](https://ci.nokogiri.org) which in turn allows us to ship releases, bugfixes, and security updates more often.
+
+  [tidelift]: https://tidelift.com/subscription/pkg/rubygems-mini.portile2?utm_source=rubygems-mini.portile2&utm_medium=referral&utm_campaign=enterprise
+
+
+## Security
+
+See [`SECURITY.md`](SECURITY.md) for vulnerability reporting details.
+
+
 ## License
 
 This library is licensed under MIT license. Please see LICENSE.txt for details.

data/Rakefile

@@ -1,11 +1,10 @@
 require "rake/clean"
-require 'bundler/gem_tasks'
-require 'concourse'
+require "bundler/gem_tasks"
 
 namespace :test do
   desc "Test MiniPortile by running unit tests"
   task :unit do
-    sh "ruby -w -W2 -I. -Ilib -e \"#{Dir["test/test_*.rb"].map{|f| "require '#{f}';"}.join}\" -- #{ENV['TESTOPTS']} -v"
+    sh "ruby -w -W2 -I. -Ilib -e \"#{Dir["test/test_*.rb"].map { |f| "require '#{f}';" }.join}\" -- #{ENV["TESTOPTS"]} -v"
   end
 
   desc "Test MiniPortile by compiling examples"
@@ -24,6 +23,3 @@ desc "Run all tests"
 task :test => ["test:unit", "test:examples"]
 
 task :default => [:test]
-
-
-Concourse.new("mini_portile").create_tasks!

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security and Vulnerability Reporting
+
+The mini_portile core contributors take security very seriously and investigate all reported vulnerabilities.
+
+If you would like to report a vulnerablity or have a security concern regarding mini_portile, please [report it via Tidelift](https://tidelift.com/security).
+
+Your report will be acknowledged within 48 hours, and you'll receive a more detailed response within 96 hours indicating next steps in handling your report.
+
+If you have not received a reply to your submission within 96 hours, Contact the current security coordinator, Mike Dalessio <mike.dalessio@gmail.com>.
+
+The information you share with the mini_portile core contributors as part of this process will be kept confidential within the team, unless or until we need to share information upstream with our dependent libraries' core teams, at which point we will notify you.
+
+If a vulnerability is first reported by you, we will credit you with the discovery in the public disclosure.