redis-script_manager 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3bf62263d3927088efc2136df3cb22f5a29ce54
-  data.tar.gz: 4c0ee1b2b1d56ae9afe620cf9397cf159bd37120
+  metadata.gz: 971772a9f0906a9df2c012d8ad100a71941ad577
+  data.tar.gz: 3a3c6fddacff400288171761caf7a8ee6361edf4
 SHA512:
-  metadata.gz: 9a1ff6adf5859dfabe42b8e93a87f1b74ceb7e571f5f7265b72fc4ca5787aa1e002ebe905dbf81273f3216ee7113372f8e7f9c5d2bbcb8e42c70ee9cce54bf38
-  data.tar.gz: be3ca085567587e9507b45917bea13d068a1616f7a18198d1d0856a197d3f72a8ddd8f1c5d5417e31a93bda31bf5c61d2f393cfeb696844189ca608c0816c81c
+  metadata.gz: a54825b7aeb87346e64ff33124164ce193f389ae95418d714a3ae8d0f27b8e17cd14a3f45d17a38bb567ede84b5a9af43fa19fe45f3e9bd086f13604340eac40
+  data.tar.gz: 9de8a278b7842a879cfdf58614f174eda0e4c816b6b160187d5cc06e17281392005b2c65ce034a859c938f9030bfb6e4d7d3e4252fcdbd6dac4c54d94f504f7f

data/.rubocop.yml

@@ -1,6 +1,199 @@
-inherit_from: .rubocop_todo.yml
+
 AllCops:
   Include:
     - Rakefile
     - Gemfile
     - '*.gemspec'
+
+# 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: 100
+  Exclude:
+    - 'test/**/*.rb'
+
+# 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/BlockLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+# Ditto I believe in more permissive rules in test code.
+#
+Metrics/ClassLength:
+  Max: 400
+  Exclude:
+    - 'test/**/*.rb'
+
+# Redis::ScriptManager#eval_gently is indeed overly complex but I am
+# happy with it until the next time something goes wrong.
+#
+# Also ditto I believe in more permissive rules in test code.
+#
+Metrics/CyclomaticComplexity:
+  Max: 30
+  Exclude:
+    - 'test/**/*.rb'
+Metrics/MethodLength:
+  Max: 100
+  Exclude:
+    - 'test/**/*.rb'
+Metrics/PerceivedComplexity:
+  Max: 21
+  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
+
+# This complains that:
+#
+#   if foo
+#     foo.bar
+#   end
+#
+# could instead be:
+#
+#   foo.bar if foo
+#
+# ...which I reject, not least because the former is a lot easier to
+# fit into an 80 character line.
+#
+Style/GuardClause:
+  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
+
+# No.
+#
+# I can catenate strings with + if I want to.  Indeed, it looks better
+# in my editor.
+#
+Style/LineEndConcatenation:
+  Enabled: false
+
+# Too pedantic.
+#
+Style/NumericLiterals:
+  Enabled: false
+
+# This complains that:
+#
+#   raise RuntimeError, "foo"
+#
+# Does not need the RuntimeError because it is redundant.
+#
+# I do not accept a requirement not to be explicit.
+#
+Style/RedundantException:
+  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
+
+# No.  attr_writer, attr_reader, etc. are strictly optional.
+#
+# If I want to use the longer, less sugary form that is my business.
+#
+# I especially believe this where, for instance, I have a trivial
+# reader but a non-trivial writer.  I want consistency between them -
+# which would be prohibited by this requirement.
+Style/TrivialAccessors:
+  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/script_manager.rb

@@ -1,6 +1,10 @@
 require "redis/script_manager/version"
 
 class Redis
+
+  # Utility to efficiently manage SCRIPT LOAD, EVAL, and EVALSHA over
+  # all Redis/Lua scripts.
+  #
   class ScriptManager
 
     # TODO: rdoc
@@ -74,7 +78,7 @@ class Redis
       # within a pipeline.
       #
       if configuration.do_minify_lua
-        lua = self.minify_lua(lua)
+        lua = minify_lua(lua)
       end
       if lua.size < configuration.max_tiny_lua
         _statsd_increment("eval")
@@ -113,20 +117,18 @@ class Redis
         #
         sha                = Digest::SHA1.hexdigest(lua)
         sha_connection_key = [redis.object_id,sha]
-        if !@@preloaded_shas.include?(sha_connection_key)
+        if !@preloaded_shas.include?(sha_connection_key)
           _statsd_increment("preloaded_shas.cache_miss")
           new_sha = redis.script(:load,lua)
-          if !new_sha.is_a?(Redis::Future)
-            if sha != new_sha
-              raise RuntimeError, "mismatch #{sha} vs #{new_sha} for lua #{lua}"
-            end
+          if !new_sha.is_a?(Redis::Future) && sha != new_sha
+            raise RuntimeError, "mismatch #{sha} vs #{new_sha} for lua #{lua}"
           end
-          @@preloaded_shas << sha_connection_key
+          @preloaded_shas  << sha_connection_key
         else
           _statsd_increment("preloaded_shas.cache_hit")
         end
         result   = redis.evalsha(sha,keys,args)
-        if configuration.preload_cache_size < @@preloaded_shas.size
+        if configuration.preload_cache_size < @preloaded_shas.size
           #
           # To defend against unbound cache size, at a predetermined
           # limit throw away half of them.
@@ -138,10 +140,10 @@ class Redis
           # bound.
           #
           _statsd_increment("preloaded_shas.cache_purge")
-          num_to_keep      = @@preloaded_shas.size / 2
-          @@preloaded_shas = @@preloaded_shas.to_a.sample(num_to_keep)
+          num_to_keep      = @preloaded_shas.size / 2
+          @preloaded_shas  = @preloaded_shas.to_a.sample(num_to_keep)
         end
-        cache_size         = @@preloaded_shas.size
+        cache_size         = @preloaded_shas.size
         _statsd_timing("preloaded_shas.cache_size",cache_size)
         return result
       end
@@ -176,10 +178,10 @@ class Redis
       end
     end
 
-    @@preloaded_shas = Set[] # [redis.object_id,sha(lua)] which have been loaded
+    @preloaded_shas = Set[] # [redis.object_id,sha(lua)] which have been loaded
 
     def self.purge_preloaded_shas # for test, clean state
-      @@preloaded_shas = Set[]
+      @preloaded_shas = Set[]
     end
 
     # To save bandwidth, minify the Lua code.
@@ -241,6 +243,8 @@ class Redis
       yield configuration
     end
 
+    # Configuration interface for Redis::ScriptManager.
+    #
     class Configuration
 
       # Defaults to nil. If non-nil, lots of stats will be tracked via

data/lib/redis/script_manager/version.rb

@@ -7,14 +7,19 @@ class Redis
     #
     # 0.0.2 - Broke out into Prosperworks/redis-script_manager, make public.
     #
-    # 0.0.3 - Got .travis.yml working with a live redis-server, some
-    #         cleanup, added Rubocop.
+    # 0.0.3 - Got .travis.yml working with a live redis-server.
+    #
+    #         Initial Rubocop integration.
+    #
+    #         Misc cleanup.
+    #
+    # 0.0.4 - Rubocop polish and defiance.
     #
     # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-script_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - jhwillett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,7 +89,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE

data/.rubocop_todo.yml

@@ -1,266 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2017-08-29 15:12:56 -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: 10
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAdjacentOneLineDefs, NumberOfEmptyLines.
-Layout/EmptyLineBetweenDefs:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, no_empty_lines
-Layout/EmptyLinesAroundBlockBody:
-  Exclude:
-    - 'redis-script_manager.gemspec'
-
-# Offense count: 7
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
-Layout/EmptyLinesAroundClassBody:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 19
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 161
-# Cop supports --auto-correct.
-Layout/SpaceAfterComma:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles.
-# SupportedStyles: space, no_space
-Layout/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: no_space
-
-# Offense count: 9
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Layout/SpaceBeforeFirstArg:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 15
-# Cop supports --auto-correct.
-Layout/SpaceBeforeSemicolon:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 13
-# Cop supports --auto-correct.
-Layout/SpaceInsideBrackets:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Layout/SpaceInsideParens:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 7
-Metrics/AbcSize:
-  Max: 81
-
-# Offense count: 4
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 99
-
-# Offense count: 1
-# Configuration parameters: CountBlocks.
-Metrics/BlockNesting:
-  Max: 4
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 425
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 20
-
-# Offense count: 7
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 81
-
-# Offense count: 7
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 78
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 21
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 4
-Style/ClassVars:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 2
-# 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'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 43
-# Cop supports --auto-correct.
-Style/LineEndConcatenation:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 3
-Style/MultilineTernaryOperator:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-    - 'lib/redis/script_manager/version.rb'
-
-# Offense count: 9
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: both, prefix, postfix
-Style/NegatedIf:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/RedundantException:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 15
-# Cop supports --auto-correct.
-# Configuration parameters: AllowAsExpressionSeparator.
-Style/Semicolon:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 84
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Rakefile'
-    - 'bin/console'
-    - 'lib/redis/script_manager.rb'
-    - 'redis-script_manager.gemspec'
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: MinSize, SupportedStyles.
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-# Offense count: 13
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyleForMultiline, SupportedStylesForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInLiteral:
-  Exclude:
-    - 'test/redis/script_manager_test.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
-# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
-Style/TrivialAccessors:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 9
-# Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles, MinSize, WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  EnforcedStyle: brackets
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/YodaCondition:
-  Exclude:
-    - 'lib/redis/script_manager.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/ZeroLengthPredicate:
-  Exclude:
-    - 'lib/redis/script_manager.rb'