redis-prescription 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e78c33e47df77d8456a6207e85758665624c1513637d4cd67a88fc10430045a
-  data.tar.gz: 9729555b027ec9d4d7acc41a2c6bd6b43e36f3d2d21a6721d503020c799ae41e
+  metadata.gz: c503c680688ac288e5d3b9e59314c20055c10239b31733de6855f6a78ed90d3e
+  data.tar.gz: f0a2373d51deb922ac02bb8283e05cb583dc3578f95ea8f4923bba2d1a3058e1
 SHA512:
-  metadata.gz: 263da116f96133dedd46869901cb455bb8dde63c8278fcef253aa9b62e64c524b28caba8ccb496662e16ea6ce4b710c54cce044b6fdd14974ddc38969a393536
-  data.tar.gz: ab11c229344bb840896bb87ead1192d3fbc9d8db97de94806699ced01dd20f0a3f0449594a485590becb0cc95d02aeafd2ec427b6e3e38858b818f42f352fe23
+  metadata.gz: 516e413b8da8d7dace049f9169c307d3a87b1ee52ecdc759368f3012d2d51e6b44732d38a2980635bc5acb1015436960c48fe17239edd734101feda83d18c503
+  data.tar.gz: 2c07386fbc7fb53a0a8093df08a35ed6d366a37084df8823cc49685cf95034e5599f7aeacb2fd502ebef6d4f0654f244988e86bd7bd26bfd30c3f0f7741d079b

data/README.adoc

@@ -45,6 +45,8 @@ This library aims to support and is tested against:
 ** 4.7.x
 ** 4.8.x
 ** 5.0.x
+* https://github.com/resque/redis-namespace[redis-namespace]
+** 1.10.x
 * https://github.com/redis-rb/redis-client[redis-client]
 ** 0.12.x
 ** 0.13.x
@@ -63,7 +65,8 @@ patches in a timely fashion. If critical issues for a particular implementation
 exist at the time of a major release, support for that Ruby version may be
 dropped.
 
-Same rules apply to *Redis Server*, *redis-rb*, and *redis-client* support.
+The same applies to *Redis Server*, *redis-rb*, *redis-namespace*,
+and *redis-client* support.
 
 
 == Similar Projects

data/lib/redis_prescription/adapters/redis.rb

@@ -14,6 +14,10 @@ class RedisPrescription
         @redis = redis
       end
 
+      def adapter_name
+        "redis"
+      end
+
       def eval(script, keys, argv)
         @redis.eval(script, keys, argv)
       rescue ::Redis::CommandError => e

data/lib/redis_prescription/adapters/redis_client.rb

@@ -17,6 +17,10 @@ class RedisPrescription
         @redis = redis
       end
 
+      def adapter_name
+        "redis-client"
+      end
+
       def eval(script, keys, argv)
         @redis.call("EVAL", script, keys.size, *keys, *argv)
       rescue ::RedisClient::CommandError => e

data/lib/redis_prescription/adapters/redis_namespace.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "../errors"
+
+class RedisPrescription
+  module Adapters
+    # redis-namespace adapter
+    class RedisNamespace
+      def self.adapts?(redis)
+        defined?(::Redis::Namespace) && redis.is_a?(::Redis::Namespace)
+      end
+
+      def initialize(redis)
+        @redis = redis
+      end
+
+      def adapter_name
+        "redis-namespace"
+      end
+
+      def eval(script, keys, argv)
+        @redis.eval(script, keys, argv)
+      rescue ::Redis::CommandError => e
+        raise CommandError, e.message
+      end
+
+      def evalsha(digest, keys, argv)
+        @redis.evalsha(digest, keys, argv)
+      rescue ::Redis::CommandError => e
+        raise CommandError, e.message
+      end
+
+      def purge!
+        @redis.redis.script("flush")
+        @redis.redis.flushdb
+      end
+    end
+  end
+end

data/lib/redis_prescription/adapters.rb

@@ -2,6 +2,7 @@
 
 require_relative "./adapters/redis"
 require_relative "./adapters/redis_client"
+require_relative "./adapters/redis_namespace"
 
 class RedisPrescription
   # @api internal
@@ -10,6 +11,7 @@ class RedisPrescription
       def [](redis)
         return Adapters::Redis.new(redis) if Adapters::Redis.adapts?(redis)
         return Adapters::RedisClient.new(redis) if Adapters::RedisClient.adapts?(redis)
+        return Adapters::RedisNamespace.new(redis) if Adapters::RedisNamespace.adapts?(redis)
 
         raise TypeError, "Unsupported redis client: #{redis.class}"
       end

data/lib/redis_prescription/errors.rb

@@ -10,17 +10,82 @@ class RedisPrescription
 
   # Lua script eval/evalsha failure
   class ScriptError < Error
-    # Lua script source.
+    # rubocop:disable Layout/LineLength
+    LUA_ERROR_MESSAGE = %r{
+      # * Error compiling script:
+      # ** Redis 6.0, 6.2, 7.0
+      # *** ERR Error compiling script (new function): user_script:7: unexpected symbol near '!'
+      # * Error running script:
+      # ** Redis 6.0, 6.2
+      # *** ERR Error running script (call to f_64203334c42d5690c2d008a78aa7789f5b83e5bb): @user_script:4: user_script:4: attempt to perform arithmetic on a string value
+      # ** Redis 7.0
+      # *** ERR user_script:4: attempt to perform arithmetic on a string value script: 64203334c42d5690c2d008a78aa7789f5b83e5bb, on @user_script:4.
+      \A
+      ERR\s
+      (?:
+        Error\scompiling\sscript\s\([^)]+\):\s          # Redis 6.0, 6.2, 7.0
+        .+:(?<loc>\d+):\s                               # Redis 6.0, 6.2, 7.0
+        (?<message>.+)                                  # Redis 6.0, 6.2, 7.0
+      |
+        (?:Error\srunning\sscript\s\([^)]+\):\s@\S+\s)? # Redis 6.0, 6.2
+        .+:(?<loc>\d+):\s                               # Redis 6.0, 6.2, 7.0
+        (?<message>.+?)                                 # Redis 6.0, 6.2, 7.0
+        (?::\s\h+,\son\s@[^:]+:\d+\.)?                  # Redis 7.0
+      )
+      \z
+    }x
+    private_constant :LUA_ERROR_MESSAGE
+    # rubocop:enable Layout/LineLength
+
+    # Lua script source
     #
     # @return [String]
     attr_reader :source
 
+    # Line of code where error was encountered
+    #
+    # @return [Integer?]
+    attr_reader :loc
+
     # @param message [String]
-    # @param source [String]
+    # @param source [#to_s]
     def initialize(message, source)
-      @source = source
+      @source = -source.to_s
+
+      if (parsed = LUA_ERROR_MESSAGE.match(message))
+        @loc    = parsed[:loc].to_i
+        message = [parsed[:message], excerpt(@source, @loc)].compact.join("\n\n")
+      end
 
       super(message)
     end
+
+    private
+
+    def excerpt(source, loc)
+      lines  = excerpt_lines(source, loc)
+      gutter = lines.map(&:first).max.to_s.length
+
+      lines.map! do |(pos, line)|
+        format(pos == loc ? "\t%#{gutter}d > %s" : "\t%#{gutter}d | %s", pos, line).rstrip
+      end
+
+      lines.join("\n")
+    rescue => e
+      warn "Failed extracting source excerpt: #{e.message}"
+      nil
+    end
+
+    def excerpt_lines(source, loc)
+      lines  = source.lines
+      pos    = loc - 1 # reported line of code is 1-offset
+      min    = pos - 2 # 2 lines of head context
+      max    = pos + 2 # 2 lines of tail context
+
+      min = 0              if min.negative?
+      max = lines.size - 1 if lines.size <= max
+
+      (min..max).map { |i| [i.succ, lines[i]] }
+    end
   end
 end

data/lib/redis_prescription/version.rb

@@ -2,5 +2,5 @@
 
 class RedisPrescription
   # Gem version.
-  VERSION = "2.0.0"
+  VERSION = "2.2.0"
 end

data/lib/redis_prescription.rb

@@ -30,7 +30,7 @@ class RedisPrescription
   # @return [String]
   attr_reader :digest
 
-  # @param source [#to_s] Lua script.
+  # @param source [#to_s] Lua script
   def initialize(source)
     @source = -source.to_s
     @digest = Digest::SHA1.hexdigest(@source).freeze
@@ -44,21 +44,13 @@ class RedisPrescription
   # @raise [ScriptError] if script execution failed
   # @return depends on the script
   def call(redis, keys: EMPTY_LIST, argv: EMPTY_LIST)
-    unpool(redis) { |r| evalsha_with_fallback(r, keys, argv) }
+    evalsha_with_fallback(Adapters[redis], keys, argv)
   rescue CommandError => e
-    raise ScriptError.new(e.message, @script)
+    raise ScriptError.new(e.message, @source)
   end
 
   private
 
-  def unpool(redis)
-    if redis.respond_to?(:with)
-      redis.with { |r| yield Adapters[r] }
-    else
-      yield Adapters[redis]
-    end
-  end
-
   def evalsha_with_fallback(redis, keys, argv)
     redis.evalsha(@digest, keys, argv)
   rescue CommandError => e

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-prescription
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Alexey Zapparov
@@ -26,6 +26,7 @@ files:
 - lib/redis_prescription/adapters.rb
 - lib/redis_prescription/adapters/redis.rb
 - lib/redis_prescription/adapters/redis_client.rb
+- lib/redis_prescription/adapters/redis_namespace.rb
 - lib/redis_prescription/errors.rb
 - lib/redis_prescription/version.rb
 homepage: https://gitlab.com/ixti/redis-prescription
@@ -35,7 +36,7 @@ metadata:
   homepage_uri: https://gitlab.com/ixti/redis-prescription
   source_code_uri: https://gitlab.com/ixti/redis-prescription
   bug_tracker_uri: https://gitlab.com/ixti/redis-prescription/issues
-  changelog_uri: https://gitlab.com/ixti/redis-prescription/blob/v2.0.0/CHANGES.md
+  changelog_uri: https://gitlab.com/ixti/redis-prescription/blob/v2.2.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []