mini_portile2 2.5.1 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f30e371678c82b2de1219ec842fa298bf1e6acc47b2f210ebfda77939aed190
-  data.tar.gz: 7ac927dc6453bf1532db4e55677cebefa115b17fffc43358ef68b8d80c967210
+  metadata.gz: 67e186927fefba71108ad1e3e0a0a27eb22c1baaeda1bb38c36f50f0257a7b26
+  data.tar.gz: bc0caaea80c4c30c56cd1ad7cfe303558bb282cc2230267721f9e09475f08a4e
 SHA512:
-  metadata.gz: df62e128fdb0a950c7f6eb45ba97bdab7793b6e8b6e4a139dd5fe93913bffee194a5505114dfe421f6d64efb25ad17215eb8f1ecd8fdc1d40969aa2b888bebee
-  data.tar.gz: c05f9262bdbb32fcdcda598c8ae0f16962219f39306ae9d4433b1e13af6e2c2ec181c33864ee99284ebe5f82828940ce3d96a9bb9a4ce00947ab56b7d3699252
+  metadata.gz: 0e9002455f2167d020f68386b628571d796f5ae3d1bc51b35b0dc17435de9ba520e6486cfe308cf70315d46fd8237c745befbb689b93d39c1624a461ff9a98af
+  data.tar.gz: d659050137d5deb3342ad9e026c0e66a7cbd030a15b9fd7133a4b653023ec552e38769705dfb5bf6fdc83170a8ed53519cd1c9157fadaa0b91eef6ef0855cc7c

data/.github/workflows/ci.yml

@@ -1,23 +1,31 @@
 name: Continuous Integration
-
+concurrency:
+  group: "${{github.workflow}}-${{github.ref}}"
+  cancel-in-progress: true
 on:
+  workflow_dispatch:
   push:
-    branches: [main]
+    branches:
+      - main
+      - v*.*.x
+    tags:
+      - v*.*.*
   pull_request:
     types: [opened, synchronize]
-    branches: [main]
+    branches:
+      - "*"
   schedule:
     - cron: "0 8 * * 5" # At 08:00 on Friday # https://crontab.guru/#0_8_*_*_5
-  workflow_dispatch:
 
 jobs:
   test-unit:
     env:
       MAKEFLAGS: -j2
     strategy:
+      fail-fast: false
       matrix:
         platform: [ubuntu-latest, windows-latest]
-        ruby: ["2.5", "2.6", "2.7", "3.0"]
+        ruby: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0", "head"]
     runs-on: ${{ matrix.platform }}
     steps:
       - name: configure git crlf on windows
@@ -38,6 +46,7 @@ jobs:
     env:
       MAKEFLAGS: -j2
     strategy:
+      fail-fast: false
       matrix:
         platform: [ubuntu-latest, windows-latest]
         ruby: ["3.0"]

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 ## mini_portile changelog
 
+### 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

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

@@ -83,11 +83,72 @@ 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")
+```
+
 
 ### 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` value passed in to the constructor
+- `"cmake"`
+
+You can pass it in like so:
+
+``` ruby
+MiniPortileCMake.new("libfoobar", "1.3.5", cmake_command: "cmake3")
+```
+
+### 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
 

data/lib/mini_portile2/mini_portile.rb

@@ -1,7 +1,6 @@
 require 'rbconfig'
 require 'net/http'
 require 'net/https'
-require 'net/ftp'
 require 'fileutils'
 require 'tempfile'
 require 'digest'
@@ -31,7 +30,7 @@ end
 class MiniPortile
   attr_reader :name, :version, :original_host
   attr_writer :configure_options
-  attr_accessor :host, :files, :patch_files, :target, :logger
+  attr_accessor :host, :files, :patch_files, :target, :logger, :source_directory
 
   def self.windows?
     RbConfig::CONFIG['target_os'] =~ /mswin|mingw/
@@ -47,7 +46,7 @@ class MiniPortile
     RbConfig::CONFIG['target_os'] =~ /mswin/
   end
 
