mmh3 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9232bb276c9e81d9283f72dd767cfac0a32a639f36051ba1719415ce941d32a
-  data.tar.gz: 2a8bcb3958785b4f198b0aeb505dec3bf50d3ab827ec981613583eae6caaffce
+  metadata.gz: 70a69ac210acc55f49b85764ddacced777cd5b14c515c587b22e77a08479356e
+  data.tar.gz: 320c6db6188375dd16f065164691af0c254bcdc01968a5dd7318b087c6bdc896
 SHA512:
-  metadata.gz: 1c99ca7f0f22ed5ee7ec6adef36bc19b9456afdc8c51ae74a970e62266e5336f2bc4617795d28210a03f1591b82980a8c9f188581c619f495765685c315ab920
-  data.tar.gz: 67df0cd6af0f55a1a5d2bc257c136e4af4ca637783f1c68bde550319a52078ef67fb51c3f9ecc303988f9b0d0a72f2b9053e4d4c9f3dbb83d88d8ea6cc49f645
+  metadata.gz: b533e1bf9b5bb655eef411e0b4f5e6cf184dfab4c9053513771941aa851f2abc768c2d81c6c97ebd37d2af7232d8f091cb9511fb8e6f2b23759727e944872555
+  data.tar.gz: dbf836b9f3e3f7cef52aa4aa414f58f960592533f40d6bbf885250ee2ce36d12bd68dd43b2c3b0417d3fbc76c5222be94dd9367b26c419d0f768fb140cbbd2c5

data/.github/workflows/build.yml

@@ -6,16 +6,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0' ]
+        ruby: [ '2.7', '3.0', '3.1' ]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Build and test with Rake
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
+        run: bundle exec rake

data/.github/workflows/coverage.yml

@@ -12,14 +12,12 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby 2.7
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.7'
+          bundler-cache: true
       - name: Build and test with Rake
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
+        run: bundle exec rake
       - name: Coveralls GitHub Action
         uses: coverallsapp/github-action@v1.1.2
         with:

data/.rubocop.yml

@@ -0,0 +1,50 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - 'Steepfile'
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
+  IgnoredPatterns: ['(\A|\s)#']
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ParameterLists:
+  Max: 8
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 16
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.2.0
+- Refactor codes and configs with RuboCop.
+
 # 1.1.0
 - Add type declaration file: sig/mmh3.rbs
 

data/Gemfile

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mmh3.gemspec
 gemspec
 
 gem 'rake', '~> 12.0'
+gem 'rbs', '~> 1.2'
 gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.24'
+gem 'rubocop-performance', '~> 1.14'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.11'
 gem 'simplecov', '~> 0.21'
 gem 'simplecov-lcov', '~> 0.8'
-gem 'rbs', '~> 1.2'
 gem 'steep', '~> 0.44'

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-2021 yoshoku
+Copyright (c) 2020-2022 yoshoku
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,6 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/mmh3/version.rb

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

data/lib/mmh3.rb

@@ -2,6 +2,8 @@
 
 require 'mmh3/version'
 
+# rubocop:disable Metrics/AbcSize, Metrics/BlockLength, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/ModuleLength, Metrics/PerceivedComplexity
+
 # This module consists module functions that implement MurmurHash3.
 # MurmurHash3 was written by Austin Appleby, and is placed in the public domain.
 # The author hereby disclaims copyright to this source code.
@@ -29,16 +31,18 @@ module Mmh3
       k = block32(keyb, bstart, 0)
       h ^= scramble32(k)
       h = rotl32(h, 13)
-      h = (h * 5 + 0xe6546b64) & 0xFFFFFFFF
+      h = ((h * 5) + 0xe6546b64) & 0xFFFFFFFF
     end
 
     tail_id = n_blocks * 4
     tail_sz = key_len & 3
 
     k = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     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
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     h ^= scramble32(k) if tail_sz.positive?
 
@@ -92,7 +96,7 @@ module Mmh3
 
       h1 = rotl64(h1, 27)
       h1 = (h1 + h2) & 0xFFFFFFFFFFFFFFFF
-      h1 = (h1 * 5 + 0x52dce729) & 0xFFFFFFFFFFFFFFFF
+      h1 = ((h1 * 5) + 0x52dce729) & 0xFFFFFFFFFFFFFFFF
 
       k2 = (k2 * c2) & 0xFFFFFFFFFFFFFFFF
       k2 = rotl64(k2, 33)
@@ -101,13 +105,14 @@ module Mmh3
 
       h2 = rotl64(h2, 31)
       h2 = (h2 + h1) & 0xFFFFFFFFFFFFFFFF
-      h2 = (h2 * 5 + 0x38495ab5) & 0xFFFFFFFFFFFFFFFF
+      h2 = ((h2 * 5) + 0x38495ab5) & 0xFFFFFFFFFFFFFFFF
     end
 
     tail_id = n_blocks * 16
     tail_sz = key_len & 15
 
     k2 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k2 ^= keyb[tail_id + 14] << 48 if tail_sz >= 15
     k2 ^= keyb[tail_id + 13] << 40 if tail_sz >= 14
     k2 ^= keyb[tail_id + 12] << 32 if tail_sz >= 13
@@ -115,6 +120,7 @@ module Mmh3
     k2 ^= keyb[tail_id + 10] << 16 if tail_sz >= 11
     k2 ^= keyb[tail_id +  9] <<  8 if tail_sz >= 10
     k2 ^= keyb[tail_id +  8]       if tail_sz >=  9
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 8
       k2 = (k2 * c2) & 0xFFFFFFFFFFFFFFFF
@@ -124,6 +130,7 @@ module Mmh3
     end
 
     k1 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k1 ^= keyb[tail_id + 7] << 56 if tail_sz >= 8
     k1 ^= keyb[tail_id + 6] << 48 if tail_sz >= 7
     k1 ^= keyb[tail_id + 5] << 40 if tail_sz >= 6
@@ -132,6 +139,7 @@ module Mmh3
     k1 ^= keyb[tail_id + 2] << 16 if tail_sz >= 3
     k1 ^= keyb[tail_id + 1] <<  8 if tail_sz >= 2
     k1 ^= keyb[tail_id]           if tail_sz >= 1
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 0
       k1 = (k1 * c1) & 0xFFFFFFFFFFFFFFFF
@@ -152,7 +160,7 @@ module Mmh3
     h1 = (h1 + h2) & 0xFFFFFFFFFFFFFFFF
     h2 = (h1 + h2) & 0xFFFFFFFFFFFFFFFF
 
-    h2 << 64 | h1
+    (h2 << 64) | h1
   end
 
   def hash128_x86(key, seed = 0)
@@ -182,7 +190,7 @@ module Mmh3
 
       h1 = rotl32(h1, 19)
       h1 = (h1 + h2) & 0xFFFFFFFF
-      h1 = (h1 * 5 + 0x561ccd1b) & 0xFFFFFFFF
+      h1 = ((h1 * 5) + 0x561ccd1b) & 0xFFFFFFFF
 
       k2 = (k2 * c2) & 0xFFFFFFFF
       k2 = rotl32(k2, 16)
@@ -191,7 +199,7 @@ module Mmh3
 
       h2 = rotl32(h2, 17)
       h2 = (h2 + h3) & 0xFFFFFFFF
-      h2 = (h2 * 5 + 0x0bcaa747) & 0xFFFFFFFF
+      h2 = ((h2 * 5) + 0x0bcaa747) & 0xFFFFFFFF
 
       k3 = (k3 * c3) & 0xFFFFFFFF
       k3 = rotl32(k3, 17)
@@ -200,7 +208,7 @@ module Mmh3
 
       h3 = rotl32(h3, 15)
       h3 = (h3 + h4) & 0xFFFFFFFF
-      h3 = (h3 * 5 + 0x96cd1c35) & 0xFFFFFFFF
+      h3 = ((h3 * 5) + 0x96cd1c35) & 0xFFFFFFFF
 
       k4 = (k4 * c4) & 0xFFFFFFFF
       k4 = rotl32(k4, 18)
@@ -209,16 +217,18 @@ module Mmh3
 
       h4 = rotl32(h4, 13)
       h4 = (h4 + h1) & 0xFFFFFFFF
-      h4 = (h4 * 5 + 0x32ac3b17) & 0xFFFFFFFF
+      h4 = ((h4 * 5) + 0x32ac3b17) & 0xFFFFFFFF
     end
 
     tail_id = n_blocks * 16
     tail_sz = key_len & 15
 
     k4 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k4 ^= keyb[tail_id + 14] << 16 if tail_sz >= 15
     k4 ^= keyb[tail_id + 13] <<  8 if tail_sz >= 14
     k4 ^= keyb[tail_id + 12]       if tail_sz >= 13
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 12
       k4 = (k4 * c4) & 0xFFFFFFFF
@@ -228,10 +238,12 @@ module Mmh3
     end
 
     k3 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k3 ^= keyb[tail_id + 11] << 24 if tail_sz >= 12
     k3 ^= keyb[tail_id + 10] << 16 if tail_sz >= 11
     k3 ^= keyb[tail_id +  9] <<  8 if tail_sz >= 10
     k3 ^= keyb[tail_id +  8]       if tail_sz >=  9
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 8
       k3 = (k3 * c3) & 0xFFFFFFFF
