redis-prescription 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c70dac256ca079b9af76b03cefc189db30507860c0a6816ddd519da7bdd75a
-  data.tar.gz: a1c5e2fe3645bd592f26a00a16accf2be1d0340468c4f824e06c7da51f1d29eb
+  metadata.gz: 3e78c33e47df77d8456a6207e85758665624c1513637d4cd67a88fc10430045a
+  data.tar.gz: 9729555b027ec9d4d7acc41a2c6bd6b43e36f3d2d21a6721d503020c799ae41e
 SHA512:
-  metadata.gz: a1f3988eb35db89865af75881b7bd0e33cb4a922fa468589f8f9de3396ac88118405b400ac8999995648ed92a224f768f2fc88a19d3a75d6c54145c9f01488b1
-  data.tar.gz: 19a72258d2adf1bef91b436965ebcea477a886cc4c9e269e81f5cffe489b406811f9fc7c46088bfc02071c720fecc016c819b48e297bd8b602e6ce11d21d31fd
+  metadata.gz: 263da116f96133dedd46869901cb455bb8dde63c8278fcef253aa9b62e64c524b28caba8ccb496662e16ea6ce4b710c54cce044b6fdd14974ddc38969a393536
+  data.tar.gz: ab11c229344bb840896bb87ead1192d3fbc9d8db97de94806699ced01dd20f0a3f0449594a485590becb0cc95d02aeafd2ec427b6e3e38858b818f42f352fe23

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Alexey Zapparov
+Copyright (c) 2020-2023 Alexey Zapparov
+Copyright (c) 2018 SensorTower Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/{README.md → README.adoc}

@@ -1,48 +1,54 @@
-# Redis::Prescription
+= Redis::Prescription
 
 Redis LUA stored procedure runner. Preloads (and reloads when needed, e.g. when
 scripts were flushed away) script and then runs it with `EVALSHA`.
 
 
-## Installation
+== Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem "redis-prescription"
-```
-
-And then execute:
-
-    $ bundle
+    $ bundle add redis-prescription
 
 Or install it yourself as:
 
     $ gem install redis-prescription
 
 
-## Usage
+== Usage
 
-``` ruby
-script = Redis::Prescription.new <<~LUA
+[source,ruby]
+----
+script = RedisPrescription.new <<~LUA
   return tonumber(redis.call('GET', KEYS[1]) or 42)
 LUA
 
-script.eval(Redis.current, :xxx) # => 42
+redis = Redis.new
+script.call(redis, keys: [:xxx]) # => 42
 
