mmh3 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b3781157663073fc2ddf9f5af0f58f28e4ef31af58cbc5ac081327b9aba327e
-  data.tar.gz: bb4cdba03cab5d309509947f917f884392a23d386a1f072a7322d2ee250dc91f
+  metadata.gz: 9b1702ed3a4591c78df8c10a33e20c5d1a64c8a10603119f7ce445e00d1f9fa7
+  data.tar.gz: 4007d57ada806c9856470c365837cda90329eae0876f2583ccef5451763aa0ad
 SHA512:
-  metadata.gz: c7fa5acfc24334d26726ac8c32f3ebbeb710012056d71ab35fa73a72ef9067e1bdc76c02e1ec7afb8f3d2f7d522fc0289231fe88cc7f622bd12149aad6ce7a42
-  data.tar.gz: c2be744d61934671e2c0ad18b842f178daab06f411f3164d77989fa9b9f347db707aff66dc186ff4bd93374b125d8968979429dc91ac7f5c39e704e14222cd96
+  metadata.gz: d48d67b0d0b56410512a1c55eaeab3af85068ca269b869dd6bf53f91cbc51ca003ec83daf7822567bcb62dd8de2c717a5cb16f797c79f89a3e8bc15949e7c1f2
+  data.tar.gz: 90ac92b83d9ed6c04da3832c226988792b9362a164c7baa7695cb2201dbd8ac5cb4e8f275300b0403711fd15075d128103da589053c5335326787c6903993662

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.0
+- Change to use keyword argument for seed and x64arch arguments.
+- Refactor hash32 method.
+- Update API documentation.
+
 # 0.3.0
 - Add option to hash128 method for generating a 128-bit hash value in x86 architecture.
 

data/README.md

@@ -1,7 +1,8 @@
 # Mmh3
 
-![Ruby](https://github.com/yoshoku/mmh3/workflows/Ruby/badge.svg)
+[![Ruby](https://github.com/yoshoku/mmh3/workflows/Ruby/badge.svg)](https://github.com/yoshoku/mmh3/actions?query=workflow%3ARuby)
 [![Gem Version](https://badge.fury.io/rb/mmh3.svg)](https://badge.fury.io/rb/mmh3)
+[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://rubydoc.info/gems/mmh3)
 
 A pure Ruby implementation of [MurmurHash3](https://en.wikipedia.org/wiki/MurmurHash).
 
@@ -24,11 +25,17 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require 'mmh3'
-
-puts Mmh3.hash32('Hello, world', 10)
-
-# => -172601702
+irb(main):001:0> require 'mmh3'
+=> true
+irb(main):002:0> Mmh3.hash32('Hello, world', seed: 3)
+=> 1659891412
+irb(main):003:0> Mmh3.hash128('Hello, world', seed: 8)
+=> 87198040132278428547135563345531192982
+irb(main):004:0> Mmh3.hash32('Hello, world')
+=> 1785891924
+irb(main):005:0> Mmh3.hash32('Hello, world', seed: 0)
+=> 1785891924
+irb(main):006:0>
 ```
 
 ## Contributing

data/lib/mmh3.rb

@@ -10,18 +10,23 @@ module Mmh3
 
   # Generate a 32-bit hash value.
   #
+  # @example
+  #   require 'mmh3'
+  #
+  #   puts Mmh3.hash32('Hello, world') # => 1785891924
+  #
   # @param key [String] Key for hash value.
   # @param seed [Integer] Seed for hash value.
   #
   # @return [Integer] Returns hash value.
-  def hash32(key, seed = 0)
+  def hash32(key, seed: 0)
     keyb = key.to_s.bytes
     key_len = keyb.size
     n_blocks = key_len / 4
 
     h = seed
     (0...n_blocks * 4).step(4) do |bstart|
-      k = keyb[bstart + 3] << 24 | keyb[bstart + 2] << 16 | keyb[bstart + 1] << 8 | keyb[bstart + 0]
+      k = block32(keyb, bstart, 0)
       h ^= scramble32(k)
       h = rotl32(h, 13)
       h = (h * 5 + 0xe6546b64) & 0xFFFFFFFF
@@ -32,8 +37,9 @@ module Mmh3
 
     k = 0
     k ^= keyb[tail_id + 2] << 16 if tail_sz >= 3
-    k ^= keyb[tail_id + 1] << 8 if tail_sz >= 2
-    k ^= keyb[tail_id + 0] if tail_sz >= 1
+    k ^= keyb[tail_id + 1] <<  8 if tail_sz >= 2
+    k ^= keyb[tail_id + 0]       if tail_sz >= 1
+
     h ^= scramble32(k) if tail_sz.positive?
 
     h = fmix32(h ^ key_len)
@@ -47,12 +53,17 @@ module Mmh3
 
   # Generate a 128-bit hash value.
   #
+  # @example
+  #   require 'mmh3'
+  #
+  #   puts Mmh3.hash128('Hello, world') # => 87198040132278428547135563345531192982
+  #
   # @param key [String] Key for hash value.
   # @param seed [Integer] Seed for hash value.
   # @param x64arch [Boolean] Flag indicating whether to generate hash value for x64 architecture.
   #
   # @return [Integer] Returns hash value.
-  def hash128(key, seed = 0, x64arch = true)
+  def hash128(key, seed: 0, x64arch: true)
     return hash128_x86(key, seed) if x64arch == false
 
     hash128_x64(key, seed)

data/lib/mmh3/version.rb

@@ -2,5 +2,5 @@
 
 module Mmh3
   # Version number of Mmh3 you are using.
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mmh3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - yoshoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-25 00:00:00.000000000 Z
+date: 2020-05-02 00:00:00.000000000 Z
 dependencies: []
 description: A pure Ruby implementation of MurmurHash3
 email:
@@ -25,8 +25,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/mmh3.rb
 - lib/mmh3/version.rb
 - mmh3.gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "mmh3"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here