magic_bytes 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4ba56d5cd2228b01a35c54c6c2e2192d47ed17d
-  data.tar.gz: ab1ec8aaedbe75604fdeef68be0d09fa27e2c702
+  metadata.gz: f329a7e5d53256b5f4889346b2f95fee7159aa11
+  data.tar.gz: 0380ac028a591eb9210691d22a74e716ac11e9f5
 SHA512:
-  metadata.gz: 3e2839aca9bd215da68122361b97ad6c488a95ebf1c2067d71f5d5dfda7114e7b90686b6eb28e7f256b3914a3d5550237af7f0336abfe3b138087c1554dd2536
-  data.tar.gz: 14724a04c4e03aa52c9a50e1586f9e00aa79befbcc24880b2bbf112b5c88a15f3d64a5a2365f07feec068fc023d1bdd5106f07b03dbf38e200151fc2350e12f9
+  metadata.gz: 41a12b10b5136b481dfd3df78b108daee7ed3e2d965780e9aab96194aecd54be42cb0863094732cec98fe6cc71150c423f986c10b011b405f1749564bb1e8407
+  data.tar.gz: b70c2fd86ea65e9594c6363607da6444d77eb60f3a9438c8d79af02b92d56b5144ba19d2f69f02e1ade4173b80f2c41db33e36212570482af3f95f6c7e1e32b1

data/lib/magic_bytes.rb

@@ -1,8 +1,15 @@
 module MagicBytes
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   
-  class FileType < Struct.new(:ext, :mime)
-  end
+  # The maximum length supported (needed for .tar archives)
+  HEADER_SIZE = 262
+  
+  # Gets raised when the file being read from is at EOF or empty
+  # (when read() from the file returns `nil`)
+  ReadError = Class.new(StandardError)
+  
+  # Describes a file type with its file extension and MIME type
+  FileType = Struct.new(:ext, :mime)
   
   extend self
   
@@ -11,8 +18,9 @@ module MagicBytes
   # @param io[#read] a readable object
   # @return [Hash, nil] the hash of ext: and mime: or nil if the type could not be deduced
   def read_and_detect(io)
-    n_bytes = 262 # The maximum length supported (needed for .tar archives)
-    detect(io.read(n_bytes))
+    first_n_bytes = io.read(HEADER_SIZE)
+    raise ReadError unless first_n_bytes
+    detect(first_n_bytes)
   end
     
   # This is a line-for-line port of https://github.com/sindresorhus/file-type
@@ -21,6 +29,7 @@ module MagicBytes
   # @param header_bytes[String] the header bytes of the file
   # @return [Hash, nil] the hash of ext: and mime: or nil if the type could not be deduced
   def detect(header_bytes)
+    raise ReadError unless header_bytes
     d = _detect(header_bytes)
     FileType.new(d.fetch(:ext), d.fetch(:mime))
   end

data/magic_bytes.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: magic_bytes 1.0.1 ruby lib
+# stub: magic_bytes 1.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "magic_bytes"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-05-28"
+  s.date = "2016-06-13"
   s.description = "Basic file type checks based on a few header bytes"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [

data/spec/magic_bytes_spec.rb

@@ -5,7 +5,24 @@ def get_extension(ext, name='fixture')
   file_type = File.open(path, 'r'){|f| MagicBytes.read_and_detect(f) }
 end
 
+describe 'MagicBytes.detect' do
+  it 'raises a meaningful exception with nil as argument' do
+    expect {
+      MagicBytes.detect(nil)
+    }.to raise_error(MagicBytes::ReadError)
+  end
+end
+
 describe 'MagicBytes.read_and_detect' do
+  describe 'with an empty file' do
+    it 'raises a meaningful exception' do
+      tf = Tempfile.new('x')
+      expect {
+        MagicBytes.read_and_detect(tf)
+      }.to raise_error(MagicBytes::ReadError)
+    end
+  end
+
   describe 'with the original tests from the JS version' do
     extensions = [
       'jpg',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_bytes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-28 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec