redis-key_hash 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7dd84fcafb7fdfa166839a664d177a851ad7bf5
-  data.tar.gz: 496ced31fb42c55927fc739c6e5a930f6ea046f2
+  metadata.gz: 1ebc31ea112f09f727db862ad79e060886d899a1
+  data.tar.gz: 346eec6148ba5d648b4ebac19f3d0b4d478841e8
 SHA512:
-  metadata.gz: 9aa7190e2b7e7f50651d8628a1b7488e864f4a11cb803f25553f2233480f37f97af38024a335502dc93e3a7c7b3d2d451676b50399b81e40ff1d75e210a0487c
-  data.tar.gz: 7356c4f3ecb5efe65b4c8e8fff4bc67d70da7cc4560974d06736dad5f1a171a9bbb80307dfc7f373dee23af6cbc9e8daace89ad53c5d2fa7890ea260756f05c7
+  metadata.gz: 603fbb62409fa053c9cdcff1bb0fcbfad08c21371d1fc1f5256a6f4063d3a7119d310c52cf3a1861689c2ac69cddabaf93a983e49be80af484a7767a0bcbfb21
+  data.tar.gz: d72e817eb421afe8bbee7c48c1fed69af91d497d8c91254d38925beb58e12cd69453b8082fc0147c3c99221c15d6d11495aecd6b95518c0457ae71b2a3d5920b

data/.gitignore

@@ -1,5 +1,4 @@
 *.gem
-*.gem
 *.rbc
 /.config
 /coverage/

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: .rubocop_todo.yml
+AllCops:
+  Include:
+    - Rakefile
+    - Gemfile
+    - '*.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,214 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-08-29 14:52:28 -0700 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 273
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 290
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 104
+# Cop supports --auto-correct.
+Layout/SpaceInsideBrackets:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 31
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 2228
+
+# Offense count: 9
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 82
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 35
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/EmptyLiteral:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: snake_case, camelCase
+Style/MethodName:
+  EnforcedStyle: snake_case
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/redis/key_hash/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: both, prefix, postfix
+Style/NegatedIf:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+# Configuration parameters: Strict.
+Style/NumericLiterals:
+  MinDigits: 6
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'redis-key_hash.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: short, verbose
+Style/PreferredHashMethods:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantBegin:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 16410
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Rakefile'
+    - 'bin/console'
+    - 'lib/redis/key_hash.rb'
+    - 'redis-key_hash.gemspec'
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, SupportedStyles.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStylesForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInLiteral:
+  Exclude:
+    - 'test/redis/key_hash_test.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles, MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: brackets
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/YodaCondition:
+  Exclude:
+    - 'lib/redis/key_hash.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/redis/key_hash.rb'

data/.travis.yml

@@ -1,5 +1,10 @@
 sudo: false
 language: ruby
+before_install:
+  - gem install bundler -v 1.14.6
+  - gem install rubocop
 rvm:
   - 2.1.6
-before_install: gem install bundler -v 1.14.6
+script:
+  - rubocop
+  - rake test

data/README.md

@@ -1,7 +1,24 @@
-# Redis::KeyHash
-
-Tests of key hash slot agreement for use with Redis Cluster and
-RedisLabs Enterprise Cluster.
+# Redis::KeyHash ![TravisCI](https://travis-ci.org/ProsperWorks/redis-key_hash.svg?branch=master)
+
+redis-key_hash provides tests of key hash slot agreement for use with
+Redis Cluster and RedisLabs Enterprise Cluster.
+
+Redis Cluster (RC) and RedisLabs Enterprise Cluster (RLEC) both
+require that all keys in multi-key operations hash to the same node.
+They use slightly different default hashing algorithms and RLEC offers
+customizable hash pattersn.
+
+It is impossible to predict which nodes will host each shard, and
+difficult to predict which slot will host each key.  But it is easy to
+identify the key hash tag which RC or RLEC will use to select a shard.
+Where key hash tags agree, we can be certain that slots and nodes will
+also agree - even if hash tag disagreement does not always imply slot
+or node disagreement.
+
+By pulling this check into Ruby we can arrange to fail fast, before
+sending a command to Redis which is at risk of CROSSLOT failure.  We
+can also validate key management schemes in unit tests which run
+without support services or with a non-sharded Redis.
 
 ## Installation
 

data/lib/redis/impending_cross_slot_error.rb

@@ -5,8 +5,6 @@
 #
 #  (error) CROSSSLOT Keys in request don't hash to the same slot
 #
-# TODO: rubocop
-#
 # TODO: rdoc
 #
 class Redis

data/lib/redis/key_hash.rb

@@ -8,13 +8,33 @@ module Redis::KeyHash
   end
 
   module ClassMethods
-    # TODO: rubocop
 
     # TODO: rdoc
 
+    # KNOWN_STYLES are the known reference styles.
     #
-    # TODO: KNOWN_STYLES hash, etc, move comments around
-    #
+    KNOWN_STYLES   ||= {
+
+      # The :style => :rc implementation matches Redis Cluster exactly
+      # and is taken largely from the reference example provided in
+      # http://redis.io/topics/cluster-spec.
+      #
+      :rc   => /^[^{]*{([^}]+)}/, # RC uses first {}-expr, but only if nonempty
+
+      # The :style => :rlec implementation is partly speculative.  It
+      # is mostly interpreted from the default RedisLabs Enterprise
+      # Cluster documentation at
+      # https://redislabs.com/redis-enterprise-documentation/concepts-architecture/architecture/database-clustering/,
+      # plus our experience at ProsperWorks that, out of the box, RLEC
+      # uses the *last* {}-expr, not the first as in RC, from :rc
+      # (which we would not care about), they are also structually
+      # different (which can cause bugs unless we take special care).
+      # :rc uses the first {}-expr in the, :rlec uses the last
+      # {}-expr.
+      #
+      :rlec => /.*\{(.*)\}.*/,    # RLEC default per docs, uses last {}-expr
+
+    }.freeze
 
     # The default for all_in_one_slot? and all_in_one_slot! is
     # [:rc,:rlec] to encourage the of portable persistent hashing
@@ -97,20 +117,6 @@ module Redis::KeyHash
     # Computes the hash tag for a given key under a given Redis
     # clustering algorithm.
     #
-    # The :style => :rc implementation matches Redis Cluster exactly
-    # and is taken largely from the reference example provided in
-    # http://redis.io/topics/cluster-spec.
-    #
-    # The :style => :rlec implementation is partly speculative.  It is
-    # mostly interpreted from the default RedisLabs Enterprise Cluster
-    # document
-    # https://redislabs.com/redis-enterprise-documentation/concepts-architecture/architecture/database-clustering/
-    # plus our experience at ProsperWorks that, out of the box, RLEC
-    # uses the *last* {}-expr, not the first as in RC, from :rc (which
-    # we would not care about), they are also structually different
-    # (which can cause bugs unless we take special care).  :rc uses
-    # the first {}-expr in the, :rlec uses the last {}-expr.
-    #
     # @param String key to be hashed
     #
     # @param Symbol :rc or rlec or Regexp which defines one capture group
@@ -119,13 +125,10 @@ module Redis::KeyHash
     #
     def hash_tag(key, style: DEFAULT_STYLE)
       regexp = nil
-      case style
-      when :rc
-        regexp = /{([^}]*)}/     # RC uses the first {}-expr
-      when :rlec
-        regexp = /.*\{(.*)\}.*/  # RLEC default per docs, uses last {}-expr
-      when Regexp
-        regexp = style           # you can define your own
+      if KNOWN_STYLES.has_key?(style)
+        regexp = KNOWN_STYLES[style] # some are predefined
+      elsif style.is_a?(Regexp)
+        regexp = style               # you can define your own
       end
       if !regexp
         raise ArgumentError, "bogus style #{style}"

data/lib/redis/key_hash/version.rb

@@ -1,17 +1,20 @@
 class Redis
   module KeyHash
     #
-    # Version plan:
+    # Version plan/history:
     #
-    # 0.0.1 - still in Prosperworks/ALI/vendor/gems/redis-key_hash
+    # 0.0.1 - Still in Prosperworks/ALI/vendor/gems/redis-key_hash.
     #
-    # 0.0.2 - broke out into Prosperworks/redis-key_hash
+    # 0.0.2 - Broke out into Prosperworks/redis-key_hash, make public.
     #
-    # 0.1.0 - big README.md and Rdoc update, open repo
+    # 0.0.3 - Fix :rc to match https://redis.io/topics/cluster-spec,
+    #         added Rubocop checks.
     #
-    # 0.2.0 - solicit and incorporate initial feedback from select
-    #         beta external users
+    # 0.1.0 - (future) Big README.md and Rdoc update, solicit feedback
+    #         from select external beta users.
     #
-    VERSION = "0.0.2" # broken into standalone repo, not polished
+    # 0.2.0 - (future) Incorporate feedback, announce.
+    #
+    VERSION = '0.0.3'
   end
 end

data/redis-key_hash.gemspec

@@ -5,12 +5,8 @@ require 'redis/key_hash/version'
 Gem::Specification.new do |spec|
   spec.name          = "redis-key_hash"
   spec.version       = Redis::KeyHash::VERSION
-  spec.authors       = [
-    "jhwillett"
-  ]
-  spec.email         = [
-    "jhw@prosperworks.com"
-  ]
+  spec.authors       = ["jhwillett"]
+  spec.email         = ["jhw@prosperworks.com"]
   spec.license       = 'MIT'
 
   spec.summary       = 'Tests Redis Cluster key hash slot agreement'
@@ -18,23 +14,6 @@ Gem::Specification.new do |spec|
   spec.description   = %{
 redis-key_hash provides tests of key hash slot agreement for use with
 Redis Cluster and RedisLabs Enterprise Cluster.
-
-Redis Cluster (RC) and RedisLabs Enterprise Cluster (RLEC) both
-require that all keys in multi-key operations hash to the same node.
-They use slightly different default hashing algorithms and RLEC offers
-customizable hash pattersn.
-
-It is impossible to predict which nodes will host each shard, and
-difficult to predict which slot will host each key.  But it is easy to
-identify the key hash tag which RC or RLEC will use to select a shard.
-Where key hash tags agree, we can be certain that slots and nodes will
-also agree - even if hash tag disagreement does not always imply slot
-or node disagreement.
-
-By pulling this check into Ruby we can arrange to fail fast, before
-sending a command to Redis which is at risk of CROSSLOT failure.  We
-can also validate key management schemes in unit tests which run
-without support services or with a non-sharded Redis.
 }
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-key_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - jhwillett
@@ -56,23 +56,6 @@ description: |2
 
   redis-key_hash provides tests of key hash slot agreement for use with
   Redis Cluster and RedisLabs Enterprise Cluster.
-
-  Redis Cluster (RC) and RedisLabs Enterprise Cluster (RLEC) both
-  require that all keys in multi-key operations hash to the same node.
-  They use slightly different default hashing algorithms and RLEC offers
-  customizable hash pattersn.
-
-  It is impossible to predict which nodes will host each shard, and
-  difficult to predict which slot will host each key.  But it is easy to
-  identify the key hash tag which RC or RLEC will use to select a shard.
-  Where key hash tags agree, we can be certain that slots and nodes will
-  also agree - even if hash tag disagreement does not always imply slot
-  or node disagreement.
-
-  By pulling this check into Ruby we can arrange to fail fast, before
-  sending a command to Redis which is at risk of CROSSLOT failure.  We
-  can also validate key management schemes in unit tests which run
-  without support services or with a non-sharded Redis.
 email:
 - jhw@prosperworks.com
 executables: []
@@ -80,6 +63,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE