redis-scripting 1.0.0

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,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Palmer
+
+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,57 @@
+# Redis::Scripting
+
+Utilities built on redis-rb for using Redis Lua scripting.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis-scripting'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-scripting
+
+## Usage
+
+Given a directory of lua scripts, you can create an object to run those
+scripts with:
+
+    > redis = Redis.new()
+    > scripts = Redis::Scripting::Module.new(redis, "/path/to/myscripts")
+
+Then you can run a script "do_work.lua" with:
+
+    > scripts.run(:do_work, [keys], [argv])
+
+See http://redis.io/commands/eval for details on the keys and argv
+params, along with more details on lua in redis. To save bandwidth this
+will use evalsha to run the script, and fallback to eval if the script
+is not yet loaded in redis.
+
+If your scripts directory "myscripts" has a "myscripts/includes"
+subdirectory, any .lua files in that subdirectory will be prepended to
+every .lua script in "myscripts" as a primitive form of extracting
+library code. For instance if your folder structure is:
+
+    - myscripts/
+      - script1.lua
+      - script2.lua
+      - includes/
+        - common.lua
+        - more.lua
+
+Then script1 and script2 will automatically have common.lua and then
+more.lua prepended to it.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/redis/scripting.rb

@@ -0,0 +1,7 @@
+require "redis/scripting/module"
+require "redis/scripting/version"
+
+class Redis
+  module Scripting
+  end
+end

data/lib/redis/scripting/module.rb

@@ -0,0 +1,48 @@
+require "redis"
+require "redis/scripting/script"
+
+class Redis
+module Scripting
+
+class Module
+  attr_reader :source_dir
+  attr_accessor :redis
+
+  def initialize(redis, source_dir, opts = {})
+    @redis = redis
+    @source_dir = source_dir
+    @scripts = {}
+    load_scripts()
+  end
+
+  def run(script_name, keys, argv)
+    script = @scripts[script_name.to_s]
+    raise(ArgumentError, "unknown script: #{script_name}") unless script
+
+    script.run(redis, keys, argv)
+  end
+
+  def inspect
+    %{<%s: 0x%x @source_dir="%s" @redis=%s>} % [self.class, object_id, source_dir, redis]
+  end
+
+  private
+
+  def load_scripts
+    headers = Dir.glob(File.join(source_dir, "includes", "*.lua")).map { |include_name|
+      File.read(include_name)
+    }
+
+    if !headers.empty?
+      header_source = headers.join("\n\n") + "\n\n"
+    end
+
+    Dir.glob(File.join(source_dir, "*.lua")).each do |filename|
+      script = Redis::Scripting::Script.new(filename, script_header: header_source)
+      @scripts[script.name] = script
+    end
+  end
+end
+
+end
+end

data/lib/redis/scripting/script.rb

@@ -0,0 +1,33 @@
+require 'openssl'
+
+class Redis
+module Scripting
+
+class Script
+  attr_reader :source_filename, :source, :name
+
+  def initialize(source_filename, opts = {})
+    @source_filename = source_filename
+    @source = File.read(source_filename)
+    if opts[:script_header]
+      @source = "#{opts[:script_header]}\n\n#{@source}"
+    end
+    @name = File.basename(source_filename, ".lua")
+  end
+
+  def run(redis, keys, argv)
+    begin
+      redis.evalsha(self.sha, keys: keys, argv: argv)
+    rescue Redis::CommandError => err
+      raise unless err.message.start_with?("NOSCRIPT")
+      redis.eval(self.source, keys: keys, argv: argv)
+    end
+  end
+
+  def sha
+    @sha ||= OpenSSL::Digest::SHA1.hexdigest(source)
+  end
+end
+
+end
+end

data/lib/redis/scripting/version.rb

@@ -0,0 +1,5 @@
+class Redis
+  module Scripting
+    VERSION = "1.0.0"
+  end
+end

data/redis-scripting.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/scripting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-scripting"
+  spec.version       = Redis::Scripting::VERSION
+  spec.authors       = ["Brian Palmer"]
+  spec.email         = ["brianp@instructure.com"]
+  spec.summary       = %q{Utilities built on redis-rb for using Redis Lua scripting.}
+  spec.homepage      = "https://github.com/codekitchen/redis-rb-scripting"
+  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", ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/redis/scripting/module_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Redis::Scripting::Module do
+  let(:redis) { double('Redis') }
+  let(:source_dir) { File.dirname(__FILE__) + "/scripts" }
+  let(:subject) { Redis::Scripting::Module.new(redis, source_dir) }
+
+  its(:source_dir) { should == source_dir }
+  its(:redis) { should == redis }
+
+  describe "#run" do
+    it "should raise on unknown" do
+      expect { subject.run(:whut, [], []) }.to raise_error(ArgumentError)
+    end
+  end
+end
+

data/spec/redis/scripting/script_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Redis::Scripting::Script do
+  let(:source_filename) { File.dirname(__FILE__) + "/scripts/test1.lua" }
+
+  context "no header" do
+    let(:subject) { Redis::Scripting::Script.new(source_filename) }
+
+    its(:name) { should == "test1" }
+    its(:source) { should == File.read(source_filename) }
+    its(:sha) { should == OpenSSL::Digest::SHA1.hexdigest(subject.source) }
+  end
+
+  context "header" do
+    let(:header) { "local x = 5" }
+    let(:subject) { Redis::Scripting::Script.new(source_filename, script_header: header) }
+
+    its(:source) { should == "#{header}\n\n#{File.read(source_filename)}" }
+    its(:sha) { should == OpenSSL::Digest::SHA1.hexdigest(subject.source) }
+  end
+
+  describe "#run" do
+    let(:subject) { Redis::Scripting::Script.new(source_filename) }
+
+    it "should evalsha first" do
+      redis = double('Redis')
+      expect(redis).to receive(:evalsha).with(subject.sha, keys: ['a'], argv: ['b']) { 1 }
+      subject.run(redis, ['a'], ['b']).should == 1
+    end
+
+    it "should eval if evalsha raises NOSCRIPT" do
+      redis = double('Redis')
+      expect(redis).to receive(:evalsha) { raise(Redis::CommandError, "NOSCRIPT doesn't exist") }
+      expect(redis).to receive(:eval).with(subject.source, keys: ['a'], argv: ['b']) { 1 }
+      subject.run(redis, ['a'], ['b']).should == 1
+    end
+  end
+end

data/spec/redis/scripting/scripts/test1.lua

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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'redis/scripting'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: redis-scripting
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Palmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brianp@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis/scripting.rb
+- lib/redis/scripting/module.rb
+- lib/redis/scripting/script.rb
+- lib/redis/scripting/version.rb
+- redis-scripting.gemspec
+- spec/redis/scripting/module_spec.rb
+- spec/redis/scripting/script_spec.rb
+- spec/redis/scripting/scripts/test1.lua
+- spec/spec_helper.rb
+homepage: https://github.com/codekitchen/redis-rb-scripting
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -614399944501012724
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -614399944501012724
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Utilities built on redis-rb for using Redis Lua scripting.
+test_files:
+- spec/redis/scripting/module_spec.rb
+- spec/redis/scripting/script_spec.rb
+- spec/redis/scripting/scripts/test1.lua
+- spec/spec_helper.rb