redis-script_manager 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a3988633cfd5315a4591a70edc873c902fe829
-  data.tar.gz: 9e279ed9af52df46d347c69a7f51ce21bf3cfc47
+  metadata.gz: b3bf62263d3927088efc2136df3cb22f5a29ce54
+  data.tar.gz: 4c0ee1b2b1d56ae9afe620cf9397cf159bd37120
 SHA512:
-  metadata.gz: 4408f0dd1575e24f23cd5888d44ce7d539d47955cd9c19100237e886ead48b0b4fd49d3d6f84e79478c307e47d0ee69e5d77ca468029704b18bc30357adddf51
-  data.tar.gz: 754d3250762ec2fbbd0e058b403ba0797aa4d1899a0ba1bc04d79430574ed7d71e882242fbd81f39134a43b1f6b0aa88b58ae7b883e23c175cb3cb87fc54e307
+  metadata.gz: 9a1ff6adf5859dfabe42b8e93a87f1b74ceb7e571f5f7265b72fc4ca5787aa1e002ebe905dbf81273f3216ee7113372f8e7f9c5d2bbcb8e42c70ee9cce54bf38
+  data.tar.gz: be3ca085567587e9507b45917bea13d068a1616f7a18198d1d0856a197d3f72a8ddd8f1c5d5417e31a93bda31bf5c61d2f393cfeb696844189ca608c0816c81c

data/.gitignore

@@ -40,11 +40,12 @@ build-iPhoneSimulator/
 /vendor/bundle
 /lib/bundler/man/
 
-# for a library or gem, you might want to ignore these files since the code is
+# For a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+#
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/.rubocop.yml

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

data/.rubocop_todo.yml

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

data/.travis.yml

@@ -1,5 +1,12 @@
 sudo: false
 language: ruby
+before_install:
+  - gem install bundler -v 1.14.6
+  - gem install rubocop
+services:
+  - redis-server
 rvm:
   - 2.1.6
-before_install: gem install bundler -v 1.14.6
+script:
+  - rubocop
+  - bundle exec env REDIS_URL=redis://localhost:6379 rake test

data/README.md

@@ -1,4 +1,4 @@
-# Redis::ScriptManager
+# Redis::ScriptManager ![TravisCI](https://travis-ci.org/ProsperWorks/redis-script_manager.svg?branch=master)
 
 Redis::ScriptManager executes your Lua scripts in your Redis
 infrastructure while managing trade-offs between bandwidth and
@@ -103,7 +103,21 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    # Configure Redis::ScriptManager from the ENV.
+    #
+    Redis::ScriptManager.configure do |config|
+      config.statsd             = $statsd
+      config.stats_prefix       = 'profile.redis_util.'
+      config.do_minify_lua      = 'true' == ENV['MY_PREF_MINIFY_LUA']
+      config.max_tiny_lua       = ENV['MY_PREF_MAGIC_SIZE_LIMIT'] || 512
+      config.do_preload         = 'true' == ENV['MY_PREF_PRELOADED_SHAS']
+      config.preload_cache_size = ENV['MY_PREF_PRELOADED_SHAS_MAX_SIZE']
+    end
+
+    # Invoke Redis::ScriptManager.eval_gently just like Redis.eval.
+    #
+    Redis.eval('return KEYS',keys: ['k1'],argv: ['a1'])
+    Redis::ScriptManager.eval_gently('return KEYS',keys: ['k1'],argv: ['a1'])
 
 ## Development
 

data/lib/redis/script_manager/version.rb

@@ -1,17 +1,20 @@
 class Redis
   class ScriptManager
     #
-    # Version plan:
+    # Version plan/history:
     #
-    # 0.0.1 - still in Prosperworks/ALI/vendor/gems/redis-script_manager
+    # 0.0.1 - Still in Prosperworks/ALI/vendor/gems/redis-script_manager.
     #
-    # 0.0.2 - broke out into Prosperworks/redis-script_manager
+    # 0.0.2 - Broke out into Prosperworks/redis-script_manager, make public.
     #
-    # 0.1.0 - big README.md and Rdoc update, open repo
+    # 0.0.3 - Got .travis.yml working with a live redis-server, some
+    #         cleanup, added Rubocop.
     #
-    # 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/lib/redis/script_manager.rb

@@ -3,8 +3,6 @@ require "redis/script_manager/version"
 class Redis
   class ScriptManager
 
-    # TODO: rubocop
-
     # TODO: rdoc
 
     # Efficiently evaluates a Lua script on Redis.
@@ -26,8 +24,6 @@ class Redis
     # @return the return result of evaluating lua against keys and args
     # on redis
     #
-    # TODO: Should this just monkey-patch over Redis.eval?
-    #
     def self.eval_gently(redis,lua,keys=[],args=[])
       [:eval,:evalsha,:script,:client].each do |method|
         if !redis.respond_to?(method) || !redis.respond_to?(:script)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-script_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - jhwillett
@@ -88,9 +88,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redis-script_manager (0.0.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.10.3)
-    rake (10.5.0)
-    redis (3.3.3)
-    redis-namespace (1.5.3)
-      redis (~> 3.0, >= 3.0.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.14)
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  redis (~> 3.2)
-  redis-namespace (~> 1.5)
-  redis-script_manager!
-
-BUNDLED WITH
-   1.15.3