ruby-magic 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39c8d257044d13e7581c09d1a546bf3a53c89721
-  data.tar.gz: c544dfb6645dff08b837e1f9583238e7e0ecfeb0
+  metadata.gz: 2bdbd8e67d4f6fdfcf17101e79003176121482b4
+  data.tar.gz: a39c944b6afb2d77087c894ed598a42d872faf5a
 SHA512:
-  metadata.gz: 5b272855f23c41b6f6e90d0688ed97309e1880ed35220cdf982e9543a4547307bddf691d338da61f42bbb090e28a112e4db39dbc74172d7ed5080e0e5347b9ba
-  data.tar.gz: ec5dfa92be79835e0d89ca23a433c55c029e72f5e847ad4931984ab150e9ee2a31dc3ee3e93dc87fbdb41a12bfb387feed952b227246ad9cfe87d91b29b7fe95
+  metadata.gz: 8ac4e55c28a4ebb20c276d3e7e8e94566c3267c89a33a36edb2e4c815fe581007980c15594a437cb560fbb3e8a62d869c52fc8462aa081370aa6f2aded32f01f
+  data.tar.gz: c5e23e0fd76c60595b75ad368f9841b83922e7796fb1d09797376c8672fd62240bfc8429242f38ec23c609e48feffc569c4fa89155596ebdb3a95f11a211b0e3

data/CHANGES

@@ -1,3 +1,48 @@
+ruby-magic (0.2.0)
+
+  * Fixed formatting and white spaces.
+  * Added Gemnasium, plus Coveralls and Code Climate integration (and hence improved
+    code test coverage).
+  * Fixed Travis CI build against Rubinius.
+  * Re-factored the API and cleaned up small portions of code and documentation.
+  * Retired support for Ruby 1.8.x (no support for MRI, Ruby Enterprise Edition and Rubinius).
+  * Added functionality to handle releasing the GVL for any file and/or I/O operations.
+  * Added ability to Magic#flags_array to return name of each flag that is set.
+  * Changed Magic#version_array and Magic#version_string methods to be a singleton methods.
+  * Renamed the Magic#flags_array method to Magic#flags_to_a.
+  * Retired testing with Ruby 1.9.2 and 2.1.0, and added 2.2.0 on Travis CI.
+  * Added naïve synchronization via Mutex#lock and Mutex#unlock methods to make interactions
+    with libmagic more thread-safe.
+  * Changed the Magic::new method, so that it accepts an array of paths from which to load
+    the Magic database.
+  * Fixed setting of global errno value to avoid race conditions.
+  * Added ability for Travis CI test against multiple versions of vanilla libmagic.
+  * Added LLVM (clang) compiler to build with to Travis CI, and fixed various issues reported
+    by clang compiler during build-time.
+  * Added ability for Magic#load to take nil as valid argument.
+  * Fixed issue with libmagic's regular expression (regex) library not working with UTF-8 (or
+    any other wide-character encoding).
+  * Fixed build to make it work with C++ compilers.
+  * Added support for the MAGIC_CONTINUE flag so that Magic#file, Magic#buffer and
+    Magic#descriptor methods will return an array for multiple results when appropriate.
+  * Moved integration with File and String core classes into separate namespace.
+  * Removed forward declaration of errno as it's not needed on systems with modern C/C++
+    libraries and compilers.
+  * Added rudimentary Vagrantfile that can be used to build a development environment.
+  * Removed the "-Wl,--no-undefined" option from LDFLAGS, as they might break on some systems.
+  * Fixed any C90 standard related build-time warnings.
+  * Changed the behaviour not to catch the generic Magic::Error, plus always to raise on errors
+    coming from libmagic. This is to make it more aligned with the standard library, where file
+    and I/O related errors would raise an appropriate exception.
+  * Fixed version number to comply with Semantic Versioning 2 (http://semver.org/).
+  * Added the Guard Ruby gem for convenience, with an appropriate Guardfile.
+  * Changed behaviour consistent among various versions of libmagic adhering to the POSIX
+    standard. This concerns the following IEEE 1003.1 standards:
+    - http://pubs.opengroup.org/onlinepubs/007904975/utilities/file.html
+    - http://pubs.opengroup.org/onlinepubs/9699919799/utilities/file.html
+
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
+
 ruby-magic (0.0.1)
 
   * First version.

data/CHANGES.rdoc

@@ -1,3 +1,48 @@
+ruby-magic (0.2.0)
+
+  * Fixed formatting and white spaces.
+  * Added Gemnasium, plus Coveralls and Code Climate integration (and hence improved
+    code test coverage).
+  * Fixed Travis CI build against Rubinius.
+  * Re-factored the API and cleaned up small portions of code and documentation.
+  * Retired support for Ruby 1.8.x (no support for MRI, Ruby Enterprise Edition and Rubinius).
+  * Added functionality to handle releasing the GVL for any file and/or I/O operations.
+  * Added ability to Magic#flags_array to return name of each flag that is set.
+  * Changed Magic#version_array and Magic#version_string methods to be a singleton methods.
+  * Renamed the Magic#flags_array method to Magic#flags_to_a.
+  * Retired testing with Ruby 1.9.2 and 2.1.0, and added 2.2.0 on Travis CI.
+  * Added naïve synchronization via Mutex#lock and Mutex#unlock methods to make interactions
+    with libmagic more thread-safe.
+  * Changed the Magic::new method, so that it accepts an array of paths from which to load
+    the Magic database.
+  * Fixed setting of global errno value to avoid race conditions.
+  * Added ability for Travis CI test against multiple versions of vanilla libmagic.
+  * Added LLVM (clang) compiler to build with to Travis CI, and fixed various issues reported
+    by clang compiler during build-time.
+  * Added ability for Magic#load to take nil as valid argument.
+  * Fixed issue with libmagic's regular expression (regex) library not working with UTF-8 (or
+    any other wide-character encoding).
+  * Fixed build to make it work with C++ compilers.
+  * Added support for the MAGIC_CONTINUE flag so that Magic#file, Magic#buffer and
+    Magic#descriptor methods will return an array for multiple results when appropriate.
+  * Moved integration with File and String core classes into separate namespace.
+  * Removed forward declaration of errno as it's not needed on systems with modern C/C++
+    libraries and compilers.
+  * Added rudimentary Vagrantfile that can be used to build a development environment.
+  * Removed the "-Wl,--no-undefined" option from LDFLAGS, as they might break on some systems.
+  * Fixed any C90 standard related build-time warnings.
+  * Changed the behaviour not to catch the generic Magic::Error, plus always to raise on errors
+    coming from libmagic. This is to make it more aligned with the standard library, where file
+    and I/O related errors would raise an appropriate exception.
+  * Fixed version number to comply with Semantic Versioning 2 (http://semver.org/).
+  * Added the Guard Ruby gem for convenience, with an appropriate Guardfile.
+  * Changed behaviour consistent among various versions of libmagic adhering to the POSIX
+    standard. This concerns the following IEEE 1003.1 standards:
+    - http://pubs.opengroup.org/onlinepubs/007904975/utilities/file.html
+    - http://pubs.opengroup.org/onlinepubs/9699919799/utilities/file.html
+
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
+
 ruby-magic (0.0.1)
 
   * First version.

data/COPYRIGHT

@@ -1 +1 @@
-Copyright 2013-2014 Krzysztof Wilczynski
+Copyright 2013-2015 Krzysztof Wilczynski

data/README.rdoc

@@ -1,7 +1,8 @@
 Simple interface to libmagic for Ruby Programming Language
 
 {<img src="https://travis-ci.org/kwilczynski/ruby-magic.png?branch=master" alt="Build Status"/>}[https://travis-ci.org/kwilczynski/ruby-magic]
+{<img src="http://inch-ci.org/github/kwilczynski/ruby-magic.svg?branch=master" alt="Documentation Status" />}[http://inch-ci.org/github/kwilczynski/ruby-magic]
+{<img src="https://badge.fury.io/rb/ruby-magic.png" alt="Gem Version" />}[http://badge.fury.io/rb/ruby-magic]
 {<img src="https://coveralls.io/repos/kwilczynski/ruby-magic/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/kwilczynski/ruby-magic?branch=master]
-{<img src="https://codeclimate.com/github/kwilczynski/ruby-magic.png" />}[https://codeclimate.com/github/kwilczynski/ruby-magic]
+{<img src="https://codeclimate.com/github/kwilczynski/ruby-magic.png" alt="Code Quality" />}[https://codeclimate.com/github/kwilczynski/ruby-magic]
 {<img src="https://gemnasium.com/kwilczynski/ruby-magic.png" alt="Dependency Status" />}[https://gemnasium.com/kwilczynski/ruby-magic]
-{<img src="https://d2weczhvl823v0.cloudfront.net/kwilczynski/ruby-magic/trend.png" alt="Bitdeli Badge" />}[https://bitdeli.com/free]

data/Rakefile

@@ -5,7 +5,7 @@
 #
 # Rakefile
 #
-# Copyright 2013-2014 Krzysztof Wilczynski
+# Copyright 2013-2015 Krzysztof Wilczynski
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -70,6 +70,7 @@ Rake::ExtensionTask.new('magic', gem) do |e|
   e.lib_dir = 'lib/magic'
 end
 
+Rake::Task[:test].prerequisites << :clobber
 Rake::Task[:test].prerequisites << :compile
 
 task :default => :test

data/TODO

@@ -1,21 +1,24 @@
-ruby-magic (0.0.4)
+ruby-magic (0.5.0)
 
   * Vendor libmagic source code?
 
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Fri, 21 Mar 2014 18:06:21 +0000
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
 
-ruby-magic (0.0.3)
+ruby-magic (0.4.0)
 
   * Add some examples;
   * Move to YARD from RDoc (as RDoc is very bad, really);
   * Improve documentation i.e. source code commenting, README file, etc.
 
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Fri, 21 Mar 2014 16:49:26 +0000
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000
 
-ruby-magic (0.0.2)
+ruby-magic (0.3.0)
 
+  * Improve test coverage (if possible to 100%);
   * Add implementation for the included "binary";
   * Add Doxygen style comments for other functions in the source code;
-  * Add RDoc and improve documentation i.e. source code commenting.
+  * Add RDoc and improve documentation i.e. source code commenting;
+  * Add support for magic_load_buffers(magic_t, void **, size_t *, size_t);
+  * Add support for Windows (if possible).
 
--- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Fri, 21 Mar 2014 16:49:26 +0000
+-- Krzysztof Wilczynski <krzysztof.wilczynski@linux.com>  Wed, 25 Mar 2015 23:27:00 +0000

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.2.0

data/bin/magic

@@ -7,7 +7,7 @@
 #
 # magic
 #
-# Copyright 2013-2014 Krzysztof Wilczynski
+# Copyright 2013-2015 Krzysztof Wilczynski
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/ext/magic/common.h

@@ -3,7 +3,7 @@
 /*
  * common.h
  *
- * Copyright 2013-2014 Krzysztof Wilczynski
+ * Copyright 2013-2015 Krzysztof Wilczynski
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -40,13 +40,20 @@ extern "C" {
 #include <fcntl.h>
 #include <errno.h>
 #include <assert.h>
-#include <locale.h>
 #include <sys/stat.h>
 #include <magic.h>
 #include <ruby.h>
 
-#if !defined(EPERM)
-# define EPERM 1
+#if defined(HAVE_LOCALE_H)
+# include <locale.h>
+#endif
+
+#if defined(HAVE_XLOCALE_H)
+# include <xlocale.h>
+#endif
+
+#if !defined(ENOMEM)
+# define ENOMEM 12
 #endif
 
 #if !defined(EFAULT)
@@ -75,11 +82,13 @@ extern "C" {
 
 #define UNUSED(x) (void)(x)
 
-#if !defined(HAVE_MAGIC_VERSION) || MAGIC_VERSION < 517
+#if !defined(HAVE_MAGIC_VERSION) || MAGIC_VERSION < 518
 # define HAVE_BROKEN_MAGIC 1
 #endif
 
-extern int errno;
+#if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
+# define HAVE_SAFE_LOCALE 1
+#endif
 
 #if defined(__cplusplus)
 }

data/ext/magic/extconf.rb

@@ -5,7 +5,7 @@
 #
 # extconf.rb
 #
-# Copyright 2013-2014 Krzysztof Wilczynski
+# Copyright 2013-2015 Krzysztof Wilczynski
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,12 +24,35 @@ require 'mkmf'
 
 RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
 
+$CFLAGS << ' -std=c99 -g -Wall -Wextra -pedantic'
+
+unless RbConfig::CONFIG['host_os'][/darwin/]
+  $LDFLAGS << ' -Wl,--as-needed'
+end
+
 $LDFLAGS << " %s" % ENV['LDFLAGS'] if ENV['LDFLAGS']
 
-$CFLAGS << " %s" % ENV['CFLAGS'] if ENV['CFLAGS']
-$CFLAGS << ' -std=c99 -g -Wall -Wextra -pedantic'
+%w(CFLAGS CXXFLAGS CPPFLAGS).each do |variable|
+  $CFLAGS << " %s" % ENV[variable] if ENV[variable]
+end
 
-unless have_header('ruby.h')
+have_header('locale.h')
+have_header('xlocale.h')
+have_header('utime.h')
+have_header('sys/types.h')
+have_header('sys/time.h')
+
+have_ruby_h = have_header('ruby.h')
+have_magic_h = have_header('magic.h')
+
+have_func('newlocale', ['locale.h', 'xlocale.h'])
+have_func('uselocale', ['locale.h', 'xlocale.h'])
+have_func('freelocale', ['locale.h', 'xlocale.h'])
+
+have_func('utime', ['utime.h', 'sys/types.h'])
+have_func('utimes', 'sys/time.h')
+
+unless have_ruby_h
   abort <<-EOS
 
   You appear to be missing Ruby development libraries and/or header
@@ -55,7 +78,10 @@ unless have_header('ruby.h')
   EOS
 end
 
-unless have_header('magic.h')
+have_func('rb_thread_call_without_gvl')
+have_func('rb_thread_blocking_region')
+
+unless have_magic_h
   abort <<-EOS
 
   You appear to be missing libmagic(3) library and/or necessary header
@@ -100,12 +126,6 @@ end
 
 have_func('magic_version', 'magic.h')
 
-have_func('utime', ['utime.h', 'sys/types.h'])
-have_func('utimes', 'sys/time.h')
-
-have_func('rb_thread_call_without_gvl')
-have_func('rb_thread_blocking_region')
-
 dir_config('magic')
 
 create_header

data/ext/magic/functions.c

@@ -3,7 +3,7 @@
 /*
  * functions.c
  *
- * Copyright 2013-2014 Krzysztof Wilczynski
+ * Copyright 2013-2015 Krzysztof Wilczynski
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,10 @@
  * limitations under the License.
  */
 
+#if defined(__cplusplus)
+extern "C" {
+#endif
+
 #include "functions.h"
 
 int suppress_error_output(void *data);
@@ -116,21 +120,44 @@ out:
 int
 override_current_locale(void *data)
 {
+#if !defined(HAVE_SAFE_LOCALE)
     char *current_locale = NULL;
+#endif
 
     save_t *s = data;
     assert(s != NULL && "Must be a valid pointer to `save_t' type");
 
     s->status = -1;
-    s->data.locale = NULL;
+
+#if defined(HAVE_SAFE_LOCALE)
+    s->data.locale.old_locale = NULL;
+    s->data.locale.new_locale = NULL;
+
+    s->data.locale.new_locale = newlocale(LC_ALL_MASK, "C", NULL);
+    if (s->data.locale.new_locale == (locale_t)0) {
+        goto out;
+    }
+
+    assert(s->data.locale.new_locale != NULL && \
+            "Must be a valid pointer to `locale_t' type");
+
+    s->data.locale.old_locale = uselocale(s->data.locale.new_locale);
+    if (s->data.locale.old_locale == (locale_t)0) {
+        goto out;
+    }
+
+    assert(s->data.locale.old_locale != NULL && \
+            "Must be a valid pointer to `locale_t' type");
+#else
+    s->data.locale.old_locale = NULL;
 
     current_locale = setlocale(LC_ALL, NULL);
     if (!current_locale) {
         goto out;
     }
 
-    s->data.locale = strndup(current_locale, strlen(current_locale));
-    if (!s->data.locale) {
+    s->data.locale.old_locale = strndup(current_locale, strlen(current_locale));
+    if (!s->data.locale.old_locale) {
         goto out;
     }
 
@@ -138,7 +165,9 @@ override_current_locale(void *data)
         goto out;
     }
 
-    assert(s->data.locale != NULL && "Must be a valid pointer to `char' type");
+    assert(s->data.locale.old_locale != NULL && \
+            "Must be a valid pointer to `char' type");
+#endif
     s->status = 0;
 
 out:
@@ -151,22 +180,44 @@ restore_current_locale(void *data)
     save_t *s = data;
     assert(s != NULL && "Must be a valid pointer to `save_t' type");
 
-    if (!s->data.locale && s->status != 0) {
+#if defined(HAVE_SAFE_LOCALE)
+    if (!s->data.locale.new_locale && !s->data.locale.old_locale && s->status != 0) {
         return -1;
     }
 
-    if (!setlocale(LC_ALL, s->data.locale)) {
+    if (uselocale(s->data.locale.old_locale) == (locale_t)0) {
         goto out;
     }
 
-    assert(s->data.locale != NULL && "Must be a valid pointer to `char' type");
-    free(s->data.locale);
+    assert(s->data.locale.new_locale != NULL && \
+            "Must be a valid pointer to `locale_t' type");
+
+    freelocale(s->data.locale.new_locale);
+#else
+    if (!s->data.locale.old_locale && s->status != 0) {
+        return -1;
+    }
+
+    if (!setlocale(LC_ALL, s->data.locale.old_locale)) {
+        goto out;
+    }
+
+    assert(s->data.locale.old_locale != NULL && \
+            "Must be a valid pointer to `char' type");
+
+    free(s->data.locale.old_locale);
+#endif
 
     return 0;
 
 out:
-    s->data.locale = NULL;
     s->status = -1;
+#if defined(HAVE_SAFE_LOCALE)
+    s->data.locale.old_locale = NULL;
+    s->data.locale.new_locale = NULL;
+#else
+    s->data.locale.old_locale = NULL;
+#endif
 
     return -1;
 }
@@ -271,4 +322,8 @@ magic_version_wrapper(void)
 #endif
 }
 
+#if defined(__cplusplus)
+}
+#endif
+
 /* vim: set ts=8 sw=4 sts=2 et : */

data/ext/magic/functions.h

@@ -3,7 +3,7 @@
 /*
  * functions.h
  *
- * Copyright 2013-2014 Krzysztof Wilczynski
+ * Copyright 2013-2015 Krzysztof Wilczynski
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -68,11 +68,22 @@ struct file_data {
 
 typedef struct file_data file_data_t;
 
+struct locale_data {
+#if defined(HAVE_SAFE_LOCALE)
+    locale_t old_locale;
+    locale_t new_locale;
+#else
+    char *old_locale;
+#endif
+};
+
+typedef struct locale_data locale_data_t;
+
 struct save {
     int status;
     union {
         file_data_t file;
-        char *locale;
+        locale_data_t locale;
     } data;
 };