ruby-magic 0.2.0 → 0.3.0

data/kwilczynski-public.pem

@@ -0,0 +1,25 @@
+-----BEGIN CERTIFICATE-----
+MIIEIDCCAoigAwIBAgIBATANBgkqhkiG9w0BAQsFADAdMRswGQYDVQQDDBJrdy9E
+Qz1saW51eC9EQz1jb20wHhcNMjEwMTAxMDAwOTU0WhcNMjYwMTAxMDAwOTU0WjAd
+MRswGQYDVQQDDBJrdy9EQz1saW51eC9EQz1jb20wggGiMA0GCSqGSIb3DQEBAQUA
+A4IBjwAwggGKAoIBgQCv02+pOrAMVUipLY7qjNLx8OMfMjnVCBH21SsWn8gyIHE9
+BtQ+tlsJU8nWNjlr++7SKIV5vQmyYsC2UY0cdcFASdoV0A3Lc2Z0makfvPgcIlpL
+5THqQtP11tJfhjQ3MSFJYRG2D6m6GNqA+WTTsvJbPIxy5PHv5xb+79LLzcVxB9Op
+C0ervTOF8W6Ye4EDvhQ5tppOr/d26UQV+8zRuxjxx5uZSPfUrE9u/gIIdeROoB3T
+cnjAfzvjIzampLQppvhUnT4Vf5Rum2LohZ5GosKLy7tM65vr1eLyI2ndvS1MXWrU
+05sFKm5CSqORD+TVkR1jd3z5HdPgO1KwadccxFixoI8kEIt/iixWTzbka2T2iJoq
+5DeNMEMYYAZKuAGBzBcgvgPccCeAXFVF9AHjfaGRUMmYNHKK2HD6AdgNdhcE18V+
+CJxFtggCJFYc1ygFOsHZPTbKo9+3ybSQhAswtDosWt26utUT1JOc2Bkj1sgQ0Yrk
+orANsdYz2ee3JFkzx08CAwEAAaNrMGkwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+HQYDVR0OBBYEFME41mMBb/XAHgjhlX4kE8xnXxewMBcGA1UdEQQQMA6BDGt3QGxp
+bnV4LmNvbTAXBgNVHRIEEDAOgQxrd0BsaW51eC5jb20wDQYJKoZIhvcNAQELBQAD
+ggGBAF/2ryrSgTpf0+wYG46Oi6V3p9A3uMxxbGsh0ZmlLQT1Z1ozclR+xzxzyIFC
+i7YWYyR085brDBnYNXgnUT9Nm4iAYx58MaPD28IFrcX0XA3DJE6Wkx4MmMV0chiJ
+kf5ASikfGtFtf9qDmpLQB4louB6HpKNq1MwsQo8zwY93t77HCiV5f0g43rcZfGTn
+wfBhpT7oOVWgfTLeBD811aS52VUCWclmnz+f01GdTeMwqsgc6oJaPSvg4JCMN94O
+wcBlxus69rhM8PeTJNhwLxzRCNnZ69t9k2cU+4lTmQQIB8gnEFJxY9gZdgQ6pej0
+HXUIut+6pp5BRYF2mTZ3fnxhWyIZaeB7lla2gI6rV2GXDbp4kVplGEuQ975YklJw
+i4y7bz2Es4Hkly2Nc/J2L0+uMoBhMWMY3Xl0XDdkZYtBdnSB5g7NacChaAsukEkd
+Ozt6vfXxSzW/KfodB+0ELjlHWiFbI8w7c8Kt7/ceZGVsXTxD/f4tVWy8MmxFy3pY
+Cpe8Kg==
+-----END CERTIFICATE-----

data/lib/magic.rb

@@ -1,32 +1,10 @@
-# -*- encoding: utf-8 -*-
-
-# :stopdoc:
-
-#
-# magic.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_relative 'magic/magic'
 require_relative 'magic/version'
 require_relative 'magic/core/file'
 require_relative 'magic/core/string'
 
-# :startdoc:
-
 #
 # File _Magic_ in Ruby.
 #
@@ -37,12 +15,12 @@ class Magic
   # call-seq:
   #    magic.inspect -> string
   #
-  # Returns
-  #
   # Example:
   #
-  #    magic = Magic.new   #=> #<Magic:0x007fd5258a1108>
-  #    magic.inspect       #=> "#<Magic:0x007fd5258a1108 @flags=0, @path=[\"/etc/magic\", \"/usr/share/misc/magic\"]>"
+  #    magic = Magic.new
+  #    magic.inspect     #=> "#<Magic:0x007fd5258a1108 @flags=0, @paths=[\"/etc/magic\", \"/usr/share/misc/magic\"]>"
+  #    magic.close
+  #    magic.inspect     #=> "#<Magic:0x007fd5258a1108 @flags=0, @paths=[\"/etc/magic\", \"/usr/share/misc/magic\"] (closed)>"
   #
   def inspect
     super.insert(-2, self.closed? ? ' (closed)' : '')
@@ -50,17 +28,11 @@ class Magic
 
   #
   # call-seq:
-  #    magic.flags_to_a( names ) -> array
+  #    magic.flags_list( boolean ) -> array
   #
-  # Returns an +array+
-  #
-  # Example:
+  # See also: Magic#flags and Magic#flags_names
   #
-  # Will raise <i>Magic::LibraryError</i> exception if, or
-  #
-  # See also: Magic#flags
-  #
-  def flags_to_a(names = false)
+  def flags_list(names = false)
     raise LibraryError, 'Magic library is not open' if closed?
     return [names ? 'NONE' : 0] if @flags.zero?
 
@@ -78,17 +50,22 @@ class Magic
     flags
   end
 
+  alias_method :flags_to_a, :flags_list
+
+  # call-seq:
+  #    magic.flags_names -> array
+  #
+  # See also: Magic#flags and Magic#flags_list
+  #
+  def flags_names
+    flags_list(true)
+  end
+
   class << self
     #
     # call-seq:
-    #    Magic.open( flags )                  -> self
-    #    Magic.open( flags ) {|magic| block } -> string or array
-    #
-    # Returns
-    #
-    # Example:
-    #
-    # Will raise <i></i>
+    #    Magic.open( integer )                  -> self
+    #    Magic.open( integer ) {|magic| block } -> string or array
     #
     # See also: Magic::mime, Magic::type, Magic::encoding, Magic::compile and Magic::check
     #
@@ -112,12 +89,6 @@ class Magic
     #    Magic.mime                  -> self
     #    Magic.mime {|magic| block } -> string or array
     #
-    # Returns
-    #
-    # Example:
-    #
-    # Will raise <i></i>
-    #
     # See also: Magic::open, Magic::type, Magic::encoding, Magic::compile and Magic::check
     #
     def mime(&block)
@@ -129,12 +100,6 @@ class Magic
     #    Magic.type                  -> self
     #    Magic.type {|magic| block } -> string or array
     #
-    # Returns
-    #
-    # Example:
-    #
-    # Will raise <i></i>
-    #
     # See also: Magic::open, Magic::mime, Magic::encoding, Magic::compile and Magic::check
     #
     def type(&block)
@@ -146,12 +111,6 @@ class Magic
     #    Magic.encoding                  -> self
     #    Magic.encoding {|magic| block } -> string or array
     #
-    # Returns
-    #
-    # Example:
-    #
-    # Will raise <i></i>
-    #
     # See also: Magic::open, Magic::mime, Magic::type, Magic::compile and Magic::check
     #
     def encoding(&block)
@@ -160,55 +119,85 @@ class Magic
 
     #
     # call-seq:
-    #    Magic.compile( path, ... ) -> true
-    #    Magic.compile( array )     -> true
+    #    Magic.compile( string, ... ) -> true
+    #    Magic.compile( array )       -> true
     #
-    # Returns
+    # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding, and Magic::check
     #
-    # Example:
+    def compile(*paths)
+      open {|m| m.compile(paths) }
+    end
+
     #
-    # Will raise <i></i>
+    # call-seq:
+    #    Magic.check( string, ... ) -> true or false
+    #    Magic.check( array )       -> true or false
     #
-    # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding, and Magic::check
+    # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding and Magic::compile
     #
-    def compile(path)
-      open {|m| m.compile(path) }
+    def check(*paths)
+      open {|m| m.check(paths) }
     end
 
     #
     # call-seq:
-    #    Magic.check( path, ... ) -> true or false
-    #    Magic.check( array )     -> true or false
+    #    Magic.file( object )          -> string or array
+    #    Magic.file( string )          -> string or array
+    #    Magic.file( string, integer ) -> string or array
     #
-    # Returns
+    # See also:
     #
-    # Example:
+    def file(path, flags = Magic::MIME)
+      open(flags).file(path)
+    end
+
     #
-    # Will raise <i></i>
+    # call-seq:
+    #    Magic.buffer( string )          -> string or array
+    #    Magic.buffer( string, integer ) -> string or array
     #
-    # See also: Magic::open, Magic::mime, Magic::type, Magic::encoding and Magic::compile
+    # See also:
     #
-    def check(path)
-      open {|m| m.check(path) }
+    def buffer(buffer, flags = Magic::MIME)
+      open(flags).buffer(buffer)
     end
-  end
 
-  alias_method :flags_array, :flags_to_a
+    #
+    # call-seq:
+    #    Magic.descriptor( object )           -> string or array
+    #    Magic.descriptor( integer )          -> string or array
+    #    Magic.descriptor( integer, integer ) -> string or array
+    #
+    # See also:
+    #
+    def descriptor(fd, flags = Magic::MIME)
+      open(flags).descriptor(fd)
+    end
+
+    alias_method :fd, :descriptor
+  end
 
   private
 
+  def power_of_two?(number)
+    number > 0 && Math.log2(number) % 1 == 0
+  end
+
   def flags_as_map
-    self.class.constants.inject({}) do |flags,constant|
-      value = self.class.const_get(constant)
-      flags[value] = constant.to_s if value.is_a?(Fixnum)
-      flags
+    klass = self.class
+
+    klass.constants.each_with_object({}) do |constant, flags|
+      constant = constant.to_s
+
+      next if constant.start_with?('PARAM_')
+
+      value = klass.const_get(constant)
+
+      if value.is_a?(Integer) && power_of_two?(value)
+        flags[value] = constant
+      end
     end
   end
 end
 
-# :enddoc:
-
 FileMagic = Magic
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/lib/magic/core/file.rb

@@ -1,57 +1,21 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-# :stopdoc:
-
-#
-# core/file.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.
-#
-
-# :startdoc:
-
-#
-#
-#
 class File
   class << self
     #
     # call-seq:
-    #    File.magic( path ) -> string or array
-    #
-    # Returns
-    #
-    # Example:
+    #    File.magic( object ) -> string or array
+    #    File.magic( string ) -> string or array
     #
     # See also: File::mime and File::type
     #
     def magic(path, flags = Magic::NONE)
-      path   = path.path    if path.respond_to?(:path)
-      path ||= path.to_path if path.respond_to?(:to_path)
-      path ||= path.to_s
-
-      Magic.open(flags | Magic::ERROR) {|mgc| mgc.file(path) }
+      Magic.open(flags) {|mgc| mgc.file(path) }
     end
 
     #
     # call-seq:
-    #    File.mime( path ) -> string or array
-    #
-    # Returns
-    #
-    # Example:
+    #    File.mime( string ) -> string or array
     #
     # See also: File::magic and File::type
     #
@@ -61,11 +25,7 @@ class File
 
     #
     # call-seq:
-    #    File.type( path ) -> string or array
-    #
-    # Returns
-    #
-    # Example:
+    #    File.type( string ) -> string or array
     #
     # See also: File::magic and File::mime
     #
@@ -76,11 +36,7 @@ class File
 
   #
   # call-seq:
-  #    File.magic( path ) -> string or array
-  #
-  # Returns
-  #
-  # Example:
+  #    File.magic -> string or array
   #
   # See also: File#mime and File#type
   #
@@ -90,11 +46,7 @@ class File
 
   #
   # call-seq:
-  #    File.mime( path ) -> string or array
-  #
-  # Returns
-  #
-  # Example:
+  #    File.mime -> string or array
   #
   # See also: File#magic and File#type
   #
@@ -104,11 +56,7 @@ class File
 
   #
   # call-seq:
-  #    File.type( path ) -> string or array
-  #
-  # Returns
-  #
-  # Example:
+  #    File.type -> string or array
   #
   # See also: File#magic and File#mime
   #
@@ -116,8 +64,3 @@ class File
     self.class.type(self)
   end
 end
-
-# :enddoc:
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8

data/lib/magic/core/string.rb

@@ -1,39 +1,10 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 
-# :stopdoc:
-
-#
-# core/string.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.
-#
-
-# :startdoc:
-
-#
-#
-#
 class String
   #
   # call-seq:
   #    string.magic -> string or array
   #
-  # Returns
-  #
-  # Example:
-  #
   # See also: String#mime and String#type
   #
   def magic(flags = Magic::NONE)
@@ -44,10 +15,6 @@ class String
   # call-seq:
   #    string.mime -> string or array
   #
-  # Returns
-  #
-  # Example:
-  #
   # See also: String#magic and String#type
   #
   def mime
@@ -58,18 +25,9 @@ class String
   # call-seq:
   #    string.type -> string or array
   #
-  # Returns
-  #
-  # Example:
-  #
   # See also: String#magic and String#mime
   #
   def type
     magic(Magic::MIME_TYPE)
   end
 end
-
-# :enddoc:
-
-# vim: set ts=2 sw=2 sts=2 et :
-# encoding: utf-8