magic 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,12 +1,13 @@
 = magic
 
-Ruby FFI bindings to the "magic" library. Determines content type and
-encoding of files and strings. There are three sets of tests,
+Ruby FFI bindings to the "magic" library, that determines content type
+and encoding of files and strings. There are three sets of tests,
 performed in this order: filesystem tests, magic number tests, and
 language tests. The first test that succeeds causes the file type to
 be printed.
 
 == Usage
+
   require "magic"
   Magic.guess_file_mime("public/images/rails.png")
   # => "image/png; charset=binary"
@@ -20,6 +21,44 @@ be printed.
   # => "utf-8"
   Magic.guess_string_mime_type("Magic® File™")
   # => "text/plain"
+  Magic.guess(:mime_type, :database => "/etc/magic") { |db| db.buffer("Magic® File™") }
+  # => "text/plain"
+
+== Installation
+
+  gem install magic --source=http://gemcutter.org
+
+=== Linux
+
+Install magic library using your package manager, e.g.:
+
+  sudo apt-get install file
+
+=== Mac OS
+
+If you don't have <tt>libmagic.1.dylib</tt> file in your system, you need to
+install it via port command:
+
+  sudo port install file
+
+Sometimes you also need to set your
+<tt>DYLD_FALLBACK_LIBRARY_PATH</tt> environment variable to the
+directory of the <tt>libmagic.1.dylib</tt>:
+
+  export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib
+
+=== Windows
+
+Install {File for
+Windows}[http://gnuwin32.sourceforge.net/packages/file.htm].  You also
+need to set your <tt>PATH</tt> environment variable to the directory of the
+<tt>magic1.dll</tt> file:
+
+  set PATH=C:\Program Files\GnuWin32\bin;%PATH%
+
+It might be also required to add <tt>database</tt> option explicitely:
+
+  Magic.guess_string_mime("Magic® File™", :database => 'C:\Program Files\GnuWin32\share\misc\magic.mgc')
 
 == Links
 * gemcutter[http://gemcutter.org/gems/magic]
@@ -28,6 +67,7 @@ be printed.
 * rdoc[http://qoobaa.github.com/magic]
 
 == Note on Patches/Pull Requests
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a future
@@ -38,6 +78,7 @@ be printed.
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
+
 Copyright (c) 2010 Jakub Kuźma. See
 LICENSE[http://github.com/qoobaa/magic/raw/master/LICENSE] for
 details.

data/Rakefile

@@ -31,7 +31,7 @@ begin
 | You'll also need to set your PATH environment variable to the     |
 | directory of the magic1.dll file                                  |
 |                                                                   |
-|   set PATH=C:\Program Files\GnuWin32\bin;%PATH%                   |
+|   set PATH=C:\\Program Files\\GnuWin32\\bin;%PATH%                   |
 |                                                                   |
 +-NOTE FOR MAC OS USERS --------------------------------------------+
 |                                                                   |

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/magic.rb

@@ -13,57 +13,59 @@ module Magic
     # ====== Example
     #   Magic.guess_file_mime("public/images/rails.png")
     #   # => "image/png; charset=binary"
-    def guess_file_mime(file)
-      guess(:file, :mime, file)
+    def guess_file_mime(filename, *args)
+      guess(*args.unshift(:mime)) { |db| db.file(filename) }
     end
 
     # Guesses mime encoding of given file
     # ===== Example
     #   Magic.guess_file_mime_encoding("public/images/rails.png")
     #   # => "binary"
-    def guess_file_mime_encoding(file)
-      guess(:file, :mime_encoding, file)
+    def guess_file_mime_encoding(filename, *args)
+      guess(*args.unshift(:mime_encoding)) { |db| db.file(filename) }
     end
 
     # Guesses mime type of given file
     # ===== Example
     #   Magic.guess_file_mime_type("public/images/rails.png")
     #   # => "image/png"
-    def guess_file_mime_type(file)
-      guess(:file, :mime_type, file)
+    def guess_file_mime_type(filename, *args)
+      guess(*args.unshift(:mime_type)) { |db| db.file(filename) }
     end
 
     # Guesses mime type of given string
     # ===== Example
     #   Magic.guess_string_mime("Magic® File™")
     #   # => "text/plain; charset=utf-8"
-    def guess_string_mime(string)
-      guess(:buffer, :mime, string)
+    def guess_string_mime(string, *args)
+      guess(*args.unshift(:mime)) { |db| db.buffer(string) }
     end
 
     # Guesses mime type of given string
     # ===== Example
     #   Magic.guess_string_mime_encoding("Magic® File™")
     #   # => "utf-8"
-    def guess_string_mime_encoding(string)
-      guess(:buffer, :mime_encoding, string)
+    def guess_string_mime_encoding(string, *args)
+      guess(*args.unshift(:mime_type)) { |db| db.buffer(string) }
     end
 
     # Guesses mime type of given string
     # ===== Example
     #   Magic.guess_string_mime_type("Magic® File™")
     #   # => "text/plain"
-    def guess_string_mime_type(string)
-      guess(:buffer, :mime_type, string)
+    def guess_string_mime_type(string, *args)
+      guess(*args.unshift(:mime_type)) { |db| db.buffer(string) }
     end
 
-    protected
-
-    def guess(type, what, where) #:nodoc:
-      db = Database.new(what)
-      result = db.send(type, where)
-      db.close
-      result
+    # Creates magic database and yields it to the given block
+    # ===== Example
+    #   Magic.guess(:mime) { |db| db.buffer("Magic® File™") }
+    #   # => "text/plain; charset=utf-8"
+    def guess(*args)
+      db = Database.new(*args)
+      yield(db).tap do
+        db.close
+      end
     end
   end
 end

data/lib/magic/api.rb

@@ -10,7 +10,7 @@ module Magic
     # attach_function :magic_descriptor, [:pointer, :int], :string
     attach_function :magic_buffer, [:pointer, :pointer, :uint], :pointer
     attach_function :magic_error, [:pointer], :string
-    # attach_function :magic_setflags, [:pointer, :int], :int
+    attach_function :magic_setflags, [:pointer, :int], :int
     attach_function :magic_load, [:pointer, :string], :int
     # attach_function :magic_compile, [:pointer, :string], :int
     # attach_function :magic_check, [:pointer, :string], :int

data/lib/magic/database.rb

@@ -1,15 +1,20 @@
 module Magic
   class Database
-    # Creates an instance of +Magic::Database+ using given flags
-    def initialize(*flags)
-      open(*flags)
-      load
+    attr_reader :flags
+
+    # Creates an instance of +Magic::Database+ using given database
+    # file and flags
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {} # extract options
+      database = options.delete(:database)
+      open(*args)
+      load(database)
     end
 
     # Opens magic db using given flags
     def open(*flags)
-      magic_flags = flags.inject(0) { |acc, flag| acc |= Constants::Flag.const_get(flag.to_s.upcase) }
-      @magic_set = Api.magic_open(magic_flags)
+      @flags = calculate_flags(*flags)
+      @magic_set = Api.magic_open(@flags)
     end
 
     # Closes the database
@@ -42,9 +47,21 @@ module Magic
       end
     end
 
-    # Returns last error occured
+    # Returns the last error occured
     def error
       Api.magic_error(@magic_set)
     end
+
+    # Sets the flags
+    def flags=(*flags)
+      @flags = calculate_flags(*flags)
+      Api.magic_setflags(@magic_set, @flags)
+    end
+
+    protected
+
+    def calculate_flags(*flags)
+      flags.inject(0) { |calculated, flag| calculated |= Constants::Flag.const_get(flag.to_s.upcase) }
+    end
   end
 end

data/test/fixtures/magic_empty

@@ -0,0 +1 @@
+# This is an empty magic database file

data/test/fixtures/magic_jpeg

@@ -0,0 +1,29 @@
+#------------------------------------------------------------------------------
+# JPEG images
+# SunOS 5.5.1 had
+#
+#       0       string          \377\330\377\340        JPEG file
+#       0       string          \377\330\377\356        JPG file
+#
+# both of which turn into "JPEG image data" here.
+#
+0       beshort         0xffd8          JPEG image data
+!:mime  image/jpeg
+!:apple 8BIMJPEG
+!:strength +1
+>6      string          JFIF            \b, JFIF standard
+# The following added by Erik Rossen <rossen@freesurf.ch> 1999-09-06
+# in a vain attempt to add image size reporting for JFIF.  Note that these
+# tests are not fool-proof since some perfectly valid JPEGs are currently
+# impossible to specify in magic(4) format.
+# First, a little JFIF version info:
+>>11    byte            x               \b %d.
+>>12    byte            x               \b%02d
+# Next, the resolution or aspect ratio of the image:
+#>>13   byte            0               \b, aspect ratio
+#>>13   byte            1               \b, resolution (DPI)
+#>>13   byte            2               \b, resolution (DPCM)
+#>>4    beshort         x               \b, segment length %d
+# Next, show thumbnail info, if it exists:
+>>18    byte            !0              \b, thumbnail %dx
+>>>19   byte            x               \b%d

data/test/test_magic.rb

@@ -42,4 +42,18 @@ class TestMagic < Test::Unit::TestCase
       Magic.guess_file_mime_encoding(fixture("non-existing.file"))
     end
   end
+
+  def test_guess_magic_logo_mime_with_jpeg_database
+    assert_equal "image/jpeg; charset=binary", Magic.guess_file_mime(fixture("filelogo.jpg"), :database => fixture("magic_jpeg"))
+  end
+
+  def test_guess_magic_logo_mime_with_empty_database
+    assert_equal "application/octet-stream; charset=binary", Magic.guess_file_mime(fixture("filelogo.jpg"), :database => fixture("magic_empty"))
+  end
+
+  def test_guess_with_block
+    result = nil
+    Magic.guess(:mime) { |db| result = db.file(fixture("filelogo.jpg")) }
+    assert_equal "image/jpeg; charset=binary", result
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: magic
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -55,45 +55,49 @@ files:
 - lib/magic/errors.rb
 - test/fixtures/filelogo.jpg
 - test/fixtures/magic.txt
+- test/fixtures/magic_empty
+- test/fixtures/magic_jpeg
 - test/helper.rb
 - test/test_magic.rb
 has_rdoc: true
 homepage: http://github.com/qoobaa/magic
 licenses: []
 
-post_install_message: "+-NOTE FOR LINUX USERS----------------------------------------------+\n\
-  |                                                                   |\n\
-  | Install libmagic using your package manager, e.g.                 |\n\
-  |                                                                   |\n\
-  |   sudo apt-get install file                                       |\n\
-  |                                                                   |\n\
-  +-NOTE FOR WINDOWS USERS -------------------------------------------+\n\
-  |                                                                   |\n\
-  | Install File for Windows from                                     |\n\
-  |                                                                   |\n\
-  |   http://gnuwin32.sourceforge.net/packages/file.htm               |\n\
-  |                                                                   |\n\
-  | You'll also need to set your PATH environment variable to the     |\n\
-  | directory of the magic1.dll file                                  |\n\
-  |                                                                   |\n\
-  |   set PATH=C:Program FilesGnuWin32\bin;%PATH%                   |\n\
-  |                                                                   |\n\
-  +-NOTE FOR MAC OS USERS --------------------------------------------+\n\
-  |                                                                   |\n\
-  | If you don't have libmagic.1.dylib file in your system            |\n\
-  |                                                                   |\n\
-  |   find / -name libmagic.1.dylib                                   |\n\
-  |                                                                   |\n\
-  | You need to install it via port command                           |\n\
-  |                                                                   |\n\
-  |   sudo port install file                                          |\n\
-  |                                                                   |\n\
-  | Sometimes you'll also need to set your DYLD_FALLBACK_LIBRARY_PATH |\n\
-  | environment variable to the directory of the libmagic.1.dylib     |\n\
-  |                                                                   |\n\
-  |   export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib                |\n\
-  |                                                                   |\n\
-  +-------------------------------------------------------------------+\n"
+post_install_message: |
+  +-NOTE FOR LINUX USERS----------------------------------------------+
+  |                                                                   |
+  | Install libmagic using your package manager, e.g.                 |
+  |                                                                   |
+  |   sudo apt-get install file                                       |
+  |                                                                   |
+  +-NOTE FOR WINDOWS USERS -------------------------------------------+
+  |                                                                   |
+  | Install File for Windows from                                     |
+  |                                                                   |
+  |   http://gnuwin32.sourceforge.net/packages/file.htm               |
+  |                                                                   |
+  | You'll also need to set your PATH environment variable to the     |
+  | directory of the magic1.dll file                                  |
+  |                                                                   |
+  |   set PATH=C:\Program Files\GnuWin32\bin;%PATH%                   |
+  |                                                                   |
+  +-NOTE FOR MAC OS USERS --------------------------------------------+
+  |                                                                   |
+  | If you don't have libmagic.1.dylib file in your system            |
+  |                                                                   |
+  |   find / -name libmagic.1.dylib                                   |
+  |                                                                   |
+  | You need to install it via port command                           |
+  |                                                                   |
+  |   sudo port install file                                          |
+  |                                                                   |
+  | Sometimes you'll also need to set your DYLD_FALLBACK_LIBRARY_PATH |
+  | environment variable to the directory of the libmagic.1.dylib     |
+  |                                                                   |
+  |   export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib                |
+  |                                                                   |
+  +-------------------------------------------------------------------+
+
 rdoc_options: 
 - --charset=UTF-8
 require_paths: