wolverine 0.0.1 → 0.0.2

data/README

@@ -0,0 +1,52 @@
+# Wolverine
+
+Wolverine is a simple library to allow you to manage and run redis server-side lua scripts from a rails app, or other ruby code.
+
+## What are you talking about?
+
+Redis versions 2.6 and up allow lua scripts to be run on the server that execute atomically and very, very quickly.
+
+This is really, really cool.
+
+Wolverine is a wrapper around that functionality, to package it up in a format more familiar to a Rails codebase.
+
+## How do I use it?
+
+1) Make sure you have redis 2.6 or higher installed. As of now, that means compiling from source.
+
+    git clone https://github.com/antirez/redis.git
+    cd redis && make
+    ./src/redis-server
+
+2) Add wolverine to your gemfile
+
+    gem 'wolverine'
+
+3) Add your lua scripts to `app/redis`
+
+    # app/redis/util/mexists.lua
+    local exists = {}
+    local existence
+    for _, key in ipairs(KEYS) do
+      table.insert(exists, redis.call('exists', key))
+    end
+    return exists
+
+4) Call from your code:
+
+    Wolverine.call('util/mexists', 'key1', 'key2', 'key3') #=> [0, 1, 0]
+
+## More information
+
+For more information on scripting redis with lua, refer to redis' excellent documentation: http://redis.io/commands/eval
+
+## License
+
+Copyright (C) 2012 Shopify
+
+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,52 @@
+# Wolverine
+
+Wolverine is a simple library to allow you to manage and run redis server-side lua scripts from a rails app, or other ruby code.
+
+## What are you talking about?
+
+Redis versions 2.6 and up allow lua scripts to be run on the server that execute atomically and very, very quickly.
+
+This is really, really cool.
+
+Wolverine is a wrapper around that functionality, to package it up in a format more familiar to a Rails codebase.
+
+## How do I use it?
+
+1) Make sure you have redis 2.6 or higher installed. As of now, that means compiling from source.
+
+    git clone https://github.com/antirez/redis.git
+    cd redis && make
+    ./src/redis-server
+
+2) Add wolverine to your gemfile
+
+    gem 'wolverine'
+
+3) Add your lua scripts to `app/redis`
+
+    -- app/redis/util/mexists.lua
+    local exists = {}
+    local existence
+    for _, key in ipairs(KEYS) do
+      table.insert(exists, redis.call('exists', key))
+    end
+    return exists
+
+4) Call from your code:
+
+    Wolverine.call('util/mexists', 'key1', 'key2', 'key3') #=> [0, 1, 0]
+
+## More information
+
+For more information on scripting redis with lua, refer to redis' excellent documentation: http://redis.io/commands/eval
+
+## License
+
+Copyright (C) 2012 Shopify
+
+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/lib/wolverine.rb

@@ -1,46 +1,25 @@
-require "wolverine/version"
 require 'redis'
 
-module Wolverine
-  def self.script_path
-    Rails.root + 'app/redis'
-  end
+require "wolverine/version"
+require 'wolverine/configuration'
+require 'wolverine/script'
 
-  def self.call(file, *args)
-    file << ".lua" unless file =~ /\.lua$/
-    LuaFile.new(script_path + file).call(redis, *args)
+module Wolverine
+  def self.config
+    @config ||= Configuration.new
   end
 
   def self.redis
-    $redis ||= Redis.new
+    config.redis
   end
 
-  class LuaFile
-    attr_reader :content, :digest
-    def initialize file
-      @content = load_lua file
-      @digest = Digest::SHA1.hexdigest @content
-    end
-
-    def call redis, *args
-      run_evalsha redis, *args
-    rescue => e
-      e.message =~ /NOSCRIPT/ ? run_eval(redis, *args) : raise
-    end
-
-    private
-
-    def run_evalsha redis, *args
-      redis.evalsha digest, args.size, *args
-    end
-
-    def run_eval redis, *args
-      redis.eval content, args.size, *args
-    end
+  def self.call(file, *args)
+    Script.new(full_path(file)).call(redis, *args)
+  end
 
-    def load_lua file
-      File.read file
-    end
+  def self.full_path(file)
+    file << ".lua" unless file =~ /\.lua$/
+    config.script_path + file
   end
 
 end

data/lib/wolverine/configuration.rb

@@ -0,0 +1,11 @@
+module Wolverine
+  class Configuration < Struct.new(:redis, :script_path)
+    def redis
+      super || @redis ||= Redis.new
+    end
+
+    def script_path
+      super || @script_path ||= Rails.root + 'app/redis'
+    end
+  end
+end

data/lib/wolverine/script.rb

