mini_portile2 2.8.5.rc1 → 2.8.5.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235fc41ae2e4aab6133eb8edb741bb535194af46c1aca4e70f0785d2c1253322
-  data.tar.gz: 4ffdc351e59c3cec669361e0fb7b50b536d113363a7ed1c91d8fb681453df4fa
+  metadata.gz: ca5eb330aa4b2b6093e3cbe77641dfd14b3eff2601dce6c97f7de69f42fffcb5
+  data.tar.gz: ad64c2536ab3e978c22d71bc380144f1fa579cf01993e97bf63553ec4732b851
 SHA512:
-  metadata.gz: 03deed0dd932686706f7956fda4f167fb46c73f87f443c058163226019de21d16252c509b453fccfaa8b661bf3f9667b0c1f2fec66edcef042a968fcd847811f
-  data.tar.gz: a5d574f3b181ed8303ae0c799e6092fde2166fd1dc5937961f7b8016eef441a287cf80c4abf1bb2ec0f036894a12ea80f12edb30cec631981f6d8f042ad87959
+  metadata.gz: 67530e1e366cb1605a272234bbfe7ccd6d8659ebd081352a93848de694c03ad0bac23425f2a13c94f67b5c0a55273f178577f31ad088d452f4bfa810e8445c45
+  data.tar.gz: 47e6b00a089e83e422f51c833744226c275af1a8700a21fa11a7f81c70b952da78fbf6df3a0cd8e1347be89b8c1ce6ac0f430a6339b3d0f3340aa2fe1efa0afb

data/CHANGELOG.md

@@ -1,12 +1,14 @@
 ## mini_portile changelog
 
-### 2.8.5.rc1 / 2023-09-13
+### 2.8.5.rc2 / 2023-09-17
 
 #### Added
 
 - New method `MiniPortile#mkmf_config` will set up MakeMakefile variables to properly link against the recipe. This should make it easier for C extensions to package third-party libraries.
   - 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.
+- New methods `#lib_path` and `#include_path` which point at the installed directories under `ports`.
 
 
 ### 2.8.4 / 2023-07-18

data/lib/mini_portile2/mini_portile.rb

@@ -27,6 +27,8 @@ class Net::HTTP
   end
 end
 
+$MINI_PORTILE_STATIC_LIBS = {}
+
 class MiniPortile
   DEFAULT_TIMEOUT = 10
 
@@ -237,11 +239,10 @@ class MiniPortile
   end
 
   def activate
-    lib_path = File.join(port_path, "lib")
     vars = {
       'PATH'          => File.join(port_path, 'bin'),
-      'CPATH'         => File.join(port_path, 'include'),
-      'LIBRARY_PATH'  => lib_path
+      'CPATH'         => include_path,
+      'LIBRARY_PATH'  => lib_path,
     }.reject { |env, path| !File.directory?(path) }
 
     output "Activating #{@name} #{@version} (from #{port_path})..."
@@ -268,11 +269,19 @@ class MiniPortile
     end
   end
 
-  def mkmf_config(pkg: nil, dir: nil)
+  # pkg: the pkg-config file name (without the .pc extension)
+  # dir: inject the directory path for the pkg-config file (probably only useful for tests)
+  # static: the name of the static library archive (without the "lib" prefix or the file extension), or nil for dynamic linking
+  #
+  # we might be able to be terribly clever and infer the name of the static archive file, but
+  # unfortunately projects have so much freedom in what they can report (for name, for libs, etc.)
+  # that it feels unreliable to try to do so, so I'm preferring to just have the developer make it
+  # explicit.
+  def mkmf_config(pkg: nil, dir: nil, static: nil)
     require "mkmf"
 
     if pkg
-      dir ||= File.join(path, "lib", "pkgconfig")
+      dir ||= File.join(lib_path, "pkgconfig")
       pcfile = File.join(dir, "#{pkg}.pc")
       unless File.exist?(pcfile)
         raise ArgumentError, "pkg-config file '#{pcfile}' does not exist"
@@ -288,42 +297,81 @@ class MiniPortile
 
       incflags = minimal_pkg_config(pcfile, "cflags-only-I")
       cflags = minimal_pkg_config(pcfile, "cflags-only-other")
-      ldflags = minimal_pkg_config(pcfile, "libs-only-L", "static")
-      libflags = minimal_pkg_config(pcfile, "libs-only-l", "static")
+      if static
+        ldflags = minimal_pkg_config(pcfile, "libs-only-L", "static")
+        libflags = minimal_pkg_config(pcfile, "libs-only-l", "static")
+      else
+        ldflags = minimal_pkg_config(pcfile, "libs-only-L")
+        libflags = minimal_pkg_config(pcfile, "libs-only-l")
+      end
     else
       output "Configuring MakeMakefile for #{@name} #{@version} (from #{path})\n"
 
-      include_path = File.join(path, "include")
-      lib_path = File.join(path, "lib")
-
       lib_name = name.sub(/\Alib/, "") # TODO: use delete_prefix when we no longer support ruby 2.4
 
-      incflags = "-I#{include_path}" if Dir.exist?(include_path)
-      ldflags = "-L#{lib_path}" if Dir.exist?(lib_path)
-      libflags = "-l#{lib_name}" if Dir.exist?(lib_path)
+      incflags = Dir.exist?(include_path) ? "-I#{include_path}" : ""
+      cflags = ""
+      ldflags = Dir.exist?(lib_path) ? "-L#{lib_path}" : ""
+      libflags = Dir.exist?(lib_path) ? "-l#{lib_name}" : ""
     end
 
-    if ldflags
-      libpaths = ldflags.split.map { |f| f.sub(/\A-L/, "") }
+    if static
+      libdir = lib_path
+      if pcfile
+        variables = minimal_pkg_config(pcfile, "print-variables").split("\n").map(&:strip)
+        if variables.include?("libdir")
+          libdir = minimal_pkg_config(pcfile, "variable=libdir")
+        end
+      end
+
+      #
+      # keep track of the libraries we're statically linking against, and fix up ldflags and
+      # libflags to make sure we link statically against the recipe's libaries.
+      #
+      # this avoids the unintentionally dynamically linking against system libraries, and makes sure
+      # that if multiple pkg-config files reference each other that we are able to intercept flags
+      # from dependent packages that reference the static archive.
+      #
+      $MINI_PORTILE_STATIC_LIBS[static] = libdir
+      static_ldflags = $MINI_PORTILE_STATIC_LIBS.values.map { |v| "-L#{v}" }
+      static_libflags = $MINI_PORTILE_STATIC_LIBS.keys.map { |v| "-l#{v}" }
+
+      # remove `-L#{libdir}` and `-lfoo`. we don't need them since we link against the static
+      # archive using the full path.
+      ldflags = ldflags.shellsplit.reject { |f| static_ldflags.include?(f) }.shelljoin
+      libflags = libflags.shellsplit.reject { |f| static_libflags.include?(f) }.shelljoin
+
+      # prepend the full path to the static archive to the linker flags
+      static_archive = File.join(libdir, "lib#{static}.#{$LIBEXT}")
+      libflags = [static_archive, libflags].join(" ").strip
     end
 
-    # prefer this package by prepending directories to the search path
+    # prefer this package by prepending to search paths and library flags
     #
-    # use $LIBPATH instead of $LDFLAGS to ensure we get the `-Wl,-rpath` linker flag for re-finding
-    # shared libraries
-    $INCFLAGS = [incflags, $INCFLAGS].join(" ").strip if incflags
-    $LIBPATH = libpaths | $LIBPATH if libpaths
+    # convert the ldflags into a list of directories and append to $LIBPATH (instead of just using
+    # $LDFLAGS) to ensure we get the `-Wl,-rpath` linker flag for re-finding shared libraries.
+    $INCFLAGS = [incflags, $INCFLAGS].join(" ").strip
+    libpaths = ldflags.shellsplit.map { |f| f.sub(/\A-L/, "") }
+    $LIBPATH = libpaths | $LIBPATH
+    $libs = [libflags, $libs].join(" ").strip
 
-    # prefer this package's flags by appending them to the command line
-    $CFLAGS = [$CFLAGS, cflags].join(" ").strip if cflags
-    $CXXFLAGS = [$CXXFLAGS, cflags].join(" ").strip if cflags
-    $libs = [$libs, libflags].join(" ").strip if libflags
+    # prefer this package's compiler flags by appending them to the command line
+    $CFLAGS = [$CFLAGS, cflags].join(" ").strip
+    $CXXFLAGS = [$CXXFLAGS, cflags].join(" ").strip
   end
 
   def path
     File.expand_path(port_path)
   end
 
+  def include_path
+    File.join(path, "include")
+  end
+
+  def lib_path
+    File.join(path, "lib")
+  end
+
   def gcc_cmd
     (ENV["CC"] || @gcc_command || RbConfig::CONFIG["CC"] || "gcc").dup
   end

data/lib/mini_portile2/version.rb

@@ -1,3 +1,3 @@
 class MiniPortile
