shapkeep 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e5e37117c826802b5ebe29ba7f9fbb0525715c6
+  data.tar.gz: 8b23acf69f30e5ebcb2f9aba40d95d8ba5925f38
+SHA512:
+  metadata.gz: 7882ad2314d0e4efcf81838f4eba8465c4b64634e7ec786780c0e9410bf20bc3b937e6ccafcb7cc9ebe2194cc25a8345dbfe7a370e90bd4890d7a372f9a450f4
+  data.tar.gz: 523ae2407eb0fd8d5b4873032b5844f58491636a933cfa41c4139d25aefc8a04fef4c6a5c732d11bb3c4180a609ab4b445a683ca7bc94ac047a11da6dd376292

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 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jake
+
+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,66 @@
+# Shapkeep
+
+Shapkeep keeps track of your Redis Lua script SHA's so you don't have to.
+
+Shapkeep will optimize your Redis EVAL calls by always attempting to use
+EVALSHA.
+
+If we get a `NOSCRIPT` error, we load the script, and then `retry`.
+
+Next time, we won't get a `NOSCRIPT`, and so it's Optimized™.
+
+Shapkeep also gives you a central repo of Lua scripts in the form of a YAML
+file that you put them all in. The advantages of this are debatable, but for right
+now I like it.
+
+It does allow us to eval scripts by name:
+
+     Shapkeep.new('/path/to/store.yml').eval(redis, :name)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shapkeep'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shapkeep
+
+## Usage
+
+Shapkeep has two ways of using it, as a separate object and as a wrapper of
+your Redis object
+
+As a separate object:
+
+     redis = Redis.new
+     shapkeep = Shapkeep.new('/path/to/store.yml')
+
+     shapkeep.eval(redis, :script__name)
+
+
+Or as a wrapper (uses SimpleDelegator)
+
+     redis = Shapkeep::Wrapper.new('/path/to/store.yml', redis)
+
+     redis.keys                # => []
+
+     redis.eval_script(:one)   # => 1
+
+`Shapkeep#eval` and `Shapkeep::Wrapper#eval_script` both accept the `keys` and
+`args` arguments as arrays.
+
+     redis.eval_script(:one, ['key1'], ['arg1'])
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/shapkeep.rb

@@ -0,0 +1,60 @@
+require 'redis'
+require 'shapkeep/version'
+
+class Shapkeep
+  InvalidScriptNameError = Class.new(StandardError)
+
+  attr_reader :sha_file
+
+  def initialize(sha_file)
+    @sha_file = sha_file
+  end
+
+  def eval(redis, name, keys = [], args = [])
+    begin
+      invalid_script_name!(name) unless script_available?(name)
+      redis.evalsha(sha_for_script(name), keys, args)
+    rescue Redis::CommandError => boom
+      raise boom unless boom.message.include?('NOSCRIPT')
+
+      load_script(redis, name)
+      retry
+    end
+  end
+
+  def load_scripts!(redis)
+    script_store.keys.each { |name| load_script(redis, name) }
+  end
+
+  def script_store
+    @script_store ||= YAML.load_file(sha_file)
+  end
+
+  def script_available?(name)
+    script_store.has_key?(name)
+  end
+
+  private
+
+  def sha_for_script(name)
+    script_store[name.to_sym][:sha] ||= sha_script(name)
+  end
+
+  def sha_script(name)
+    Digest::SHA1.hexdigest(script_for_name(name))
+  end
+
+  def script_for_name(name)
+    script_store[name.to_sym][:script]
+  end
+
+  def load_script(redis, name)
+    sha = redis.script(:load, script_for_name(name))
+    script_store[name][:sha] = sha
+  end
+
+  def invalid_script_name!(name)
+    raise InvalidScriptNameError.new("No script with name [ #{name} ].")
+  end
+
+end

data/lib/shapkeep/version.rb

@@ -0,0 +1,3 @@
+class Shapkeep
+  VERSION = "0.0.1"
+end

data/lib/shapkeep/wrapper.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+require 'shapkeep'
+
+class Shapkeep
+  class Wrapper < SimpleDelegator
+
+    attr_reader :shapkeep
+
+    def initialize(script_file, redis)
+      super(redis)
+      @shapkeep = Shapkeep.new(script_file)
+    end
+
+    def eval_script(script_name, keys = [], args = [])
+      shapkeep.eval(redis, script_name, keys, args)
+    end
+
+    def redis
+      __getobj__
+    end
+  end
+end

data/sha_file.yml

@@ -0,0 +1,5 @@
+---
+:zero:
+  :script: return 0
+:one:
+  :script: return 1

data/shapkeep.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shapkeep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shapkeep"
+  spec.version       = Shapkeep::VERSION
+  spec.authors       = ['j-wilkins']
+  spec.email         = ['jake@jakewilkins.com']
+  spec.description   = %q{EVAL Lua scripts in Redis by name}
+  spec.summary       = %q{EVAL Lua scripts in Redis by name}
+  spec.homepage      = ""
+  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_runtime_dependency 'redis', '~> 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/fixtures/store.yml

@@ -0,0 +1,5 @@
+---
+:zero:
+  :script: return 0
+:one:
+  :script: return 1

data/spec/fixtures/store_error.yml

@@ -0,0 +1,7 @@
+---
+:zero:
+  :script: return 0
+:one:
+  :script: return 1
+:error:
+  :script: asdf123

data/spec/shapkeep/wrapper_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Shapkeep::Wrapper do
+  let(:redis) { Redis.new }
+  subject { Shapkeep::Wrapper.new('spec/fixtures/store.yml', redis) }
+
+  describe 'shapkeep' do
+    specify { expect(subject.shapkeep).to be_instance_of(Shapkeep) }
+  end
+
+  describe 'eval_script' do
+    specify { expect(subject.respond_to?(:eval_script)).to be_true }
+    specify { expect(subject.eval_script(:zero)).to be(0) }
+    specify { expect(subject.eval_script(:one)).to be(1) }
+  end
+
+  describe 'delegating to redis' do
+    specify { expect(subject.keys).to be_instance_of(Array) }
+    specify { expect(subject.set('asdf', 'yupyupyup')).to eq('OK') }
+    specify { expect(subject.del('asdf')).to be_instance_of(Fixnum) }
+  end
+end

data/spec/shapkeep_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Shapkeep do
+  let(:redis) { Redis.new }
+  subject { Shapkeep.new('spec/fixtures/store.yml') }
+
+  context 'script store' do
+    specify { expect(subject.script_store.keys).to eq([:zero, :one]) }
+  end
+
+  context 'script available' do
+    specify { expect(subject.script_available?(:nope)).to be_false }
+    specify { expect(subject.script_available?(:zero)).to be_true }
+  end
+
+  describe 'load scripts' do
+    before { redis.script(:flush); subject.load_scripts!(redis) }
+    specify do
+      expect(redis.script(:exists, [subject.send(:sha_for_script, :zero),
+        subject.send(:sha_for_script, :one)])).to be_true
+    end
+  end
+
+  describe 'eval' do
+    context 'invalid script name' do
+      specify do
+        expect(Proc.new { subject.eval(nil, :nope) }).to(
+          raise_error(Shapkeep::InvalidScriptNameError))
+      end
+    end
+
+    context 'script not loaded' do
+      before { redis.script(:flush) }
+      specify { expect(subject.eval(redis, :zero)).to eq(0) }
+    end
+
+    context 'script loaded' do
+      before do
+        redis.script(:load, subject.script_store[:one][:script])
+        def subject.load_script(*args)
+          raise 'Tried to Load a script #wtf!'
+        end
+      end
+      specify do
+        expect(subject.eval(redis, :one)).to be(1)
+      end
+    end
+
+    context 'script errors' do
+      subject { Shapkeep.new('spec/fixtures/store_error.yml') }
+      specify do
+        expect(Proc.new { subject.eval(redis, :error) }).to(
+          raise_error(Redis::CommandError))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'shapkeep/wrapper'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: shapkeep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- j-wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: rspec
+  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: EVAL Lua scripts in Redis by name
+email:
+- jake@jakewilkins.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shapkeep.rb
+- lib/shapkeep/version.rb
+- lib/shapkeep/wrapper.rb
+- sha_file.yml
+- shapkeep.gemspec
+- spec/fixtures/store.yml
+- spec/fixtures/store_error.yml
+- spec/shapkeep/wrapper_spec.rb
+- spec/shapkeep_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.4
+signing_key: 
+specification_version: 4
+summary: EVAL Lua scripts in Redis by name
+test_files:
+- spec/fixtures/store.yml
+- spec/fixtures/store_error.yml
+- spec/shapkeep/wrapper_spec.rb
+- spec/shapkeep_spec.rb
+- spec/spec_helper.rb