ruby-magic 0.0.1 → 0.2.0

data/ext/magic/ruby-magic.c

@@ -3,7 +3,7 @@
 /*
  * ruby-magic.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 "ruby-magic.h"
 
 ID id_at_flags, id_at_path, id_at_mutex;
@@ -76,7 +80,7 @@ static VALUE magic_return(VALUE value, void *data);
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
  * Will raise <i>Magic::LibraryError</i> exception if, or
- * <i>Magic::MagicError</i> exception if, or
+ * <i>Magic::MagicError</i> exception if
  *
  * See also: Magic::open, Magic::mime, Magic::type, Magic::encoding, Magic::compile and Magic::check
  */
@@ -241,7 +245,7 @@ rb_mgc_get_flags(VALUE object)
  *    magic.flags = Magic::MIME_TYPE   #=> 16
  *
  * Will raise <i>Magic::FlagsError</i> exception if, or
- * <i>Magic::LibraryError</i> exception if, or 
+ * <i>Magic::LibraryError</i> exception if, or
  * <i>Magic::NotImplementedError</i> exception if, or
  */
 VALUE
@@ -289,7 +293,9 @@ rb_mgc_set_flags(VALUE object, VALUE value)
  *    magic.load("/usr/share/misc/magic", "/etc/magic")   #=> ["/usr/share/misc/magic", "/etc/magic"]
  *    magic.load                                          #=> ["/etc/magic", "/usr/share/misc/magic"]
  *
- * Will raise <i>Magic::LibraryError</i> exception if, or 
+ * Will raise <i>Magic::LibraryError</i> exception if, or
+ *
+ * See also: Magic#check, Magic#compile, Magic::check and Magic::compile
  */
 VALUE
 rb_mgc_load(VALUE object, VALUE arguments)
@@ -329,9 +335,9 @@ rb_mgc_load(VALUE object, VALUE arguments)
  *
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
- * See also: Magic#check, Magic::check and Magic::compile
- *
  * Will raise <i>Magic::LibraryError</i> exception if, or
+ *
+ * See also: Magic#check, Magic::check and Magic::compile
  */
 VALUE
 rb_mgc_compile(VALUE object, VALUE arguments)
@@ -369,9 +375,9 @@ rb_mgc_compile(VALUE object, VALUE arguments)
  *
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
- * See also: Magic#compile, Magic::compile and Magic::check
+ * Will raise <i>Magic::LibraryError</i> exception if, or
  *
- * Will raise <i>Magic::LibraryError</i> exception if, or 
+ * See also: Magic#compile, Magic::compile and Magic::check
  */
 VALUE
 rb_mgc_check(VALUE object, VALUE arguments)
@@ -409,7 +415,7 @@ rb_mgc_check(VALUE object, VALUE arguments)
  *
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
- * Will raise <i>Magic::LibraryError</i> exception if, or 
+ * Will raise <i>Magic::LibraryError</i> exception if, or
  *
  * See also: Magic#buffer and Magic#descriptor
  */
@@ -459,7 +465,7 @@ rb_mgc_file(VALUE object, VALUE value)
  *
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
- * Will raise <i>Magic::LibraryError</i> exception if, or 
+ * Will raise <i>Magic::LibraryError</i> exception if, or
  *
  * See also: Magic#file and Magic#descriptor
  */
@@ -497,7 +503,7 @@ rb_mgc_buffer(VALUE object, VALUE value)
  *
  *    magic = Magic.new   #=> #<Magic:0x007f8fdc012e58>
  *
- * Will raise <i>Magic::LibraryError</i> exception if, or 
+ * Will raise <i>Magic::LibraryError</i> exception if, or
  *
  * See also: Magic#file and Magic#buffer
  */
@@ -556,7 +562,7 @@ rb_mgc_version(VALUE object)
     return INT2NUM(rv);
 }
 
-/* :enddoc: */
+/* :stopdoc: */
 
 static inline void*
 nogvl_magic_load(void *data)
@@ -654,7 +660,7 @@ magic_allocate(VALUE klass)
 
     cookie = magic_open(MAGIC_NONE);
     if (!cookie) {
-        MAGIC_GENERIC_ERROR(rb_mgc_eLibraryError, EPERM,
+        MAGIC_GENERIC_ERROR(rb_mgc_eLibraryError, ENOMEM,
                 error(E_MAGIC_LIBRARY_INITIALIZE));
     }
 
@@ -761,13 +767,15 @@ magic_return(VALUE value, void *data)
     VALUE array = Qnil;
 
     if (ma->flags & MAGIC_CONTINUE) {
-        array = magic_split(value, CSTR2RVAL("\\012\055\040"));
+        array = magic_split(value, CSTR2RVAL("\x5c\x30\x31\x32\x2d\x20"));
         return (NUM2INT(magic_size(array)) > 1) ? array : magic_shift(array);
     }
 
     return value;
 }
 
+/* :startdoc: */
+
 void
 Init_magic(void)
 {
@@ -970,4 +978,10 @@ Init_magic(void)
     rb_define_const(rb_cMagic, "NO_CHECK_TROFF", INT2NUM(MAGIC_NO_CHECK_TROFF));
 }
 
+/* :enddoc: */
+
+#if defined(__cplusplus)
+}
+#endif
+
 /* vim: set ts=8 sw=4 sts=2 et : */

data/ext/magic/ruby-magic.h

@@ -3,7 +3,7 @@
 /*
  * ruby-magic.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.

data/lib/magic.rb

@@ -5,7 +5,7 @@
 #
 # magic.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.
@@ -20,10 +20,10 @@
 # limitations under the License.
 #
 
-require 'magic/magic'
-require 'magic/version'
-require 'magic/core/file'
-require 'magic/core/string'
+require_relative 'magic/magic'
+require_relative 'magic/version'
+require_relative 'magic/core/file'
+require_relative 'magic/core/string'
 
 # :startdoc:
 
@@ -61,14 +61,12 @@ class Magic
   # See also: Magic#flags
   #
   def flags_to_a(names = false)
-    raise LibraryError, "Magic library is not open" if closed?
+    raise LibraryError, 'Magic library is not open' if closed?
+    return [names ? 'NONE' : 0] if @flags.zero?
 
     n, i = 0, @flags
-
     flags = []
 
-    return [names ? 'NONE' : 0] if @flags.zero?
-
     @@flags_map ||= flags_as_map if names
 
     while i > 0
@@ -90,6 +88,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::mime, Magic::type, Magic::encoding, Magic::compile and Magic::check
     #
     def open(flags = Magic::NONE)
@@ -116,6 +116,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::open, Magic::type, Magic::encoding, Magic::compile and Magic::check
     #
     def mime(&block)
@@ -131,6 +133,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::open, Magic::mime, Magic::encoding, Magic::compile and Magic::check
     #
     def type(&block)
@@ -146,6 +150,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::open, Magic::mime, Magic::type, Magic::compile and Magic::check
     #
     def encoding(&block)
@@ -161,6 +167,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding, and Magic::check
     #
     def compile(path)
@@ -176,6 +184,8 @@ class Magic
     #
     # Example:
     #
+    # Will raise <i></i>
+    #
     # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding and Magic::compile
     #
     def check(path)
@@ -189,7 +199,7 @@ class Magic
 
   def flags_as_map
     self.class.constants.inject({}) do |flags,constant|
-      value        = self.class.const_get(constant)
+      value = self.class.const_get(constant)
       flags[value] = constant.to_s if value.is_a?(Fixnum)
       flags
     end

data/lib/magic/core/file.rb

@@ -5,7 +5,7 @@
 #
 # core/file.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.
@@ -29,7 +29,7 @@ class File
   class << self
     #
     # call-seq:
-    #    File.magic( path ) -> string, array or nil
+    #    File.magic( path ) -> string or array
     #
     # Returns
     #
@@ -42,13 +42,12 @@ class File
       path ||= path.to_path if path.respond_to?(:to_path)
       path ||= path.to_s
 
-      Magic.open(flags) {|mgc| mgc.file(path) }
-    rescue Magic::Error
+      Magic.open(flags | Magic::ERROR) {|mgc| mgc.file(path) }
     end
 
     #
     # call-seq:
-    #    File.mime( path ) -> string, array or nil
+    #    File.mime( path ) -> string or array
     #
     # Returns
     #
@@ -62,7 +61,7 @@ class File
 
     #
     # call-seq:
-    #    File.type( path ) -> string, array or nil
+    #    File.type( path ) -> string or array
     #
     # Returns
     #
@@ -77,7 +76,7 @@ class File
 
   #
   # call-seq:
-  #    File.magic( path ) -> string, array or nil
+  #    File.magic( path ) -> string or array
   #
   # Returns
   #
@@ -91,7 +90,7 @@ class File
 
   #
   # call-seq:
-  #    File.mime( path ) -> string, array or nil
+  #    File.mime( path ) -> string or array
   #
   # Returns
   #
@@ -105,7 +104,7 @@ class File
 
   #
   # call-seq:
-  #    File.type( path ) -> string, array or nil
+  #    File.type( path ) -> string or array
   #
   # Returns
   #

data/lib/magic/core/string.rb

@@ -5,7 +5,7 @@
 #
 # core/string.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.
@@ -28,7 +28,7 @@
 class String
   #
   # call-seq:
-  #    string.magic -> string, array or nil
+  #    string.magic -> string or array
   #
   # Returns
   #
@@ -38,12 +38,11 @@ class String
   #
   def magic(flags = Magic::NONE)
     Magic.open(flags) {|mgc| mgc.buffer(self) }
-  rescue Magic::Error
   end
 
   #
   # call-seq:
-  #    string.mime -> string, array or nil
+  #    string.mime -> string or array
   #
   # Returns
   #
@@ -57,7 +56,7 @@ class String
 
   #
   # call-seq:
-  #    string.type -> string, array or nil
+  #    string.type -> string or array
   #
   # Returns
   #

data/lib/magic/version.rb

@@ -5,7 +5,7 @@
 #
 # version.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.
@@ -26,7 +26,7 @@ class Magic
   #
   # Current version of _Magic_.
   #
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'.freeze
 
   class << self
     #

data/ruby-magic.gemspec

@@ -5,7 +5,7 @@
 #
 # ruby-magic.gemspec
 #
-# 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.
@@ -23,7 +23,8 @@
 signing_key = File.expand_path('~/.gem/kwilczynski-private.pem')
 
 Gem::Specification.new do |s|
-  s.name = 'ruby-magic'
+  s.name    = 'ruby-magic'
+  s.summary = 'File Magic in Ruby'
 
   s.description = <<-EOS
 File Magic in Ruby.
@@ -37,12 +38,10 @@ Simple interface to libmagic for Ruby Programming Language.
   s.author   = 'Krzysztof Wilczynski'
   s.email    = 'krzysztof.wilczynski@linux.com'
   s.homepage = 'http://about.me/kwilczynski'
+  s.has_rdoc = true
 
-  s.rubyforge_project = 'ruby-magic'
-  s.rubygems_version  = '~> 2.2.0'
-  s.has_rdoc          = true
-
-  s.summary = 'File Magic in Ruby'
+  s.required_ruby_version = '>= 1.9.2'
+  s.rubygems_version      = '~> 2.2.0'
 
   s.files = Dir['ext/**/*.{c,h,rb}'] +
             Dir['lib/**/*.rb']       +
@@ -56,11 +55,6 @@ Simple interface to libmagic for Ruby Programming Language.
   s.require_paths << 'lib'
   s.extensions    << 'ext/magic/extconf.rb'
 
-  s.add_development_dependency 'rake', '~> 10.1', '>= 10.1.1'
-  s.add_development_dependency 'rdoc', '~> 4.1', '>= 4.1.1'
-  s.add_development_dependency 'test-unit', '~> 2.5', '>= 2.5.5'
-  s.add_development_dependency 'rake-compiler', '~> 0.9', '>= 0.9.2'
-
   s.signing_key = signing_key if File.exists?(signing_key)
 end
 

data/test/helpers/magic_test_helper.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+# :enddoc:
+
+#
+# helpers.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.
+#
+
+require 'stringio'
+
+module MagicTestHelpers
+  def capture_stderr
+    saved_stderr, $stderr = $stderr, StringIO.new
+    [yield, $stderr.string]
+  ensure
+    $stderr = saved_stderr
+  end
+end
+
+# vim: set ts=2 sw=2 sts=2 et :
+# encoding: utf-8