wolverine 0.0.2 → 0.0.3

data/LICENSE

@@ -0,0 +1,7 @@
+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

@@ -12,29 +12,46 @@ Wolverine is a wrapper around that functionality, to package it up in a format m
 
 ## 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. As of now, that means compiling from source:
 
-    git clone https://github.com/antirez/redis.git
-    cd redis && make
-    ./src/redis-server
+```shell
+git clone https://github.com/antirez/redis.git
+cd redis && make
+./src/redis-server
+```
 
-2) Add wolverine to your gemfile
+2) Add wolverine to your Gemfile:
 
-    gem 'wolverine'
+```ruby
+gem 'wolverine'
+```
 
-3) Add your lua scripts to `app/redis`
+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
+```lua
+-- 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:
+4) Call wolverine from your code:
 
-    Wolverine.call('util/mexists', 'key1', 'key2', 'key3') #=> [0, 1, 0]
+```ruby
+Wolverine.call('util/mexists', 'key1', 'key2', 'key3') #=> [0, 1, 0]
+```
+
+## Configuration
+
+Available configuration options:
+
+* `Wolverine.config.redis` (default `Redis.new`)
+* `Wolverine.config.script_path` (default `Rails.root + 'app/wolverine'`)
+
+If you want to override one or both of these, doing so in an initializer is recommended but not required.
 
 ## More information
 

data/TODO

@@ -0,0 +1 @@
+* Support calling templates like: `Wolverine.util.mexists('key1', 'key2', 'key3')`

data/examples/mexists.lua

@@ -0,0 +1,6 @@
+local exists = {}
+local existence
+for _, key in ipairs(KEYS) do
+  table.insert(exists, redis.call('exists', key))
+end
+return exists

data/lib/wolverine/configuration.rb

@@ -5,7 +5,7 @@ module Wolverine
     end
 
     def script_path
-      super || @script_path ||= Rails.root + 'app/redis'
+      super || @script_path ||= Rails.root + 'app/wolverine'
     end
   end
 end

data/lib/wolverine/version.rb

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

data/test/wolverine/configuration_test.rb

@@ -16,7 +16,7 @@ module Wolverine
 
     def test_default_script_path
       actual = Wolverine::Configuration.new.script_path
-      assert_equal Pathname.new('foo/app/redis'), actual
+      assert_equal Pathname.new('foo/app/wolverine'), actual
     end
 
     def test_setting_redis

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wolverine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   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: &70114961106680 !ruby/object:Gem::Requirement
+  requirement: &70311257068780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70114961106680
+  version_requirements: *70311257068780
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70114961105880 !ruby/object:Gem::Requirement
+  requirement: &70311257065340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70114961105880
+  version_requirements: *70311257065340
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70114961105380 !ruby/object:Gem::Requirement
+  requirement: &70311257101280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70114961105380
+  version_requirements: *70311257101280
 description: Wolverine provides a simple way to run server-side redis scripts from
   a rails app
 email:
@@ -54,9 +54,11 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README
+- LICENSE
 - README.md
 - Rakefile
+- TODO
+- examples/mexists.lua
 - lib/wolverine.rb
 - lib/wolverine/configuration.rb
 - lib/wolverine/script.rb

data/README

@@ -1,52 +0,0 @@
-# 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.
-