mini_portile2 2.1.0 → 2.8.7

data/lib/mini_portile2/mini_portile_cmake.rb

@@ -0,0 +1,119 @@
+require 'mini_portile2/mini_portile'
+require 'open3'
+
+class MiniPortileCMake < MiniPortile
+  attr_accessor :system_name
+
+  def configure_prefix
+    "-DCMAKE_INSTALL_PREFIX=#{File.expand_path(port_path)}"
+  end
+
+  def initialize(name, version, **kwargs)
+    super(name, version, **kwargs)
+    @cmake_command = kwargs[:cmake_command]
+    @cmake_build_type = kwargs[:cmake_build_type]
+  end
+
+  def configure_defaults
+    [
+      generator_defaults,
+      cmake_compile_flags,
+    ].flatten
+  end
+
+  def configure
+    return if configured?
+
+    cache_file = File.join(tmp_path, 'configure.options_cache')
+    File.open(cache_file, "w") { |f| f.write computed_options.to_s }
+
+    execute('configure', [cmake_cmd] + computed_options + ["."])
+  end
+
+  def configured?
+    configure = File.join(work_path, 'configure')
+    makefile  = File.join(work_path, 'CMakefile')
+    cache_file  = File.join(tmp_path, 'configure.options_cache')
+
+    stored_options  = File.exist?(cache_file) ? File.read(cache_file) : ""
+    current_options = computed_options.to_s
+
+    (current_options == stored_options) && newer?(makefile, configure)
+  end
+
+  def make_cmd
+    return "nmake" if MiniPortile.mswin?
+    super
+  end
+
+  def cmake_cmd
+    (ENV["CMAKE"] || @cmake_command || "cmake").dup
+  end
+
+  def cmake_build_type
+    (ENV["CMAKE_BUILD_TYPE"] || @cmake_build_type || "Release").dup
+  end
+
+  private
+
+  def generator_defaults
+    if MiniPortile.mswin? && generator_available?('NMake')
+      ['-G', 'NMake Makefiles']
+    elsif MiniPortile.mingw? && generator_available?('MSYS')
+      ['-G', 'MSYS Makefiles']
+    else
+      []
+    end
+  end
+
+  def cmake_compile_flags
+    # RbConfig::CONFIG['CC'] and RbConfig::CONFIG['CXX'] can contain additional flags, for example
+    # "clang++ -std=gnu++11" or "clang -fdeclspec". CMake is just looking for the command name.
+    cc_compiler = cc_cmd.split.first
+    cxx_compiler = cxx_cmd.split.first
+
+    # needed to ensure cross-compilation with CMake targets the right CPU and compilers
+    [
+      "-DCMAKE_SYSTEM_NAME=#{cmake_system_name}",
+      "-DCMAKE_SYSTEM_PROCESSOR=#{cpu_type}",
+      "-DCMAKE_C_COMPILER=#{cc_compiler}",
+      "-DCMAKE_CXX_COMPILER=#{cxx_compiler}",
+      "-DCMAKE_BUILD_TYPE=#{cmake_build_type}",
+    ]
+  end
+
+  # Full list: https://gitlab.kitware.com/cmake/cmake/-/blob/v3.26.4/Modules/CMakeDetermineSystem.cmake?ref_type=tags#L12-31
+  def cmake_system_name
+    return system_name if system_name
+
+    if MiniPortile.linux?
+      'Linux'
+    elsif MiniPortile.darwin?
+      'Darwin'
+    elsif MiniPortile.windows?
+      'Windows'
+    elsif MiniPortile.freebsd?
+      'FreeBSD'
+    elsif MiniPortile.openbsd?
+      'OpenBSD'
+    elsif MiniPortile.solaris?
+      'SunOS'
+    else
+      raise "Unable to set CMAKE_SYSTEM_NAME for #{MiniPortile.target_os}"
+    end
+  end
+
+  def generator_available?(generator_type)
+    stdout_str, status = Open3.capture2("#{cmake_cmd} --help")
+
+    raise 'Unable to determine whether CMake supports #{generator_type} Makefile generator' unless status.success?
+
+    stdout_str.include?("#{generator_type} Makefiles")
+  end
+
+  def cpu_type
+    return 'x86_64' if MiniPortile.target_cpu == 'x64'
+
+    MiniPortile.target_cpu
+  end
+end

data/lib/mini_portile2/version.rb

@@ -1,3 +1,3 @@
 class MiniPortile
-  VERSION = "2.1.0"
+  VERSION = "2.8.7"
 end

data/lib/mini_portile2.rb

@@ -1,2 +1,3 @@
 require "mini_portile2/version"
 require "mini_portile2/mini_portile"
+require "mini_portile2/mini_portile_cmake"

data/mini_portile2.gemspec

@@ -1,37 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mini_portile2/version'
+require_relative "lib/mini_portile2/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "mini_portile2"
-  spec.version       = MiniPortile::VERSION
+  spec.name = "mini_portile2"
+  spec.version = MiniPortile::VERSION
 
-  spec.authors       = ['Luis Lavena', 'Mike Dalessio', 'Lars Kanis']
-  spec.email         = 'mike.dalessio@gmail.com'
+  spec.authors = ["Luis Lavena", "Mike Dalessio", "Lars Kanis"]
+  spec.email = "mike.dalessio@gmail.com"
 
-  spec.summary       = "Simplistic port-like solution for developers"
-  spec.description   = "Simplistic port-like solution for developers. It provides a standard and simplified way to compile against dependency libraries without messing up your system."
+  spec.summary = "Simple autoconf and cmake builder for developers"
+  spec.description = <<~TEXT
+    Simple autoconf and cmake builder for developers. It provides a standard way to compile against
+    dependency libraries without requiring system-wide installation. It also simplifies
+    vendoring and cross-compilation by providing a consistent build interface.
+  TEXT
 
-  spec.homepage      = 'http://github.com/flavorjones/mini_portile'
-  spec.licenses      = ['MIT']
+  spec.homepage = "https://github.com/flavorjones/mini_portile"
+  spec.licenses = ["MIT"]
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  begin
+    spec.files = `git ls-files -z`.split("\x0")
+  rescue Exception => e
+    warn "WARNING: could not set spec.files: #{e.class}: #{e}"
+  end
 
   # omit the `examples` directory from the gem, because it's large and
   # not necessary to be packaged in the gem.
-  example_files      = spec.files.grep(%r{^examples/})
+  example_files = spec.files.grep(%r{^examples/})
   spec.files -= example_files
 
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features|examples)/})
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features|examples)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.8.0"
-  spec.add_development_dependency "minitest-hooks", "~> 1.4.0"
-  spec.add_development_dependency "minitar", "~> 0.5.4"
+  spec.required_ruby_version = ">= 2.3.0"
 
-  spec.required_ruby_version = ">= 1.9.2"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "minitar", "~> 0.9"
+  spec.add_development_dependency "minitest", "~> 5.15"
+  spec.add_development_dependency "minitest-hooks", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "webrick", "~> 1.7"
 end

data/test/assets/gpg-fixtures/data

@@ -0,0 +1 @@
+test

data/test/assets/gpg-fixtures/data.asc

@@ -0,0 +1,9 @@
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1
+
+iJwEAAECAAYFAlcFOD8ACgkQZeg+SWTDcLNIswP/XvVRoJ+eQ2u2v+WjXdBBKBSW
+pzM216aJPRBxPl98xNUUKjqga+tjKmIHJn5T4CIxHqis1toPxtE5tKnc6cVO1aqY
+bCUfkWyt/A3qRHQuniRUWSBKZWdk+j3AopTpd3i/r/s0pDj3bMHJ7bDOTsEskNcM
+KpgFfNM1ieFRQmIWPWg=
+=kbKc
+-----END PGP SIGNATURE-----

data/test/assets/gpg-fixtures/data.invalid.asc

@@ -0,0 +1,9 @@
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG v1
+
+iJwEAQECAAYFAlcFLEgACgkQZeg+SWTDcLPVwgQAg8KTI91Ryx38YplzgWV9tUPj
+o7J7IEzb8faE7m2mgtq8m62DvA4h/PJzmbh1EJJ4VkO+A4O2LVh/bTgnyYXv+kMu
+sEmvK35PnAC8r7pv98VSbMEXyV/rK3+uGhTvnXZYkULvMVYkN/EHIh2bCQJ3R14X
+MY8El95QST8/dR/yBkw=
+=qbod
+-----END PGP SIGNATURE-----

data/test/assets/pkgconf/libxml2/libxml-2.0.pc

@@ -0,0 +1,13 @@
+prefix=/foo/libxml2/2.11.5
+exec_prefix=${prefix}
+libdir=/foo/libxml2/2.11.5/lib
+includedir=${prefix}/include
+modules=1
+
+Name: libXML
+Version: 2.11.5
+Description: libXML library version2.
+Requires:
+Libs: -L${libdir} -lxml2
+Libs.private: -L/foo/zlib/1.3/lib -lz     -lm  
+Cflags: -I${includedir}/libxml2 -ggdb3

data/test/assets/pkgconf/libxslt/libexslt.pc

@@ -0,0 +1,13 @@
+prefix=/foo/libxslt/1.1.38
+exec_prefix=${prefix}
+libdir=/foo/libxslt/1.1.38/lib
+includedir=${prefix}/include
+
+
+Name: libexslt
+Version: 0.8.21
+Description: EXSLT Extension library
+Requires: libxml-2.0, libxslt
+Cflags: -I${includedir}
+Libs: -L${libdir} -lexslt
+Libs.private: -lm 

data/test/assets/pkgconf/libxslt/libxslt.pc

@@ -0,0 +1,13 @@
+prefix=/foo/libxslt/1.1.38
+exec_prefix=${prefix}
+libdir=/foo/libxslt/1.1.38/lib
+includedir=${prefix}/include
+
+
+Name: libxslt
+Version: 1.1.38
+Description: XSLT library version 2.
+Requires: libxml-2.0
+Cflags: -I${includedir} -Wno-deprecated-enum-enum-conversion
+Libs: -L${libdir} -lxslt
+Libs.private: -lm

data/test/assets/test-cmake-1.0/CMakeLists.txt

@@ -0,0 +1,7 @@
+# CMakeLists files in this project can
+# refer to the root source directory of the project as ${HELLO_SOURCE_DIR} and
+# to the root binary directory of the project as ${HELLO_BINARY_DIR}.
+cmake_minimum_required (VERSION 2.8.7)
+project (HELLO)
+add_executable (hello hello.c)
+install (TARGETS hello DESTINATION bin)

data/test/assets/test-cmake-1.0/hello.c

@@ -0,0 +1,4 @@
+int main(int argc, char** argv)
+{
+  return 0 ;
+}

data/test/helper.rb

@@ -9,6 +9,12 @@ require 'archive/tar/minitar'
 require 'fileutils'
 require 'erb'
 require 'mini_portile2'
+require 'logger'
+
+puts "#{__FILE__}:#{__LINE__}: relevant RbConfig::CONFIG values:"
+%w[target_os target_cpu CC CXX].each do |key|
+  puts "- #{key}: #{RbConfig::CONFIG[key].inspect}"
+end
 
 class TestCase < Minitest::Test
   include Minitest::Hooks
@@ -18,7 +24,12 @@ class TestCase < Minitest::Test
   attr_accessor :webrick
 
   def start_webrick(path)
-    @webrick = WEBrick::HTTPServer.new(:Port => HTTP_PORT, :DocumentRoot => path).tap do |w|
+    @webrick = WEBrick::HTTPServer.new(
+      :Port => HTTP_PORT,
+      :DocumentRoot => path,
+      :Logger => Logger.new(File::NULL),
+      :AccessLog => [],
+    ).tap do |w|
       Thread.new do
         w.start
       end
@@ -37,11 +48,11 @@ class TestCase < Minitest::Test
     end
   end
 
-  def create_tar(tar_path, assets_path)
+  def create_tar(tar_path, assets_path, directory)
     FileUtils.mkdir_p(File.dirname(tar_path))
     Zlib::GzipWriter.open(tar_path) do |fdtgz|
       Dir.chdir(assets_path) do
-        Archive::Tar::Minitar.pack("test mini portile-1.0.0", fdtgz)
+        Archive::Tar::Minitar.pack(directory, fdtgz)
       end
     end
   end
@@ -49,4 +60,28 @@ class TestCase < Minitest::Test
   def work_dir(r=recipe)
     "tmp/#{r.host}/ports/#{r.name}/#{r.version}/#{r.name}-#{r.version}"
   end
+
+  def with_custom_git_dir(dir)
+    old = ENV['GIT_DIR']
+    ENV['GIT_DIR'] = dir
+    yield
+  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_activate.rb

