wolverine 0.3.0 → 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c5fc98fc36182dede7420bff6d5cb3d472beae1
+  data.tar.gz: 1ba28844128a4f9684425a1661f93b0a3631fe08
+SHA512:
+  metadata.gz: 9de7a79b487864c018a94ea8dd333b1d46f756dfffa4f2f33398413053d4746505717b50170218a124d61ce30bf45670d15af3f906f818fadd1f393dec3a4658
+  data.tar.gz: 3777478645a4f36720d46604e47722b671b2734a6d0d3a23c4a8a3edd163b4ca282399ef6f87e6660b407f4f8ec481773803835774fa3c911e5a15350528e170

data/README.md

@@ -4,18 +4,14 @@ Wolverine is a simple library to allow you to manage and run redis server-side l
 
 Redis versions 2.6 and up allow lua scripts to be run on the server that execute atomically and very quickly.
 
-This is *extremely* useful.
-
 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:
+1) Make sure you have redis 2.6 or higher installed.
 
-```shell
-git clone https://github.com/antirez/redis.git
-cd redis && make
-./src/redis-server
+```
+redis-server -v
 ```
 
 2) Add wolverine to your Gemfile:
@@ -39,12 +35,56 @@ return exists
 4) Call wolverine from your code:
 
 ```ruby
