cache_key_monster 0.0.1

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 cache_key_monster.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Doug Rohde
+
+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,29 @@
+# CacheKeyMonster
+
+CacheKeyMonster provides a lightweight, declarative-style syntax for adding the cache_key method which is used by Rails' "cache" method.  It allows you to cache Plain Old Ruby objects based on their constituent data.  This is useful for objects that are transient by their very nature.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cache_key_monster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_key_monster
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/cache_key_monster.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_key_monster/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cache_key_monster"
+  gem.version       = CacheKeyMonster::VERSION
+  gem.authors       = ["Doug Rohde"]
+  gem.email         = ["doug.rohde@tstmedia.com"]
+  gem.description   = %q{A simple way to provide cache_key method to Plain Old Ruby objects}
+  gem.summary       = %q{A simple way to provide cache_key method to Plain Old Ruby objects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rspec"
+end

data/lib/cache_key_monster/cache_key.rb

@@ -0,0 +1,41 @@
+require "cache_key_monster/strategy"
+
+module CacheKeyMonster
+  module CacheKey
+
+    module ClassMethods
+      attr_reader :cache_key_monster_strategies
+
+      def cache_key(options={})
+        @cache_key_monster_strategies ||= []
+        strategy = Strategy.new(options[:key], options[:duration], options[:condition])
+        @cache_key_monster_strategies << strategy
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def cache_key
+      self.class.cache_key_monster_strategies.each do |strategy|
+        if strategy.condition_applies?(self)
+          return "#{prefix}-#{cache_key_body(strategy)}"
+        end
+      end
+      "#{prefix}-#{default_cache_key_monster_key}"
+    end
+
+    def cache_key_body(strategy)
+      strategy.execute_key_definition(self)
+    end
+    
+    def prefix
+      self.class.name.downcase
+    end
+    
+    def default_cache_key_monster_key
+      self.hash
+    end
+  end
+end

data/lib/cache_key_monster/strategy.rb

@@ -0,0 +1,22 @@
+module CacheKeyMonster
+  class Strategy
+    
+    attr_reader :key_definition, :condition
+    
+    def initialize(key_definition, duration, condition)
+      @key_definition = key_definition
+      @duration = duration || 0
+      @condition = condition || Proc.new{|obj| true}
+    end
+    
+    def condition_applies?(obj)
+      return true if condition.nil?
+      condition.call(obj)
+    end
+    
+    def execute_key_definition(obj)
+      key_definition ? key_definition.call(obj) : obj.default_cache_key_monster_key
+    end
+    
+  end
+end

data/lib/cache_key_monster/version.rb

@@ -0,0 +1,3 @@
+module CacheKeyMonster
+  VERSION = "0.0.1"
+end

data/lib/cache_key_monster.rb

@@ -0,0 +1,6 @@
+require "cache_key_monster/version"
+require "cache_key_monster/cache_key"
+
+module CacheKeyMonster
+  # Your code goes here...
+end

data/spec/lib/cache_key_monster/cache_key_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe CacheKeyMonster::CacheKey do
+
+  context "a list of batting leaders" do
+
+    before(:each) do
+      @players = Player.new(14, "Andres", 0.371), Player.new(19, "Tony", 0.358), Player.new(25, "Gregg", 0.342)
+      @leaders = BattingLeaders.new(@players)
+    end
+
+    it "should respond to cache_key method" do
+      @leaders.should respond_to(:cache_key)
+    end
+
+    it "should create a cache key from constituent data" do
+      @leaders.cache_key.should eq("battingleaders-1419250.3710.3580.342")
+    end
+
+    it "should return the hash of the object if no definition provided" do
+      no_key = NoKeyProvided.new
+      no_key.cache_key.should eq("nokeyprovided-#{no_key.hash.to_s}")
+    end
+  end
+  
+  context "a live event" do
+    
+    before(:each) do
+      @event = LiveEvent.new(id: 99, title: "Live Event")
+    end
+    
+    it "should return pending status key" do
+      @event.status = "pending"
+      @event.cache_key.should eq("liveevent-Live Event")
+    end
+    
+    it "should return completed status key" do
+      @event.status = "completed"
+      @event.cache_key.should eq("liveevent-99")
+    end
+    
+    it "should return default key if status does not match" do
+      @event.status = "cancelled"
+      obj_hash = @event.hash
+      @event.cache_key.should eq("liveevent-#{obj_hash}")
+    end
+  end
+
+end
+

data/spec/lib/cache_key_monster_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+require 'spec_helper'
+
+describe CacheKeyMonster do
+
+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
+Dir["spec/support/**/*.rb"].each {|f| require "./#{f}"} 
+
+
+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

data/spec/support/batting_leaders.rb

@@ -0,0 +1,15 @@
+require 'cache_key_monster'
+
+class BattingLeaders
+
+  include CacheKeyMonster::CacheKey
+
+  cache_key key: ->(obj){obj.leaders.map(&:id).join + obj.leaders.map(&:avg).join}
+
+  attr_accessor :leaders
+
+  def initialize(leaders)
+    @leaders = leaders
+  end
+
+end

data/spec/support/live_event.rb

@@ -0,0 +1,18 @@
+require 'cache_key_monster'
+
+class LiveEvent
+
+  include CacheKeyMonster::CacheKey
+
+  cache_key key: ->(obj){obj.title}, condition: ->(obj){obj.status == "pending"}
+  cache_key key: ->(obj){obj.id}, condition: ->(obj){obj.status == "completed"}
+  
+  attr_accessor :status
+  attr_reader :id, :title
+  
+  def initialize(params={})
+    @id = params[:id]
+    @title = params[:title]
+  end
+  
+end

data/spec/support/no_key_provided.rb

@@ -0,0 +1,9 @@
+require 'cache_key_monster'
+
+class NoKeyProvided
+  
+  include CacheKeyMonster::CacheKey
+
+  cache_key
+  
+end

data/spec/support/player.rb

@@ -0,0 +1,10 @@
+class Player
+
+  attr_accessor :id, :name, :avg
+
+  def initialize(id, name, avg)
+    @id = id
+    @name = name
+    @avg = avg
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: cache_key_monster
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Doug Rohde
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A simple way to provide cache_key method to Plain Old Ruby objects
+email: 
+- doug.rohde@tstmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_key_monster.gemspec
+- cache_key_monster.jpg
+- lib/cache_key_monster.rb
+- lib/cache_key_monster/cache_key.rb
+- lib/cache_key_monster/strategy.rb
+- lib/cache_key_monster/version.rb
+- spec/lib/cache_key_monster/cache_key_spec.rb
+- spec/lib/cache_key_monster_spec.rb
+- spec/spec_helper.rb
+- spec/support/batting_leaders.rb
+- spec/support/live_event.rb
+- spec/support/no_key_provided.rb
+- spec/support/player.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A simple way to provide cache_key method to Plain Old Ruby objects
+test_files: 
+- spec/lib/cache_key_monster/cache_key_spec.rb
+- spec/lib/cache_key_monster_spec.rb
+- spec/spec_helper.rb
+- spec/support/batting_leaders.rb
+- spec/support/live_event.rb
+- spec/support/no_key_provided.rb
+- spec/support/player.rb