redis-lua 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6d170cfb2288e3cd04b8bb5963f5e6e4c6056a7
+  data.tar.gz: e250f67f25adf641d2734c242db5bbea5fb5e065
+SHA512:
+  metadata.gz: a4e94191e274b5f235a6e0a652175eff40a57b1d5e78581be0eda3db7ffecea57c22a60e875c6c8b106a969f503c2e6e877224d864c41f6d95734887344bf5ea
+  data.tar.gz: d9bf3e4805d4c3076373152cada03467d0d4e112b64500226108d265cba36a4857a4871dff79ed40ec703d04dd18aca2ae411d53a4d0f10e061a0e89562991ca

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-lua.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Hanks
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Redis::Lua
+
+Adds a few methods to Ruby's Redis class to make handling Lua scripts a bit easier.
+
+    # When your application initializes:
+    $redis = Redis.new
+    $redis.register_script(:my_script, "return 1")
+
+    # Later...
+    $redis.run_script(:my_script) #=> 1
+
+You can also put scripts in their own files:
+
+    # scripts/my_file_script.lua
+    return 3
+
+    # In your app:
+    $redis.register_script_files('./scripts/*')
+    $redis.run_script(:my_file_script) #=> 3
+
+This lets you manage your Lua scripts in version control with the rest of your app, so you don't need to worry about loading them manually. If Redis' script cache is lost, they'll be automatically reloaded as needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-lua'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-lua
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :default do |spec|
+  spec.pattern = './spec/**/*_spec.rb'
+end

data/lib/redis/lua.rb

@@ -0,0 +1,57 @@
+require 'redis'
+require 'digest/sha1'
+
+class Redis
+  module Lua
+    Version = '0.1.0'
+
+    def run_script(name, *args)
+      raise "Nonexistent Lua script!" unless s = scripts.find { |script| script.name == name }
+
+      case @client
+      when Client
+        begin
+          evalsha s.sha, *args
+        rescue CommandError => e
+          raise unless e.message =~ /\ANOSCRIPT/
+          script :load, s.text
+          evalsha s.sha, *args
+        end
+      when Pipeline
+        # When pipelining or in a transaction block, an error will abort the
+        # whole thing and there's no way to check whether the script has
+        # already been loaded. So, to be safe, just eval the script text.
+        eval s.text, *args
+      end
+    end
+
+    def register_script(name, text)
+      script = Script.new(name, text)
+      scripts << script
+      script
+    end
+
+    def register_script_files(glob)
+      Dir[glob].map do |filename|
+        script_name = filename.split('/').last.split('.').first
+        register_script script_name, File.read(filename)
+      end
+    end
+
+    def scripts
+      @scripts ||= []
+    end
+
+    class Script
+      attr_reader :name, :text, :sha
+
+      def initialize(name, text)
+        @name = name.to_sym
+        @text = text.dup.freeze
+        @sha  = Digest::SHA1.hexdigest(text).freeze
+      end
+    end
+  end
+
+  include Lua
+end

data/redis-lua.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis/lua'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis-lua'
+  spec.version       = Redis::Lua::Version
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ['christopher.m.hanks@gmail.com']
+  spec.description   = %q{A few more methods for the Redis class to make Lua script usage cleaner.}
+  spec.summary       = %q{Cleaner Lua script usage with redis-rb.}
+  spec.homepage      = 'https://github.com/chanks/redis-lua'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'redis'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'redis-pool'
+end

data/spec/lua_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe Redis do
+  describe "#register_script" do
+    it "should remember a Lua script for execution" do
+      script = $redis.register_script 'my_script', "return 1"
+      script.should be_an_instance_of Redis::Script
+      $redis.scripts.should == [script]
+
+      script.text.should == "return 1"
+      script.text.should be_frozen
+
+      script.name.should == :my_script
+
+      script.sha.should == 'e0e1f9fabfc9d4800c877a703b823ac0578ff8db'
+      script.sha.should be_frozen
+    end
+  end
+
+  describe "#register_script_files" do
+    it "should register the scripts in a glob of files, using their filenames as script names" do
+      result = $redis.register_script_files './spec/support/scripts/*'
+      result.length.should be 2
+      result.each { |s| s.should be_an_instance_of Redis::Script }
+      result.should == $redis.scripts
+
+      one, two = result.sort_by(&:name)
+      one.name.should == :one
+      one.text.should == "return 1\n"
+      one.sha.should  == "48df9b519ca145c867b895f740b37bd891e887af"
+
+      two.name.should == :two
+      two.text.should == "return 2\n"
+      two.sha.should  == "b7ac6454df41a85df39e338f3e08cce31719ab72"
+    end
+  end
+
+  describe "#run_script" do
+    before do
+      $redis.register_script 'argless', "return 1"
+      $redis.register_script 'onearg',  "return ARGV[1] + 1"
+      $redis.register_script 'twoargs', "return ARGV[1] + ARGV[2]"
+    end
+
+    it "should load and execute a Lua script that hasn't been run before" do
+      $redis.run_script(:argless).should == 1
+      $redis.run_script(:onearg, :argv => [3]).should == 4
+      $redis.run_script(:twoargs, :argv => [4, 5]).should == 9
+    end
+
+    it "should execute a Lua script that's been loaded and run before" do
+      sha = $redis.script :load, "return 1"
+      $redis.run_script(:argless).should == 1
+    end
+
+    it "with an unregistered Lua script should raise an error" do
+      proc{$redis.run_script :nonexistent_script}.should raise_error RuntimeError, /Nonexistent Lua script!/
+    end
+
+    it "should gracefully handle a loss of the script cache" do
+      $redis.run_script(:argless).should == 1
+      $redis.script(:flush)
+      $redis.run_script(:argless).should == 1
+    end
+
+    it "in a transaction should execute a Lua script that hasn't been run before without losing the transaction" do
+      result = nil
+
+      $redis.multi do
+        $redis.incr 'key'
+        result = $redis.run_script :argless
+      end
+
+      $redis.get('key').should == '1'
+      result.class.should == Redis::Future
+      result.value.should == 1
+    end
+
+    it "in a pipeline should execute a Lua script that hasn't been run before" do
+      result = nil
+
+      $redis.pipelined do
+        $redis.incr 'key'
+        result = $redis.run_script :argless
+      end
+
+      $redis.get('key').should == '1'
+      result.class.should == Redis::Future
+      result.value.should == 1
+    end
+  end
+end
+
+describe Redis::Pool do
+  it "should work as expected" do
+    $redis_pool.register_script(:my_script, 'return 1')
+
+    10.times.map do
+      Thread.new do
+        10.times do
+          $redis_pool.run_script(:my_script).should == 1
+        end
+      end
+    end.each(&:join)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'redis/lua'
+require 'redis/pool'
+
+RSpec.configure do |config|
+  config.before do
+    $redis.flushdb
+    $redis.script :flush
+    $redis.scripts.clear
+    $redis_pool.scripts.clear
+  end
+end
+
+$redis      = Redis.new
+$redis_pool = Redis::Pool.new(:size => 5)

data/spec/support/scripts/one.lua

@@ -0,0 +1 @@
+return 1

data/spec/support/scripts/two

@@ -0,0 +1 @@
+return 2

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: redis-lua
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Hanks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-21 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: redis-pool
+  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: A few more methods for the Redis class to make Lua script usage cleaner.
+email:
+- christopher.m.hanks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis/lua.rb
+- redis-lua.gemspec
+- spec/lua_spec.rb
+- spec/spec_helper.rb
+- spec/support/scripts/one.lua
+- spec/support/scripts/two
+homepage: https://github.com/chanks/redis-lua
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Cleaner Lua script usage with redis-rb.
+test_files:
+- spec/lua_spec.rb
+- spec/spec_helper.rb
+- spec/support/scripts/one.lua
+- spec/support/scripts/two