-Redis.current.set(:xxx, 123)
-script.eval(Redis.current, :xxx) # => 123
-```
+redis.set(:xxx, 123)
+script.call(redis, keys: [:xxx]) # => 123
+----
 
 
-## Supported Ruby Versions
+== Supported Ruby Versions
 
-This library aims to support and is [tested against][1] the following Ruby
-versions:
+This library aims to support and is tested against:
 
-* Ruby 2.3.x
-* Ruby 2.4.x
-* Ruby 2.5.x
+* https://www.ruby-lang.org[Ruby]
+** MRI 3.0.x
+** MRI 3.1.x
+* https://redis.io[Redis Server]
+** 6.2.x
+** 7.0.x
+* https://github.com/redis/redis-rb[redis-rb]
+** 4.7.x
+** 4.8.x
+** 5.0.x
+* https://github.com/redis-rb/redis-client[redis-client]
+** 0.12.x
+** 0.13.x
+** 0.14.x
 
 If something doesn't work on one of these versions, it's a bug.
 
@@ -57,33 +63,26 @@ 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.
+
+
+== Similar Projects
+
+* https://github.com/Shopify/wolverine
 
-## Development
 
-After checking out the repo, run `bundle install` to install dependencies.
-Then, run `bundle exec rake spec` to run the tests with ruby-rb client.
+== Development
 
-To install this gem onto your local machine, run `bundle exec rake install`.
-To release a new version, update the version number in `version.rb`, and then
-run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to [rubygems.org][2].
+  scripts/update-gemfiles
+  scripts/run-rspec
+  bundle exec rubocop
 
 
-## Contributing
+== Contributing
 
-* Fork sidekiq-throttled on GitHub
+* Fork redis-prescription
 * Make your changes
 * Ensure all tests pass (`bundle exec rake`)
-* Send a pull request
+* Send a merge request
 * If we like them we'll merge them
 * If we've accepted a patch, feel free to ask for commit access!
-
-
-## Copyright
-
-Copyright (c) 2018 SensorTower Inc.
-See LICENSE.md for further details.
-
-
-[1]: http://travis-ci.org/sensortower/redis-prescription
-[2]: https://rubygems.org

data/lib/redis-prescription.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "redis_prescription"

data/lib/redis_prescription/adapters/redis.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "../errors"
+
+class RedisPrescription
+  module Adapters
+    # redis-rb adapter
+    class Redis
+      def self.adapts?(redis)
+        defined?(::Redis) && redis.is_a?(::Redis)
+      end
+
+      def initialize(redis)
+        @redis = redis
+      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.script("flush")
+        @redis.flushdb
+      end
+    end
+  end
+end

data/lib/redis_prescription/adapters/redis_client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../errors"
+
+class RedisPrescription
+  module Adapters
+    # redis-client adapter
+    class RedisClient
+      def self.adapts?(redis)
+        return true if defined?(::RedisClient) && redis.is_a?(::RedisClient)
+        return true if defined?(::RedisClient::Decorator::Client) && redis.is_a?(::RedisClient::Decorator::Client)
+
+        false
+      end
+
+      def initialize(redis)
+        @redis = redis
+      end
+
+      def eval(script, keys, argv)
+        @redis.call("EVAL", script, keys.size, *keys, *argv)
+      rescue ::RedisClient::CommandError => e
+        raise CommandError, e.message
+      end
+
+      def evalsha(digest, keys, argv)
+        @redis.call("EVALSHA", digest, keys.size, *keys, *argv)
+      rescue ::RedisClient::CommandError => e
+        raise CommandError, e.message
+      end
+
+      def purge!
+        @redis.call("SCRIPT", "FLUSH")
+        @redis.call("FLUSHDB")
+      end
+    end
+  end
+end

data/lib/redis_prescription/adapters.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "./adapters/redis"
+require_relative "./adapters/redis_client"
+
+class RedisPrescription
+  # @api internal
+  module Adapters
+    class << self
+      def [](redis)
+        return Adapters::Redis.new(redis) if Adapters::Redis.adapts?(redis)
+        return Adapters::RedisClient.new(redis) if Adapters::RedisClient.adapts?(redis)
+
+        raise TypeError, "Unsupported redis client: #{redis.class}"
+      end
+    end
+  end
+end

data/lib/redis_prescription/errors.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class RedisPrescription
+  # Top-level error class for all RedisPrescription errors
+  class Error < StandardError; end
+
+  # Redis command error wrapper, `#cause` will be `Redis::CommandError` or
+  # `RedisClient::CommandError`.
+  class CommandError < Error; end
+
+  # Lua script eval/evalsha failure
+  class ScriptError < Error
+    # Lua script source.
+    #
+    # @return [String]
+    attr_reader :source
+
+    # @param message [String]
+    # @param source [String]
+    def initialize(message, source)
+      @source = source
+
+      super(message)
+    end
+  end
+end

data/lib/redis_prescription/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class RedisPrescription
+  # Gem version.
+  VERSION = "2.0.0"
+end

data/lib/redis_prescription.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "./redis_prescription/adapters"
+require_relative "./redis_prescription/errors"
+require_relative "./redis_prescription/version"
+
+# Lua script executor for redis.
+#
+# Instead of executing script with `EVAL` everytime - loads script once
+# and then runs it with `EVALSHA`.
+#
+# @example Usage
+#
+#     redis  = Redis.new
+#     script = RedisPrescription.new("return ARGV[1] + ARGV[2]")
+#     script.call(redis, argv: [2, 2]) # => 4
+class RedisPrescription
+  # Redis error fired when script ID is unkown.
+  NOSCRIPT = "NOSCRIPT"
+  private_constant :NOSCRIPT
+
+  EMPTY_LIST = [].freeze
+  private_constant :EMPTY_LIST
+
+  # Lua script source.
+  # @return [String]
+  attr_reader :source
+
+  # Lua script SHA1 digest.
+  # @return [String]
+  attr_reader :digest
+
+  # @param source [#to_s] Lua script.
+  def initialize(source)
+    @source = -source.to_s
+    @digest = Digest::SHA1.hexdigest(@source).freeze
+  end
+
+  # Executes script and return result of execution.
+  # @param redis [Redis, RedisClient]
+  # @param keys [Array] keys to pass to the script
+  # @param argv [Array] arguments to pass to the script
+  # @raise [TypeError] if given redis client is not supported
+  # @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) }
+  rescue CommandError => e
+    raise ScriptError.new(e.message, @script)
+  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
+    raise unless e.message.include?(NOSCRIPT)
+
+    redis.eval(@source, keys, argv)
+  end
+end

metadata

@@ -1,56 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: redis-prescription
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexey Zapparov
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2018-02-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+date: 2023-04-05 00:00:00.000000000 Z
+dependencies: []
 description: |
-  Preloads (and reloads when needed, e.g. when scripts
-  were flushed away) script and then runs it with `EVALSHA`.
+  Preloads (and reloads when needed, e.g. when scripts were flushed away)
+  script and then runs it with `EVALSHA`.
 email:
-- ixti@member.fsf.org
+- alexey@zapparov.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
-- Gemfile
-- Guardfile
 - LICENSE.txt
-- README.md
-- Rakefile
-- lib/redis/prescription.rb
-- lib/redis/prescription/version.rb
-- redis-prescription.gemspec
-homepage: https://github.com/ixti/redis-prescription
+- README.adoc
+- lib/redis-prescription.rb
+- lib/redis_prescription.rb
+- lib/redis_prescription/adapters.rb
+- lib/redis_prescription/adapters/redis.rb
+- lib/redis_prescription/adapters/redis_client.rb
+- lib/redis_prescription/errors.rb
+- lib/redis_prescription/version.rb
+homepage: https://gitlab.com/ixti/redis-prescription
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+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
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,16 +45,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Redis LUA stored procedure runner.
 test_files: []

data/.gitignore

@@ -1,10 +0,0 @@
-/Gemfile.lock
-
-/.autoenv.zsh
-/.bundle
-/.yardoc
-/_yardoc
-/coverage
-/doc
-/pkg
-/tmp

data/.rspec

@@ -1 +0,0 @@
---require spec_helper

data/.rubocop.yml

@@ -1,40 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.3
-  DisplayCopNames: true
-
-
-## Layout ######################################################################
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-
-Layout/IndentArray:
-  EnforcedStyle: consistent
-
-
-## Metrics #####################################################################
-
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-
-
-## Style #######################################################################
-
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-Style/RegexpLiteral:
-  EnforcedStyle: percent_r
-
-Style/RescueStandardError:
-  EnforcedStyle: implicit
-
-Style/SafeNavigation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/YodaCondition:
-  Enabled: false

data/.travis.yml

@@ -1,28 +0,0 @@
-language: ruby
-sudo: false
-
-services:
-  - redis-server
-
-cache: bundler
-
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-
-matrix:
-  fast_finish: true
-  include:
-    - rvm: 2.4
-      env: TEST_SUITE="rubocop"
-
-before_install:
-  - gem update --system
-  - gem --version
-  - gem install bundler --no-rdoc --no-ri
-  - bundle --version
-
-install: bundle install --without development doc
-
-script: bundle exec rake $TEST_SUITE

data/.yardopts

@@ -1,2 +0,0 @@
---markup-provider=redcarpet
---markup=markdown

data/Gemfile

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-ruby RUBY_VERSION
-
-gem "rake"
-gem "rspec"
-gem "rubocop", "~> 0.52.0", :require => false
-
-gem "redis"
-gem "redis-namespace"
-
-group :development do
-  gem "guard",         :require => false
-  gem "guard-rspec",   :require => false
-  gem "guard-rubocop", :require => false
-  gem "pry",           :require => false
-end
-
-group :test do
-  gem "codecov",    :require => false
-  gem "simplecov",  :require => false
-end
-
-group :doc do
-  gem "redcarpet"
-  gem "yard"
-end
-
-# Specify your gem's dependencies in redis-prescription.gemspec
-gemspec

data/Guardfile

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-guard :rspec, :cmd => "bundle exec rspec" do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end
-
-guard :rubocop do
-  watch(%r{.+\.rb$})
-  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
-end

data/Rakefile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-if ENV["CI"]
-  task :default => :spec
-else
-  task :default => %i[rubocop spec]
-end

data/lib/redis/prescription/version.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-class Redis
-  class Prescription
-    # Gem version.
-    VERSION = "1.0.0"
-  end
-end

data/lib/redis/prescription.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "prescription/version"
-
-# @see https://github.com/redis/redis-rb
-class Redis
-  # Lua script executor for redis.
-  #
-  # Instead of executing script with `EVAL` everytime - loads script once
-  # and then runs it with `EVALSHA`.
-  #
-  # @example Usage
-  #
-  #     script = Redis::Prescription.new("return ARGV[1] + ARGV[2]")
-  #     script.eval(Redis.current, :argv => [2, 2]) # => 2
-  class Prescription
-    # Script load command.
-    LOAD = "load"
-    private_constant :LOAD
-
-    # Redis error fired when script ID is unkown.
-    NOSCRIPT = "NOSCRIPT"
-    private_constant :NOSCRIPT
-
-    # LUA script source.
-    # @return [String]
-    attr_reader :source
-
-    # LUA script SHA1 digest.
-    # @return [String]
-    attr_reader :digest
-
-    # @param source [#to_s] Lua script.
-    def initialize(source)
-      @source = source.to_s.strip.freeze
-      @digest = Digest::SHA1.hexdigest(@source).freeze
-    end
-
-    # Loads script to redis.
-    # @param redis (see #namespaceless)
-    # @return [void]
-    def bootstrap!(redis)
-      digest = namespaceless(redis).script(LOAD, @source)
-      return if @digest == digest
-
-      # XXX: this may happen **ONLY** if script digesting will be
-      #   changed in redis, which is not likely gonna happen.
-      warn "[#{self.class}] Unexpected digest: " \
-        "#{digest.inspect} (expected: #{@digest.inspect})"
-
-      @digest = digest.freeze
-    end
-
-    # Executes script and returns result of execution.
-    # @param redis (see #namespaceless)
-    # @param keys [Array] keys to pass to the script
-    # @param argv [Array] arguments to pass to the script
-    # @return depends on the script
-    def eval(redis, keys: [], argv: [])
-      redis.evalsha(@digest, keys, argv)
-    rescue => e
-      raise unless e.message.include? NOSCRIPT
-
-      bootstrap!(redis)
-      redis.evalsha(@digest, keys, argv)
-    end
-
-    # Reads given file and returns new {Prescription} with its contents.
-    # @param file [String]
-    # @return [Prescription]
-    def self.read(file)
-      new File.read file
-    end
-
-    private
-
-    # Yields real namespace-less redis client.
-    # @param redis [Redis, Redis::Namespace]
-    # @return [Redis]
-    def namespaceless(redis)
-      if redis.is_a?(Redis)
-        redis
-      elsif defined?(Redis::Namespace) && redis.is_a?(Redis::Namespace)
-        redis.redis
-      else
-        raise TypeError, "Unsupported redis client type: #{redis.class}"
-      end
-    end
-  end
-end

data/redis-prescription.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require "redis/prescription/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "redis-prescription"
-  spec.version       = Redis::Prescription::VERSION
-  spec.authors       = ["Alexey Zapparov"]
-  spec.email         = ["ixti@member.fsf.org"]
-
-  spec.summary       = "Redis LUA stored procedure runner."
-  spec.description   = <<~DESCRIPTION
-    Preloads (and reloads when needed, e.g. when scripts
-    were flushed away) script and then runs it with `EVALSHA`.
-  DESCRIPTION
-
-  spec.homepage      = "https://github.com/ixti/redis-prescription"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-end