redis-key_hash 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ebc31ea112f09f727db862ad79e060886d899a1
-  data.tar.gz: 346eec6148ba5d648b4ebac19f3d0b4d478841e8
+  metadata.gz: af4659873609b59ab1f7caf0280ee74603724bcd
+  data.tar.gz: 67795113e9239ec7697da473dbf57ae21d28c128
 SHA512:
-  metadata.gz: 603fbb62409fa053c9cdcff1bb0fcbfad08c21371d1fc1f5256a6f4063d3a7119d310c52cf3a1861689c2ac69cddabaf93a983e49be80af484a7767a0bcbfb21
-  data.tar.gz: d72e817eb421afe8bbee7c48c1fed69af91d497d8c91254d38925beb58e12cd69453b8082fc0147c3c99221c15d6d11495aecd6b95518c0457ae71b2a3d5920b
+  metadata.gz: 75bb4c2afa6697f0dadf890c020566f2f2fa739b8e643958c91f76d6c982eaf2d42277f4126ce759135314cdd9ee4c25bb42613d4b62096c8bcb50a53dcb65e0
+  data.tar.gz: dd77b81d539ed376e2601abf20cd3430bde9de6277ef3e82300e8923d5773b1c644ce59862c2d76f0f7ed41460241cc6b8a896f4d28707bdaf47c14cd986fda0

data/.rubocop.yml

@@ -1,6 +1,141 @@
-inherit_from: .rubocop_todo.yml
+
 AllCops:
   Include:
     - Rakefile
     - Gemfile
     - '*.gemspec'
+
+# Broadly speaking, test code gets a pass for most of the Metrics family.
+#
+# IMO test code is not the place get pedantic about class length,
+# method complexity, etc.  One should be encouraged to add more tests
+# with minimal friction, not forced to make a hard choice between
+# cutting tests or splitting up my test suites.
+#
+Metrics/ClassLength:
+  Max: 400
+  Exclude:
+    - 'test/**/*.rb'
+
+# I like this Metric in principle, but I don't like the default max of
+# 15.
+#
+# Also, as per Metrics/ClassLength IMO this kind of limit should not
+# apply to test code (I get up to 318 over there).
+#
+Metrics/AbcSize:
+  Max: 30
+  Exclude:
+    - 'test/**/*.rb'
+
+# I like this Metric in principle, but I don't like the default max of
+# 10.
+#
+# Also, as per Metrics/ClassLength IMO this kind of limit should not
+# apply to test code.
+#
+Metrics/MethodLength:
+  Max: 50
+  Exclude:
+    - 'test/**/*.rb'
+
+# I put extra spaces in a lot of expressions for a lot of different
+# reasons, including especially readability.
+#
+# I reject these cops.
+#
+Layout:
+  Enabled: false
+
+# I like a lot of the Lint tests, but not these.
+#
+Lint/AmbiguousBlockAssociation:           # obnoxiously rejects idiomatic Ruby
+  Enabled: false
+
+# This does no more than insist I type "format" instead of "sprintf",
+# where the two are aliases.
+#
+Style/FormatString:
+  Enabled: false
+
+# There is nothing wrong with Ruby 1.9 Hash syntax.
+#
+Style/HashSyntax:
+  Enabled: false
+
+# No.  Indeed, postfix if can often drive a line over 80 columns wide.
+#
+Style/IfUnlessModifier:
+  Enabled: false
+
+# No.  There is nothing wrong with "if !foo".
+#
+# As far as I'm concerned, "unless" is in poor taste because it means
+# I have to think in English in two different logical senses - and
+# English is a poor language for logical senses.
+#
+Style/NegatedIf:
+  Enabled: false
+
+# Too pedantic.
+#
+Style/NumericLiterals:
+  Enabled: false
+
+# "Do not use semicolons to terminate expressions."
+#
+# That's great when I terminate a single-line expression with a
+# redundant semicolo because I forget I'm not using C.
+#
+# But when I'm using a semicolon to separate two expressions there is
+# no other choice.  So this really ought to be Style/OneExprPerLine,
+# which I reject.
+#
+Style/Semicolon:
+  Enabled: false
+
+# No.
+#
+# Some lines must have '\"'.  It is ugly to use a mix of '"' and '\''
+# in LoCs which are close to one another.  Therefore, banning '"' if
+# '"' is not strictly necessary drives visual inconsistency.
+#
+Style/StringLiterals:
+  Enabled: false
+
+# This is the same kind of obnoxious pedantry which drove Hungarian
+# Notation.
+#
+# The [] literal syntax is perfectly servicable and there is no point
+# _tightly_ coupling it to the content of the array.  That's why we
+# have context-free grammers!
+#
+Style/SymbolArray:
+  Enabled: false
+
+# Shockingly, this cop requires us to *OMIT*, not *INCLUDE* parens in
+# ternery conditons.
+#
+# IMO this one is actively harmful in that it discourages attention to
+# clarity and avoiding some nasty precedence surprises.
+#
+Style/TernaryParentheses:
+  Enabled: false
+
+# I am a huge fan of using trailing commas when I break an argument
+# list down one-per line.
+#
+# As such, I reject this test.
+#
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+# Too pedantic.  I am starting to think I should switch from "opt out"
+# to "opt in" on the Style family.
+#
+Style/WordArray:
+  Enabled: false
+Style/YodaCondition:
+  Enabled: false
+Style/ZeroLengthPredicate:
+  Enabled: false

data/lib/redis/impending_cross_slot_error.rb

@@ -1,16 +1,55 @@
-# Raised from Redis::KeyHash.all_in_one_slot! on a mismatch.
-#
-# Generally, this indicates we were about to risk a Redis operation
-# which is likely to produce a Redis error result like:
-#
-#  (error) CROSSSLOT Keys in request don't hash to the same slot
-#
-# TODO: rdoc
-#
+
 class Redis
-  class ImpendingCrossSlotError < ArgumentError # TODO: Redis::CommandError?
-    #
-    # TODO: capture the problems with the keys?
-    #
+
+  # Forward declarations of Redis package errors so we can declare
+  # them as the parent of Redis::ImpendingCrossSlotError without
+  # taking a hard development or runtime dependency on the gem
+  # 'redis'.
+  #
+  # There remains an implicit dependency that later, when the 'redis'
+  # gem is loaded by the app, these declarations are consistent with
+  # those in the gem.
+  #
+  class BaseError < RuntimeError
   end
+  class CommandError < BaseError
+  end
+
+  # Captures the details from a potential CROSSSLOT error as
+  # identified by Redis::KeyHash.all_in_one_slot!.
+  #
+  # Generally, this indicates we were about to risk a Redis operation
+  # which is likely to produce a Redis error result like:
+  #
+  #  (error) CROSSSLOT Keys in request don't hash to the same slot
+  #
+  # TODO: rdoc
+  #
+  # Redis::ImpendingCrossSlotError is a Redis::CommandError because
+  # the intention is to use Redis::KeyHash.all_in_one_slot! as a
+  # filter in front of Redis#eval, which will raise a
+  # Redis::CommandError when redis-server returns a CROSSSLOT error.
+  #
+  class ImpendingCrossSlotError < CommandError
+
+    def initialize(namespace,keys,namespaced_keys,problems)
+      err  = "CROSSSLOT"
+      err += " namespace=#{namespace.inspect}"
+      err += " keys=#{keys.inspect}"
+      err += " namespaced_keys=#{namespaced_keys.inspect}"
+      err += " problems=#{problems.inspect}"
+      super(err)
+      @namespace       = namespace ? namespace.dup.freeze : nil
+      @keys            = keys.dup.freeze
+      @namespaced_keys = namespaced_keys.dup.freeze
+      @problems        = problems.dup.freeze
+    end
+
+    attr_accessor :namespace
+    attr_accessor :keys
+    attr_accessor :namespaced_keys
+    attr_accessor :problems
+
+  end
+
 end

data/lib/redis/key_hash.rb

@@ -1,13 +1,11 @@
 require 'redis/key_hash/version'
 require 'redis/impending_cross_slot_error'
 
-module Redis::KeyHash
+class Redis
 
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  module ClassMethods
+  # Namespace for key-hashing methods.
+  #
+  class KeyHash
 
     # TODO: rdoc
 
@@ -19,12 +17,14 @@ module Redis::KeyHash
       # 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
+      :rc   => /^[^{]*{([^}]+)}/, # RC w/ 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/,
+      # 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
@@ -66,14 +66,12 @@ module Redis::KeyHash
     # @return true if all of keys provably have the same hash_slot under
     # all styles by virtue of having a single hash_tag, false otherwise.
     #
-    def all_in_one_slot?(*keys, namespace: nil, styles: DEFAULT_STYLES)
-      begin
-        all_in_one_slot!(*keys, namespace: namespace, styles: styles)
-      rescue Redis::ImpendingCrossSlotError
-        return false
-      else
-        return true
-      end
+    def self.all_in_one_slot?(*keys, namespace: nil, styles: DEFAULT_STYLES)
+      all_in_one_slot!(*keys, namespace: namespace, styles: styles)
+    rescue Redis::ImpendingCrossSlotError
+      return false
+    else
+      return true
     end
 
     # Like all_in_one_slot?, mismatch raises Redis::ImpendingCrossSlotError.
@@ -95,21 +93,36 @@ module Redis::KeyHash
     # keys have a different hash_tag hence will not provably have the
     # same hash_slot
     #
-    def all_in_one_slot!(*keys, namespace: nil, styles: DEFAULT_STYLES)
-      nkeys       = namespace ? keys.map { |key| "#{namespace}:#{key}" } : keys
-      style2slot  = Hash.new
-      problems    = []
+    def self.all_in_one_slot!(*keys, namespace: nil, styles: DEFAULT_STYLES)
+      namespaced_keys   = keys
+      if namespace
+        #
+        # Although Redis::Namespace.add_namespace is private, I have
+        # confirmed that when namespace is the empty string, "key"
+        # maps to ":key".
+        #
+        # That is, namespace nil has no effect, but namespace ''
+        # results in a ':' prepended to every key.
+        #
+        # Naturally, this can affect the key's hash tag.
+        #
+        namespaced_keys = keys.map { |key| "#{namespace}:#{key}" }
+      end
+      problems          = []
       styles.each do |style|
-        tags      = nkeys.map { |nkey| hash_tag(nkey,style: style) }.uniq
+        tags            = namespaced_keys.map do |namespaced_key|
+          hash_tag(namespaced_key,style: style)
+        end.uniq
         next if tags.size <= 1
         problems << "style #{style} sees tags #{tags.join(',')}"
       end
       if 0 != problems.size
-        err  = "CROSSSLOT"
-        err += " namespace=#{namespace}"
-        err += " keys=#{keys}"
-        err += " problems=#{problems}"
-        raise Redis::ImpendingCrossSlotError, err
+        raise Redis::ImpendingCrossSlotError.new(
+                namespace,
+                keys,
+                namespaced_keys,
+                problems
+              )
       end
       true
     end
@@ -123,9 +136,9 @@ module Redis::KeyHash
     #
     # @param String the tag extracted from key as appropriate for :style.
     #
-    def hash_tag(key, style: DEFAULT_STYLE)
+    def self.hash_tag(key, style: DEFAULT_STYLE)
       regexp = nil
-      if KNOWN_STYLES.has_key?(style)
+      if KNOWN_STYLES.key?(style)
         regexp = KNOWN_STYLES[style] # some are predefined
       elsif style.is_a?(Regexp)
         regexp = style               # you can define your own
@@ -134,7 +147,7 @@ module Redis::KeyHash
         raise ArgumentError, "bogus style #{style}"
       end
       match = regexp.match(key)
-      return match ? match[1] : key
+      match ? match[1] : key
     end
 
     # Computes the Redis hash_slot for a given key.
@@ -153,7 +166,7 @@ module Redis::KeyHash
     #
     # @param non-negative Integer the hash which Redis will use to slot key
     #
-    def hash_slot(key, style: DEFAULT_STYLE)
+    def self.hash_slot(key, style: DEFAULT_STYLE)
       tag = hash_tag(key, style: style)
       crc16(tag) % 16384
     end
@@ -169,10 +182,10 @@ module Redis::KeyHash
     # @param non-negative Integer the crc16 which Redis will use to
     # compute a hash_key.
     #
-    def crc16(key)
+    def self.crc16(key)
       crc = 0
       key.each_char do |char|
-        crc = ((crc << 8) & 0xFFFF) ^ CRC16TAB[((crc >> 8) ^ char.ord) & 0x00FF]
+        crc = ((crc<<8) & 0xFFFF) ^ CRC16TAB[((crc>>8) ^ char.ord) & 0x00FF]
       end
       crc
     end

data/lib/redis/key_hash/version.rb

@@ -1,5 +1,5 @@
 class Redis
-  module KeyHash
+  class KeyHash
     #
     # Version plan/history:
     #
@@ -10,11 +10,24 @@ class Redis
     # 0.0.3 - Fix :rc to match https://redis.io/topics/cluster-spec,
     #         added Rubocop checks.
     #
+    # 0.0.4 - Verified existing behavior w/r/t Redis::Namespace.
+    #
+    #         Added more details in Redis::ImpendingCrossSlotError.
+    #
+    #         Rubocop polish and defiance.
+    #
+    #         Redis::KeyHash::ClassMethods inner-inner class removed.
+    #
+    #         Redis::KeyHash changed to a class, not a module.
+    #
+    #         Redis::ImpendingCrossSlotError changed from
+    #         ArgumentError to Redis::RuntimeError.
+    #
     # 0.1.0 - (future) Big README.md and Rdoc update, solicit feedback
     #         from select external beta users.
     #
     # 0.2.0 - (future) Incorporate feedback, announce.
     #
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'.freeze
   end
 end

data/redis-key_hash.gemspec

@@ -11,10 +11,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Tests Redis Cluster key hash slot agreement'
   spec.homepage      = 'https://github.com/ProsperWorks/redis-key_hash'
-  spec.description   = %{
-redis-key_hash provides tests of key hash slot agreement for use with
-Redis Cluster and RedisLabs Enterprise Cluster.
-}
+  spec.description   =
+    'Hash slot tests for Redis Cluster and RedisLabs Enterprise Cluster.'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-key_hash
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - jhwillett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
-description: |2
-
-  redis-key_hash provides tests of key hash slot agreement for use with
-  Redis Cluster and RedisLabs Enterprise Cluster.
+description: Hash slot tests for Redis Cluster and RedisLabs Enterprise Cluster.
 email:
 - jhw@prosperworks.com
 executables: []
@@ -64,7 +61,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE

data/.rubocop_todo.yml

@@ -1,214 +0,0 @@
-# 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'