digest-sip_hash 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a821cc359081b3b9c8184db677719fce137d35f3a190839b99dbe2e05b3bc9a8
-  data.tar.gz: bc743f50abfe70fff01e3c7b9f438bfbb8e73e884928118a75dff76f72e1f314
+  metadata.gz: 18035bf6f7ce76a23b7fc1ab2fe34eb5d3b1278bc89208930f94da9b558408dc
+  data.tar.gz: d16db0e9d7effe9083c891e195577ac1c2972a95907cddb80e61695f5c59d9d5
 SHA512:
-  metadata.gz: 4e0c910c3e8e2b0131ccaef872e39e39767563655ef66b3ed48336125a1d17d7881b19aad12b98f5515327f175e44a7c256b1df1cd231cf3a5b42a0a6068bc80
-  data.tar.gz: 63743fce636a8dcd204f04d72edd1259f031d9b07e453d43783616c9341e7a0e16082598ddf5fff44d5bf0e92b0c53e162810a077a8b831d0ef69f8e3e9ac552
+  metadata.gz: d4ae174a68b2adc47bcc92fbe3885742cbc5e105637caf3b661e8ab07cd57a47160975b3704f257ee7c100682104a426ecf78e3846f2bae3b339a4a5ea283264
+  data.tar.gz: 81693f1ff47e17d7f6c68972d422f9a55e7ec47db15896b8e53378ea19173a0f8bf7c7831037bebdbbe10f7c78ad68f6b59563aa4ba11a53f9c8adaa818b0d23

data/README.md

@@ -1,6 +1,6 @@
 # Digest::SipHash
 
-A pure Ruby implementation of SipHash 1-3 and 2-4. Arbitrary round counts are also supported. If rounds and key are not specified, the default is SipHash 1-3 with a key of sixteen null bytes.
+A pure Ruby implementation of SipHash 1-3 and 2-4. Arbitrary round counts are also supported. If rounds and key are not specified, the default is SipHash 1-3 with a key of 16 null bytes.
 
 ## Installation
 
@@ -10,26 +10,65 @@ gem install digest-sip_hash
 
 ## Library Examples
 
-The default key is 16 null bytes. Use `SecureRandom.bytes 16` to generate a random key.
+The default key is 16 null bytes.
 
 ```ruby
-Digest::SipHash.new.hexdigest ''
+require 'digest/sip_hash'
+
+Digest::SipHash.hexdigest ''
 #=> "d1fba762150c532c"
 
-Digest::SipHash.new(key: 16.times.map(&:chr).join).hexdigest ''
-#=> "abac0158050fc4dc"
+Digest::SipHash13.hexdigest ''
+#=> "d1fba762150c532c"
 
 Digest::SipHash.new(1, 3).hexdigest ''
 #=> "d1fba762150c532c"
 
-Digest::SipHash13.hexdigest ''
+Digest::SipHash.new(key: 0.chr * 16).hexdigest ''
 #=> "d1fba762150c532c"
 
+Digest::SipHash.new(key: 16.times.map(&:chr).join).hexdigest ''
+#=> "abac0158050fc4dc"
+
 Digest::SipHash.new(2, 4).hexdigest ''
 #=> "1e924b9d737700d7"
 
 Digest::SipHash24.hexdigest ''
 #=> "1e924b9d737700d7"
+
+Digest::SipHash.new(4, 8).hexdigest ''
+#=> "23ec6dd806738af3"
+
+Digest::SipHash.new(8, 16).hexdigest ''
+#=> "c05e9233091eb559"
+```
+
+Use `SecureRandom.bytes 16` to generate a random key.
+
+```ruby
+require 'digest/sip_hash'
+require 'securerandom'
+
+secret = SecureRandom.bytes 16
+#=> "\r\xCBv\xE7\xA2V\xB9X`NP4[0\x98\xFD"
+
+digest = Digest::SipHash.new
+#=> #<Digest::SipHash: d1fba762150c532c>
+
+digest.hexdigest
+#=> "d1fba762150c532c"
+
+digest.key = secret
+#=> "\r\xCBv\xE7\xA2V\xB9X`NP4[0\x98\xFD"
+
+digest.hexdigest
+#=> "dd854240c470edef"
+
+digest << 'nom'
+#<Digest::SipHash: 85b61bc79bb9e7c4>
+
+digest.hexdigest
+#=> "85b61bc79bb9e7c4"
 ```
 
 ## Command Line Examples

data/Rakefile

@@ -5,3 +5,7 @@ task default: %w[test]
 task :test do
   ruby 'spec/runner.rb'
 end
+
+task :bench do
+  ruby 'bench/runner.rb'
+end

data/lib/digest/sip_hash.rb

@@ -89,14 +89,14 @@ module Digest
 
       def compress
         @v0 = add @v0, @v1
-        @v1 = rotate @v1, 13, xor: @v0
+        @v1 = rotate @v1, 13, @v0
         @v0 = rotate @v0, 32
         @v2 = add @v2, @v3
-        @v3 = rotate @v3, 16, xor: @v2
+        @v3 = rotate @v3, 16, @v2
         @v0 = add @v0, @v3
-        @v3 = rotate @v3, 21, xor: @v0
+        @v3 = rotate @v3, 21, @v0
         @v2 = add @v2, @v1
-        @v1 = rotate @v1, 17, xor: @v2
+        @v1 = rotate @v1, 17, @v2
         @v2 = rotate @v2, 32
       end
 
@@ -104,7 +104,7 @@ module Digest
         a + b & MASK
       end
 
-      def rotate n, by, xor: 0
+      def rotate n, by, xor = 0
         n << by & MASK | n >> 64 - by ^ xor
       end
     end

data/lib/digest/sip_hash/version.rb

@@ -4,6 +4,6 @@ require 'digest'
 
 module Digest
   class SipHash < Digest::Class
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/spec/helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path '../../lib', __FILE__
+lib = File.expand_path '../lib', __dir__
 $LOAD_PATH.prepend lib unless $LOAD_PATH.include? lib
 
 require 'digest/sip_hash'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: digest-sip_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Shannon Skipper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2018-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
 description: An implementation of SipHash 1-3, 2-4, etc. in pure Ruby.
 email:
 - shannonskipper@gmail.com