-  VERSION = "2.8.5.rc1"
+  VERSION = "2.8.5.rc2"
 end

data/test/test_mkmf_config.rb

@@ -3,11 +3,17 @@ require File.expand_path('../helper', __FILE__)
 require "mkmf" # initialize $LDFLAGS et al here, instead of in the middle of a test
 
 class TestMkmfConfig < TestCase
-  attr_reader :recipe, :include_path, :lib_path
+  attr_reader :recipe
 
   LIBXML_PCP = File.join(__dir__, "assets", "pkgconf", "libxml2")
   LIBXSLT_PCP = File.join(__dir__, "assets", "pkgconf", "libxslt")
 
+  def make_recipe(name, version)
+    MiniPortile.new(name, version).tap do |recipe|
+      recipe.logger = StringIO.new # hush output
+    end
+  end
+
   def setup
     super
 
@@ -19,14 +25,11 @@ class TestMkmfConfig < TestCase
     $CFLAGS = "-xxx"
     $CXXFLAGS = "-xxx"
     $libs = "-lxxx"
+    $MINI_PORTILE_STATIC_LIBS = {}
 
     FileUtils.rm_rf(["tmp", "ports"]) # remove any previous test files
 
-    @recipe = MiniPortile.new("libfoo", "1.0.0").tap do |recipe|
-      recipe.logger = StringIO.new
-    end
-    @include_path = File.join(@recipe.path, "include")
-    @lib_path = File.join(@recipe.path, "lib")
+    @recipe = make_recipe("libfoo", "1.0.0")
   end
 
   def teardown
@@ -37,6 +40,7 @@ class TestMkmfConfig < TestCase
     $CFLAGS = ""
     $CXXFLAGS = ""
     $libs = ""
+    $MINI_PORTILE_STATIC_LIBS = {}
     @save_env.each do |var, val|
       ENV[var] = val
     end
@@ -47,35 +51,48 @@ class TestMkmfConfig < TestCase
   def test_mkmf_config_recipe_LIBPATH_global_lib_dir_does_not_exist
     recipe.mkmf_config
 
-    refute_includes($LIBPATH, lib_path)
-    refute_includes($libs.split, "-lfoo")
+    refute_includes($LIBPATH, recipe.lib_path)
+    refute_includes($libs.shellsplit, "-lfoo")
   end
 
-  def test_mkmf_config_recipe_LIBPATH_global
-    FileUtils.mkdir_p(lib_path)
+  def test_mkmf_config_recipe_LIBPATH_global_not_static
+    FileUtils.mkdir_p(recipe.lib_path)
 
     recipe.mkmf_config
 
-    assert_includes($LIBPATH, lib_path)
-    assert_operator($LIBPATH.index(lib_path), :<, $LIBPATH.index("xxx")) # prepend
+    assert_includes($LIBPATH, recipe.lib_path)
+    assert_operator($LIBPATH.index(recipe.lib_path), :<, $LIBPATH.index("xxx")) # prepend
+
+    assert_includes($libs.shellsplit, "-lfoo") # note the recipe name is "libfoo"
+    assert_match(%r{-lfoo.*-lxxx}, $libs) # prepend
+  end
+
+  def test_mkmf_config_recipe_LIBPATH_global_static
+    FileUtils.mkdir_p(recipe.lib_path)
+    static_lib_path = File.join(recipe.lib_path, "libfoo.#{$LIBEXT}")
+
+    recipe.mkmf_config(static: "foo")
+
+    refute_includes($LIBPATH, recipe.lib_path)
 
-    assert_includes($libs.split, "-lfoo") # note the recipe name is "libfoo"
-    assert_match(%r{-lxxx.*-lfoo}, $libs) # append
+    refute_includes($libs.shellsplit, "-lfoo") # note the recipe name is "libfoo"
+    assert_includes($libs.shellsplit, static_lib_path)
+    assert_match(%r{#{static_lib_path}.*-lxxx}, $libs) # prepend
   end
 
   def test_mkmf_config_recipe_INCFLAGS_global_include_dir_does_not_exist
     recipe.mkmf_config
 
-    refute_includes($INCFLAGS.split, "-I#{include_path}")
+    refute_includes($INCFLAGS.shellsplit, "-I#{recipe.include_path}")
   end
 
   def test_mkmf_config_recipe_INCFLAGS_global
-    FileUtils.mkdir_p(include_path)
+    FileUtils.mkdir_p(recipe.include_path)
 
     recipe.mkmf_config
 
-    assert_includes($INCFLAGS.split, "-I#{include_path}")
-    assert_match(%r{-I#{include_path}.*-I/xxx}, $INCFLAGS) # prepend
+    assert_includes($INCFLAGS.shellsplit, "-I#{recipe.include_path}")
+    assert_match(%r{-I#{recipe.include_path}.*-I/xxx}, $INCFLAGS) # prepend
   end
 
   def test_mkmf_config_pkgconf_does_not_exist
@@ -84,7 +101,7 @@ class TestMkmfConfig < TestCase
     end
   end
 
-  def test_mkmf_config_pkgconf_LIBPATH_global
+  def test_mkmf_config_pkgconf_LIBPATH_global_not_static
     # can't get the pkgconf utility to install on windows with ruby 2.3 in CI
     skip if MiniPortile.windows? && RUBY_VERSION < "2.4"
 
@@ -92,9 +109,28 @@ class TestMkmfConfig < TestCase
 
     assert_includes($LIBPATH, "/foo/libxml2/2.11.5/lib")
     assert_operator($LIBPATH.index("/foo/libxml2/2.11.5/lib"), :<, $LIBPATH.index("xxx")) # prepend
+    refute_includes($LIBPATH, "/foo/zlib/1.3/lib")
+
+    assert_includes($libs.shellsplit, "-lxml2")
+    assert_match(%r{-lxml2.*-lxxx}, $libs) # prepend
+    refute_includes($libs.shellsplit, "-lz")
+  end
+
+  def test_mkmf_config_pkgconf_LIBPATH_global_static
+    # can't get the pkgconf utility to install on windows with ruby 2.3 in CI
+    skip if MiniPortile.windows? && RUBY_VERSION < "2.4"
+
+    static_lib_path = "/foo/libxml2/2.11.5/lib/libxml2.#{$LIBEXT}"
 
-    assert_includes($libs.split, "-lxml2")
-    assert_match(%r{-lxxx.*-lxml2}, $libs) # append
+    recipe.mkmf_config(pkg: "libxml-2.0", dir: LIBXML_PCP, static: "xml2")
+
+    refute_includes($LIBPATH, "/foo/libxml2/2.11.5/lib")
+    refute_includes($libs.shellsplit, "-lxml2")
+    assert_includes($libs.shellsplit, static_lib_path)
+    assert_match(%r{#{static_lib_path}.*-lxxx}, $libs) # prepend
+
+    assert_includes($LIBPATH, "/foo/zlib/1.3/lib") # from --static
+    assert_includes($libs.shellsplit, "-lz") # from --static
   end
 
   def test_mkmf_config_pkgconf_CFLAGS_global
@@ -103,14 +139,14 @@ class TestMkmfConfig < TestCase
 
     recipe.mkmf_config(pkg: "libxml-2.0", dir: LIBXML_PCP)
 
-    assert_includes($INCFLAGS.split, "-I/foo/libxml2/2.11.5/include/libxml2")
+    assert_includes($INCFLAGS.shellsplit, "-I/foo/libxml2/2.11.5/include/libxml2")
     assert_match(%r{-I/foo/libxml2/2.11.5/include/libxml2.*-I/xxx}, $INCFLAGS) # prepend
 
-    assert_includes($CFLAGS.split, "-ggdb3")
-    assert_match(%r{-xxx.*-ggdb3}, $CFLAGS) # prepend
+    assert_includes($CFLAGS.shellsplit, "-ggdb3")
+    assert_match(%r{-xxx.*-ggdb3}, $CFLAGS) # append
 
-    assert_includes($CXXFLAGS.split, "-ggdb3")
-    assert_match(%r{-xxx.*-ggdb3}, $CXXFLAGS) # prepend
+    assert_includes($CXXFLAGS.shellsplit, "-ggdb3")
+    assert_match(%r{-xxx.*-ggdb3}, $CXXFLAGS) # append
   end
 
   def test_mkmf_config_pkgconf_path_accumulation
@@ -122,37 +158,44 @@ class TestMkmfConfig < TestCase
       refute_includes(pcpaths, LIBXSLT_PCP)
     end
 
-    recipe.mkmf_config(pkg: "libxml-2.0", dir: LIBXML_PCP)
+    make_recipe("libxml2", "2.11.5").tap do |recipe|
+      recipe.mkmf_config(pkg: "libxml-2.0", dir: LIBXML_PCP, static: "xml2")
 
-    ENV["PKG_CONFIG_PATH"].split(File::PATH_SEPARATOR).tap do |pcpaths|
-      assert_includes(pcpaths, LIBXML_PCP)
-      refute_includes(pcpaths, LIBXSLT_PCP)
+      ENV["PKG_CONFIG_PATH"].split(File::PATH_SEPARATOR).tap do |pcpaths|
+        assert_includes(pcpaths, LIBXML_PCP)
+        refute_includes(pcpaths, LIBXSLT_PCP)
+      end
     end
 
-    recipe.mkmf_config(pkg: "libxslt", dir: LIBXSLT_PCP)
+    make_recipe("libxslt", "1.13.8").tap do |recipe|
+      recipe.mkmf_config(pkg: "libxslt", dir: LIBXSLT_PCP, static: "xslt")
 
-    ENV["PKG_CONFIG_PATH"].split(File::PATH_SEPARATOR).tap do |pcpaths|
-      assert_includes(pcpaths, LIBXML_PCP)
-      assert_includes(pcpaths, LIBXSLT_PCP)
-    end
+      ENV["PKG_CONFIG_PATH"].split(File::PATH_SEPARATOR).tap do |pcpaths|
+        assert_includes(pcpaths, LIBXML_PCP)
+        assert_includes(pcpaths, LIBXSLT_PCP)
+      end
 
-    recipe.mkmf_config(pkg: "libexslt", dir: LIBXSLT_PCP)
+      recipe.mkmf_config(pkg: "libexslt", dir: LIBXSLT_PCP, static: "exslt")
+    end
 
-    $INCFLAGS.split.tap do |incflags|
+    $INCFLAGS.shellsplit.tap do |incflags|
       assert_includes(incflags, "-I/foo/libxml2/2.11.5/include/libxml2")
       assert_includes(incflags, "-I/foo/libxslt/1.1.38/include")
     end
-    assert_includes($LIBPATH, "/foo/libxml2/2.11.5/lib")
-    assert_includes($LIBPATH, "/foo/libxslt/1.1.38/lib")
-    assert_includes($LIBPATH, "/foo/zlib/1.3/lib") # from `--static`
-    $CFLAGS.split.tap do |cflags|
+    $CFLAGS.shellsplit.tap do |cflags|
       assert_includes(cflags, "-ggdb3")
       assert_includes(cflags, "-Wno-deprecated-enum-enum-conversion")
     end
-    $libs.split.tap do |libflags|
-      assert_includes(libflags, "-lxml2")
-      assert_includes(libflags, "-lxslt")
-      assert_includes(libflags, "-lexslt")
+    refute_includes($LIBPATH, "/foo/libxml2/2.11.5/lib")
+    refute_includes($LIBPATH, "/foo/libxslt/1.1.38/lib")
+    assert_includes($LIBPATH, "/foo/zlib/1.3/lib") # from `--static`
+    $libs.shellsplit.tap do |libflags|
+      refute_includes(libflags, "-lxml2")
+      assert_includes(libflags, "/foo/libxml2/2.11.5/lib/libxml2.#{$LIBEXT}")
+      refute_includes(libflags, "-lxslt")
+      assert_includes(libflags, "/foo/libxslt/1.1.38/lib/libxslt.#{$LIBEXT}")
+      refute_includes(libflags, "-lexslt")
+      assert_includes(libflags, "/foo/libxslt/1.1.38/lib/libexslt.#{$LIBEXT}")
       assert_includes(libflags, "-lz") # from `--static`
     end
   end

data/test/test_recipe.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestRecipe < TestCase
+  def test_path
+    recipe = MiniPortile.new("libfoo", "1.0.0")
+    assert_equal(File.expand_path(File.join(recipe.target, recipe.host, recipe.name, recipe.version)), recipe.path)
+  end
+
+  def test_lib_path
+    recipe = MiniPortile.new("libfoo", "1.0.0")
+    assert_equal(File.join(recipe.path, "lib"), recipe.lib_path)
+  end
+
+  def test_include_path
+    recipe = MiniPortile.new("libfoo", "1.0.0")
+    assert_equal(File.join(recipe.path, "include"), recipe.include_path)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mini_portile2
 version: !ruby/object:Gem::Version
-  version: 2.8.5.rc1
+  version: 2.8.5.rc2
 platform: ruby
 authors:
 - Luis Lavena
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-13 00:00:00.000000000 Z
+date: 2023-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,6 +139,7 @@ files:
 - test/test_execute.rb
 - test/test_mkmf_config.rb
 - test/test_proxy.rb
+- test/test_recipe.rb
 homepage: https://github.com/flavorjones/mini_portile
 licenses:
 - MIT
@@ -184,3 +185,4 @@ test_files:
 - test/test_execute.rb
 - test/test_mkmf_config.rb
 - test/test_proxy.rb
+- test/test_recipe.rb