ruby-magic-static 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e25b370819fbafc50a7ea88a29f26c42be0eed8823fe62750cf580587a77ddb2
-  data.tar.gz: d9e4e9dd790db8a7ce9b3960df281b3ab45690a93780979e32faf39f17eb9e49
+  metadata.gz: d2c030798a63296efab456780eb4c3007d726a6b1d4e476eeb3dc75d0b841a38
+  data.tar.gz: f6160d4cbd9f4b06f258c4520c053a8547fdba2f19929379a5f9f6838027eeb8
 SHA512:
-  metadata.gz: 527d6cf28036c92c87a4065897d19652d4b74c7ab54c7e7c54128e99d82bad98d232c1626a90c898a9810dd5a73419359fb72dfadb4f1fec86e1ad6b6759191b
-  data.tar.gz: 94354ba381a33c3212d82a5d9d1cd00f692d27cc529709a5f96a4059407527525689b2547105b1c1651dbc93546d7a56a83577a3c12151529cb961a44391225c
+  metadata.gz: 33b1443a54625b4743970a2993306847cf87b5746c05062f1b078340291d3cb7694308ed7c8805b6228dc1ca41de13565e038f637e52f88361e173943fd7e7e9
+  data.tar.gz: cc704e577a836cab16a29fe05426e0a7ca1971591b0578095ba5c998c0a05a3a952e990b6756491c62ec769e56399d8e3d6c6e3e1d582b4fd864dc931651a550

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.5

data/ext/magic/extconf.rb

@@ -1,42 +1,152 @@
 # frozen_string_literal: true
 
+require 'find'
 require 'mkmf'
-require 'digest'
-require 'open-uri'
-
-LIBMAGIC_TAG = '5.39'.freeze
-
-workdir = Dir.pwd
-libdir = File.join(workdir, 'file-' + LIBMAGIC_TAG)
-gemdir = File.expand_path(File.join(__dir__, '../..'))
-gem_ext_dir = File.join(gemdir, 'lib', 'ext')
-gem_include_dir = File.join(gem_ext_dir, 'include')
-gem_lib_dir = File.join(gem_ext_dir, 'lib')
-build_lib_dir = File.join(libdir, 'src', '.libs')
-
-expected_sha256 = 'f05d286a76d9556243d0cb05814929c2ecf3a5ba07963f8f70bfaaa70517fad1'
-filename = "#{workdir}/file.tar.gz"
-
-unless File.exist?(filename)
-  File.open(filename, 'wb') do |target_file|
-    URI.open("ftp://ftp.astron.com/pub/file/file-#{LIBMAGIC_TAG}.tar.gz", 'rb') do |read_file|
-      target_file.write(read_file.read)
+require 'pathname'
+
+LIBMAGIC_TAG = '5.39'
+LIBIMAGE_SHA256 = 'f05d286a76d9556243d0cb05814929c2ecf3a5ba07963f8f70bfaaa70517fad1'
+
+# helpful constants
+PACKAGE_ROOT_DIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+
+# The gem version constraint in the Rakefile is not respected at install time.
+# Keep this version in sync with the one in the Rakefile !
+REQUIRED_MINI_PORTILE_VERSION = "~> 2.5.0"
+
+MAGIC_HELP_MESSAGE = <<~HELP
+  USAGE: ruby #{$0} [options]
+
+    Flags that are always valid:
+
+      --use-system-libraries
+      --enable-system-libraries
+          Use system libraries instead of building and using the packaged libraries.
+
+      --disable-system-libraries
+          Use the packaged libraries, and ignore the system libraries. This is the default on most
+          platforms, and overrides `--use-system-libraries` and the environment variable
+          `RB_MAGIC_USE_SYSTEM_LIBRARIES`.
+
+      --disable-clean
+          Do not clean out intermediate files after successful build.
+
+    Flags only used when building and using the packaged libraries:
+
+      --disable-static
+          Do not statically link packaged libraries, instead use shared libraries.
+
+      --enable-cross-build
+          Enable cross-build mode. (You probably do not want to set this manually.)
+
+    Flags only used when using system libraries:
+
+      Related to libmagic:
+
+        --with-magic-dir=DIRECTORY
+            Look for libmagic headers and library in DIRECTORY.
+
+        --with-magic-lib=DIRECTORY
+            Look for libmagic library in DIRECTORY.
+
+        --with-magic-include=DIRECTORY
+            Look for libmagic headers in DIRECTORY.
+
+    Environment variables used:
+
+      CC
+          Use this path to invoke the compiler instead of `RbConfig::CONFIG['CC']`
+
+      CPPFLAGS
+          If this string is accepted by the C preprocessor, add it to the flags passed to the C preprocessor
+
+      CFLAGS
+          If this string is accepted by the compiler, add it to the flags passed to the compiler
+
+      LDFLAGS
+          If this string is accepted by the linker, add it to the flags passed to the linker
+
+      LIBS
+          Add this string to the flags passed to the linker
+HELP
+
+def process_recipe(name, version, static_p, cross_p)
+  require 'rubygems'
+  gem('mini_portile2', REQUIRED_MINI_PORTILE_VERSION)
+  require 'mini_portile2'
+  message("Using mini_portile version #{MiniPortile::VERSION}\n")
+
+  MiniPortile.new(name, version).tap do |recipe|
+    # Prefer host_alias over host in order to use i586-mingw32msvc as
+    # correct compiler prefix for cross build, but use host if not set.
+    recipe.host = RbConfig::CONFIG["host_alias"].empty? ? RbConfig::CONFIG["host"] : RbConfig::CONFIG["host_alias"]
+    recipe.target = File.join(PACKAGE_ROOT_DIR, "ports")
+    recipe.configure_options << "--libdir=#{File.join(recipe.path, 'lib')}"
+
+    yield recipe
+
+    env = Hash.new do |hash, key|
+      hash[key] = (ENV[key]).to_s
     end
-  end
 
-  checksum = Digest::SHA256.hexdigest(File.read(filename))
+    recipe.configure_options.flatten!
+
+    recipe.configure_options = [
+      "--disable-silent-rules",
+      "--disable-dependency-tracking",
+      "--enable-fsect-man5"
+    ]
+
+    if static_p
+      recipe.configure_options += [
+        "--disable-shared",
+        "--enable-static",
+      ]
+      env["CFLAGS"] = concat_flags(env["CFLAGS"], "-fPIC")
+    else
+      recipe.configure_options += [
+        "--enable-shared",
+        "--disable-static",
+      ]
+    end
+
+    if cross_p
+      recipe.configure_options += [
+        "--target=#{recipe.host}",
+        "--host=#{recipe.host}",
+      ]
+    end
+
+    recipe.configure_options += env.map do |key, value|
+      "#{key}=#{value.strip}"
+    end
 
-  if checksum != expected_sha256
-    raise "SHA256 of #{filename} does not match: got #{checksum}, expected #{expected_sha256}"
+    recipe.cook
+    recipe.activate
   end
 end
 
-system("tar -xzf #{filename}") || raise('ERROR')
-system("cd #{libdir} && ./configure --prefix=#{gem_ext_dir} && make install") || raise('ERROR')
+#
+#  utility functions
+#
+def config_clean?
+  enable_config('clean', true)
+end
 
-$LOCAL_LIBS << '-lmagic'
-$LIBPATH << gem_lib_dir
-$CFLAGS << " -I #{libdir}/src"
+def config_static?
+  default_static = !truffle?
+  enable_config("static", default_static)
+end
+
+def config_cross_build?
+  enable_config("cross-build")
+end
+
+def config_system_libraries?
+  enable_config("system-libraries", ENV.key?("RB_MAGIC_USE_SYSTEM_LIBRARIES")) do |_, default|
+    arg_config('--use-system-libraries', default)
+  end
+end
 
 def darwin?
   RbConfig::CONFIG['target_os'] =~ /darwin/
@@ -46,6 +156,89 @@ def windows?
   RbConfig::CONFIG['target_os'] =~ /mswin|mingw32|windows/
 end
 
+def truffle?
+  ::RUBY_ENGINE == 'truffleruby'
+end
+
+def concat_flags(*args)
+  args.compact.join(" ")
+end
+
+def do_help
+  print(MAGIC_HELP_MESSAGE)
+  exit!(0)
+end
+
+def do_clean
+  root = Pathname(PACKAGE_ROOT_DIR)
+  pwd  = Pathname(Dir.pwd)
+
+  # Skip if this is a development work tree
+  unless (root + '.git').exist?
+    message("Cleaning files only used during build.\n")
+
+    # (root + 'tmp') cannot be removed at this stage because
+    # libmagic.so is yet to be copied to lib.
+
+    # clean the ports build directory
+    Pathname.glob(pwd.join('tmp', '*', 'ports')) do |dir|
+      FileUtils.rm_rf(dir, verbose: true)
+    end
+
+    FileUtils.rm_rf(root + 'ports' + 'archives', verbose: true)
+
+    # Remove everything but share/ directory
+    remove_paths = %w[bin include]
+    remove_paths << 'lib' if config_static?
+
+    Pathname.glob(File.join(root, 'ports', '*', 'libmagic', '*')) do |dir|
+      remove_paths.each do |path|
+        remove_dir = File.join(dir, path)
+        FileUtils.rm_rf(remove_dir, verbose: true)
+      end
+    end
+  end
+
+  exit!(0)
+end
+
+#
+#  main
+#
+do_help if arg_config('--help')
+do_clean if arg_config('--clean')
+
+if config_system_libraries?
+  message "Building ruby-magic using system libraries.\n"
+
+  dir_config('magic')
+else
+  message "Building ruby-magic using packaged libraries.\n"
+
+  static_p = config_static?
+  message "Static linking is #{static_p ? 'enabled' : 'disabled'}.\n"
+  cross_build_p = config_cross_build?
+  message "Cross build is #{cross_build_p ? 'enabled' : 'disabled'}.\n"
+
+  libmagic_recipe = process_recipe('libmagic', LIBMAGIC_TAG, static_p, cross_build_p) do |recipe|
+    recipe.files = [{
+                      url: "https://gitlab.com/gitlab-org/file-mirror/-/package_files/8589820/download",
+                      sha256: LIBIMAGE_SHA256
+                    }]
+  end
+
+  $LIBPATH = [File.join(libmagic_recipe.path, 'lib')]
+  $CFLAGS << " -I#{File.join(libmagic_recipe.path, 'include')} "
+  $LDFLAGS += " -Wl,-rpath,#{libmagic_recipe.path}/lib"
+
+  if static_p
+    ENV['PKG_CONFIG_PATH'] = "#{libmagic_recipe.path}/lib/pkgconfig"
+    # mkmf appends -- to the first option
+    $LIBS += " " + pkg_config('libmagic', 'libs --static')
+    $LIBS += " " + File.join(libmagic_recipe.path, 'lib', "libmagic.#{$LIBEXT}")
+  end
+end
+
 if ENV['CC']
   RbConfig::CONFIG['CC'] = RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC']
 end
@@ -120,8 +313,6 @@ unless have_header('ruby.h')
   EOS
 end
 
-have_library('ruby')
-
 have_func('rb_thread_call_without_gvl')
 have_func('rb_thread_blocking_region')
 
@@ -190,7 +381,17 @@ end
   have_func(f)
 end
 
-dir_config('magic', [gem_include_dir], [gem_lib_dir])
-
 create_header
 create_makefile('magic/magic')
+
+if config_clean?
+  # Do not clean if run in a development work tree.
+  File.open('Makefile', 'at') do |mk|
+    mk.print(<<~EOF)
+
+      all: clean-ports
+      clean-ports: $(DLLIB)
+      \t-$(Q)$(RUBY) $(srcdir)/extconf.rb --clean --#{static_p ? 'enable' : 'disable'}-static
+    EOF
+  end
+end

data/lib/magic/version.rb

@@ -4,7 +4,7 @@ class Magic
   #
   # Current version of _Magic_.
   #
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.5'.freeze
 
   class << self
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-magic-static
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Krzysztof Wilczyński
@@ -9,8 +9,22 @@ autorequire:
 bindir: bin
 cert_chain:
 - kwilczynski-public.pem
-date: 2021-03-25 00:00:00.000000000 Z
-dependencies: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_portile2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 description: |
   File Magic in Ruby.
 
@@ -39,15 +53,14 @@ files:
 - lib/magic/core/file.rb
 - lib/magic/core/string.rb
 - lib/magic/version.rb
-homepage: https://github.com/kwilczynski/ruby-magic
+homepage: https://gitlab.com/gitlab-org/ruby-magic
 licenses:
 - Apache-2.0
 metadata:
-  bug_tracker_uri: https://github.com/kwilczynski/ruby-magic/issues
+  bug_tracker_uri: https://gitlab.com/gitlab-org/ruby-magic/-/issues
   source_code_uri: https://gitlab.com/gitlab-org/ruby-magic
-  changelog_uri: https://github.com/kwilczynski/ruby-magic/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/ruby-magic
-  wiki_uri: https://github.com/kwilczynski/ruby-magic/wiki
+  changelog_uri: https://gitlab.com/gitlab-org/ruby-magic/-/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/ruby-magic-static
 post_install_message: 'Thank you for installing!
 
 '