@@ -0,0 +1,139 @@
+require File.expand_path('../helper', __FILE__)
+
+class TestActivate < TestCase
+  attr_reader :recipe
+
+  def setup
+    super
+
+    @save_env = %w[PATH CPATH LIBRARY_PATH LDFLAGS].inject({}) do |env, var|
+      env.update(var => ENV[var])
+    end
+
+    FileUtils.rm_rf(["tmp", "ports"]) # remove any previous test files
+
+    @recipe = MiniPortile.new("foo", "1.0.0").tap do |recipe|
+      recipe.logger = StringIO.new
+    end
+  end
+
+  def teardown
+    FileUtils.rm_rf(["tmp", "ports"]) # remove any previous test files
+
+    @save_env.each do |var, val|
+      ENV[var] = val
+    end
+
+    super
+  end
+
+  def test_PATH_env_var_when_bin_does_not_exist
+    ENV["PATH"] = "foo"
+    refute(Dir.exist?(bin_path))
+    refute_includes(path_elements('PATH'), bin_path)
+
+    recipe.activate
+
+    refute_includes(path_elements('PATH'), bin_path)
+  end
+
+  def test_PATH_env_var_when_bin_exists
+    ENV["PATH"] = "foo"
+    FileUtils.mkdir_p(bin_path)
+    refute_includes(path_elements('PATH'), bin_path)
+
+    recipe.activate
+
+    assert_includes(path_elements('PATH'), bin_path)
+    assert_equal(path_elements('PATH').first, bin_path)
+  end
+
+  def test_CPATH_env_var_when_include_does_not_exist
+    ENV["CPATH"] = "foo"
+    refute(Dir.exist?(include_path))
+    refute_includes(path_elements('CPATH'), include_path)
+
+    recipe.activate
+
+    refute_includes(path_elements('CPATH'), include_path)
+  end
+
+  def test_CPATH_env_var_when_include_exists
+    ENV["CPATH"] = "foo"
+    FileUtils.mkdir_p(include_path)
+    refute_includes(path_elements('CPATH'), include_path)
+
+    recipe.activate
+
+    assert_includes(path_elements('CPATH'), include_path)
+    assert_equal(path_elements('CPATH').first, include_path)
+  end
+
+  def test_LIBRARY_PATH_env_var_when_lib_does_not_exist
+    ENV["LIBRARY_PATH"] = "foo"
+    refute(Dir.exist?(lib_path))
+    refute_includes(path_elements('LIBRARY_PATH'), lib_path)
+
+    recipe.activate
+
+    refute_includes(path_elements('LIBRARY_PATH'), lib_path)
+  end
+
+  def test_LIBRARY_PATH_env_var_when_lib_exists
+    ENV["LIBRARY_PATH"] = "foo"
+    FileUtils.mkdir_p(lib_path)
+    refute_includes(path_elements('LIBRARY_PATH'), lib_path)
+
+    recipe.activate
+
+    assert_includes(path_elements('LIBRARY_PATH'), lib_path)
+    assert_equal(path_elements('LIBRARY_PATH').first, lib_path)
+  end
+
+  def test_LDFLAGS_env_var_when_not_cross_compiling
+    ENV["LDFLAGS"] = "-lfoo"
+    FileUtils.mkdir_p(lib_path)
+    assert_equal(recipe.host, recipe.original_host) # assert on setup)
+
+    refute_includes(flag_elements('LDFLAGS'), "-L#{lib_path}")
+
+    recipe.activate
+
+    refute_includes(flag_elements('LDFLAGS'), "-L#{lib_path}")
+  end
+
+  def test_LDFLAGS_env_var_when_cross_compiling
+    ENV["LDFLAGS"] = "-lfoo"
+    recipe.host = recipe.original_host + "-x" # make them not-equal
+    FileUtils.mkdir_p(lib_path)
+
+    refute_includes(flag_elements('LDFLAGS'), "-L#{lib_path}")
+
+    recipe.activate
+
+    assert_includes(flag_elements('LDFLAGS'), "-L#{lib_path}")
+    assert_equal(flag_elements('LDFLAGS').first, "-L#{lib_path}")
+  end
+
+  private
+
+  def path_elements(varname)
+    ENV.fetch(varname, "").split(File::PATH_SEPARATOR)
+  end
+
+  def flag_elements(varname)
+    ENV.fetch(varname, "").split
+  end
+
+  def bin_path
+    MiniPortile.native_path(File.join(recipe.path, "bin"))
+  end
+
+  def include_path
+    MiniPortile.native_path(File.join(recipe.path, "include"))
+  end
+
+  def lib_path
+    MiniPortile.native_path(File.join(recipe.path, "lib"))
+  end
+end