@@ -241,10 +253,12 @@ module Mmh3
     end
 
     k2 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k2 ^= keyb[tail_id +  7] << 24 if tail_sz >=  8
     k2 ^= keyb[tail_id +  6] << 16 if tail_sz >=  7
     k2 ^= keyb[tail_id +  5] <<  8 if tail_sz >=  6
     k2 ^= keyb[tail_id +  4]       if tail_sz >=  5
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 4
       k2 = (k2 * c2) & 0xFFFFFFFF
@@ -254,10 +268,12 @@ module Mmh3
     end
 
     k1 = 0
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators
     k1 ^= keyb[tail_id +  3] << 24 if tail_sz >=  4
     k1 ^= keyb[tail_id +  2] << 16 if tail_sz >=  3
     k1 ^= keyb[tail_id +  1] <<  8 if tail_sz >=  2
     k1 ^= keyb[tail_id]            if tail_sz >=  1
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators
 
     if tail_sz > 0
       k1 = (k1 * c1) & 0xFFFFFFFF
@@ -290,33 +306,37 @@ module Mmh3
     h3 = (h1 + h3) & 0xFFFFFFFF
     h4 = (h1 + h4) & 0xFFFFFFFF
 
-    h4 << 96 | h3 << 64 | h2 << 32 | h1
+    (h4 << 96) | (h3 << 64) | (h2 << 32) | h1
   end
 
   def block32(kb, bstart, offset)
-    kb[bstart + offset + 3] << 24 |
-    kb[bstart + offset + 2] << 16 |
-    kb[bstart + offset + 1] <<  8 |
-    kb[bstart + offset]
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators, Layout/MultilineOperationIndentation
+    (kb[bstart + offset + 3] << 24) |
+    (kb[bstart + offset + 2] << 16) |
+    (kb[bstart + offset + 1] <<  8) |
+     kb[bstart + offset]
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators, Layout/MultilineOperationIndentation
   end
 
   def block64(kb, bstart, offset)
-    kb[2 * bstart + (7 + offset)] << 56 |
-    kb[2 * bstart + (6 + offset)] << 48 |
-    kb[2 * bstart + (5 + offset)] << 40 |
-    kb[2 * bstart + (4 + offset)] << 32 |
-    kb[2 * bstart + (3 + offset)] << 24 |
-    kb[2 * bstart + (2 + offset)] << 16 |
-    kb[2 * bstart + (1 + offset)] <<  8 |
-    kb[2 * bstart + offset]
+    # rubocop:disable Layout/ExtraSpacing, Layout/SpaceAroundOperators, Layout/MultilineOperationIndentation
+    (kb[(2 * bstart) + (7 + offset)] << 56) |
+    (kb[(2 * bstart) + (6 + offset)] << 48) |
+    (kb[(2 * bstart) + (5 + offset)] << 40) |
+    (kb[(2 * bstart) + (4 + offset)] << 32) |
+    (kb[(2 * bstart) + (3 + offset)] << 24) |
+    (kb[(2 * bstart) + (2 + offset)] << 16) |
+    (kb[(2 * bstart) + (1 + offset)] <<  8) |
+     kb[(2 * bstart) + offset]
+    # rubocop:enable Layout/ExtraSpacing, Layout/SpaceAroundOperators, Layout/MultilineOperationIndentation
   end
 
   def rotl32(x, r)
-    (x << r | x >> (32 - r)) & 0xFFFFFFFF
+    ((x << r) | (x >> (32 - r))) & 0xFFFFFFFF
   end
 
   def rotl64(x, r)
-    (x << r | x >> (64 - r)) & 0xFFFFFFFFFFFFFFFF
+    ((x << r) | (x >> (64 - r))) & 0xFFFFFFFFFFFFFFFF
   end
 
   def scramble32(k)
@@ -343,3 +363,5 @@ module Mmh3
 
   private_class_method :hash128_x64, :hash128_x86, :block32, :block64, :rotl32, :rotl64, :scramble32, :fmix32, :fmix64
 end
+
+# rubocop:enable Metrics/AbcSize, Metrics/BlockLength, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/ModuleLength, Metrics/PerceivedComplexity

data/mmh3.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/mmh3/version'
 
 Gem::Specification.new do |spec|
@@ -24,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mmh3
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - yoshoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies: []
 description: A pure Ruby implementation of MurmurHash3
 email:
@@ -22,6 +22,7 @@ files:
 - ".github/workflows/coverage.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -40,7 +41,8 @@ metadata:
   source_code_uri: https://github.com/yoshoku/mmh3
   changelog_uri: https://github.com/yoshoku/mmh3/blob/main/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/mmh3
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -55,8 +57,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: A pure Ruby implementation of MurmurHash3
 test_files: []