-  def initialize(name, version)
+  def initialize(name, version, **kwargs)
     @name = name
     @version = version
     @target = 'ports'
@@ -55,8 +54,23 @@ class MiniPortile
     @patch_files = []
     @log_files = {}
     @logger = STDOUT
+    @source_directory = nil
 
     @original_host = @host = detect_host
+
+    @gcc_command = kwargs[:gcc_command]
+    @make_command = kwargs[:make_command]
+  end
+
+  def source_directory=(path)
+    @source_directory = File.expand_path(path)
+  end
+
+  def prepare_build_directory
+    raise "source_directory is not set" if source_directory.nil?
+    output "Building #{@name} #{@version} from source at '#{source_directory}'"
+    FileUtils.mkdir_p(File.join(tmp_path, [name, version].join("-")))
+    FileUtils.rm_rf(port_path) # make sure we always re-install
   end
 
   def download
@@ -110,15 +124,16 @@ class MiniPortile
   def configure
     return if configured?
 
+    FileUtils.mkdir_p(tmp_path)
     cache_file = File.join(tmp_path, 'configure.options_cache')
     File.open(cache_file, "w") { |f| f.write computed_options.to_s }
 
+    command = Array(File.join((source_directory || "."), "configure"))
     if RUBY_PLATFORM=~/mingw|mswin/
       # Windows doesn't recognize the shebang.
-      execute('configure', %w(sh ./configure) + computed_options)
-    else
-      execute('configure', %w(./configure) + computed_options)
+      command.unshift("sh")
     end
+    execute('configure', command + computed_options)
   end
 
   def compile
@@ -139,7 +154,7 @@ class MiniPortile
   end
 
   def configured?
-    configure = File.join(work_path, 'configure')
+    configure = File.join((source_directory || work_path), 'configure')
     makefile  = File.join(work_path, 'Makefile')
     cache_file  = File.join(tmp_path, 'configure.options_cache')
 
@@ -157,9 +172,13 @@ class MiniPortile
   end
 
   def cook
-    download unless downloaded?
-    extract
-    patch
+    if source_directory
+      prepare_build_directory
+    else
+      download unless downloaded?
+      extract
+      patch
+    end
     configure unless configured?
     compile
     install unless installed?
@@ -206,6 +225,14 @@ class MiniPortile
     File.expand_path(port_path)
   end
 
+  def gcc_cmd
+    (ENV["CC"] || @gcc_command || RbConfig::CONFIG["CC"] || "gcc").dup
+  end
+
+  def make_cmd
+    (ENV["MAKE"] || @make_command || ENV["make"] || "make").dup
+  end
+
 private
 
   def tmp_path
@@ -473,7 +500,6 @@ private
   def download_file_http(url, full_path, count = 3)
     filename = File.basename(full_path)
     with_tempfile(filename, full_path) do |temp_file|
-      progress = 0
       total = 0
       params = {
         "Accept-Encoding" => 'identity',
@@ -482,7 +508,6 @@ private
           if total
             new_progress = (bytes * 100) / total
             message "\rDownloading %s (%3d%%) " % [filename, new_progress]
-            progress = new_progress
           else
             # Content-Length is unavailable because Transfer-Encoding is chunked
             message "\rDownloading %s " % [filename]
@@ -530,16 +555,15 @@ private
   end
 
   def download_file_ftp(uri, full_path)
+    require "net/ftp"
     filename = File.basename(uri.path)
     with_tempfile(filename, full_path) do |temp_file|
-      progress = 0
       total = 0
       params = {
         :content_length_proc => lambda{|length| total = length },
         :progress_proc => lambda{|bytes|
           new_progress = (bytes * 100) / total
           message "\rDownloading %s (%3d%%) " % [filename, new_progress]
-          progress = new_progress
         }
       }
       if ENV["ftp_proxy"]
@@ -555,6 +579,8 @@ private
       end
       output
     end
+  rescue LoadError
+    raise LoadError, "Ruby #{RUBY_VERSION} does not provide the net-ftp gem, please add it as a dependency if you need to use FTP"
   rescue Net::FTPError
     return false
   end
@@ -568,14 +594,4 @@ private
     FileUtils.mkdir_p File.dirname(full_path)
     FileUtils.mv temp_file.path, full_path, :force => true
   end
-
-  def gcc_cmd
-    cc = ENV["CC"] || RbConfig::CONFIG["CC"] || "gcc"
-    return cc.dup
-  end
-
-  def make_cmd
-    m = ENV['MAKE'] || ENV['make'] || 'make'
-    return m.dup
-  end
 end

data/lib/mini_portile2/mini_portile_cmake.rb

@@ -5,6 +5,11 @@ class MiniPortileCMake < MiniPortile
     "-DCMAKE_INSTALL_PREFIX=#{File.expand_path(port_path)}"
   end
 
+  def initialize(name, version, **kwargs)
+    super(name, version, **kwargs)
+    @cmake_command = kwargs[:cmake_command]
+  end
+
   def configure_defaults
     if MiniPortile.mswin?
       ['-G', 'NMake Makefiles']
@@ -21,7 +26,7 @@ class MiniPortileCMake < MiniPortile
     cache_file = File.join(tmp_path, 'configure.options_cache')
     File.open(cache_file, "w") { |f| f.write computed_options.to_s }
 
-    execute('configure', %w(cmake) + computed_options + ["."])
+    execute('configure', [cmake_cmd] + computed_options + ["."])
   end
 
   def configured?
@@ -39,4 +44,8 @@ class MiniPortileCMake < MiniPortile
     return "nmake" if MiniPortile.mswin?
     super
   end
+
+  def cmake_cmd
+    (ENV["CMAKE"] || @cmake_command || "cmake").dup
+  end
 end

data/lib/mini_portile2/version.rb

@@ -1,3 +1,3 @@
 class MiniPortile
-  VERSION = "2.5.1"
+  VERSION = "2.7.1"
 end

data/mini_portile2.gemspec

@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features|examples)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.3.0"
+
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "minitar", "~> 0.7"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "minitest-hooks", "~> 1.5.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "webrick", "~> 1.0"
-
-  spec.required_ruby_version = ">= 2.3.0"
 end

data/test/helper.rb

@@ -57,4 +57,20 @@ class TestCase < Minitest::Test
   ensure
     ENV['GIT_DIR'] = old
   end
+
+  def with_env(env)
+    before = ENV.to_h.dup
+    env.each { |k, v| ENV[k] = v }
+    yield
+  ensure
+    ENV.replace(before)
+  end
+
+  def without_env(*keys, &blk)
+    before = ENV.to_h.dup
+    keys.flatten.each { |k| ENV.delete(k) }
+    yield
+  ensure
+    ENV.replace(before)
+  end
 end

data/test/test_cmake.rb

@@ -58,3 +58,33 @@ class TestCMake < TestCase
     assert File.exist?(binary), binary
   end
 end
+
+class TestCMakeConfig < TestCase
+  def test_make_command_configuration
+    MiniPortile.stub(:mswin?, false) do
+      without_env("MAKE") do
+        assert_equal("make", MiniPortileCMake.new("test", "1.0.0").make_cmd)
+        assert_equal("xyzzy", MiniPortileCMake.new("test", "1.0.0", make_command: "xyzzy").make_cmd)
+      end
+      with_env("MAKE"=>"asdf") do
+        assert_equal("asdf", MiniPortileCMake.new("test", "1.0.0").make_cmd)
+        assert_equal("asdf", MiniPortileCMake.new("test", "1.0.0", make_command: "xyzzy").make_cmd)
+      end
+    end
+
+    MiniPortile.stub(:mswin?, true) do
+      assert_equal("nmake", MiniPortileCMake.new("test", "1.0.0").make_cmd)
+    end
+  end
+
+  def test_cmake_command_configuration
+    without_env("CMAKE") do
+      assert_equal("cmake", MiniPortileCMake.new("test", "1.0.0").cmake_cmd)
+      assert_equal("xyzzy", MiniPortileCMake.new("test", "1.0.0", cmake_command: "xyzzy").cmake_cmd)
+    end
+    with_env("CMAKE"=>"asdf") do
+      assert_equal("asdf", MiniPortileCMake.new("test", "1.0.0").cmake_cmd)
+      assert_equal("asdf", MiniPortileCMake.new("test", "1.0.0", cmake_command: "xyzzy").cmake_cmd)
+    end
+  end
+end

data/test/test_cook.rb

@@ -67,6 +67,32 @@ class TestCook < TestCase
   end
 end
 
+class TestCookConfiguration < TestCase
+  def test_make_command_configuration
+    without_env("MAKE") do
+      assert_equal("make", MiniPortile.new("test", "1.0.0").make_cmd)
+      assert_equal("xyzzy", MiniPortile.new("test", "1.0.0", make_command: "xyzzy").make_cmd)
+    end
+    with_env("MAKE"=>"asdf") do
+      assert_equal("asdf", MiniPortile.new("test", "1.0.0").make_cmd)
+      assert_equal("asdf", MiniPortile.new("test", "1.0.0", make_command: "xyzzy").make_cmd)
+    end
+  end
+
+  def test_gcc_command_configuration
+    without_env("CC") do
+      expected_compiler = RbConfig::CONFIG["CC"] || "gcc"
+      assert_equal(expected_compiler, MiniPortile.new("test", "1.0.0").gcc_cmd)
+      assert_equal("xyzzy", MiniPortile.new("test", "1.0.0", gcc_command: "xyzzy").gcc_cmd)
+    end
+    with_env("CC"=>"asdf") do
+      assert_equal("asdf", MiniPortile.new("test", "1.0.0").gcc_cmd)
+      assert_equal("asdf", MiniPortile.new("test", "1.0.0", gcc_command: "xyzzy").gcc_cmd)
+    end
+  end
+end
+
+
 class TestCookWithBrokenGitDir < TestCase
   #
   #  this is a test for #69
@@ -113,3 +139,32 @@ class TestCookWithBrokenGitDir < TestCase
     end
   end
 end
+
+class TestCookAgainstSourceDirectory < TestCase
+  attr_accessor :recipe
+
+  def setup
+    super
+
+    @recipe ||= MiniPortile.new("test mini portile", "1.0.0").tap do |recipe|
+      recipe.source_directory = File.expand_path("../assets/test mini portile-1.0.0", __FILE__)
+    end
+  end
+
+  def test_source_directory
+    recipe.cook
+
+    path = File.join(work_dir, "configure.txt")
+    assert(File.exist?(path))
+    assert_equal((recipe.configure_options + ["--prefix=#{recipe.path}"]).inspect,
+                 File.read(path).chomp);
+
+    path = File.join(work_dir, "compile.txt")
+    assert(File.exist?(path))
+    assert_equal("[\"all\"]", File.read(path).chomp);
+
+    path = File.join(work_dir, "install.txt")
+    assert(File.exist?(path))
+    assert_equal("[\"install\"]", File.read(path).chomp);
+  end
+end

data/test/test_download.rb

@@ -18,10 +18,12 @@ describe "recipe download" do
       end
     end
 
-    block.call
-
-    thread.kill
-    server.close
+    begin
+      block.call
+    ensure
+      thread.kill
+      server.close
+    end
 
     request_count.must_be :>, 0
   end
@@ -60,7 +62,7 @@ describe "recipe download" do
       @recipe.files << "file://#{path}"
       @recipe.download
       assert File.exist?(dest)
-      Digest::MD5.file(dest).hexdigest.must_equal "5deffb997041bbb5f11bdcafdbb47975"
+      Digest::MD5.file(dest).hexdigest.must_equal "ee0e9f44e72213015ef976d5ac23931d"
     end
 
     it "other" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_portile2
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.7.1
 platform: ruby
 authors:
 - Luis Lavena
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Simplistic port-like solution for developers