-Wolverine.util.mexists('key1', 'key2', 'key3') #=> [0, 1, 0]
+Wolverine.util.mexists(['key1', 'key2', 'key3']) #=> [0, 1, 0]
+```
+
+Or
+
+```ruby
+Wolverine.util.mexists(:keys => ['key1', 'key2', 'key3']) #=> [0, 1, 0]
 ```
 
 Methods are available on `Wolverine` paralleling the directory structure
 of wolverine's `script_path`.
 
+#### Nested Lua Scripts
+
+For lua scripts with shared code, Wolverine supports ERB style templating.
+
+If your app has lua scripts at
+
+- `app/wolverine/do_something.lua`
+- `app/wolverine/do_something_else.lua`
+
+that both have shared lua code, you can factor it out into a lua "partial":
+
+- `app/wolverine/shared/_common.lua`
+
+```lua
+-- app/wolverine/shared/_common.lua
+local function complex_redis_command(key, value)
+  local dict = {}
+  dict[key] = value
+end
+```
+
+```lua
+-- app/wolverine/do_something.lua
+<%= include_partial 'shared/_common.lua' %>
+complex_redis_command("foo", "bar")
+return true
+```
+
+```lua
+-- app/wolverine/do_something_else.lua
+<%= include_partial 'shared/_common.lua' %>
+complex_redis_command("bar", "baz")
+return false
+```
+
+- partials are loaded relative to the `Wolverine.config.script_path` location
+- partials can be protected by adding an underscore (eg. `shared/_common.lua`). This disallows EVAL access through `Wolverine.shared._common`
+
 ## Configuration
 
 Available configuration options:
@@ -59,13 +99,3 @@ If you want to override one or more of these, doing so in an initializer is reco
 
 For more information on scripting redis with lua, refer to redis' excellent documentation: http://redis.io/commands/eval
 
-## License
-
-Copyright (C) 2012 [Shopify](http://shopify.com) by [Burke Libbey](http://burkelibbey.org)
-
-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

@@ -23,6 +23,14 @@ class Wolverine
     config.redis
   end
 
+  def self.statsd_enabled?
+    @statsd_enabled
+  end
+
+  def self.enable_statsd!
+    @statsd_enabled = true
+  end
+
   # Resets all the scripts cached by Wolverine. Scripts are lazy-loaded and
   # cached in-memory, so if a file changes on disk, it will be necessary to
   # manually reset the cache using +reset!+.
@@ -30,6 +38,7 @@ class Wolverine
   # @return [void]
   def self.reset!
     @root_directory = nil
+    reset_cached_methods
   end
 
   # Used to handle dynamic accesses to scripts. Successful lookups will be
@@ -58,10 +67,17 @@ class Wolverine
 
   def reset!
     @root_directory = nil
+    reset_cached_methods
   end
 
   def method_missing sym, *args
-    root_directory.send(sym, *args)
+    # Disallow access to protected partials (files that begin with _ character)
+    if sym[0] == '_'
+      super
+    else
+      root_directory.send(sym, *args)
+    end
+    
   rescue PathComponent::MissingTemplate
     super
   end
@@ -69,11 +85,31 @@ class Wolverine
   private
 
   def self.root_directory
-    @root_directory ||= PathComponent.new(config.script_path)
+    @root_directory ||= PathComponent.new(config.script_path, {:cache_to => self})
+  end
+
+  def self.cached_methods
+    @cached_methods ||= Hash.new
+  end
+
+  def self.reset_cached_methods
+    metaclass = class << self; self; end
+    cached_methods.each_key { |method| metaclass.send(:undef_method, method) }
+    cached_methods.clear
   end
 
   def root_directory
-    @root_directory ||= PathComponent.new(config.script_path, {:config => config, :redis => redis})
+    @root_directory ||= PathComponent.new(config.script_path, {:cache_to => self, :config => config, :redis => redis})
+  end
+
+  def cached_methods
+    @cached_methods ||= Hash.new
+  end
+
+  def reset_cached_methods
+    metaclass = class << self; self; end
+    cached_methods.each_key { |method| metaclass.send(:undef_method, method) }
+    cached_methods.clear
   end
 
 end

data/lib/wolverine/path_component.rb

@@ -18,6 +18,7 @@ class Wolverine
     def initialize path, options = {}
       @path = path
       @options = options
+      @cache_to = options[:cache_to]
       @redis = options[:redis] || Wolverine.redis
       @config = options[:config] || Wolverine.config
     end
@@ -53,15 +54,19 @@ class Wolverine
     end
 
     def define_directory_method path, sym
-      dir = PathComponent.new(path, @options)
-      define_metaclass_method(sym) { dir }
+      options = @options.merge({:cache_to => nil})
+      dir = PathComponent.new(path, options)
+      cb = proc { dir }
+      define_metaclass_method(sym, &cb)
+      cache_metaclass_method(sym, &cb)
     end
 
     def define_script_method path, sym, *args
-      script = Wolverine::Script.new(path, @options)
-      define_metaclass_method(sym) { |*args|
-        script.call(@redis, *args)
-      }
+      redis, options = @redis, @options.merge({:cache_to => nil})
+      script = Wolverine::Script.new(path, options)
+      cb = proc { |*args| script.call(redis, *args) }
+      define_metaclass_method(sym, &cb) 
+      cache_metaclass_method(sym, &cb)
     end
 
     def define_metaclass_method sym, &block
@@ -69,6 +74,15 @@ class Wolverine
       metaclass.send(:define_method, sym, &block)
     end
 
+    def cache_metaclass_method sym, &block
+      unless @cache_to.nil?
+        metaclass = class << @cache_to; self; end
+        metaclass.send(:define_method, sym, &block)
+        cached_methods = @cache_to.send(:cached_methods)
+        cached_methods[sym] = self
+      end
+    end
+
   end
 
 end

data/lib/wolverine/script.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'benchmark'
 require 'digest/sha1'
+require 'erb'
 
 class Wolverine
   # {Script} represents a lua script in the filesystem. It loads the script
@@ -30,6 +31,7 @@ class Wolverine
     # @raise [LuaError] if the script failed to compile of encountered a
     #   runtime error
     def call redis, *args
+      t = Time.now
       begin
         run_evalsha redis, *args
       rescue => e
@@ -41,19 +43,26 @@ class Wolverine
       else
         raise
       end
+    ensure
+      StatsD.measure(statsd_key, (Time.now - t) * 1000, 0.001) if Wolverine.statsd_enabled?
     end
 
     private
 
+    def statsd_key
+      k = @file.relative_path_from(Wolverine.config.script_path).to_s.sub!(/\.lua$/,'').gsub!(/\//,'.')
+      "Wolverine.#{k}"
+    end
+
     def run_evalsha redis, *args
       instrument :evalsha do
-        redis.evalsha @digest, args.size, *args
+        redis.evalsha @digest, *args
       end
     end
 
     def run_eval redis, *args
       instrument :eval do
-        redis.eval @content, args.size, *args
+        redis.eval @content, *args
       end
     end
 
@@ -69,7 +78,22 @@ class Wolverine
     end
 
     def load_lua file
-      File.read file
+      TemplateContext.template(file)
+    end
+
+    class TemplateContext
+      
+      def self.template(pathname)
+        ERB.new(File.read(pathname)).result binding
+      end
+
+      # helper method to include a lua partial within another lua script
+      #
+      # @param relative_path [String] the relative path to the script from 
+      #     `Wolverine.config.script_path`
+      def self.include_partial(relative_path)
+        template( Pathname.new("#{Wolverine.config.script_path}/#{relative_path}") )
+      end
     end
 
   end

data/lib/wolverine/version.rb

@@ -1,3 +1,3 @@
 class Wolverine
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/integration/wolverine_integration_test.rb

@@ -7,10 +7,10 @@ class WolverineIntegrationTest < MiniTest::Unit::TestCase
   def mock_redis
     stub.tap do |redis|
       redis.expects(:evalsha).
-        with('fe24f4dd4ba7881608cca4b846f009195e06d79a', 2, :a, :b).
+        with('fe24f4dd4ba7881608cca4b846f009195e06d79a', :a, :b).
         raises("NOSCRIPT").once
       redis.expects(:eval).
-        with(CONTENT, 2, :a, :b).
+        with(CONTENT, :a, :b).
         returns([1, 0]).once
     end
   end
@@ -20,6 +20,7 @@ class WolverineIntegrationTest < MiniTest::Unit::TestCase
     Wolverine.config.script_path = Pathname.new(File.expand_path('../lua', __FILE__))
 
     assert_equal [1, 0], Wolverine.util.mexists(:a, :b)
+    assert Wolverine.methods.include?(:util)
   end
 
   def test_everything_instantiated
@@ -28,6 +29,7 @@ class WolverineIntegrationTest < MiniTest::Unit::TestCase
 
     wolverine = Wolverine.new(config)
     assert_equal [1, 0], wolverine.util.mexists(:a, :b)
+    assert wolverine.methods.include?(:util)
   end
 
 end

data/test/wolverine/lua/outer.lua

@@ -0,0 +1,2 @@
+<%= include_partial 'shared/_inner.lua' %>
+return do_something()

data/test/wolverine/lua/shared/_inner.lua

@@ -0,0 +1,3 @@
+local function do_something()
+  return 15;
+end

data/test/wolverine/script_templating_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.expand_path('../../test_helper', __FILE__))
+require 'digest/sha1'
+require 'fileutils'
+
+RESULT = <<EOF
+local function do_something()
+  return 15;
+end
+return do_something()
+EOF
+
+class Wolverine
+  class ScriptTemplatingTest < MiniTest::Unit::TestCase
+    
+    def setup
+      base = Pathname.new('test/wolverine/lua')
+      Wolverine.config.script_path = base
+    end
+
+    def teardown
+      Wolverine.config.instrumentation = proc{}
+    end
+
+    def script
+      @script ||= Wolverine::Script.new('test/wolverine/lua/outer.lua')
+    end
+
+    def test_templating
+      assert_equal script.instance_variable_get('@content'), RESULT
+    end
+
+  end
+end

data/test/wolverine/script_test.rb

@@ -43,7 +43,7 @@ class Wolverine
       }
       Wolverine.config.instrumentation = callback
       redis = Class.new do
-        define_method(:evalsha) do |digest, size, *args|
+        define_method(:evalsha) do |digest, *args|
           nil
         end
       end
@@ -53,9 +53,8 @@ class Wolverine
     def test_call_with_cache_hit
       tc = self
       redis = Class.new do
-        define_method(:evalsha) do |digest, size, *args|
+        define_method(:evalsha) do |digest, *args|
           tc.assert_equal DIGEST, digest
-          tc.assert_equal 2, size
           tc.assert_equal [:a, :b], args
         end
       end
@@ -68,9 +67,8 @@ class Wolverine
         define_method(:evalsha) do |*|
           raise "NOSCRIPT No matching script. Please use EVAL."
         end
-        define_method(:eval) do |content, size, *args|
+        define_method(:eval) do |content, *args|
           tc.assert_equal CONTENT, content
-          tc.assert_equal 2, size
           tc.assert_equal [:a, :b], args
         end
       end

data/wolverine.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Wolverine::VERSION
   s.authors     = ["Burke Libbey"]
   s.email       = ["burke@burkelibbey.org"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/Shopify/wolverine"
   s.summary     = %q{Wolverine provides a simple way to run server-side redis scripts from a rails app}
   s.description = %q{Wolverine provides a simple way to run server-side redis scripts from a rails app}
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency     'redis',    '>= 2.2.2'
+  s.add_runtime_dependency     'redis',    '>= 3.0.0'
   s.add_development_dependency 'mocha',    '~> 0.10.5'
   s.add_development_dependency 'minitest', '~> 2.11.3'
   s.add_development_dependency 'rake'

metadata

@@ -1,96 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: wolverine
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Burke Libbey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-07 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
-    none: false
-  name: redis
+        version: 3.0.0
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
-    none: false
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.5
-    none: false
-  name: mocha
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.5
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
-    none: false
-  name: minitest
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: rake
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: yard
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 description: Wolverine provides a simple way to run server-side redis scripts from
   a rails app
 email:
@@ -99,8 +88,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -120,33 +109,35 @@ files:
 - test/integration/wolverine_integration_test.rb
 - test/test_helper.rb
 - test/wolverine/configuration_test.rb
+- test/wolverine/lua/outer.lua
+- test/wolverine/lua/shared/_inner.lua
 - test/wolverine/path_component_test.rb
+- test/wolverine/script_templating_test.rb
 - test/wolverine/script_test.rb
 - test/wolverine_test.rb
 - wolverine.gemspec
-homepage: ''
+homepage: https://github.com/Shopify/wolverine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 requirements: []
 rubyforge_project: wolverine
-rubygems_version: 1.8.23
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wolverine provides a simple way to run server-side redis scripts from a rails
   app
 test_files:
@@ -154,7 +145,10 @@ test_files:
 - test/integration/wolverine_integration_test.rb
 - test/test_helper.rb
 - test/wolverine/configuration_test.rb
+- test/wolverine/lua/outer.lua
+- test/wolverine/lua/shared/_inner.lua
 - test/wolverine/path_component_test.rb
+- test/wolverine/script_templating_test.rb
 - test/wolverine/script_test.rb
 - test/wolverine_test.rb
 has_rdoc: