coffee_table 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@coffee_table

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in coffee_table.gemspec
+gemspec
+
+gem "redis"
+gem "awesome_print"
+
+group :test do
+  gem "rspec"
+  gem "mock_redis"
+  gem "spork"
+end

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/coffee_table.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "coffee_table/version"
+
+Gem::Specification.new do |s|
+  s.name        = "coffee_table"
+  s.version     = CoffeeTable::VERSION
+  s.authors     = ["Stewart McKee"]
+  s.email       = ["stewart@theizone.co.uk"]
+  s.homepage    = ""
+  s.summary     = "Gem to manage cache stored in redis"
+  s.description = "rails cache gem to fragment cache with smart cache key management"
+
+  s.rubyforge_project = "coffee_table"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/coffee_table/version.rb

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

data/lib/coffee_table.rb

@@ -0,0 +1,128 @@
+require "coffee_table/version"
+require "utility"
+require "redis"
+
+module CoffeeTable
+  class Cache
+
+    include CoffeeTable::Utility
+  
+    def initialize(options={})
+      @options = options
+
+      default_enable_cache_to true
+      default_redis_namespace_to :coffee_table
+      default_redis_server_to "127.0.0.1"
+      default_redis_port_to 6789
+      
+    end
+
+    def get_cache(initial_key, *related_objects, &block)
+      setup_redis
+
+      # check objects are valid
+      related_objects.map{|o| raise "Objects passed in must have an id method" unless o.respond_to? "id"}
+
+      # if first related_object is integer or fixnum it is used as an expiry time for the cache object
+      # TODO change this to use hash and be at the end as convention
+      if related_objects.empty?
+        key = "#{initial_key}"
+      else
+        key = "#{initial_key}_#{related_objects.flatten.map{|o| "#{underscore(o.class.to_s)}[#{o.id}]"}.join("_")}"
+      end
+      
+      if @options[:enable_cache]
+        # if first element is an integer or fixnum then use that as an expiry for this key
+        expiry = nil
+        if !related_objects.nil? and !related_objects.empty? and !related_objects.first.nil? and (related_objects.first.instance_of? Integer or related_objects.first.instance_of? Fixnum) 
+          expiry = related_objects[0].to_i
+          related_objects = related_objects[1..-1]
+        end
+        
+        @redis.sadd "cache_keys", key unless @redis.sismember "cache_keys", key
+        if @redis.exists(key)
+          result = marshal_value(@redis.get(key))
+        else
+          result = yield
+          # if its a relation, call all to get an array to cache the result
+          #if result.class == ActiveRecord::Relation
+          #  @logger.debug "Expanding ActiveRecord::Relation..."
+          #  result = result.all
+          #end
+          @redis.set key, Marshal.dump(result)
+          @redis.expire key expiry unless expiry.nil?
+        end
+      else
+        unless @options[:enable_cache] && block_given?
+          raise "cache is disabled and no block is given"
+        else
+          result = yield
+        end
+      end
+      result
+    end
+  
+    def expire_key(key)
+      setup_redis
+      @redis.del(key)
+      @redis.srem "cache_keys", key
+    end
+  
+    def expire_all
+      keys.map{|key| expire_key(key)}
+    end
+  
+    def keys
+      setup_redis
+      @redis.smembers "cache_keys"
+    end  
+  
+    def expire_for(*objects)
+      perform_caching = Rails.application.configure do
+        config.action_controller.perform_caching
+      end    
+    
+      if perform_caching
+        deleted_keys = []
+        unless objects.empty?
+          self.keys.each do |key|
+            expire = true
+            objects.each do |object|
+              mod_key = "_#{key}_"
+              if object.class == String
+                unless mod_key.include?("_#{object}_") or mod_key.include?("_#{object.pluralize}_")
+                  expire = false
+                end
+              else
+                object_type = object.class.to_s.underscore
+                unless mod_key.include?("_#{object_type.to_sym}[#{object.id}]_") or mod_key.include?("_#{object_type.pluralize}_")
+                  expire = false
+                end
+              end 
+            end
+            if expire
+              expire_key(key)
+              deleted_keys << key
+            end
+          end
+        end
+        deleted_keys
+      end
+    end
+  
+    private
+    def marshal_value(value)
+      begin
+        result = Marshal.load(value)
+      rescue ArgumentError => e
+        puts "Attempting to load class/module #{e.message.split(" ")[-1]}"
+        e.message.split(" ")[-1].constantize
+        result = marshal_value(value)
+      end
+      result
+    end
+    def setup_redis
+      @redis = Redis.new #::Namespace.new(options[:redis_namespace], :redis => Redis.new({:server => @options[:redis_server], :port => @options[:redis_port]}))
+    end
+  end
+end

data/lib/utility.rb

@@ -0,0 +1,23 @@
+module CoffeeTable
+  module Utility
+
+    
+    # used for setting default options
+    def method_missing(method_sym, *arguments, &block)
+      if method_sym.to_s =~ /^default_(.*)_to$/
+        tag_name = method_sym.to_s.split("_")[1..-2].join("_").to_sym
+        @options[tag_name] = arguments[0] unless @options.has_key?(tag_name)
+      else
+        super
+      end
+    end
+
+    def underscore(text)
+      text.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end

data/spec/lib/coffee_table_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CoffeeTable do
+  
+  before(:each) do
+    @coffee_table = CoffeeTable::Cache.new
+  end
+  
+  specify { CoffeeTable::Cache.should respond_to :new}
+  specify { @coffee_table.should respond_to :get_cache}
+  specify { @coffee_table.should respond_to :expire_key}
+  specify { @coffee_table.should respond_to :expire_all}
+  specify { @coffee_table.should respond_to :keys}
+  specify { @coffee_table.should respond_to :expire_for}
+  
+  describe "config" do
+    it "should take a hash for config" do
+      CoffeeTable::Cache.new({:test => "asdf"})
+    end
+    it "should not raise exception when hash not given" do
+      lambda{CoffeeTable::Cache.new}.should_not raise_exception
+    end
+  end
+  
+  describe "get_cache" do
+    it "should raise an exception when block not given" do
+      lambda{@coffee_table.get_cache("asdf")}.should raise_exception "no block given (yield)"
+    end
+    it "should not raise an exception if cache value is available and no block given" do
+      result = @coffee_table.get_cache("test_key") do
+        "this is a valid result"
+      end
+      
+      @coffee_table.get_cache("test_key").should == "this is a valid result"
+    end
+    it "should execute block when cache value not available" do
+      result = @coffee_table.get_cache("asdf") do
+        "this is a value"
+      end
+      
+      result.should == "this is a value"      
+    end
+    it "should return cached value when cache available" do
+      @coffee_table.get_cache("asdf") do
+        "this is a value"
+      end
+      result = @coffee_table.get_cache("asdf") do
+        "this is a changed value"
+      end
+        
+      result.should == "this is a value"      
+      
+    end
+    it "should execute block when store not available" do
+      @coffee_table.get_cache(:test_key) do
+        TESTVAR = "testvar"
+        "this is a value"
+      end
+      @coffee_table.get_cache(:test_key) do
+        TESTVAR = "testvar2"
+        "this is a value"
+      end
+      
+      TESTVAR.should == "testvar"
+      
+    end
+    context "without related objects" do
+      it "should create a key with just the initial key" do        
+        result = @coffee_table.get_cache(:test_key) do
+          "this is a changed value"
+        end
+        
+        @coffee_table.keys.should include "test_key"
+        
+      end
+    end
+    context "with related objects" do
+      it "should create a key from the id's of the related objects" do
+        test_object = SampleClass.new
+        result = @coffee_table.get_cache(:test_key, test_object) do
+          "this is a changed value"
+        end
+        
+        puts @coffee_table.keys
+        @coffee_table.keys.should include "test_key_sample_class[9939]"
+        
+      end
+      it "should raise an exception if a related object does not respond_to id" do
+        test_object = SampleClassWithoutId.new
+
+        lambda {
+        result = @coffee_table.get_cache(:test_key, test_object) do
+          "this is a changed value"
+        end
+        }.should raise_exception "Objects passed in must have an id method"
+        
+      end
+    end
+    context "with expiry" do
+      it "should not execute block when cache available and not expired"
+      it "should execute block and return value when cache has expired"
+    end
+  end
+  
+  describe "expire_key" do
+  end
+  
+  describe "expire_all" do
+  end
+  
+  describe "keys" do
+  end
+  
+  describe "expire_for" do
+  end
+    
+end

data/spec/lib/sample_class.rb

@@ -0,0 +1,5 @@
+class SampleClass
+  def id
+    9939
+  end
+end

data/spec/lib/sample_class_without_id.rb

@@ -0,0 +1,2 @@
+class SampleClassWithoutId
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'spork'
+require 'mock_redis'
+require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/spec/lib/sample_class')
+require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/spec/lib/sample_class_without_id')
+
+Spork.prefork do
+  require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table.rb')
+end
+
+Spork.each_run do
+  RSpec.configure do |config|
+    config.before(:each) {
+      
+      
+      redis = mock(:redis)
+      Redis.stub!(:new).and_return(MockRedis.new)
+      CoffeeTable::Cache.new.expire_all
+      
+    }
+
+    config.after(:each) {
+    }
+  end  
+end
+
+
+
+def load_sample(filename)
+  File.open(File.dirname(__FILE__) + "/samples/" + filename).map { |line| line}.join("\n")  
+end
+def load_binary_sample(filename)
+  File.open(File.dirname(__FILE__) + "/samples/" + filename, 'rb')
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: coffee_table
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stewart McKee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-16 00:00:00.000000000 Z
+dependencies: []
+description: rails cache gem to fragment cache with smart cache key management
+email:
+- stewart@theizone.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Rakefile
+- coffee_table.gemspec
+- lib/coffee_table.rb
+- lib/coffee_table/version.rb
+- lib/utility.rb
+- spec/lib/coffee_table_spec.rb
+- spec/lib/sample_class.rb
+- spec/lib/sample_class_without_id.rb
+- spec/spec_helper.rb
+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: coffee_table
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Gem to manage cache stored in redis
+test_files:
+- spec/lib/coffee_table_spec.rb
+- spec/lib/sample_class.rb
+- spec/lib/sample_class_without_id.rb
+- spec/spec_helper.rb