digest-xxhash 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 155293f54dc37486a7827e7356f3758f0cd411e444a66be7e35058e7f6ed742e
-  data.tar.gz: 5c304167f2978dec00ed022c985360af16bcd91581f35a280a2c42aa7a4f5555
+  metadata.gz: 62b0480e6329d7a6f65173ab69262e2c3a0b26fed7d0eaa5d3500c86139b7103
+  data.tar.gz: 619a548d378beb8c0ab223843451452ea834272bb8df69971ecabf5bd6bd0ec7
 SHA512:
-  metadata.gz: 510fd4a123c89d68eeb45a263f120dd85e88aa2dca4ca747f4231195dbb1687d77b997a50d3675a2627607f55b22a4134a231c73a7fbf312cef8e6a8676cf846
-  data.tar.gz: 22dd84864a3bace71d39cd0886d13d74d867b680b6b28fc72d684ff98c169632e1de22758b1063c1514d795caacd019edf6281b480bf78175d8d7ecf7201b099
+  metadata.gz: 35b10f17d3d35c0b43662cc37c50b3bf3e008fc8305a3a6357c10f5fd588be3b56a75acd7e6feaeec409455691a010ef112543dbe454c6be66e7217efc26fda0
+  data.tar.gz: 995863f40af717ec3ba53f7e2429ed01d43ae677aeca1ac5ef9b29b998c1099cf995a3bc81d89a30862bd265cd3c752b999fe75037f07d86425561621bcd7ca2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017 konsolebox
+Copyright (c) 2021 konsolebox
 
 MIT License
 

data/README.md

@@ -1,15 +1,15 @@
-# 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 provides XXH32, XXH64, XXH3_64bits and XXH3_128bits
+functionalities 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.
+Its core implementation comes 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 +17,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 +63,34 @@ Or install it yourself as:
     Digest::XXH64.new.reset("0123456789abcdef").update("12").update("34").hexdigest
     => "d7544504de216507"
 
+    Digest::XXH3_64bits.hexdigest("1234", "0123456789abcdef")
+    => "4156724c7605b1be"
+
+    Digest::XXH3_64bits.new.reset_with_secret("abcd" * 34).update("1234").hexdigest
+    => "f7bbdbf9ec8c6394"
+
+    Digest::XXH3_128bits.hexdigest("1234", "0123456789abcdef") # XXH3_128bits() only allows 64-bit seeds
+    => "ad6108fb0b9a6b51b7f80d053c76c0fd"
+
+    Digest::XXH3_128bits.new.reset_with_secret("abcd" * 34).update("1234").hexdigest
+    => "0d44dd7fde8ea2b4ba961e1a26f71f21"
+
+## 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://github.com/konsolebox/digest-xxhash-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/konsolebox/digest-xxhash-ruby/actions/workflows/ruby.yml)
+[![Build Status](https://ci.appveyor.com/api/projects/status/kb6hvlxjms3ftw7u?svg=true)](https://ci.appveyor.com/project/konsolebox/digest-xxhash-ruby)

data/Rakefile

@@ -1,10 +1,21 @@
 require 'bundler/gem_tasks'
+require 'rake/extensiontask'
 require 'rake/testtask'
 
 # clean, clobber, compile, and compile:digest/xxhash
-require 'rake/extensiontask'
 Rake::ExtensionTask.new('digest/xxhash', Bundler::GemHelper.gemspec)
 
+# install
+Rake::Task[:install].clear
+task :install => :build do
+  name = Bundler::GemHelper.gemspec.name
+  pkg_dir = File.join(Bundler::GemHelper.instance.base, "pkg")
+  built_gem = Dir.chdir(pkg_dir){ Dir.glob("#{name}-*.gem").sort_by{ |f| File.mtime(f) }.last }
+  gem_command = (ENV["GEM_COMMAND"].shellsplit rescue nil) || ["gem"]
+  options = ARGV.select{ |e| e =~ /\A--?/ }
+  Process.wait spawn(*gem_command, "install", File.join(pkg_dir, built_gem), *options)
+end
+
 # test
 Rake::TestTask.new(:test => :compile) do |t|
   t.test_files = FileList['test/test.rb']
@@ -17,7 +28,7 @@ task :clean do
   rm_f list unless list.empty?
 end
 
-# Set 'test' as default task.
+# default
 task :default => :test
 
 # Run `rake --tasks` for a list of tasks.

data/digest-xxhash.gemspec

@@ -9,20 +9,24 @@ Gem::Specification.new do |spec|
   spec.version       = Digest::XXHash::VERSION
   spec.authors       = ["konsolebox"]
   spec.email         = ["konsolebox@gmail.com"]
-  spec.summary       = "XXHash for Ruby"
-  spec.description   = "An XXHash library that complies with Digest::Instance's functional design."
+  spec.summary       = "A Digest framework based XXHash library for Ruby"
+  spec.description   = <<-EOF
+    This gem provides XXH32, XXH64, XXH3_64bits and XXH3_128bits
+    functionalities for Ruby.  It inherits Digest::Class and complies
+    with Digest::Instance's functional design.
+  EOF
   spec.homepage      = "https://github.com/konsolebox/digest-xxhash-ruby"
   spec.license       = "MIT"
 
   spec.required_ruby_version = '>= 2.2'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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"]
 
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rake-compiler", "~> 1.0"
+  spec.add_development_dependency "rake-compiler", "~> 1.0", "!= 1.1.3", "!= 1.1.4", "!= 1.1.5"
   spec.add_development_dependency "minitest", "~> 5.8"
 
   spec.extensions = %w[ext/digest/xxhash/extconf.rb]