xxhash 0.2.0 → 0.5.0

data/lib/xxhash.rb

@@ -1,20 +1,104 @@
 require 'xxhash/version'
 require 'xxhash/xxhash'
+require 'digest'
 
 module XXhash
-  def self.xxh32(input, seed)
-    Internal.xxh32(input, seed)
+  def self.xxh32(input, seed = 0)
+    XXhashInternal.xxh32(input.to_s, seed.to_i)
   end
 
-  def self.xxh32_stream(io, seed, chunk_size = 32)
-    raise ArgumentError, 'first argument should be IO' if !io.is_a?(IO) && !io.is_a?(StringIO)
+  def self.xxh64(input, seed = 0)
+    XXhashInternal.xxh64(input.to_s, seed.to_i)
+  end
+
+  def self.xxh32_file(filename, seed = 0)
+    XXhashInternal.xxh32_file(filename.to_s, seed.to_i)
+  end
+
+  def self.xxh64_file(filename, seed = 0)
+    XXhashInternal.xxh64_file(filename.to_s, seed.to_i)
+  end
 
-    hash = Internal::StreamingHash.new(seed)
+  def self.xxh32_stream(io, seed = 0, chunk_size = 32)
+    seed = seed.to_i
+    chunk_size = chunk_size.to_i
+    raise ArgumentError, 'first argument should be IO' if !io.respond_to?(:read)
+
+    hash = XXhashInternal::StreamingHash32.new(seed)
 
     while chunk = io.read(chunk_size)
-      hash.update(chunk)
+      hash.update(chunk.to_s)
     end
 
     hash.digest
   end
+
+  def self.xxh64_stream(io, seed = 0, chunk_size = 32)
+    seed = seed.to_i
+    chunk_size = chunk_size.to_i
+    raise ArgumentError, 'first argument should be IO' if !io.respond_to?(:read)
+
+    hash = XXhashInternal::StreamingHash64.new(seed)
+
+    while chunk = io.read(chunk_size)
+      hash.update(chunk.to_s)
+    end
+
+    hash.digest
+  end
+
+end
+
+module Digest
+  class XXHash < Digest::Class
+    attr_reader :digest_length
+
+    def initialize(bitlen, seed = 0)
+      bitlen = bitlen.to_i
+      seed = seed.to_i
+      @hash = case bitlen
+      when 32
+        XXhash::XXhashInternal::StreamingHash32.new(seed)
+      when 64
+        XXhash::XXhashInternal::StreamingHash64.new(seed)
+      else
+        raise ArgumentError, "Unsupported bit length: %s" % bitlen.inspect
+      end
+
+      @digest_length = bitlen
+    end
+
+    def update(chunk)
+      @hash.update(chunk.to_s)
+    end
+
+    def digest(val = nil)
+      @hash.update(val) if val
+
+      @hash.digest
+    end
+
+    def digest!(val = nil)
+      result = digest(val)
+      @hash.reset
+
+      result
+    end
+
+    def reset
+      @hash.reset
+    end
+  end
+
+  class XXHash32 < Digest::XXHash
+    def initialize(seed = 0)
+      super(32, seed.to_i)
+    end
+  end
+
+  class XXHash64 < Digest::XXHash
+    def initialize(seed = 0)
+      super(64, seed.to_i)
+    end
+  end
 end

data/test/xxhash_test.rb

@@ -1,13 +1,54 @@
-require 'test_helper'
+require_relative 'test_helper'
 require 'stringio'
 
 describe XXhash do
-  it 'returns hash' do
+  it 'is marked as ractor-safe' do
+    skip("Ractorrs are not supported in this version of ruby(#{RUBY_VERSION})") unless defined?(Ractor)
+
+    ractor = Ractor.new do
+      Ractor.yield XXhash.xxh32(Ractor.receive)
+    end
+
+    ractor.send('test')
+    assert_equal ractor.take, XXhash.xxh32('test')
+  end
+
+  it 'returns 32-bit hash' do
     assert_equal 2758658570, XXhash.xxh32('test', 123)
   end
 
-  describe 'StreamingHash' do
-    it 'rises ArgumentError if forst argument is not IO object' do
+  it 'returns 32-bit hash from a file' do
+    assert_equal XXhash.xxh32(File.read(__FILE__)), XXhash.xxh32_file(__FILE__)
+    assert_equal XXhash.xxh32(File.read(__FILE__), 123), XXhash.xxh32_file(__FILE__, 123)
+  end
+
+  it 'returns 64-bit hash' do
+    assert_equal 3134990500624303823, XXhash.xxh64('test', 123)
+  end
+
+  it 'returns 64-bit hash from a file' do
+    assert_equal XXhash.xxh64(File.read(__FILE__)), XXhash.xxh64_file(__FILE__)
+    assert_equal XXhash.xxh64(File.read(__FILE__), 123), XXhash.xxh64_file(__FILE__, 123)
+  end
+
+  it 'uses 0 (default value) if seed is not specified' do
+    assert_equal 1042293711, XXhash.xxh32('test')
+    assert_equal 5754696928334414137, XXhash.xxh64('test')
+  end
+
+  it 'raises an Errno exception for invalid file' do
+    assert_raises Errno::ENOENT do
+      XXhash.xxh32_file('nonexistent-file')
+    end
+
+    assert_raises Errno::ENOENT do
+      XXhash.xxh64_file('nonexistent-file')
+    end
+  end
+
+  describe 'XXhashInternal::StreamingHash32' do
+
+    it 'rises ArgumentError if first argument is not IO object' do
       assert_raises(ArgumentError) do
         XXhash.xxh32_stream('test', 123)
       end
@@ -23,4 +64,98 @@ describe XXhash do
       assert_equal h1, h2
     end
   end
+
+  describe 'XXhashInternal::StreamingHash64' do
+    it 'rises ArgumentError if first argument is not IO object' do
+      assert_raises(ArgumentError) do
+        XXhash.xxh64_stream('test', 123)
+      end
+    end
+
+    it 'returns the hash for streamed strings' do
+      assert_equal 3134990500624303823, XXhash.xxh64_stream(StringIO.new('test'), 123)
+    end
+
+    it 'returns the hash for streamed files' do
+      h1 = XXhash.xxh64(File.read(__FILE__), 123)
+      h2 = XXhash.xxh64_stream(File.open(__FILE__), 123)
+      assert_equal h1, h2
+    end
+
+    it 'exception (not segfault) on nil' do
+      begin
+        XXhash.xxh64(nil)
+        fail
+      rescue
+      end
+    end
+  end
+
+  def use_external_hash hash, io, chunk_size=1024
+    while chunk=io.read(chunk_size)
+      hash.update(chunk)
+    end
+    hash.digest
+  end
+
+  describe 'Digest::XXhash32' do
+
+    it 'returns the hash for streamed strings' do
+      StringIO.open('test') do |io|
+        xxhash = Digest::XXHash32.new(123)
+        result = use_external_hash xxhash, io
+        assert_equal 2758658570, result
+      end
+    end
+
+    it 'returns the hash for streamed files' do
+      h1 = XXhash.xxh32(File.read(__FILE__), 123)
+      xxhash = Digest::XXHash32.new(123)
+      result = use_external_hash xxhash, File.open(__FILE__)
+      assert_equal h1, result
+    end
+
+    it 'returns correct hash after a reset' do
+      h1 = XXhash.xxh32(File.read(__FILE__), 123)
+      xxhash = Digest::XXHash32.new(123)
+      assert_equal 2758658570, xxhash.digest('test')
+      xxhash.reset
+      result = use_external_hash xxhash, File.open(__FILE__)
+      assert_equal h1, result
+    end
+
+    it 'exception (not segfault) on nil' do
+      begin
+        XXhash.xxh32(nil)
+      rescue
+      end
+    end
+  end
+
+  describe 'Digest::XXhash64' do
+    it 'returns the hash for streamed strings' do
+      StringIO.open('test') do |io|
+        xxhash = Digest::XXHash64.new(123)
+        result = use_external_hash xxhash, io
+        assert_equal 3134990500624303823, result
+      end
+    end
+
+    it 'returns the hash for streamed files' do
+      h1 = XXhash.xxh64(File.read(__FILE__), 123)
+      xxhash = Digest::XXHash64.new(123)
+      result = use_external_hash xxhash, File.open(__FILE__)
+      assert_equal h1, result
+    end
+
+    it 'returns correct hash after reset' do
+      h1 = XXhash.xxh64(File.read(__FILE__), 123)
+      xxhash = Digest::XXHash64.new(123)
+      assert_equal 3134990500624303823, xxhash.digest('test')
+      xxhash.reset
+      result = use_external_hash xxhash, File.open(__FILE__)
+      assert_equal h1, result
+    end
+  end
+
 end

data/xxhash.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Ruby wrapper for xxHash lib}
   gem.summary       = %q{Ruby wrapper for xxHash lib}
   gem.homepage      = "http://github.com/nashby/xxhash"
-
+  gem.license       = 'MIT'
+  
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xxhash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Vasiliy Ermolovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for xxHash lib
 email:
@@ -19,8 +18,8 @@ extensions:
 - ext/xxhash/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/ruby.yml"
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -29,41 +28,35 @@ files:
 - ext/xxhash/extconf.rb
 - ext/xxhash/libxxhash.c
 - ext/xxhash/libxxhash.h
-- ext/xxhash/xxhash.cc
+- ext/xxhash/xxhash.c
+- ext/xxhash/xxhash.h
 - lib/xxhash.rb
 - lib/xxhash/version.rb
 - test/test_helper.rb
 - test/xxhash_test.rb
 - xxhash.gemspec
 homepage: http://github.com/nashby/xxhash
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3728750430932162062
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3728750430932162062
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.0.9
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for xxHash lib
 test_files:
 - test/test_helper.rb

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - rbx-19mode

data/ext/xxhash/xxhash.cc

@@ -1,56 +0,0 @@
-#include <ruby.h>
-#include "libxxhash.h"
-
-// Use this typedef to make the compiler happy when
-// calling rb_define_method()
-typedef VALUE (ruby_method)(...);
-
-extern "C" VALUE xxhash_xxh32(VALUE mod, VALUE input, VALUE seed)
-{
-  return ULL2NUM(XXH32(StringValuePtr(input), RSTRING_LEN(input), NUM2ULL(seed)));
-}
-
-extern "C" void xxhash_streaming_hash_free(void* state)
-{
-  // Digest frees the memory.
-  (void) XXH32_digest(state);
-}
-
-extern "C" VALUE xxhash_streaming_hash_new(VALUE klass, VALUE seed)
-{
-  void* state = XXH32_init(NUM2ULL(seed));
-  return Data_Wrap_Struct(klass, 0, xxhash_streaming_hash_free, state);
-}
-
-extern "C" VALUE xxhash_streaming_hash_update(VALUE self, VALUE data)
-{
-  void* state;
-  Data_Get_Struct(self, void, state);
-
-  XXH32_update(state, StringValuePtr(data), RSTRING_LEN(data));
-  return Qnil;
-}
-
-extern "C" VALUE xxhash_streaming_hash_digest(VALUE self)
-{
-  void* state;
-  Data_Get_Struct(self, void, state);
-
-  // Do not free memory now.
-  return ULL2NUM(XXH32_intermediateDigest(state));
-}
-
-extern "C" void Init_xxhash()
-{
-  VALUE mXXhash = rb_define_module("XXhash");
-  VALUE mInternal = rb_define_module_under(mXXhash, "Internal");
-
-  rb_define_singleton_method(mInternal, "xxh32", (ruby_method*) &xxhash_xxh32, 2);
-
-  VALUE cStreamingHash = rb_define_class_under(mInternal, "StreamingHash", rb_cObject);
-
-  rb_define_singleton_method(cStreamingHash, "new", (ruby_method*) &xxhash_streaming_hash_new, 1);
-  rb_define_method(cStreamingHash, "update", (ruby_method*) &xxhash_streaming_hash_update, 1);
-  rb_define_method(cStreamingHash, "digest", (ruby_method*) &xxhash_streaming_hash_digest, 0);
-  rb_define_method(cStreamingHash, "intermediate_digest", (ruby_method*) &xxhash_streaming_hash_digest, 0);
-}