ruby-magic 0.3.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a066f36addb7d1c8cbe0858a67fa6a8e2103b3d365ab2d0ccda3027ea43a8ce
-  data.tar.gz: 3828bda59c9df6377991481d7f4fa9a8526e981804ff80dbb84aeba7eb316578
+  metadata.gz: ce261c39e721356e45db04684e03911148e8f83c4aed053d17c8594f59da9248
+  data.tar.gz: ca2fc5dd7c36810d595d1b0c8381eae7dc028506a7495a399ee879850c88b8aa
 SHA512:
-  metadata.gz: 1ea5942f3c0f33f438f684437a3def3db633f18a279c84574f8a9ee0022d60e8852954b99ee32cc5ad7aa0fa5e10e1b1673e97575d72dfe28c862ac18476d551
-  data.tar.gz: 7ad49df412d72dd3d2b29e07509916e7aef46bf3058191019a290d07fed8792877fa623b9d327e4fa94fa21f49ef2fc8ad242777d3f398c53322a08413dd6a58
+  metadata.gz: c853a4112e2b606bf4827974fd8ec9118c06627f0e4001732a33ee32cb7059bcf13bc875a14b3076911102f5a7eb3c70f07539453254f06f0f1aa6e8d8e469b2
+  data.tar.gz: 6197afd12f7549160b7824f1283effd630edce3b13fabd1e018c45fc9e4ddd2f4ef12877de00a3ae73b03f4b82184084e095e154fcae960e107bde3c90bdf6a5

data/CHANGELOG.md

@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.5.3] - 2021-12-22
+
+### Fixed
+
+- ext: load C extension files from non-native gems via "require"
+
+## [0.5.2] - 2021-11-20
+
+- No changes
+
+## [0.5.1] - 2021-11-20
+
+### Fixed
+
+- Check for pkg-config when building static libraries.
+
+## [0.5.0] - 2021-09-30
+
+### Added
+
+- Introduce support for building native gems.
+
+### Changed
+
+- Relax mini_portile2 dependency.
+- Use RB_ALLOC() over calling ruby_xmalloc() directly
+- Address warnings reported by cppcheck.
+- Address code style that checkpatch.pl script reported.
+- Fix how flags are set for the open() function.
+- Clean up type definitions.
+- Add alias Magic::mime_type for Magic::mime.
+ - Make magic_set_flags() return void as its return value was never used.
+
+### Fixed
+
+- Fix truffleruby test failure
+- Fix --use-system-libraries not working with Rake install
+
 ## [0.2.0] - 2015-03-25
 ### Added
 

data/CONTRIBUTORS.md

@@ -7,8 +7,9 @@ of Ruby Magic. They are hereby acknowledged and collectively identified as "The
 Ruby Magic Authors". Copyright is held by the original contributor according to
 the versioning history; see [LICENSE](LICENSE) file.
 
