ruby-filemagic 0.6.3-x86-mswin32-60 → 0.7.0-x86-mswin32-60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 604cdeadc00cb17c12254bb6338e7cc608cb324a
-  data.tar.gz: 5e01b3eba5d45f2d2ab75923dac21373859c99b1
+  metadata.gz: 8349a5eb4ea628e8d5fe33c0737cf80f0452a3e1
+  data.tar.gz: 3f34794198e5513f0c4613da05c9fe4a8d90d1f0
 SHA512:
-  metadata.gz: 410e24ad907fa27f6a619c10335804d7c7eea55af4150f256e3325a6a63cf017cc58ceaf963e9fbe07008cef705af24c0143ec39aa81606407bc871f944d0d6c
-  data.tar.gz: 8ff4edb43c95056d52a1073d509eb9d4c3d56042fc8b1f0c1b26548c30f7faefef0a203d73a12f1885b1db5de55c8edbfb9a943160ec25a86c185244b0a89284
+  metadata.gz: 0de88a03aecb65ae95a12a81ee57600bd32c6be249d68dc578545f1a22fbdb34e80fc11754b56f0d33ca98882d4782d5e8551a7f50368d3644f948b645dbaad2
+  data.tar.gz: 33050f022f7e39db0791d9b43e8cf8ea3a998d769e4c45600b4dbb65f63e14b978a6e6e2c68a65a5efecb181fa35610ea185f1c647c491e9b4837ed374d2a785

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Please note that this project is in **maintenance mode**. Bug reports and pull requests are welcome, but only [file](http://www.darwinsys.com/file/) **5.11 or higher** is actually supported.

data/ChangeLog

@@ -2,6 +2,14 @@
 
 = Revision history for ruby-filemagic
 
+== 0.7.0 [2015-07-28]
+
+* Changed FileMagic#io to optionally rewind input afterwards.
+* New method FileMagic.library_version (+magic_version+).
+* New method FileMagic#descriptor (+magic_descriptor+).
+* New method FileMagic#fd.
+* Added new constants from file 5.23.
+
 == 0.6.3 [2015-02-06]
 
 * Fixed build error with Clang (issue #13 by Stan Carver II).

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to filemagic version 0.6.3
+This documentation refers to filemagic version 0.7.0
 
 
 == DESCRIPTION
@@ -29,10 +29,11 @@ FileMagic extension module. See also libmagic(3), file(1) and magic(4).
 <tt>check(filename)</tt>::   Checks the validity of entries in the database
                              file passed in as filename
 <tt>compile(filename)</tt>:: Compiles the database file passed in as filename
+<tt>load(filename)</tt>::    Loads the database file passed in as filename
 <tt>close()</tt>::           Closes the magic database and frees any memory
                              allocated
 
-=== Synospis
+=== Synopsis
 
   require 'filemagic'
 
@@ -56,13 +57,22 @@ FileMagic extension module. See also libmagic(3), file(1) and magic(4).
   mime = FileMagic.mime
   p mime.flags
 
+=== Environment
+
+The environment variable +MAGIC+ can be used to set the default magic file name.
+
 === Installation
 
 Install the gem:
 
   sudo gem install ruby-filemagic
 
-The file(1) library and headers are required.
+The file(1) library and headers are required:
+
+Debian/Ubuntu:: +libmagic-dev+
+Fedora/SuSE::   +file-devel+
+Gentoo::        +sys-libs/libmagic+
+OS X::          <tt>brew install libmagic</tt>
 
 
 == LINKS

data/ext/filemagic/extconf.rb

@@ -9,6 +9,7 @@ dir_config('gnurx')
 have_library('gnurx')
 
 if have_library('magic', 'magic_open') && have_header('magic.h')
+  have_func('magic_version')
   have_header('file/patchlevel.h')
   create_makefile('filemagic/ruby_filemagic')
 else

data/ext/filemagic/filemagic.c

@@ -1,5 +1,15 @@
 #include "filemagic.h"
 
+/* Returns the magic version */
+static VALUE
+rb_magic_version(VALUE klass) {
+  char version[8] = "0";
+#ifdef HAVE_MAGIC_VERSION
+  RB_MAGIC_SET_VERSION(magic_version() / 100, magic_version() % 100)
+#endif
+  return rb_str_new2(version);
+}
+
 /* Returns the magic path */
 static VALUE
 rb_magic_getpath(VALUE klass) {
@@ -146,12 +156,15 @@ rb_magic_closed_p(VALUE self) {
   return rb_attr_get(self, rb_intern("closed"));
 }
 
-/* Return a string describing file */
+/* Return a string describing the named file */
 RB_MAGIC_TYPE(file, FILE)
 
 /* Return a string describing the string buffer */
 RB_MAGIC_TYPE(buffer, BUFFER)
 
+/* Return a string describing the file descriptor */
+RB_MAGIC_TYPE(descriptor, DESCRIPTOR)
+
 /* Get the flags as array of symbols */
 static VALUE
 rb_magic_getflags(VALUE self) {
@@ -205,21 +218,23 @@ Init_ruby_filemagic() {
 
   rb_define_const(cFileMagic, "MAGIC_VERSION", rb_str_new2(version));
 
-  rb_define_singleton_method(cFileMagic, "path",  rb_magic_getpath,  0);
-  rb_define_singleton_method(cFileMagic, "flags", rb_magic_flags,    1);
-  rb_define_singleton_method(cFileMagic, "new",   rb_magic_new,     -1);
-
-  rb_define_method(cFileMagic, "initialize", rb_magic_init,     -1);
-  rb_define_method(cFileMagic, "close",      rb_magic_close,     0);
-  rb_define_method(cFileMagic, "closed?",    rb_magic_closed_p,  0);
-  rb_define_method(cFileMagic, "file",       rb_magic_file,     -1);
-  rb_define_method(cFileMagic, "buffer",     rb_magic_buffer,   -1);
-  rb_define_method(cFileMagic, "flags",      rb_magic_getflags,  0);
-  rb_define_method(cFileMagic, "flags=",     rb_magic_setflags,  1);
-  rb_define_method(cFileMagic, "list",       rb_magic_list,     -1);
-  rb_define_method(cFileMagic, "load",       rb_magic_load,     -1);
-  rb_define_method(cFileMagic, "check",      rb_magic_check,    -1);
-  rb_define_method(cFileMagic, "compile",    rb_magic_compile,  -1);
+  rb_define_singleton_method(cFileMagic, "library_version", rb_magic_version,  0);
+  rb_define_singleton_method(cFileMagic, "path",            rb_magic_getpath,  0);
+  rb_define_singleton_method(cFileMagic, "flags",           rb_magic_flags,    1);
+  rb_define_singleton_method(cFileMagic, "new",             rb_magic_new,     -1);
+
+  rb_define_method(cFileMagic, "initialize", rb_magic_init,       -1);
+  rb_define_method(cFileMagic, "close",      rb_magic_close,       0);
+  rb_define_method(cFileMagic, "closed?",    rb_magic_closed_p,    0);
+  rb_define_method(cFileMagic, "file",       rb_magic_file,       -1);
+  rb_define_method(cFileMagic, "buffer",     rb_magic_buffer,     -1);
+  rb_define_method(cFileMagic, "descriptor", rb_magic_descriptor, -1);
+  rb_define_method(cFileMagic, "flags",      rb_magic_getflags,    0);
+  rb_define_method(cFileMagic, "flags=",     rb_magic_setflags,    1);
+  rb_define_method(cFileMagic, "list",       rb_magic_list,       -1);
+  rb_define_method(cFileMagic, "load",       rb_magic_load,       -1);
+  rb_define_method(cFileMagic, "check",      rb_magic_check,      -1);
+  rb_define_method(cFileMagic, "compile",    rb_magic_compile,    -1);
 
   rb_alias(cFileMagic, rb_intern("valid?"), rb_intern("check"));
 
@@ -267,6 +282,15 @@ Init_ruby_filemagic() {
 #ifdef MAGIC_APPLE
   rb_define_const(cFileMagic, "MAGIC_APPLE",             INT2FIX(MAGIC_APPLE));
 #endif
+#ifdef MAGIC_EXTENSION
+  rb_define_const(cFileMagic, "MAGIC_EXTENSION",         INT2FIX(MAGIC_EXTENSION));
+#endif
+#ifdef MAGIC_COMPRESS_TRANSP
+  rb_define_const(cFileMagic, "MAGIC_COMPRESS_TRANSP",   INT2FIX(MAGIC_COMPRESS_TRANSP));
+#endif
+#ifdef MAGIC_NODESC
+  rb_define_const(cFileMagic, "MAGIC_NODESC",            INT2FIX(MAGIC_NODESC));
+#endif
 #ifdef MAGIC_NO_CHECK_COMPRESS
   rb_define_const(cFileMagic, "MAGIC_NO_CHECK_COMPRESS", INT2FIX(MAGIC_NO_CHECK_COMPRESS));
 #endif

data/ext/filemagic/filemagic.h

@@ -18,19 +18,18 @@
   }\
 }
 
-#define RB_MAGIC_TYPE_FILE   magic_file(ms, str)
-#define RB_MAGIC_TYPE_BUFFER magic_buffer(ms, str, RSTRING_LEN(arg))
+#define RB_MAGIC_TYPE_FILE       magic_file(ms, StringValuePtr(arg))
+#define RB_MAGIC_TYPE_BUFFER     magic_buffer(ms, StringValuePtr(arg), RSTRING_LEN(arg))
+#define RB_MAGIC_TYPE_DESCRIPTOR magic_descriptor(ms, NUM2INT(arg))
 
 #define RB_MAGIC_TYPE(what, WHAT) \
 static VALUE \
 rb_magic_##what(int argc, VALUE *argv, VALUE self) {\
   VALUE arg, simple, res;\
-  const char *str, *type;\
+  const char *type;\
   magic_t ms;\
 \
   rb_scan_args(argc, argv, "11", &arg, &simple);\
-\
-  str = StringValuePtr(arg);\
   GetMagicSet(self, ms);\
 \
   if ((type = RB_MAGIC_TYPE_##WHAT) == NULL) {\
@@ -72,6 +71,7 @@ rb_magic_##what(int argc, VALUE *argv, VALUE self) {\
 
 static VALUE cFileMagic, rb_FileMagicError;
 
+static VALUE rb_magic_version(VALUE);
 static VALUE rb_magic_getpath(VALUE);
 static VALUE rb_magic_flags(VALUE, VALUE);
 
@@ -84,6 +84,7 @@ static VALUE rb_magic_closed_p(VALUE);
 
 static VALUE rb_magic_file(int, VALUE*, VALUE);
 static VALUE rb_magic_buffer(int, VALUE*, VALUE);
+static VALUE rb_magic_descriptor(int, VALUE*, VALUE);
 
 static VALUE rb_magic_getflags(VALUE);
 static VALUE rb_magic_setflags(VALUE, VALUE);

data/lib/filemagic.rb

@@ -9,6 +9,11 @@ require 'filemagic/version'
 
 class FileMagic
 
+  unless ENV['MAGIC_SILENCE_VERSION_CHECK'] || MAGIC_VERSION == library_version
+    warn "#{self} v#{VERSION}: compiled magic version [#{MAGIC_VERSION}] " <<
+         "does not match with shared library magic version [#{library_version}]"
+  end
+
   DEFAULT_MAGIC = __FILE__.sub(/\.rb\z/, '/magic.mgc')
 
   ENV['MAGIC'] ||= DEFAULT_MAGIC unless path
@@ -20,15 +25,18 @@ class FileMagic
     :symlink,            # Follow symlinks
     :compress,           # Check inside compressed files
     :devices,            # Look at the contents of devices
-    :mime_type,          # Return only the MIME type
+    :mime_type,          # Return the MIME type
     :continue,           # Return all matches
     :check,              # Print warnings to stderr
     :preserve_atime,     # Restore access time on exit
-    :raw,                # Don't translate unprint chars
+    :raw,                # Don't convert unprintable chars
     :error,              # Handle ENOENT etc as real errors
-    :mime_encoding,      # Return only the MIME encoding
+    :mime_encoding,      # Return the MIME encoding
     :mime,               # MAGIC_MIME_TYPE | MAGIC_MIME_ENCODING
-    :apple,              # Return the Apple creator and type
+    :apple,              # Return the Apple creator/type
+    :extension,          # Return a /-separated list of extensions
+    :compress_transp,    # Check inside compressed files but not report compression
+    :nodesc,             # MAGIC_EXTENSION | MAGIC_MIME | MAGIC_APPLE
     :no_check_compress,  # Don't check for compressed files
     :no_check_tar,       # Don't check for tar files
     :no_check_soft,      # Don't check magic entries
@@ -36,7 +44,7 @@ class FileMagic
     :no_check_elf,       # Don't check for elf details
     :no_check_text,      # Don't check for text files
     :no_check_cdf,       # Don't check for cdf files
-    :no_check_tokens,    # Don't check ascii/tokens
+    :no_check_tokens,    # Don't check tokens
     :no_check_encoding,  # Don't check text encodings
     :no_check_builtin,   # No built-in tests; only consult the magic file
 
@@ -131,8 +139,15 @@ class FileMagic
     @simplified
   end
 
-  def io(io, length = 8)
+  def io(io, length = 8, rewind = false)
+    pos = io.pos if rewind
     buffer(io.read(length))
+  ensure
+    io.pos = pos if pos
+  end
+
+  def fd(fd)
+    descriptor(fd.respond_to?(:fileno) ? fd.fileno : fd)
   end
 
   def inspect

data/lib/filemagic/version.rb

@@ -3,8 +3,8 @@ class FileMagic
   module Version
 
     MAJOR = 0
-    MINOR = 6
-    TINY  = 3
+    MINOR = 7
+    TINY  = 0
 
     class << self
 

data/test/filemagic_test.rb

@@ -59,6 +59,55 @@ magic file from #{FileMagic.path}
     assert_equal('POSIX shell script, ASCII text executable', res)
   end
 
+  def test_descriptor
+    fm = FileMagic.new(FileMagic::MAGIC_NONE)
+
+    python_script = match_version(
+      0    => 'a python script, ASCII text executable',
+      5.11 => 'Python script, ASCII text executable'
+    )
+
+    fd_for('pyfile') { |fd|
+      res = fm.descriptor(fd)
+      assert_equal(python_script, res)
+    }
+
+    if File.symlink?(path_to('pylink'))
+      fd_for('pylink') { |fd|
+        res = fm.descriptor(fd)
+        assert_equal(python_script, res.strip)
+      }
+    end
+
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_SYMLINK)
+
+    fd_for('pylink') { |fd|
+      res = fm.descriptor(fd)
+      assert_equal(python_script, res)
+    }
+
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_SYMLINK | FileMagic::MAGIC_MIME)
+
+    fd_for('pylink') { |fd|
+      res = fm.descriptor(fd)
+      assert_equal('text/plain; charset=us-ascii', res)
+    }
+
+    fm.close
+    fm = FileMagic.new(FileMagic::MAGIC_COMPRESS)
+
+    fd_for('pyfile-compressed.gz') { |fd|
+      res = fm.descriptor(fd)
+      gzip_compressed = 'gzip compressed data, was "pyfile-compressed"'
+      assert_match(Gem.win_platform? ? /^#{gzip_compressed}/ :
+                   /^#{python_script} \(#{gzip_compressed}/, res)
+    }
+
+    fm.close
+  end
+
   def test_check
     return if Gem.win_platform?
     fm = FileMagic.new(FileMagic::MAGIC_NONE)
@@ -213,6 +262,12 @@ magic file from #{FileMagic.path}
     File.join(dir, file)
   end
 
+  def fd_for(file)
+    File.open(path_to(file)) { |f| yield f.fileno }
+  rescue Errno::EBADF => err
+    warn err.to_s
+  end
+
   def silence_stderr
     require 'nuggets/io/redirect'
     $stderr.redirect { yield }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-filemagic
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: x86-mswin32-60
 authors:
 - Travis Whitton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hen
@@ -20,7 +20,7 @@ dependencies:
         version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +82,7 @@ extra_rdoc_files:
 - ChangeLog
 - ext/filemagic/filemagic.c
 files:
+- CONTRIBUTING.md
 - ChangeLog
 - README
 - Rakefile
@@ -113,13 +114,17 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  ruby-filemagic-0.6.3 [2015-02-06]:
+  ruby-filemagic-0.7.0 [2015-07-28]:
 
-  * Fixed build error with Clang (issue #13 by Stan Carver II).
+  * Changed FileMagic#io to optionally rewind input afterwards.
+  * New method FileMagic.library_version (+magic_version+).
+  * New method FileMagic#descriptor (+magic_descriptor+).
+  * New method FileMagic#fd.
+  * Added new constants from file 5.23.
 
 rdoc_options:
 - "--title"
-- ruby-filemagic Application documentation (v0.6.3)
+- ruby-filemagic Application documentation (v0.7.0)
 - "--charset"
 - UTF-8
 - "--line-numbers"
@@ -140,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby bindings to the magic(4) library