digest-xxhash 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155293f54dc37486a7827e7356f3758f0cd411e444a66be7e35058e7f6ed742e
-  data.tar.gz: 5c304167f2978dec00ed022c985360af16bcd91581f35a280a2c42aa7a4f5555
+  metadata.gz: 557c034e51c5ed220c3ebba704e0b6d5dbd415c4178b2fecf4d6adb153cb9562
+  data.tar.gz: 209905cf00b851386b306a5a61a8a8a8de42cc7d30159fea4384ffb060cbc114
 SHA512:
-  metadata.gz: 510fd4a123c89d68eeb45a263f120dd85e88aa2dca4ca747f4231195dbb1687d77b997a50d3675a2627607f55b22a4134a231c73a7fbf312cef8e6a8676cf846
-  data.tar.gz: 22dd84864a3bace71d39cd0886d13d74d867b680b6b28fc72d684ff98c169632e1de22758b1063c1514d795caacd019edf6281b480bf78175d8d7ecf7201b099
+  metadata.gz: 528a1c15bf7aa8c9aecc9e86c4e953b1fefb6b38b64c64852cffd2dbc254550ef8062f6ebbb5324e6026cc69b4d32f0db2c865a4088dbff1ee1c7c5bf440b511
+  data.tar.gz: dec45992be6ff41b92f26ff55e06be1832a115ac2885aa012342cb51643950b35e8a18aaedfb445bd2da7bbaa110d008b5be9b11fbe8fd5f5ed71a87533edda8

data/README.md

@@ -1,15 +1,14 @@
-# digest-xxhash-ruby
+# digest-xxhash
 
-This gem 'digest-xxhash' provides XXH32 and XXH64 functions for Ruby.  It works
-on top of Digest::Class and complies with the functional design of
-Digest::Instance.
+This gem 'digest-xxhash' provides XXH32 and XXH64 functions for Ruby.  It
+inherits Digest::Class and complies with Digest::Instance's functional design.
 
 Its core implementation was taken from the official source, which is
 in https://github.com/Cyan4973/xxHash.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to the application's Gemfile:
 
     gem 'digest-xxhash'
 
@@ -17,10 +16,21 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+It can also be installed manually with:
 
     $ gem install digest-xxhash
 
+The library can also be installed in Gentoo system-wide using 'layman':
+
+    # Fetch remote list of overlays, and add 'konsolebox' overlay
+    layman -f && layman -a konsolebox
+
+    # Unmask unstable keyword
+    echo 'dev-ruby/digest-xxhash' > /etc/portage/package.keywords/dev-ruby.digest-xxhash
+
+    # Merge package
+    emerge dev-ruby/digest-xxhash
+
 ## Example Usage
 
     require 'digest/xxhash'
@@ -52,13 +62,23 @@ Or install it yourself as:
     Digest::XXH64.new.reset("0123456789abcdef").update("12").update("34").hexdigest
     => "d7544504de216507"
 
+## API Documentation
+
+RubyGems.org provides autogenerated API documentation of the library in
+https://www.rubydoc.info/gems/digest-xxhash/.
+
+## Homepage
+
+https://rubygems.org/gems/digest-xxhash
+
 ## Contributing
 
 1. Fork it ( https://github.com/konsolebox/digest-xxhash-ruby/fork ).
-2. Create your feature branch (`git checkout -b my-new-feature`).
-3. Commit your changes (`git commit -am 'Add some feature'`).
+2. Create feature branch (`git checkout -b my-new-feature`).
+3. Commit changes (`git commit -am 'Add some feature'`).
 4. Push to the branch (`git push origin my-new-feature`).
 5. Create a new Pull Request.
 
 [![Build Status](https://travis-ci.org/konsolebox/digest-xxhash-ruby.svg?branch=master)](https://travis-ci.org/konsolebox/digest-xxhash-ruby)
-[![Build status](https://ci.appveyor.com/api/projects/status/kb6hvlxjms3ftw7u?svg=true)](https://ci.appveyor.com/project/konsolebox/digest-xxhash-ruby)
+[![Build Status](https://ci.appveyor.com/api/projects/status/kb6hvlxjms3ftw7u?svg=true)](https://ci.appveyor.com/project/konsolebox/digest-xxhash-ruby)
+[![Build Status](https://github.com/konsolebox/digest-xxhash-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/konsolebox/digest-xxhash-ruby/actions/workflows/ruby.yml)

data/digest-xxhash.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject{ |f| f =~ /\.yml$/ }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/ext/digest/xxhash/ext.c

@@ -67,6 +67,8 @@ static VALUE _Digest_XXHash;
 static VALUE _Digest_XXH32;
 static VALUE _Digest_XXH64;
 
+#define _RSTRING_PTR_UCHAR(x) ((const unsigned char *)RSTRING_PTR(x))
+
 /*
  * Data types
  */
@@ -123,10 +125,10 @@ static VALUE _encode_big_endian_32(uint32_t num)
 		temp = num;
 	}
 
-	return rb_usascii_str_new((unsigned char *) &temp, sizeof(uint32_t));
+	return rb_usascii_str_new((char *) &temp, sizeof(uint32_t));
 }
 
-static uint32_t _decode_big_endian_32_cstr(unsigned char *str)
+static uint32_t _decode_big_endian_32_cstr(const char *str)
 {
 	uint32_t temp = read32(str);
 
@@ -152,10 +154,10 @@ static VALUE _encode_big_endian_64(uint64_t num)
 		temp = num;
 	}
 
-	return rb_usascii_str_new((unsigned char *) &temp, sizeof(uint64_t));
+	return rb_usascii_str_new((char *) &temp, sizeof(uint64_t));
 }
 
-static uint64_t _decode_big_endian_64_cstr(unsigned char *str)
+static uint64_t _decode_big_endian_64_cstr(const char *str)
 {
 	uint64_t temp = read64(str);
 
@@ -175,7 +177,7 @@ static VALUE _hex_encode_str(VALUE str)
 {
 	int len = RSTRING_LEN(str);
 	VALUE hex = rb_str_new(0, len * 2);
-	hex_encode_str_implied(RSTRING_PTR(str), len, RSTRING_PTR(hex));
+	hex_encode_str_implied(_RSTRING_PTR_UCHAR(str), len, (unsigned char *)RSTRING_PTR(hex));
 	return hex;
 }
 
@@ -221,7 +223,7 @@ static VALUE _Digest_XXHash_ifinish(VALUE self)
 
 static VALUE _do_digest(int argc, VALUE* argv, VALUE self, ID finish_method_id)
 {
-	VALUE str, seed;
+	VALUE str, seed, result;
 	int argc2 = argc > 0 ? rb_scan_args(argc, argv, "02", &str, &seed) : 0;
 
 	if (argc2 > 0) {
@@ -236,7 +238,7 @@ static VALUE _do_digest(int argc, VALUE* argv, VALUE self, ID finish_method_id)
 		rb_funcall(self, _id_update, 1, str);
 	}
 
-	VALUE result = rb_funcall(self, finish_method_id, 0);
+	result = rb_funcall(self, finish_method_id, 0);
 
 	if (argc2 > 0)
 		rb_funcall(self, _id_reset, 0);
@@ -278,7 +280,8 @@ static VALUE _Digest_XXHash_digest(int argc, VALUE* argv, VALUE self)
  */
 static VALUE _Digest_XXHash_hexdigest(int argc, VALUE* argv, VALUE self)
 {
-	VALUE result = _do_digest(argc, argv, self, _id_finish);
+	VALUE result;
+	result = _do_digest(argc, argv, self, _id_finish);
 	return _hex_encode_str(result);
 }
 
@@ -302,7 +305,8 @@ static VALUE _Digest_XXHash_idigest(int argc, VALUE* argv, VALUE self)
  */
 static VALUE _Digest_XXHash_idigest_bang(VALUE self)
 {
-	VALUE result = rb_funcall(self, _id_ifinish, 0);
+	VALUE result;
+	result = rb_funcall(self, _id_ifinish, 0);
 	rb_funcall(self, _id_reset, 0);
 	return result;
 }
@@ -313,7 +317,7 @@ static VALUE _Digest_XXHash_idigest_bang(VALUE self)
  * This method is called when instances are cloned.  It is responsible for
  * replicating internal data.
  */
-static VALUE _Digest_XXHash_initialize_copy(VALUE orig)
+static VALUE _Digest_XXHash_initialize_copy(VALUE self, VALUE orig)
 {
 	rb_raise(rb_eNotImpError, "initialize_copy method not implemented.");
 }
@@ -325,27 +329,31 @@ static VALUE _Digest_XXHash_initialize_copy(VALUE orig)
  */
 static VALUE _Digest_XXHash_inspect(VALUE self)
 {
-	VALUE klass = rb_obj_class(self);
-	VALUE klass_name = rb_class_name(klass);
+	VALUE klass, klass_name, hexdigest, args[2];
+	klass = rb_obj_class(self);
+	klass_name = rb_class_name(klass);
 
 	if (klass_name == Qnil)
 		klass_name = rb_inspect(klass);
 
-	VALUE hexdigest = rb_funcall(self, _id_hexdigest, 0);
+	hexdigest = rb_funcall(self, _id_hexdigest, 0);
 
-	VALUE args[] = { klass_name, hexdigest };
+	args[0] = klass_name;
+	args[1] = hexdigest;
 	return rb_str_format(sizeof(args), args, rb_str_new_literal("#<%s|%s>"));
 }
 
 static VALUE _instantiate_and_digest(int argc, VALUE* argv, VALUE klass, ID digest_method_id)
 {
-	VALUE str, seed;
-	int argc2 = rb_scan_args(argc, argv, "11", &str, &seed);
+	VALUE str, seed, instance;
+	int argc2;
+
+	argc2 = rb_scan_args(argc, argv, "11", &str, &seed);
 
 	if (TYPE(str) != T_STRING)
 		rb_raise(rb_eTypeError, "Argument type not string.");
 
-	VALUE instance = rb_funcall(klass, _id_new, 0);
+	instance = rb_funcall(klass, _id_new, 0);
 
 	if (argc2 > 1)
 		return rb_funcall(instance, digest_method_id, 2, str, seed);
@@ -453,12 +461,12 @@ static VALUE _Digest_XXH32_reset(int argc, VALUE* argv, VALUE self)
 				if (len == (sizeof(uint32_t) * 2)) {
 					unsigned char hex_decoded_seed[sizeof(uint32_t)];
 
-					if (! hex_decode_str_implied(RSTRING_PTR(seed), sizeof(uint32_t) * 2, hex_decoded_seed))
+					if (! hex_decode_str_implied(_RSTRING_PTR_UCHAR(seed), sizeof(uint32_t) * 2, hex_decoded_seed))
 						rb_raise(rb_eArgError, "Invalid hex string seed: %s\n", StringValueCStr(seed));
 
-					decoded_seed = _decode_big_endian_32_cstr(hex_decoded_seed);
+					decoded_seed = _decode_big_endian_32_cstr((const char *)hex_decoded_seed);
 				} else if (len == sizeof(uint32_t)) {
-					decoded_seed = _decode_big_endian_32_cstr(RSTRING_PTR(seed));
+					decoded_seed = _decode_big_endian_32(seed);
 				} else {
 					rb_raise(rb_eArgError, "Invalid seed length.  Expecting an 8-character hex string or a 4-byte string.");
 				}
@@ -601,12 +609,12 @@ static VALUE _Digest_XXH64_reset(int argc, VALUE* argv, VALUE self)
 				if (len == (sizeof(uint64_t) * 2)) {
 					unsigned char hex_decoded_seed[sizeof(uint64_t)];
 
-					if (! hex_decode_str_implied(RSTRING_PTR(seed), sizeof(uint64_t) * 2, hex_decoded_seed))
+					if (! hex_decode_str_implied(_RSTRING_PTR_UCHAR(seed), sizeof(uint64_t) * 2, hex_decoded_seed))
 						rb_raise(rb_eArgError, "Invalid hex string seed: %s\n", StringValueCStr(seed));
 
-					decoded_seed = _decode_big_endian_64_cstr(hex_decoded_seed);
+					decoded_seed = _decode_big_endian_64_cstr((const char *)hex_decoded_seed);
 				} else if (len == sizeof(uint64_t)) {
-					decoded_seed = _decode_big_endian_64_cstr(RSTRING_PTR(seed));
+					decoded_seed = _decode_big_endian_64(seed);
 				} else {
 					rb_raise(rb_eArgError, "Invalid seed length.  Expecting a 16-character hex string or an 8-byte string.");
 				}

data/ext/digest/xxhash/extconf.rb

@@ -1,2 +1,4 @@
 require 'mkmf'
+$defs.push('-Wall') if enable_config('all-warnings')
 create_makefile('digest/xxhash')
+File.write('Makefile', 'V = 1', mode: 'a') if enable_config('verbose-mode')

data/ext/digest/xxhash/utils.h

@@ -69,9 +69,10 @@ static uint64_t read64(const void *ptr)
 static void hex_encode_str_implied(const unsigned char *src, size_t len, unsigned char *dest)
 {
 	static const unsigned char table[] = "0123456789abcdef";
+	unsigned char c;
 
 	for (; len > 0; --len) {
-		unsigned char c = *src++;
+		c = *src++;
 		*dest++ = table[c >> 4];
 		*dest++ = table[c & 0x0f];
 	}
@@ -86,8 +87,10 @@ static void hex_encode_str_implied(const unsigned char *src, size_t len, unsigne
  */
 static int hex_decode_str_implied(const unsigned char *src, size_t len, unsigned char *dest)
 {
+	unsigned char low, high;
+
 	if (len % 2) {
-		unsigned char low = *src++;
+		low = *src++;
 
 		if (low >= '0' && low <= '9') {
 			low -= '0';
@@ -104,7 +107,7 @@ static int hex_decode_str_implied(const unsigned char *src, size_t len, unsigned
 	}
 
 	for (; len > 0; len -= 2) {
-		unsigned char high = *src++;
+		high = *src++;
 
 		if (high >= '0' && high <= '9') {
 			high -= '0';
@@ -116,7 +119,7 @@ static int hex_decode_str_implied(const unsigned char *src, size_t len, unsigned
 			return 0;
 		}
 
-		unsigned char low = *src++;
+		low = *src++;
 
 		if (low >= '0' && low <= '9') {
 			low -= '0';
@@ -134,6 +137,7 @@ static int hex_decode_str_implied(const unsigned char *src, size_t len, unsigned
 	return -1;
 }
 
+#if 0
 /*
  * Calculates length of string that would store decoded hex.
  */
@@ -147,5 +151,6 @@ static size_t calc_hex_decoded_str_length(size_t hex_encoded_length)
 
 	return hex_encoded_length / 2;
 }
+#endif
 
 #endif

data/lib/digest/xxhash/version.rb

@@ -2,6 +2,6 @@ require 'digest'
 
 module Digest
   class XXHash < Digest::Class
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/test/test.rb

@@ -20,38 +20,38 @@ end
 [Digest::XXH32, Digest::XXH64].each do |klass|
   describe klass do
     it "produces correct types of digest outputs" do
-      klass.digest("").must_be_instance_of String
-      klass.hexdigest("").must_be_instance_of String
-      klass.idigest("").must_be_kind_of Integer
-      klass.new.digest("").must_be_instance_of String
-      klass.new.hexdigest("").must_be_instance_of String
-      klass.new.idigest("").must_be_kind_of Integer
+      _(klass.digest("")).must_be_instance_of String
+      _(klass.hexdigest("")).must_be_instance_of String
+      _(klass.idigest("")).must_be_kind_of Integer
+      _(klass.new.digest("")).must_be_instance_of String
+      _(klass.new.hexdigest("")).must_be_instance_of String
+      _(klass.new.idigest("")).must_be_kind_of Integer
     end
 
     it "produces similar output with its digest, hexdigest and idigest methods" do
       digest = klass.digest("abcd")
-      klass.new.digest("abcd").must_equal digest
-      klass.new.update("ab").update("cd").digest.must_equal digest
-      klass.new.update("ab").update("cd").digest!.must_equal digest
-      klass.new.reset.update("ab").update("cd").digest!.must_equal digest
+      _(klass.new.digest("abcd")).must_equal digest
+      _(klass.new.update("ab").update("cd").digest).must_equal digest
+      _(klass.new.update("ab").update("cd").digest!).must_equal digest
+      _(klass.new.reset.update("ab").update("cd").digest!).must_equal digest
 
       hexdigest = klass.hexdigest("abcd")
-      klass.new.hexdigest("abcd").must_equal hexdigest
-      klass.new.update("ab").update("cd").hexdigest.must_equal hexdigest
-      klass.new.update("ab").update("cd").hexdigest!.must_equal hexdigest
-      klass.new.reset.update("ab").update("cd").hexdigest!.must_equal hexdigest
+      _(klass.new.hexdigest("abcd")).must_equal hexdigest
+      _(klass.new.update("ab").update("cd").hexdigest).must_equal hexdigest
+      _(klass.new.update("ab").update("cd").hexdigest!).must_equal hexdigest
+      _(klass.new.reset.update("ab").update("cd").hexdigest!).must_equal hexdigest
 
       idigest = klass.idigest("abcd")
-      klass.new.idigest("abcd").must_equal idigest
-      klass.new.update("ab").update("cd").idigest.must_equal idigest
-      klass.new.update("ab").update("cd").idigest!.must_equal idigest
-      klass.new.reset.update("ab").update("cd").idigest!.must_equal idigest
+      _(klass.new.idigest("abcd")).must_equal idigest
+      _(klass.new.update("ab").update("cd").idigest).must_equal idigest
+      _(klass.new.update("ab").update("cd").idigest!).must_equal idigest
+      _(klass.new.reset.update("ab").update("cd").idigest!).must_equal idigest
 
       digest_enc = digest.unpack('H*').pop
-      hexdigest.must_equal digest_enc
+      _(hexdigest).must_equal digest_enc
 
       idigest_enc = "%08x" % idigest
-      hexdigest.must_equal idigest_enc
+      _(hexdigest).must_equal idigest_enc
     end
   end
 end
@@ -80,7 +80,7 @@ CSV.foreach(File.join(TEST_DIR, 'test.vectors'), col_sep: '|').with_index(1) do
   describe klass do
     describe "using #{msg_method}(#{msg_length}) as message generator, and #{seed} as seed" do
       it "should produce #{sum}"  do
-        klass.hexdigest(msg, seed).must_equal sum
+        _(klass.hexdigest(msg, seed)).must_equal sum
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digest-xxhash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - konsolebox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -60,12 +60,10 @@ extensions:
 - ext/digest/xxhash/extconf.rb
 extra_rdoc_files: []
 files:
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- appveyor.yml
 - digest-xxhash.gemspec
 - ext/digest/xxhash/debug-funcs.h
 - ext/digest/xxhash/ext.c
@@ -81,7 +79,7 @@ homepage: https://github.com/konsolebox/digest-xxhash-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.2.14
+signing_key:
 specification_version: 4
 summary: XXHash for Ruby
 test_files:

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
- - 2.2
- - 2.3
- - 2.4
- - 2.5

data/appveyor.yml

@@ -1,19 +0,0 @@
-version: 1.0.{build}
-init:
-- cmd: >-
-    set base_path=C:/Program Files/7-Zip;C:/Program Files/AppVeyor/BuildAgent;C:/Program Files/Git/cmd;C:/Windows/system32;C:/Windows;"C:/Program Files (x86)/GNU/GnuPG/pub"
-
-    set PATH=C:/ruby%ruby_version%/bin;C:/msys64/usr/bin;%base_path%
-environment:
-  matrix:
-  - ruby_version: 22-x64
-  - ruby_version: 23-x64
-  - ruby_version: 24-x64
-  - ruby_version: 25-x64
-install:
-- cmd: bundle install
-build_script:
-- cmd: bundle exec rake -rdevkit compile
-test_script:
-- cmd: bundle exec rake test
-deploy: off