-
+- Igor Victor ([@gogainda](https://github.com/gogainda))
 - John Hawthorn ([@jhawthorn](https://github.com/jhawthorn))
+- Mike Dalessio ([@flavorjones](https://github.com/flavorjones))
 - Shinya Maeda ([@dosuken123](https://github.com/dosuken123))
 - Stan Hu ([@stanhu](https://github.com/stanhu))
 

data/dependencies.yml

@@ -0,0 +1,22 @@
+libmagic:
+  version: "5.39"
+  sha256: "f05d286a76d9556243d0cb05814929c2ecf3a5ba07963f8f70bfaaa70517fad1"
+  #  Manually verified checksum:
+  #
+  #    $ gpg --verify file-5.39.tar.gz.asc file-5.39.tar.gz
+  #    gpg: Signature made Mon Jun 15 02:06:08 2020 CEST
+  #    gpg:                using DSA key 0x71112AB16CB33B3A
+  #    gpg: Good signature from "Christos Zoulas (personal key) <christos@zoulas.com>" [unknown]
+  #    gpg:                 aka "Christos Zoulas (NetBSD key) <christos@netbsd.org>" [unknown]
+  #    gpg: WARNING: This key is not certified with a trusted signature!
+  #    gpg:          There is no indication that the signature belongs to the owner.
+  #    Primary key fingerprint: BE04 995B A8F9 0ED0 C0C1  76C4 7111 2AB1 6CB3 3B3A
+  #
+  #  Using this PGP signature:
+  #
+  #    -----BEGIN PGP SIGNATURE-----
+  #
+  #    iEYEABECAAYFAl7mu3AACgkQcREqsWyzOzppXACgoqokKabq7bwN9aKvd/H/yhF+
+  #    9PUAoOPrAtxFkfNUvtqK/trY+v/Gk5JM
+  #    =tA6a
+  #    -----END PGP SIGNATURE-----

data/ext/magic/common.h

@@ -36,27 +36,27 @@ extern "C" {
 # include <ruby/io.h>
 #else
 # include <rubyio.h>
-#endif
+#endif /* HAVE_RUBY_IO_H */
 
-#if !defined(BIT)
-# define BIT(n) (1 << (n))
-#endif
+#define BIT(n) (1 << (n))
 
 #if !defined(UNUSED)
 # define UNUSED(x) (void)(x)
-#endif
+#endif /* UNUSED */
+
+#define ARRAY_SIZE(a) (int)(sizeof(a) / sizeof((a)[0]))
 
 #if defined(F_DUPFD_CLOEXEC)
 # define HAVE_F_DUPFD_CLOEXEC 1
-#endif
+#endif /* F_DUPFD_CLOEXEC */
 
 #if defined(O_CLOEXEC)
 # define HAVE_O_CLOEXEC 1
-#endif
+#endif /* O_CLOEXEC */
 
 #if defined(POSIX_CLOSE_RESTART)
 # define HAVE_POSIX_CLOSE_RESTART 1
-#endif
+#endif /* POSIX_CLOSE_RESTART */
 
 #define MAGIC_EXTENSION_SEPARATOR "/"
 #define MAGIC_CONTINUE_SEPARATOR "\n- "
@@ -65,15 +65,21 @@ extern "C" {
 # define MAGIC_STATUS_CHECK(x) x
 #else
 # define MAGIC_STATUS_CHECK(x) 1
-#endif
+#endif /* MAGIC_SYSTEM_LIBRARIES */
+
+#if !defined(MAGIC_CUSTOM_CHECK_TYPE)
+# define MAGIC_CHECK_RUBY_TYPE(o, t) Check_Type((o), (t))
+#else
+# define MAGIC_CHECK_RUBY_TYPE(o, t) magic_check_ruby_type((o), (t))
+#endif /* MAGIC_CUSTOM_CHECK_TYPE */
 
 #if !defined(MAGIC_NO_CHECK_CSV)
 # define MAGIC_NO_CHECK_CSV 0
-#endif
+#endif /* MAGIC_NO_CHECK_CSV */
 
 #if !defined(MAGIC_NO_CHECK_JSON)
 # define MAGIC_NO_CHECK_JSON 0
-#endif
+#endif /* MAGIC_NO_CHECK_JSON */
 
 #define DATA_P(x)    (RB_TYPE_P((x), T_DATA))
 #define BOOLEAN_P(x) (RB_TYPE_P((x), T_TRUE) || RB_TYPE_P((x), T_FALSE))
@@ -81,11 +87,13 @@ extern "C" {
 #define ARRAY_P(x)   (RB_TYPE_P((x), T_ARRAY))
 #define FILE_P(x)    (RB_TYPE_P((x), T_FILE))
 
-#define RVAL2CBOOL(x) (RTEST(x))
-#define CBOOL2RVAL(x) ((x) ? Qtrue : Qfalse)
+#define RVAL2CBOOL(b) (RTEST(b))
+#define CBOOL2RVAL(b) ((b) ? Qtrue : Qfalse)
+
+#define RVAL2CSTR(s) (NIL_P(s) ? NULL : StringValueCStr(s))
+#define CSTR2RVAL(s) ((s) == NULL ? Qnil : rb_str_new2((const char *)s))
 
-#define RVAL2CSTR(x) (NIL_P(x) ? NULL : StringValueCStr(x))
-#define CSTR2RVAL(x) ((x) == NULL ? Qnil : rb_str_new2(x))
+#define RSTRING_EMPTY_P(s) (RSTRING_LEN(s) == 0)
 
 #define RARRAY_EMPTY	  rb_ary_new()
 #define RARRAY_EMPTY_P(a) (RARRAY_LEN(a) == 0)
@@ -95,25 +103,32 @@ extern "C" {
 # define RVALUE_TYPE enum ruby_value_type
 #else
 # define RVALUE_TYPE int
-#endif
+#endif /* RUBY_API_VERSION_CODE > 20700 */
+
+#if RUBY_API_VERSION_CODE >= 20700
+# define HAVE_RUBY_GC_COMPACT 1
+# define MAGIC_GC_MARK(x) rb_gc_mark_movable((x))
+#else
+# define MAGIC_GC_MARK(x) rb_gc_mark((x))
+#endif /* RUBY_API_VERSION_CODE >= 20700 */
 
 #define CLASS_NAME(o) (NIL_P((o)) ? "nil" : rb_obj_classname((o)))
 
 #if !defined(T_INTEGER)
 # define T_INTEGER rb_cInteger
-#endif
+#endif /* T_INTEGER */
 
 #if !defined(HAVE_RB_IO_T)
 # define rb_io_t OpenFile
-#endif
+#endif /* HAVE_RB_IO_T */
 
 #if !defined(GetReadFile)
 # define FPTR_TO_FD(p) ((p)->fd)
 #else
 # define FPTR_TO_FD(p) (fileno(GetReadFile(p)))
-#endif
+#endif /* GetReadFile */
 
-#define NOGVL_FUNCTION (VALUE (*)(void *))
+#define NOGVL_FUNCTION (VALUE(*)(void *))
 
 #if defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL) && \
     defined(HAVE_RUBY_THREAD_H) && HAVE_RUBY_THREAD_H
@@ -138,7 +153,10 @@ fake_blocking_region(VALUE (*f)(ANYARGS), void *data)
 }
 # define NOGVL(f, d) \
 	fake_blocking_region(NOGVL_FUNCTION(f), (d))
-#endif
+#endif /*
+	* HAVE_RB_THREAD_CALL_WITHOUT_GVL
+	* HAVE_RUBY_THREAD_H
+	*/
 
 #if defined(__cplusplus)
 }

data/ext/magic/extconf.rb

@@ -4,15 +4,12 @@ require 'find'
 require 'mkmf'
 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"
+REQUIRED_MINI_PORTILE_VERSION = "~> 2.6"
 
 MAGIC_HELP_MESSAGE = <<~HELP
   USAGE: ruby #{$0} [options]
@@ -81,6 +78,7 @@ def process_recipe(name, version, static_p, cross_p)
     # 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.patch_files = Dir[File.join(PACKAGE_ROOT_DIR, "patches", name, "*.patch")].sort
     recipe.configure_options << "--libdir=#{File.join(recipe.path, 'lib')}"
 
     yield recipe
@@ -91,6 +89,20 @@ def process_recipe(name, version, static_p, cross_p)
 
     recipe.configure_options.flatten!
 
+    recipe.configure_options.delete_if do |option|
+      case option
+      when /\A(\w+)=(.*)\z/
+        env[Regexp.last_match(1)] = if env.key?(Regexp.last_match(1))
+          concat_flags(env[Regexp.last_match(1)], Regexp.last_match(2))
+        else
+          Regexp.last_match(2)
+        end
+        true
+      else
+        false
+      end
+    end
+
     recipe.configure_options = [
       "--disable-silent-rules",
       "--disable-dependency-tracking",
@@ -117,11 +129,42 @@ def process_recipe(name, version, static_p, cross_p)
       ]
     end
 
+    if RbConfig::CONFIG['target_cpu'] == 'universal'
+      %w[CFLAGS LDFLAGS].each do |key|
+        unless env[key].include?('-arch')
+          env[key] = concat_flags(env[key], RbConfig::CONFIG['ARCH_FLAG'])
+        end
+      end
+    end
+
     recipe.configure_options += env.map do |key, value|
       "#{key}=#{value.strip}"
     end
 
-    recipe.cook
+    checkpoint = "#{recipe.target}/#{recipe.name}-#{recipe.version}-#{recipe.host}.installed"
+
+    if File.exist?(checkpoint)
+      message("Building Ruby Magic with a packaged version of #{name}-#{version}.\n")
+    else
+      message(<<~EOM)
+        ---------- IMPORTANT NOTICE ----------
+        Building Ruby Magic with a packaged version of #{name}-#{version}.
+        Configuration options: #{recipe.configure_options.shelljoin}
+      EOM
+
+      unless recipe.patch_files.empty?
+        message("The following patches are being applied:\n")
+
+        recipe.patch_files.each do |patch|
+          message("  - %s\n" % File.basename(patch))
+        end
+      end
+
+      recipe.cook
+
+      FileUtils.touch(checkpoint)
+    end
+
     recipe.activate
   end
 end
@@ -220,6 +263,10 @@ append_ldflags(ENV["LDFLAGS"].split) if ENV["LDFLAGS"]
 
 $LIBS = concat_flags($LIBS, ENV["LIBS"]) if ENV["LIBS"]
 
+if truffle?
+  $CPPFLAGS += " -DMAGIC_CUSTOM_CHECK_TYPE"
+end
+
 if config_system_libraries?
   message "Building ruby-magic using system libraries.\n"
 
@@ -229,16 +276,19 @@ if config_system_libraries?
 else
   message "Building ruby-magic using packaged libraries.\n"
 
+  require 'yaml'
+  dependencies = YAML.load_file(File.join(PACKAGE_ROOT_DIR, "dependencies.yml"))
+
   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|
+  libmagic_recipe = process_recipe('libmagic', dependencies["libmagic"]["version"], static_p, cross_build_p) do |recipe|
     recipe.files = [{
-                      url: "https://ruby-magic.s3.eu-central-1.amazonaws.com/file-#{recipe.version}.tar.gz",
-                      sha256: LIBIMAGE_SHA256
-                    }]
+      url: "https://ruby-magic.s3.nl-ams.scw.cloud/file-#{recipe.version}.tar.gz",
+      sha256: dependencies["libmagic"]["sha256"],
+    }]
   end
 
   $LIBPATH = [File.join(libmagic_recipe.path, 'lib')]
@@ -248,9 +298,21 @@ else
   if static_p
     ENV['PKG_CONFIG_PATH'] = "#{libmagic_recipe.path}/lib/pkgconfig"
     # mkmf appends -- to the first option
-    $LIBS += " " + pkg_config('libmagic', 'libs --static')
+    pkg_config_flags = pkg_config('libmagic', 'libs --static')
+
+    raise 'Please install the `pkg-config` utility' unless pkg_config_flags
+
+    $LIBS += " " + pkg_config_flags
     $LIBS += " " + File.join(libmagic_recipe.path, 'lib', "libmagic.#{$LIBEXT}")
   end
+
+  if cross_build_p
+    # database files will be packaged up by the cross-compiling callback in the ExtensionTask
+    to_path = File.join(PACKAGE_ROOT_DIR, "ext/magic/share")
+    FileUtils.rm_rf(to_path, secure: true)
+    FileUtils.mkdir(to_path)
+    FileUtils.cp_r(Dir[File.join(libmagic_recipe.path, 'share/misc/*.mgc')], to_path)
+  end
 end
 
 $CFLAGS += ' -std=c99'
@@ -321,6 +383,13 @@ unless have_header('ruby.h')
   EOS
 end
 
+# these are needed for `rb_thread_call_without_gvl` to be properly detected on some linux systems.
+# specifically, rake-compiler-dock's redhat-based image needs these.
+have_library('pthread')
+have_library('rt')
+have_library('dl')
+have_library('crypt')
+
 have_func('rb_thread_call_without_gvl')
 have_func('rb_thread_blocking_region')
 

data/ext/magic/functions.c

@@ -4,14 +4,14 @@ extern "C" {
 
 #include "functions.h"
 
-int check_fd(int fd);
+static int check_fd(int fd);
 static int safe_dup(int fd);
 static int safe_close(int fd);
 static int safe_cloexec(int fd);
-int override_error_output(void *data);
-int restore_error_output(void *data);
+static int override_error_output(void *data);
+static int restore_error_output(void *data);
 
-inline int
+static inline int
 check_fd(int fd)
 {
 	errno = 0;
@@ -42,6 +42,7 @@ safe_dup(int fd)
 			goto error;
 		}
 	}
+
 	if (safe_cloexec(new_fd) < 0) {
 		local_errno = errno;
 		goto error;
@@ -78,6 +79,7 @@ safe_cloexec(int fd)
 		local_errno = errno;
 		goto error;
 	}
+
 	if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) < 0) {
 		local_errno = errno;
 		goto error;
@@ -89,18 +91,18 @@ error:
 	return -1;
 }
 
-int
+static int
 override_error_output(void *data)
 {
 	int local_errno;
-	mode_t mode = S_IRWXU | S_IRWXG | S_IRWXO;
+	int flags = O_WRONLY | O_APPEND;
 	save_t *s = data;
 
 #if defined(HAVE_O_CLOEXEC)
-	mode |= O_CLOEXEC;
+	flags |= O_CLOEXEC;
 #endif
 
-	assert(s != NULL && \
+	assert(s != NULL &&
 	       "Must be a valid pointer to `save_t' type");
 
 	s->file.old_fd = -1;
@@ -116,7 +118,7 @@ override_error_output(void *data)
 		goto error;
 	}
 
-	s->file.new_fd = open("/dev/null", O_WRONLY | O_APPEND, mode);
+	s->file.new_fd = open("/dev/null", flags, 0222);
 	if (s->file.new_fd < 0) {
 		local_errno = errno;
 
@@ -128,10 +130,12 @@ override_error_output(void *data)
 		safe_close(s->file.old_fd);
 		goto error;
 	}
+
 	if (safe_cloexec(s->file.new_fd) < 0) {
 		local_errno = errno;
 		goto error;
 	}
+
 	if (dup2(s->file.new_fd, fileno(stderr)) < 0) {
 		local_errno = errno;
 		goto error;
@@ -146,13 +150,13 @@ error:
 	return -1;
 }
 
-int
+static int
 restore_error_output(void *data)
 {
 	int local_errno;
 	save_t *s = data;
 
-	assert(s != NULL && \
+	assert(s != NULL &&
 	       "Must be a valid pointer to `save_t' type");
 
 	if (s->file.old_fd < 0 && s->status != 0)
@@ -278,15 +282,21 @@ inline int
 magic_load_wrapper(magic_t magic, const char *magic_file, int flags)
 {
 	int rv;
+
 	MAGIC_FUNCTION(magic_load, rv, flags, magic, magic_file);
+
 	return rv;
 }
 
 inline int
-magic_load_buffers_wrapper(magic_t magic, void **buffers, size_t *sizes, size_t count, int flags)
+magic_load_buffers_wrapper(magic_t magic, void **buffers, size_t *sizes,
+			   size_t count, int flags)
 {
 	int rv;
-	MAGIC_FUNCTION(magic_load_buffers, rv, flags, magic, buffers, sizes, count);
+
+	MAGIC_FUNCTION(magic_load_buffers, rv, flags, magic, buffers, sizes,
+		       count);
+
 	return rv;
 }
 
@@ -294,7 +304,9 @@ inline int
 magic_compile_wrapper(magic_t magic, const char *magic_file, int flags)
 {
 	int rv;
+
 	MAGIC_FUNCTION(magic_compile, rv, flags, magic, magic_file);
+
 	return rv;
 }
 
@@ -302,15 +314,19 @@ inline int
 magic_check_wrapper(magic_t magic, const char *magic_file, int flags)
 {
 	int rv;
+
 	MAGIC_FUNCTION(magic_check, rv, flags, magic, magic_file);
+
 	return rv;
 }
 
 inline const char*
-magic_file_wrapper(magic_t magic, const char* filename, int flags)
+magic_file_wrapper(magic_t magic, const char *filename, int flags)
 {
 	const char *cstring;
+
 	MAGIC_FUNCTION(magic_file, cstring, flags, magic, filename);
+
 	return cstring;
 }
 
@@ -318,7 +334,9 @@ inline const char*
 magic_buffer_wrapper(magic_t magic, const void *buffer, size_t size, int flags)
 {
 	const char *cstring;
+
 	MAGIC_FUNCTION(magic_buffer, cstring, flags, magic, buffer, size);
+
 	return cstring;
 }
 

data/ext/magic/functions.h

@@ -9,7 +9,7 @@ extern "C" {
 
 #define MAGIC_FUNCTION(f, r, x, ...)			 \
 	do {						 \
-		if ((x) & MAGIC_DEBUG)			 \
+		if ((x) & (MAGIC_DEBUG | MAGIC_CHECK))   \
 			r = f(__VA_ARGS__);		 \
 		else {					 \
 			save_t __##f;			 \
@@ -17,7 +17,7 @@ extern "C" {
 			r = f(__VA_ARGS__);		 \
 			restore_error_output(&(__##f));  \
 		}					 \
-	} while(0)
+	} while (0)
 
 typedef struct file_data {
 	fpos_t position;
@@ -33,30 +33,36 @@ typedef struct save {
 extern magic_t magic_open_wrapper(int flags);
 extern void magic_close_wrapper(magic_t magic);
 
-extern const char* magic_error_wrapper(magic_t magic);
+extern const char *magic_error_wrapper(magic_t magic);
 extern int magic_errno_wrapper(magic_t magic);
 
-extern const char* magic_getpath_wrapper(void);
+extern const char *magic_getpath_wrapper(void);
 
-extern int magic_getparam_wrapper(magic_t magic, int parameter, void *value);
+extern int magic_getparam_wrapper(magic_t magic, int parameter,
+				  void *value);
 extern int magic_setparam_wrapper(magic_t magic, int parameter,
 				  const void *value);
 
 extern int magic_getflags_wrapper(magic_t magic);
 extern int magic_setflags_wrapper(magic_t magic, int flags);
 
-extern int magic_load_wrapper(magic_t magic, const char *magic_file, int flags);
+extern int magic_load_wrapper(magic_t magic, const char *magic_file,
+			      int flags);
 extern int magic_load_buffers_wrapper(magic_t magic, void **buffers,
-				      size_t *sizes, size_t count, int flags);
+				      size_t *sizes, size_t count,
+				      int flags);
 
-extern int magic_compile_wrapper(magic_t magic, const char *magic_file, int flags);
-extern int magic_check_wrapper(magic_t magic, const char *magic_file, int flags);
+extern int magic_compile_wrapper(magic_t magic, const char *magic_file,
+				 int flags);
+extern int magic_check_wrapper(magic_t magic, const char *magic_file,
+			       int flags);
 
-extern const char* magic_file_wrapper(magic_t magic, const char *filename,
+extern const char *magic_file_wrapper(magic_t magic, const char *filename,
 				      int flags);
-extern const char* magic_buffer_wrapper(magic_t magic, const void *buffer,
+extern const char *magic_buffer_wrapper(magic_t magic, const void *buffer,
 					size_t size, int flags);
-extern const char* magic_descriptor_wrapper(magic_t magic, int fd, int flags);
+extern const char *magic_descriptor_wrapper(magic_t magic, int fd,
+					    int flags);
 
 extern int magic_version_wrapper(void);