ruby-magic 0.2.0 → 0.3.0

data/README.md

@@ -0,0 +1,43 @@
+# File Magic in Ruby
+
+[![Build Status](https://travis-ci.org/kwilczynski/ruby-magic.svg)](https://travis-ci.org/kwilczynski/ruby-magic)
+[![Documentation Status](https://inch-ci.org/github/kwilczynski/ruby-magic.svg)](https://inch-ci.org/github/kwilczynski/ruby-magic)
+[![Gem Version](https://badge.fury.io/rb/ruby-magic.svg)](http://badge.fury.io/rb/ruby-magic)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+## Introduction
+
+Provides simple interface to [libmagic][1] for Ruby Programming Language.
+
+## Table of Contents
+
+1. [Contributing](#contributing)
+2. [Versioning](#versioning)
+3. [Author](#author)
+4. [Copyright](#copyright)
+5. [License](#license)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on
+setting up your development environment.
+
+## Versioning
+
+This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+For the versions available, see the tags on this repository.
+
+## Author
+
+Krzysztof Wilczyński (<kw@linux.com>)
+
+## Copyright
+
+Copyright 2013-2021 Krzysztof Wilczyński
+
+## License
+
+This project is licensed under the terms of the Apache License, Version 2.0 license.   
+To view the full license see the included [LICENSE](LICENSE) file.
+
+[1]: https://en.wikipedia.org/wiki/File_(command)

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/ext/magic/common.h

@@ -1,23 +1,3 @@
-/* :enddoc: */
-
-/*
- * common.h
- *
- * 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.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 #if !defined(_COMMON_H)
 #define _COMMON_H 1
 
@@ -29,12 +9,17 @@
 # define _BSD_SOURCE 1
 #endif
 
+#if !defined(_DEFAULT_SOURCE)
+# define _DEFAULT_SOURCE 1
+#endif
+
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <limits.h>
 #include <string.h>
 #include <unistd.h>
 #include <fcntl.h>
@@ -44,50 +29,100 @@ extern "C" {
 #include <magic.h>
 #include <ruby.h>
 
-#if defined(HAVE_LOCALE_H)
-# include <locale.h>
+#if defined(HAVE_RUBY_IO_H)
+# include <ruby/io.h>
+#else
+# include <rubyio.h>
 #endif
 
-#if defined(HAVE_XLOCALE_H)
-# include <xlocale.h>
+#if !defined(BIT)
+# define BIT(n) (1 << (n))
 #endif
 
-#if !defined(ENOMEM)
-# define ENOMEM 12
+#if !defined(UNUSED)
+# define UNUSED(x) (void)(x)
 #endif
 
-#if !defined(EFAULT)
-# define EFAULT 14
+#if defined(F_DUPFD_CLOEXEC)
+# define HAVE_F_DUPFD_CLOEXEC 1
 #endif
 
-#if !defined(EINVAL)
-# define EINVAL 22
+#if defined(O_CLOEXEC)
+# define HAVE_O_CLOEXEC 1
 #endif
 
-#if !defined(ENOSYS)
-# define ENOSYS 38
+#if defined(POSIX_CLOSE_RESTART)
+# define HAVE_POSIX_CLOSE_RESTART 1
 #endif
 
-#if !defined(ANYARGS)
-# if defined(__cplusplus)
-#  define ANYARGS ...
-# else
-#  define ANYARGS
-# endif
+#define MAGIC_EXTENSION_SEPARATOR "/"
+#define MAGIC_CONTINUE_SEPARATOR "\n- "
+
+#if !defined(MAGIC_NO_CHECK_CSV)
+# define MAGIC_NO_CHECK_CSV 0
 #endif
 
-#if defined(UNUSED)
-# undef(UNUSED)
+#if !defined(MAGIC_NO_CHECK_JSON)
+# define MAGIC_NO_CHECK_JSON 0
+#endif
+
+#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))
+#define STRING_P(x)  (RB_TYPE_P((x), T_STRING))
+#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 RVAL2CSTR(x) (NIL_P(x) ? NULL : StringValueCStr(x))
+#define CSTR2RVAL(x) ((x) == NULL ? Qnil : rb_str_new2(x))
+
+#define RARRAY_EMPTY	  rb_ary_new()
+#define RARRAY_EMPTY_P(a) (RARRAY_LEN(a) == 0)
+#define RARRAY_FIRST(a)   (RARRAY_EMPTY_P(a) ? Qnil : rb_ary_entry((a), 0))
+
+#define CLASS_NAME(o) (NIL_P((o)) ? "nil" : rb_obj_classname((o)))
+
+#if !defined(T_INTEGER)
+# define T_INTEGER rb_cInteger
 #endif
 
-#define UNUSED(x) (void)(x)
+#if !defined(HAVE_RB_IO_T)
+# define rb_io_t OpenFile
+#endif
 
-#if !defined(HAVE_MAGIC_VERSION) || MAGIC_VERSION < 518
-# define HAVE_BROKEN_MAGIC 1
+#if !defined(GetReadFile)
+# define FPTR_TO_FD(p) ((p)->fd)
+#else
+# define FPTR_TO_FD(p) (fileno(GetReadFile(p)))
 #endif
 
-#if defined(HAVE_NEWLOCALE) && defined(HAVE_USELOCALE) && defined(HAVE_FREELOCALE)
-# define HAVE_SAFE_LOCALE 1
+#define NOGVL_FUNCTION (VALUE (*)(void *))
+
+#if defined(HAVE_RB_THREAD_CALL_WITHOUT_GVL) && \
+    defined(HAVE_RUBY_THREAD_H) && HAVE_RUBY_THREAD_H
+# include <ruby/thread.h>
+# define NOGVL(f, d) \
+	rb_thread_call_without_gvl((f), (d), RUBY_UBF_IO, NULL)
+#elif defined(HAVE_RB_THREAD_BLOCKING_REGION)
+# define NOGVL(f, d) \
+	rb_thread_blocking_region(NOGVL_FUNCTION(f), (d), RUBY_UBF_IO, NULL)
+#else
+# include <rubysig.h>
+static inline VALUE
+fake_blocking_region(VALUE (*f)(ANYARGS), void *data)
+{
+	VALUE rv;
+
+	TRAP_BEG;
+	rv = f(data);
+	TRAP_END;
+
+	return rv;
+}
+# define NOGVL(f, d) \
+	fake_blocking_region(NOGVL_FUNCTION(f), (d))
 #endif
 
 #if defined(__cplusplus)
@@ -95,5 +130,3 @@ extern "C" {
 #endif
 
 #endif /* _COMMON_H */
-
-/* vim: set ts=8 sw=4 sts=2 et : */

data/ext/magic/extconf.rb

@@ -1,135 +1,194 @@
-# -*- encoding: utf-8 -*-
-
-# :enddoc:
-
-#
-# extconf.rb
-#
-# 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.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
+# frozen_string_literal: true
 
 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("https://fossies.org/linux/misc/file-#{LIBMAGIC_TAG}.tar.gz", 'rb') do |read_file|
+      target_file.write(read_file.read)
+    end
+  end
+
+  checksum = Digest::SHA256.hexdigest(File.read(filename))
+
+  if checksum != expected_sha256
+    raise "SHA256 of #{filename} does not match: got #{checksum}, expected #{expected_sha256}"
+  end
+end
+
+system("tar -xzf #{filename}") || raise('ERROR')
+system("cd #{libdir} && ./configure --prefix=#{gem_ext_dir} && make install") || raise('ERROR')
+
+$LOCAL_LIBS << '-lmagic'
+$LIBPATH << gem_lib_dir
+$CFLAGS << " -I #{libdir}/src"
 
-RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC'] if ENV['CC']
+def darwin?
+  RbConfig::CONFIG['target_os'] =~ /darwin/
+end
 
-$CFLAGS << ' -std=c99 -g -Wall -Wextra -pedantic'
+def windows?
+  RbConfig::CONFIG['target_os'] =~ /mswin|mingw32|windows/
+end
 
-unless RbConfig::CONFIG['host_os'][/darwin/]
-  $LDFLAGS << ' -Wl,--as-needed'
+if ENV['CC']
+  RbConfig::CONFIG['CC'] = RbConfig::MAKEFILE_CONFIG['CC'] = ENV['CC']
 end
 
-$LDFLAGS << " %s" % ENV['LDFLAGS'] if ENV['LDFLAGS']
+ENV['CC'] = RbConfig::CONFIG['CC']
+
+$CFLAGS += ' -std=c99 -fPIC'
+$CFLAGS += ' -Wall -Wextra -pedantic'
 
-%w(CFLAGS CXXFLAGS CPPFLAGS).each do |variable|
-  $CFLAGS << " %s" % ENV[variable] if ENV[variable]
+if RbConfig::CONFIG['CC'] =~ /gcc/
+  $CFLAGS += ' -O3' unless $CFLAGS =~ /-O\d/
+  $CFLAGS += ' -Wcast-qual -Wwrite-strings -Wconversion -Wmissing-noreturn -Winline'
 end
 
-have_header('locale.h')
-have_header('xlocale.h')
-have_header('utime.h')
-have_header('sys/types.h')
-have_header('sys/time.h')
+unless darwin?
+  $LDFLAGS += ' -Wl,--as-needed -Wl,--no-undefined'
+end
+
+if windows?
+  $LDFLAGS += ' -static-libgcc'
+end
+
+%w[
+  CFLAGS
+  CXXFLAGS
+  CPPFLAGS
+].each do |variable|
+  $CFLAGS += format(' %s', ENV[variable]) if ENV[variable]
+end
 
-have_ruby_h = have_header('ruby.h')
-have_magic_h = have_header('magic.h')
+$LDFLAGS += format(' %s', ENV['LDFLAGS']) if ENV['LDFLAGS']
 
-have_func('newlocale', ['locale.h', 'xlocale.h'])
-have_func('uselocale', ['locale.h', 'xlocale.h'])
-have_func('freelocale', ['locale.h', 'xlocale.h'])
+unless have_header('ruby.h')
+  abort "\n" + (<<-EOS).gsub(/^[ ]{,3}/, '') + "\n"
+    You appear to be missing Ruby development libraries and/or header
+    files. You can install missing compile-time dependencies in one of
+    the following ways:
 
-have_func('utime', ['utime.h', 'sys/types.h'])
-have_func('utimes', 'sys/time.h')
+    - Debian / Ubuntu
 
-unless have_ruby_h
-  abort <<-EOS
+        apt-get install ruby-dev
 
-  You appear to be missing Ruby development libraries and/or header
-  files. You can install missing compile-time dependencies in one of
-  the following ways:
+    - Red Hat / CentOS / Fedora
 
-  - Debian / Ubuntu
+        yum install ruby-devel or dnf install ruby-devel
 
-      apt-get install ruby-dev
+    - Mac OS X (Darwin)
 
-  - Red Hat / CentOS / Fedora
+        brew install ruby (for Homebrew, see https://brew.sh)
+        port install ruby2.6 (for MacPorts, see https://www.macports.org)
 
-      yum install ruby-devel
+    - OpenBSD / NetBSD
 
+        pkg_add ruby (for pkgsrc, see https://www.pkgsrc.org)
 
-  Alternatively, you can use either of the following Ruby version
-  managers in order to install Ruby locally (for your user only)
-  and/or system-wide:
+    - FreeBSD
 
-  - Ruby Version Manager (for RVM, see http://rvm.io/)
-  - Ruby Environment (for rbenv, see http://github.com/sstephenson/rbenv)
+        pkg install ruby (for FreeBSD Ports, see https://www.freebsd.org/ports)
 
+    Alternatively, you can use either of the following Ruby version
+    managers in order to install Ruby locally (for your user only)
+    and/or system-wide:
+
+    - Ruby Version Manager (for RVM, see https://rvm.io)
+    - Ruby Environment (for rbenv, see https://github.com/sstephenson/rbenv)
+    - Change Ruby (for chruby, see https://github.com/postmodern/chruby)
+
+    More information about how to install Ruby on various platforms
+    available at the following web site:
+
+      https://www.ruby-lang.org/en/documentation/installation
   EOS
 end
 
 have_func('rb_thread_call_without_gvl')
 have_func('rb_thread_blocking_region')
 
-unless have_magic_h
-  abort <<-EOS
+unless have_header('magic.h')
+  abort "\n" + (<<-EOS).gsub(/^[ ]{,3}/, '') + "\n"
+    You appear to be missing libmagic(3) library and/or necessary header
+    files. You can install missing compile-time dependencies in one of
+    the following ways:
 
-  You appear to be missing libmagic(3) library and/or necessary header
-  files. You can install missing compile-time dependencies in one of
-  the following ways:
+    - Debian / Ubuntu
 
-  - Debian / Ubuntu
+        apt-get install libmagic-dev
 
-      apt-get install libmagic-dev
+    - Red Hat / CentOS / Fedora
 
-  - Red Hat / CentOS / Fedora
+        yum install file-devel or dns install file-devel
 
-       yum install file-devel
+    - Mac OS X (Darwin)
 
-  - Mac OS X (Darwin)
+        brew install libmagic (for Homebrew, see https://brew.sh)
+        port install libmagic (for MacPorts, see https://www.macports.org)
 
-       brew install libmagic (for Homebrew, see http://brew.sh/)
-       port install libmagic (for MacPorts, see http://www.macports.org/)
+    - OpenBSD / NetBSD
 
+        pkg_add file (for pkgsrc, see https://www.pkgsrc.org)
 
-  Alternatively, you can download recent release of the file(1) package
-  from the following web site and attempt to compile libmagic(3) manually:
+    - FreeBSD
 
-    http://www.darwinsys.com/file/
+        pkg install file (for FreeBSD Ports, see https://www.freebsd.org/ports)
 
+    Alternatively, you can download recent release of the file(1) package
+    from the following web site and attempt to compile libmagic(3) manually:
+
+      https://www.darwinsys.com/file
   EOS
 end
 
-unless have_library('magic', 'magic_getpath')
-  abort <<-EOS
-
-  Your version of libmagic(3) appears to be too old.  Please, consider
-  upgrading to at least version 5.09 or newer if possible ...
+have_library('magic')
 
-  For more information about file(1) command and libmagic(3) please
-  visit the following web site:
+unless have_func('magic_getpath')
+  abort "\n" + (<<-EOS).gsub(/^[ ]{,3}/, '') + "\n"
+    Your version of libmagic(3) appears to be too old.
 
-    http://www.darwinsys.com/file/
+    Please, consider upgrading to at least version 5.29 or newer,
+    if possible. For more information about file(1) command and
+    libmagic(3) please visit the following web site:
 
+      https://www.darwinsys.com/file
   EOS
 end
 
-have_func('magic_version', 'magic.h')
+have_func('magic_getflags')
 
-dir_config('magic')
+%w[
+  utime.h
+  sys/types.h
+  sys/time.h
+].each do |h|
+  have_header(h)
+end
+
+%w[
+  utime
+  utimes
+].each do |f|
+  have_func(f)
+end
+
+dir_config('magic', [gem_include_dir], [gem_lib_dir])
 
 create_header
 create_makefile('magic/magic')
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8