digest-ed2k-hash 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c45ba32ed829add3658beb53e3d759e18f2c701
-  data.tar.gz: 8c6c76c0908c82069b9e1ae9de60413b81bcfc2f
+  metadata.gz: c566efddbb745ed6d57490058dec5e58d3cf5947
+  data.tar.gz: 62330d443a752bf07ff48e228f370440d2a522fa
 SHA512:
-  metadata.gz: 14dee83b52e39f823a7fb1428394f14a832b6893d3f560681f08c43c3fb85a9e5316dfbe8f3d96dbfea94d9593be263a698c0197f3da39c4b9a8e2d8119eb40c
-  data.tar.gz: 20e6b9c2a9220ad706e64dccccbdfdc94dd140864676930b8bc258fe79349f9cd37d4b9a01928f74d6559e6807b04958d5bd5cdd1de79bc7b2faca57ceb2a02b
+  metadata.gz: 0215025b821f70c0f64c2d37340af4169890cf49b24555d4840762485e4c14110a6918de3881582037cab416b604e0be7e72bfd5a5191d8034af221458f20dfd
+  data.tar.gz: 9603340360cf8ab63ce224ca5cfd8ae6d879dfd085aa8f580ba112538331c759eac9a13004a29858fb853dbf670455add054a37f4f2d3282e169a9bf2d990b56

data/.rubocop.yml

@@ -2,6 +2,8 @@ AllCops:
   TargetRubyVersion: 2.3
   DisplayCopNames: true
   DisplayStyleGuide: true
+  Exclude:
+    - 'spec/**/*'
 
 
 # Because only 2 spaces indent is insane

data/README.md

@@ -1,10 +1,15 @@
 # ED2K digest for Ruby
 
 [![build status](https://gitlab.com/valeth/digest-ed2k-hash.rb/badges/master/build.svg)](https://gitlab.com/valeth/digest-ed2k-hash.rb/commits/master)
+[![Gem](https://img.shields.io/gem/v/digest-ed2k-hash.svg)](https://rubygems.org/gems/digest-ed2k-hash)
+[![Gem](https://img.shields.io/gem/dt/digest-ed2k-hash.svg)](https://rubygems.org/gems/digest-ed2k-hash)
+[![Inline docs](https://inch-ci.org/github/valeth/digest-ed2k-hash.rb.svg?branch=master&style=shields)](https://inch-ci.org/github/valeth/digest-ed2k-hash.rb)
+[![Code Climate](https://codeclimate.com/github/valeth/digest-ed2k-hash.rb/badges/gpa.svg)](https://codeclimate.com/github/valeth/digest-ed2k-hash.rb)
 
 This is a Ruby implementation of the [ED2k](https://en.wikipedia.org/wiki/Ed2k_URI_scheme#eD2k_hash_algorithm) hashing algorithm.
 Additional information can be found [here](http://wiki.anidb.net/w/Ed2k-hash).
 
+[Documentation](http://www.rubydoc.info/gems/digest-ed2k-hash)
 
 ## Installation
 

data/lib/digest/ed2k.rb

@@ -25,11 +25,7 @@ module Digest # :nodoc:
         # @param   [IO] io  the IO object that will be read
         # @return  self  to allow method chaining
         def io(io)
-            while (buf = io.read(CHUNK_SIZE))
-                self << buf
-            end
-
-            self
+            self << io
         end
 
         # Calculate the hash of a file.
@@ -46,51 +42,68 @@ module Digest # :nodoc:
         def reset
             @md4.reset
             @finalized = false
-            @small     = true
-            @buf       = ''
 
             self
         end
 
         # Rehash with new data.
         #
-        # @param  [String] data  the chunk of data to add to the hash
+        # @param  [String, IO] data  the chunk of data to add to the hash
         # @return  self  to allow method chaining
         # @raise  RuntimeError  if the digest object has been finalized
         def update(data)
             raise RuntimeError if @finalized
 
-            @buf += data
-            hash
+            # get the IO object
+            buf = to_io(data)
+
+            # if the chunk is smaller than CHUNK_SIZE just return the MD4 hash
+            if buf.size < CHUNK_SIZE
+                @md4 << buf.read
+            else
+                # read chunks from the IO object and update the MD4 hash
+                while (chunk = buf.read(CHUNK_SIZE))
+                    @md4 << MD4.digest(chunk)
+                end
+
+                # weird EDonkey bug requires multiples of CHUNK_SIZE
+                # to append one additional MD4 hash
+                @md4 << MD4.new.digest if multiple?(buf.size)
+            end
 
             self
         end
 
         alias << update
 
-        # Finalize the digest.
+        # Finalize the hash and return the digest.
         #
-        # @param  [String] str  use this string to digest,
-        #                       otherwise digest the current md4 hash
-        def digest(str = nil)
-            if str.nil?
+        # If no string is provided, the current hash is used
+        #
+        # @param  [String, IO] data  hash this chunk of data
+        def digest(data = nil)
+            if data.nil?
                 finish
                 @md4.digest
             else
                 reset
-                self << str
+                self << data
                 digest
             end
         end
 
-        # {include:#digest}
-        def hexdigest(str = nil)
-            if str.nil?
+        # Finalize the hash and return the hexdigest.
+        #
+        # If no string is provided, the current hash is used
+        #
+        # @param  [String, IO] data  hash this chunk of data
+        def hexdigest(data = nil)
+            if data.nil?
                 finish
                 @md4.hexdigest
             else
                 reset
-                self << str
+                self << data
                 hexdigest
             end
         end
@@ -99,15 +112,7 @@ module Digest # :nodoc:
         #
         # @return  self  to allow method chaining
         def finish
-            unless @finalized
-                @md4 << if @small
-                            @buf
-                        else
-                            MD4.digest(@buf)
-                        end
-
-                @finalized = true
-            end
+            @finalized = true unless @finalized
 
             self
         end
@@ -122,20 +127,22 @@ module Digest # :nodoc:
         class << self
             # Calculate the digest of a string.
             #
-            # @param  [String] str  the string to digest
+            # @param  [String, IO] data  the string to digest
             # @return a finalized digest object
-            def digest(str)
-                new.digest(str)
+            def digest(data)
+                new.digest(data)
             end
 
             # Calculate the hexdigest of a string.
-            # @param  [String] str  the string to digest
+            #
+            # @param  [String, IO] data  the string to digest
             # @return a finalized digest object
-            def hexdigest(str)
-                new.hexdigest(str)
+            def hexdigest(data)
+                new.hexdigest(data)
             end
 
             # Create a new digest object from a IO object.
+            #
             # @param  [IO] io  the IO object to read
             # @return a new digest object
             def io(io)
@@ -143,7 +150,8 @@ module Digest # :nodoc:
             end
 
             # Create a new digest object from a file.
-            # @param  [String] file the file to read
+            #
+            # @param  [String] path  the file to read
             # @return a new digest object
             def file(path)
                 new.file(path)
@@ -152,11 +160,18 @@ module Digest # :nodoc:
 
         private
 
-        def hash
-            while @buf.size >= CHUNK_SIZE
-                @small = false
-                @md4 << MD4.digest(@buf.slice!(0...CHUNK_SIZE))
+        def to_io(obj)
+            if obj.is_a? String
+                StringIO.new(obj)
+            elsif obj.is_a? IO
+                obj
+            else
+                raise ArgumentError, "cannot hash #{obj.class.name} object"
             end
         end
+
+        def multiple?(buf_size)
+            (buf_size % CHUNK_SIZE).zero?
+        end
     end
 end

data/lib/digest/ed2k/version.rb

@@ -3,6 +3,6 @@
 module Digest
     class ED2K < Digest::Class
         # The current gem version.
-        VERSION = '0.2.0'
+        VERSION = '0.3.0'
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest-ed2k-hash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Valeth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler