xxhash 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7631f1cb865522390841ca6345dadf0247b78404
-  data.tar.gz: 07f7a162f2be6f2df03aad3993e8fa74ded83fcc
+SHA256:
+  metadata.gz: b9e0c970d797503c0fd848023fbf5c4ac64d17744417e990d7d638cbe4447fd2
+  data.tar.gz: 41814924ceba3ab4647fc24e22cec307ea03c4f4076f0f91af7872b60f3807f7
 SHA512:
-  metadata.gz: 278c331aaa693e1489ceaf6c302a8f9f21087457867807a9f043ad3fe673279e09a05906e10e57266ee3980ce51c3d60c13d70b133b7312b75c8cb8962c5cbd2
-  data.tar.gz: e220c7ee0bc95631668cbc981deb5105fdf7f09c1c2acfe4f7a3bf4f532d03e69bdf7950403ade750cd8ceeede2f75df63967df98c478a595e1a6c33bf310ea1
+  metadata.gz: 2512c453f3ca7d14e70d2b64ac54daa76efaf36bb8da9a713462aea1f404cbb20953adbd59d4c96375ea08ddf2edd93cdcb9280ffc02cd5a06ff6a47365a8867
+  data.tar.gz: 143dda9ce66c0f980d78d79550f0fd4cebe9b64fd48533f6ea3af2d78300fb063cf8430013dd5f53f4a6379323d40966556642df08a74cb6cd95fa037c1f3a2e

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-### 0.4.0  (December 11, 2016)
+### 0.5.0 (July 28, 2022)
+  * Mark extension as Ractor-safe (by [@kreynolds](https://github.com/kreynolds))
+  * Add ability to hash files by path directly with `XXhash.xxh32_file` and `XXhash.xxh64_file` (by [@kreynolds](https://github.com/kreynolds))
+
+### 0.4.0 (December 11, 2016)
   * Add xxHash to `Digest` module and make it more compatieble
     with another hash functions from `Digest`. (by [@justinwsmith](https://github.com/justinwsmith))
   * Add a `StreamingHash` class that's externally instantiatable. (by [@justinwsmith](https://github.com/justinwsmith))

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 

data/README.md

@@ -25,20 +25,26 @@ You can use it with `IO` objects too:
 XXhash.xxh32_stream(StringIO.new('test'), 123) # => 2758658570
 ```
 
+You can use it with file path directly, avoiding costly ruby-related operations.
+
+```ruby
+XXhash.xxh32_file(__FILE__)
+```
+
 Note that you can also pass a chunk size as third param (it's 32 bytes by default)
 
-XXH64 is also supported: you can use `xxh64` and `xxh64_stream`.
+XXH64 is also supported: you can use `xxh64`, `xxh64_stream`, `.xxh64_file`.
 
 ### Supported Ruby versions
 
-- MRI 1.9.3, 2.0, 2.1, 2.2.
+- MRI 2.3+
 - rbx-19mode
 
 Note: It doesn't work on JRuby as it uses C extension.
 
 ### Versioning
 
-Version 0.4.0 is equal to [0.6.2](https://github.com/Cyan4973/xxHash/tree/v0.6.2)
+Version 0.5.0 is equal to [0.6.2](https://github.com/Cyan4973/xxHash/tree/v0.6.2)
 
 ## Contributing
 
@@ -50,5 +56,5 @@ Version 0.4.0 is equal to [0.6.2](https://github.com/Cyan4973/xxHash/tree/v0.6.2
 
 ### Copyright
 
-Copyright (c) 2013 Vasiliy Ermolovich. See LICENSE.txt for
+Copyright (c) 2022 Vasiliy Ermolovich. See LICENSE.txt for
 further details.

data/ext/xxhash/xxhash.c

@@ -1,5 +1,67 @@
 #include "xxhash.h"
 
+VALUE xxhash_xxh32_file(VALUE mod, VALUE filename, VALUE seed)
+{
+  StringValue(filename);
+
+  XXH32_state_t* state = XXH32_createState();
+  if (state == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "Cannot create state, out of memory");
+  }
+
+  XXH32_reset(state, NUM2INT(seed));
+
+  char buffer[16384];
+  size_t count;
+  FILE *fp = fopen(RSTRING_PTR(filename), "rb");
+  if (fp == NULL) {
+    XXH32_freeState(state);
+    VALUE error = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(1, &error, rb_eSystemCallError));
+  }
+
+  while ((count = fread(buffer, 1, sizeof(buffer), fp)) != 0) {
+    XXH32_update(state, buffer, count);
+  }
+  fclose(fp);
+
+  XXH32_hash_t result = XXH32_digest(state);
+
+  XXH32_freeState(state);
+  return ULL2NUM(result);
+}
+
+VALUE xxhash_xxh64_file(VALUE mod, VALUE filename, VALUE seed)
+{
+  StringValue(filename);
+
+  XXH64_state_t* state = XXH64_createState();
+  if (state == NULL) {
+    rb_raise(rb_eRuntimeError, "%s", "Cannot create state, out of memory");
+  }
+
+  XXH64_reset(state, NUM2INT(seed));
+
+  char buffer[16384];
+  size_t count;
+  FILE *fp = fopen(RSTRING_PTR(filename), "rb");
+  if (fp == NULL) {
+    XXH64_freeState(state);
+    VALUE error = INT2FIX(errno);
+    rb_exc_raise(rb_class_new_instance(1, &error, rb_eSystemCallError));
+  }
+
+  while ((count = fread(buffer, 1, sizeof(buffer), fp)) != 0) {
+    XXH64_update(state, buffer, count);
+  }
+  fclose(fp);
+
+  XXH64_hash_t result = XXH64_digest(state);
+
+  XXH64_freeState(state);
+  return ULL2NUM(result);
+}
+
 VALUE xxhash_xxh32(VALUE mod, VALUE input, VALUE seed)
 {
   return ULL2NUM(XXH32(StringValuePtr(input), (size_t)RSTRING_LEN(input), (unsigned int)NUM2ULL(seed)));
@@ -129,6 +191,10 @@ VALUE xxhash64_streaming_hash_digest(VALUE self)
 
 void Init_xxhash(void)
 {
+  #ifdef HAVE_RB_EXT_RACTOR_SAFE
+    rb_ext_ractor_safe(true);
+  #endif
+
   VALUE cStreamingHash;
   VALUE cStreamingHash64;
   VALUE mXXhash;
@@ -138,7 +204,9 @@ void Init_xxhash(void)
   mInternal = rb_define_module_under(mXXhash, "XXhashInternal");
 
   rb_define_singleton_method(mInternal, "xxh32", (ruby_method*) &xxhash_xxh32, 2);
+  rb_define_singleton_method(mInternal, "xxh32_file", (ruby_method*) &xxhash_xxh32_file, 2);
   rb_define_singleton_method(mInternal, "xxh64", (ruby_method*) &xxhash_xxh64, 2);
+  rb_define_singleton_method(mInternal, "xxh64_file", (ruby_method*) &xxhash_xxh64_file, 2);
 
   cStreamingHash = rb_define_class_under(mInternal, "StreamingHash32", rb_cObject);
 

data/ext/xxhash/xxhash.h

@@ -1,4 +1,5 @@
 #include <stdlib.h>
+#include <errno.h>
 #include <ruby.h>
 #include "libxxhash.h"
 
@@ -17,12 +18,14 @@ typedef struct {
 typedef VALUE (ruby_method)();
 
 VALUE xxhash_xxh32(VALUE mod, VALUE input, VALUE seed);
+VALUE xxhash_xxh32_file(VALUE mod, VALUE filename, VALUE seed);
 void xxhash32_streaming_hash_free(xxhash_xxh32_t* state);
 VALUE xxhash32_streaming_hash_new(VALUE klass, VALUE seed);
 VALUE xxhash32_streaming_hash_update(VALUE self, VALUE data);
 VALUE xxhash32_streaming_hash_reset(VALUE self);
 VALUE xxhash32_streaming_hash_digest(VALUE self);
 VALUE xxhash_xxh64(VALUE mod, VALUE input, VALUE seed);
+VALUE xxhash_xxh64_file(VALUE mod, VALUE filename, VALUE seed);
 void xxhash64_streaming_hash_free(xxhash_xxh64_t* state);
 VALUE xxhash64_streaming_hash_new(VALUE klass, VALUE seed);
 VALUE xxhash64_streaming_hash_update(VALUE self, VALUE data);

data/lib/xxhash/version.rb

@@ -1,3 +1,3 @@
 module XXhash
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/xxhash.rb

@@ -11,6 +11,14 @@ module XXhash
     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
+
   def self.xxh32_stream(io, seed = 0, chunk_size = 32)
     seed = seed.to_i
     chunk_size = chunk_size.to_i

data/test/xxhash_test.rb

@@ -2,19 +2,50 @@ require_relative 'test_helper'
 require 'stringio'
 
 describe XXhash 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
 
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xxhash
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vasiliy Ermolovich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-11 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies: []
 description: Ruby wrapper for xxHash lib
 email:
@@ -18,8 +18,8 @@ extensions:
 - ext/xxhash/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -54,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for xxHash lib

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-before_install:
-  - gem install bundler
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - 2.2
-script: "bundle exec rake test"