redis_lua_script 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6bff5852216da649ba066217fd1a5667703d61cdfdec54905992a38cb1bd649f
+  data.tar.gz: 3517ccc6e0f1afe441167d3344ccf5ded1004d897d9620ce7576edb03df6a123
+SHA512:
+  metadata.gz: ee056fef4a44e200f854f985721789c794bf31c25d9786c93534bb48b78c72b4f570624ce126531ab0fbf3ed4a95dd9ad0b7b64c73a3ee3cc766f17becebe986
+  data.tar.gz: 06ad63688692bf5f0cd5064dfbbc77a53d0438295c812ef7b9e93dc6d905b58f11f5fa580ae55b486908601b12a08b8aaff8f72fd4989fa404ef3c256a8daf48

data/lib/redis/lua_script/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  class LuaScript
+    VERSION = "0.0.1"
+  end
+end

data/lib/redis/lua_script.rb

@@ -0,0 +1,51 @@
+require "digest"
+require "redis"
+require "redis/lua_script/version"
+
+class Redis
+  class LuaScript
+    attr_reader :source
+
+    def initialize(source)
+      @source = source.dup.freeze
+    end
+
+    def sha
+      @sha ||= Digest::SHA1.hexdigest(minify).freeze
+    end
+
+    def eval(redis, *args)
+      redis.evalsha(sha, *args)
+    rescue Redis::CommandError => e
+      raise unless e.message.include?("NOSCRIPT")
+
+      # fall back to regular eval, which will trigger
+      # script to be cached for next time
+      redis.eval(minify, *args)
+    end
+
+    def load(redis)
+      redis.script(:load, minify).tap do |sha|
+        unless sha == self.sha
+          raise "unexpected script SHA: expected #{self.sha}, got #{sha}"
+        end
+      end
+    end
+
+    def loaded?(redis)
+      redis.script(:exists, sha)
+    end
+
+    def to_s
+      source
+    end
+
+    private
+
+    def minify
+      # trim comments (whole line and partial)
+      # and whitespace (prefix and empty lines)
+      @minify ||= source.gsub(/^\s*--.*\n|\s*--.*|^\s*|^$\n/, "").chomp.freeze
+    end
+  end
+end

data/lib/redis_lua_script.rb

@@ -0,0 +1 @@
+require "redis/lua_script"

data/spec/lua_script_spec.rb

@@ -0,0 +1,109 @@
+describe Redis::LuaScript do
+  subject { Redis::LuaScript.new("return redis.call('PING')") }
+
+  before { redis.script(:flush) }
+
+  let(:redis) { Redis.new }
+
+  it { is_expected.to be_a Redis::LuaScript }
+
+  describe "#eval" do
+    def ping
+      expect(subject.eval(redis)).to eq "PONG"
+    end
+
+    it { ping }
+
+    it "loads the script into redis" do
+      expect(redis).to receive(:evalsha).once.and_call_original
+      expect(redis).to receive(:eval).once.and_call_original
+      ping
+      expect(subject.loaded?(redis)).to be true
+    end
+  end
+
+  describe "#load" do
+    it "loads script into redis" do
+      expect(redis.script(:exists, subject.sha)).to be false
+      subject.load(redis)
+      expect(redis.script(:exists, subject.sha)).to be true
+    end
+
+    it "returns the sha" do
+      expect(subject.load(redis)).to eq subject.sha
+    end
+
+    it "validates the returned sha" do
+      allow(redis).to receive(:script).with(:flush).and_call_original
+      expect(redis).to receive(:script).with(:load, String).and_return("abc")
+      expect { subject.load(redis) }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe "#loaded?" do
+    it do
+      expect(subject.loaded?(redis)).to be false
+      subject.load(redis)
+      expect(subject.loaded?(redis)).to be true
+    end
+  end
+
+  describe "#to_s" do
+    it { expect(subject.to_s).to be subject.source }
+  end
+
+  describe "#minify" do
+    subject { Redis::LuaScript.new(lua) }
+
+    shared_examples "minified lua" do
+      it do
+        expect(subject.send(:minify)).to eq expected
+      end
+    end
+
+    context do
+      let(:lua) do <<-LUA
+          -- this comment gets removed
+          return redis.call('PING')  -- this one too
+        LUA
+      end
+
+      let(:expected) { "return redis.call('PING')" }
+
+      it_behaves_like "minified lua"
+
+      it "executes properly" do
+        expect(subject.eval(redis)).to eq "PONG"
+      end
+    end
+
+    context "with if statement" do
+      let(:lua) do <<~LUA
+          local val = tonumber(ARGV[1])
+          if val > 123 then
+            return val
+          end
+
+          return 123
+        LUA
+      end
+
+      let(:expected) do
+        [
+          "local val = tonumber(ARGV[1])",
+          "if val > 123 then",
+          "return val",
+          "end",
+          "return 123",
+        ].join "\n"
+      end
+
+      it_behaves_like "minified lua"
+
+      it "executes properly" do
+        expect(subject.eval(redis, [], [ 0 ])).to eq 123
+        expect(subject.eval(redis, [], [ 999 ])).to eq 999
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: redis_lua_script
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Pepper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Redis Lua script optimization
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/redis/lua_script.rb
+- lib/redis/lua_script/version.rb
+- lib/redis_lua_script.rb
+- spec/lua_script_spec.rb
+homepage: https://github.com/dpep/redis_lua_script_rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Redis::LuaScript
+test_files:
+- spec/lua_script_spec.rb