@@ -0,0 +1,31 @@
+module Wolverine
+  class Script
+    attr_reader :content, :digest
+    def initialize file
+      @content = load_lua file
+      @digest = Digest::SHA1.hexdigest @content
+    end
+
+    def call redis, *args
+      run_evalsha redis, *args
+    rescue => e
+      e.message =~ /NOSCRIPT/ ? run_eval(redis, *args) : raise
+    end
+
+    private
+
+    def run_evalsha redis, *args
+      redis.evalsha digest, args.size, *args
+    end
+
+    def run_eval redis, *args
+      redis.eval content, args.size, *args
+    end
+
+    def load_lua file
+      File.read file
+    end
+
+  end
+end
+

data/lib/wolverine/version.rb

@@ -1,3 +1,3 @@
 module Wolverine
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'mocha'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'wolverine'

data/test/wolverine/configuration_test.rb

@@ -0,0 +1,35 @@
+require_relative '../test_helper'
+require 'pathname'
+
+module Rails
+  def self.root
+    Pathname.new('foo')
+  end
+end
+
+module Wolverine
+  class ConfigurationTest < MiniTest::Unit::TestCase
+
+    def test_default_redis
+      assert_instance_of Redis, Wolverine::Configuration.new.redis
+    end
+
+    def test_default_script_path
+      actual = Wolverine::Configuration.new.script_path
+      assert_equal Pathname.new('foo/app/redis'), actual
+    end
+
+    def test_setting_redis
+      config = Wolverine::Configuration.new
+      config.redis = :foo
+      assert_equal :foo, config.redis
+    end
+
+    def test_setting_script_path
+      config = Wolverine::Configuration.new
+      config.script_path = :foo
+      assert_equal :foo, config.script_path
+    end
+
+  end
+end

data/test/wolverine/script_test.rb

@@ -0,0 +1,51 @@
+require_relative '../test_helper'
+require 'digest/sha1'
+
+module Wolverine
+  class ScriptTest < MiniTest::Unit::TestCase
+    CONTENT = "return 1"
+    DIGEST = Digest::SHA1.hexdigest(CONTENT)
+
+    def setup
+      Wolverine::Script.any_instance.stubs(load_lua: CONTENT)
+    end
+
+    def script
+      @script ||= Wolverine::Script.new('file1')
+    end
+
+    def test_digest_and_content
+      content = "return 1" 
+      assert_equal CONTENT, script.content
+      assert_equal DIGEST, script.digest
+    end
+
+    def test_call_with_cache_hit
+      tc = self
+      redis = Class.new do
+        define_method(:evalsha) do |digest, size, *args|
+          tc.assert_equal DIGEST, digest
+          tc.assert_equal 2, size
+          tc.assert_equal [:a, :b], args
+        end
+      end
+      script.call(redis.new, :a, :b)
+    end
+
+    def test_call_with_cache_miss
+      tc = self
+      redis = Class.new do
+        define_method(:evalsha) do |*|
+          raise "NOSCRIPT No matching script. Please use EVAL."
+        end
+        define_method(:eval) do |content, size, *args|
+          tc.assert_equal CONTENT, content
+          tc.assert_equal 2, size
+          tc.assert_equal [:a, :b], args
+        end
+      end
+      script.call(redis.new, :a, :b)
+    end
+
+  end
+end

data/test/wolverine_test.rb

@@ -0,0 +1,25 @@
+require_relative 'test_helper'
+
+class WolverineTest < MiniTest::Unit::TestCase
+
+  def setup
+    Wolverine.config.redis = :redis
+    Wolverine.config.script_path = Pathname.new('foo')
+  end
+
+  def test_adds_extension_if_none_present
+    assert_equal Pathname.new('foo/bar.lua'), Wolverine.full_path('bar')
+  end
+
+  def test_redis
+    assert_equal :redis, Wolverine.redis
+  end
+
+  def test_call
+    script = stub
+    script.expects(:call).with(:redis, :a, :b).returns(:return)
+    Wolverine::Script.expects(:new).with(Pathname.new('foo/bar.lua')).returns(script)
+    assert_equal :return, Wolverine.call('bar', :a, :b)
+  end
+
+end

data/wolverine.gemspec

@@ -19,4 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'redis'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'minitest'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wolverine
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70192619258840 !ruby/object:Gem::Requirement
+  requirement: &70114961106680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,29 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70192619258840
+  version_requirements: *70114961106680
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70114961105880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70114961105880
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70114961105380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70114961105380
 description: Wolverine provides a simple way to run server-side redis scripts from
   a rails app
 email:
@@ -32,9 +54,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README
+- README.md
 - Rakefile
 - lib/wolverine.rb
+- lib/wolverine/configuration.rb
+- lib/wolverine/script.rb
 - lib/wolverine/version.rb
+- test/test_helper.rb
+- test/wolverine/configuration_test.rb
+- test/wolverine/script_test.rb
+- test/wolverine_test.rb
 - wolverine.gemspec
 homepage: ''
 licenses: []
@@ -61,4 +91,8 @@ signing_key:
 specification_version: 3
 summary: Wolverine provides a simple way to run server-side redis scripts from a rails
   app
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/wolverine/configuration_test.rb
+- test/wolverine/script_test.rb
+- test/wolverine_test.rb