coffee_table 0.0.1 → 0.0.3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+# uncomment this line if your project needs to run something other than `rake`:
+script: rspec spec

data/Gemfile

@@ -5,6 +5,8 @@ gemspec
 
 gem "redis"
 gem "awesome_print"
+gem "rufus-scheduler"
+gem "activesupport"
 
 group :test do
   gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    coffee_table (0.0.2)
+      activesupport
+      redis
+      rufus-scheduler
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    awesome_print (1.1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    mock_redis (0.6.3)
+    multi_json (1.0.4)
+    redis (3.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rufus-scheduler (2.0.17)
+      tzinfo (>= 0.3.23)
+    spork (0.9.2)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  awesome_print
+  coffee_table!
+  mock_redis
+  redis
+  rspec
+  rufus-scheduler
+  spork

data/README.textile

@@ -0,0 +1,79 @@
+
+h1. CoffeeTable v0.0.3
+
+!https://secure.travis-ci.org/stewartmckee/coffee_table.png?branch=master!
+!https://gemnasium.com/stewartmckee/coffee_table.png!
+
+h2. Intro 
+  
+  CoffeeTable was born out of a frustration with the standard caching methods around.  Maintaining the cache keys constantly was a headache and 'bet its a caching issue' was a phrase uttered way too much.  CoffeeTable maintains a list of its keys in a known format and when expiry is required for an object it knows which ones to expire
+    
+h3. Installation
+
+bc. gem install coffee_table
+
+h2. Usage
+
+h3. CoffeeTable::Cache
+
+h4. new(options)
+
+Creates a new cache object.  You can pass various options into this method to set configuration options for the cache.
+
+  * :enable_cache  This defaults to true, but can be set to false to disable the cache
+  * :redis_namespace defaults to ":coffee_table" and is set to seperate out the keys from other redis users
+  * :redis_server defaults to "127.0.0.1"
+  * :redis_port defaults to 6789
+  
+
+h4. get_cache(initial_key, *related_objects, &block)
+
+This is the main caching method.  Pass into this method as a block the chunck of code you want cached.  The first parameter is your key for this data and is then followed by as many objects as are valid for this block of code.  You can even pass in arrays and they will be expanded.  The only requirement for the objects being passed in is that they respond to an 'id' method.  If the last parameter is a Hash, this will be used as per cache options.  These options can be used for expiry of cache. 
+
+bc. user_details = @coffee_table.get_cache(:user_detail, @user, :expiry => 600) do
+  @user.get_expensive_user_details
+end
+
+Each time this is ran, a unique cache key is generated, assuming the @user.id is '1' the cache key would be "user_detail_user[1]".  The more objects the longer the key.  It is good practice to put in objects that are used within the block, as in order to expire the key you need to specify the objects you want to expire for.  If this key contained one of those objects, it would be removed and the next time this was ran, fresh data would be placed in the cache.
+
+If you wish to specify a whole model type, for example, all users from above, you would pass in the class, for example:
+
+bc. user_details = @coffee_table.get_cache(:user_detail, User) do
+  @user.get_something_that_uses_all_users
+end
+
+In this case the key will be "user_detail_users", for which you can expire_for(User) which will clear regardless of the specific object id.
+
+The only required field is the first parameter, so you can create keys and cache as you normally would, ignoring the objects.
+
+h4. expire_key(key)
+
+This method directly expires a known key.
+
+bc. @coffee_table.expire_key("user_detail_user[1]")
+
+The above code would expire the above example of cache.
+
+h4. expire_all
+
+This method clears the whole cache.
+
+bc. @coffee_table.expire_all
+
+h4. keys
+
+This is a helper method to return the list of keys currently in the system.  This list is maintained when cache is created and expired.
+
+h4. expire_for(*objects)
+
+This is the main expire method.  In order to expire a cache, you only need to pass in any objects that would be invalidated.  With the above example this would be as follows.
+
+bc. @coffee_table.expire_for(@user)
+
+This would search through the keys to find any that contain this particular user.  If it finds any, it will invalidate that cache entry.
+
+You can also expire for a whole class type
+
+bc. @coffee_table.expire_for(User)
+
+this would expire all keys that reference the user objects.

data/coffee_table.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "rspec"
+  s.add_dependency "redis"
+  s.add_dependency "rufus-scheduler"
+  s.add_dependency "activesupport"
+
 end

data/lib/coffee_table.rb

@@ -1,12 +1,14 @@
 require "coffee_table/version"
 require "utility"
 require "redis"
+require 'rufus/scheduler'
+require 'active_support/inflector'
 
 module CoffeeTable
   class Cache
 
     include CoffeeTable::Utility
-  
+
     def initialize(options={})
       @options = options
 
@@ -14,29 +16,38 @@ module CoffeeTable
       default_redis_namespace_to :coffee_table
       default_redis_server_to "127.0.0.1"
       default_redis_port_to 6789
+
+      setup_redis
+      @scheduler = Rufus::Scheduler.start_new
       
     end
 
     def get_cache(initial_key, *related_objects, &block)
-      setup_redis
+
+      raise CoffeeTableBlockMissingError, "No block given to generate cache from" unless block_given?
+
+      # extract the options hash if it is present
+      options = {}
+      if related_objects[-1].instance_of? Hash
+        options = related_objects[-1]
+        related_objects = related_objects[0..-2]
+      end
 
       # check objects are valid
-      related_objects.map{|o| raise "Objects passed in must have an id method" unless o.respond_to? "id"}
+      related_objects.flatten.map{|o| raise CoffeeTableInvalidObjectError, "Objects passed in must have an id method or be a class" unless object_valid?(o)}
 
       # 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("_")}"
+        key = "#{initial_key}|#{related_objects.flatten.map{|o| key_for_object(o)}.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]
+        if options.has_key?(:expiry)
+          expiry = options[:expiry]
+        else
+          expiry = nil
         end
         
         @redis.sadd "cache_keys", key unless @redis.sismember "cache_keys", key
@@ -50,20 +61,20 @@ module CoffeeTable
           #  result = result.all
           #end
           @redis.set key, Marshal.dump(result)
-          @redis.expire key expiry unless expiry.nil?
+          unless expiry.nil?
+            @redis.expire key, expiry
+            @scheduler.in "#{expiry}s" do
+              @redis.srem "cache_keys", key
+            end
+          end
         end
       else
-        unless @options[:enable_cache] && block_given?
-          raise "cache is disabled and no block is given"
-        else
-          result = yield
-        end
+        result = yield
       end
       result
     end
   
     def expire_key(key)
-      setup_redis
       @redis.del(key)
       @redis.srem "cache_keys", key
     end
@@ -73,29 +84,37 @@ module CoffeeTable
     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 defined? Rails
+        perform_caching = Rails.application.configure do
+          config.action_controller.perform_caching
+        end
+      else
+        perform_caching = true
+      end
     
       if perform_caching
         deleted_keys = []
-        unless objects.empty?
-          self.keys.each do |key|
+        unless objects.count == 0
+          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}_")
+              mod_key = "|#{key}|"
+              if object.class == String || object.class == Symbol
+                unless mod_key.include?("|#{object}|")
+                  expire = false
+                end
+              elsif object.class == Class
+                object_type = underscore(object.to_s)
+                unless mod_key.include?("|#{object_type}[") or mod_key.include?("|#{ActiveSupport::Inflector.pluralize(object_type)}|")
                   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}_")
+                object_type = underscore(object.class.to_s)
+                unless mod_key.include?("|#{object_type.to_sym}[#{object.id}]|") or mod_key.include?("|#{object_type}|")
                   expire = false
                 end
               end 
@@ -124,5 +143,15 @@ module CoffeeTable
     def setup_redis
       @redis = Redis.new #::Namespace.new(options[:redis_namespace], :redis => Redis.new({:server => @options[:redis_server], :port => @options[:redis_port]}))
     end
+    def object_valid?(o)
+      o.respond_to?(:id) || o.class == Class
+    end
+    def key_for_object(o)
+      if o.class == Class
+        "#{ActiveSupport::Inflector.pluralize(underscore(o.to_s))}"
+      else
+        "#{underscore(o.class.to_s)}[#{o.id}]"
+      end
+    end
   end
 end

data/lib/coffee_table/coffee_table_block_missing_error.rb

@@ -0,0 +1,3 @@
+class CoffeeTableBlockMissingError < StandardError
+  
+end

data/lib/coffee_table/coffee_table_invalid_object_error.rb

@@ -0,0 +1,3 @@
+class CoffeeTableInvalidObjectError < StandardError
+  
+end

data/lib/coffee_table/version.rb

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

data/spec/lib/coffee_table_spec.rb

@@ -18,20 +18,13 @@ describe CoffeeTable 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
+      lambda{CoffeeTable::Cache.new}.should_not raise_exception CoffeeTableBlockMissingError
     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"
+      lambda{@coffee_table.get_cache("asdf")}.should raise_exception CoffeeTableBlockMissingError
     end
     it "should execute block when cache value not available" do
       result = @coffee_table.get_cache("asdf") do
@@ -64,54 +57,274 @@ describe CoffeeTable do
       TESTVAR.should == "testvar"
       
     end
-    context "without related objects" do
-      it "should create a key with just the initial key" do        
+
+    context "keys" 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"
-        
+        @coffee_table.keys.should == ["test_key"]
+      end
+
+      it "should create key from class" do
+        result = @coffee_table.get_cache(:test_key, SampleClass) do
+          "this is a changed value"
+        end
+        @coffee_table.keys.should == ["test_key|sample_classes"]
+      end
+      
+      it "should use class name for keys" do
+        result = @coffee_table.get_cache(:test_key, SampleClass.new(2)) do
+          "this is a changed value"
+        end
+        @coffee_table.keys.should == ["test_key|sample_class[2]"]
+      end
+
+      it "should use id from class in key" do
+        result = @coffee_table.get_cache(:test_key, SampleClass.new(2)) do
+          "this is a changed value"
+        end
+        @coffee_table.keys.should == ["test_key|sample_class[2]"]
       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
+        test_object = SampleClass.new(9938)
         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]"
+        @coffee_table.keys.should include "test_key|sample_class[9938]"
         
       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
+          result = @coffee_table.get_cache(:test_key, test_object) do
+            "this is a changed value"
+          end
+        }.should raise_exception CoffeeTableInvalidObjectError, "Objects passed in must have an id method or be a class"
+        
+      end
+
+      it "should create a universal key if the objects passed in are an uninitialised class" do
+
+        result = @coffee_table.get_cache(:test_key, SampleClass) do
           "this is a changed value"
         end
-        }.should raise_exception "Objects passed in must have an id method"
         
+        @coffee_table.keys.should include "test_key|sample_classes"          
       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"
+      it "keys should update when cache expires" do
+        @coffee_table.get_cache(:test_key, :expiry => 0.2) do
+          "object1"
+        end
+        @coffee_table.keys.count.should == 1
+        sleep 0.5
+        @coffee_table.keys.count.should == 0
+      end
+      it "should not execute block during cache period" do
+        @coffee_table.get_cache("asdf", :expiry => 1) 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 and return value when cache has expired" do
+        @coffee_table.get_cache("asdf", :expiry => 1) do
+          "this is a value"
+        end
+        sleep 2
+        result = @coffee_table.get_cache("asdf") do
+          "this is a changed value"
+        end      
+        result.should == "this is a changed value"      
+      end
     end
   end
   
   describe "expire_key" do
+    it "should expire the specified key" do
+      @coffee_table.get_cache(:first_key) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key) do
+        "object3"
+      end
+
+      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+      @coffee_table.expire_key("second_key")
+      @coffee_table.keys.sort.should == ["first_key", "third_key"].sort
+
+    end
+    it "should not expire anything if no matches" do
+      @coffee_table.get_cache(:first_key) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key) do
+        "object3"
+      end
+
+      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+      @coffee_table.expire_key("fourth_key")
+      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+
+    end
   end
   
   describe "expire_all" do
+    before(:each) do
+
+      object1 = [SampleClass.new(1), SampleClass.new(2), SampleClass.new(3)]
+      object2 = [SampleClass.new(4), SampleClass.new(2), SampleClass.new(5)]
+      object3 = [SampleClass.new(7), SampleClass.new(2), SampleClass.new(8)]
+
+      @coffee_table.get_cache(:first_key) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key) do
+        "object3"
+      end
+    end
+
+    it "should delete all keys" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_all
+      @coffee_table.keys.count.should == 0
+
+      result = @coffee_table.get_cache(:first_key) do
+        "changed value"
+      end
+
+      result.should == "changed value"
+
+    end
   end
   
   describe "keys" do
+    before(:each) do
+      @object1 = [SampleClass.new(1), SampleClass.new(2), SampleClass.new(3)]
+      @object2 = [SampleClass.new(4), SampleClass.new(2), SampleClass.new(5)]
+      @object3 = [SampleClass.new(7), SampleClass.new(2), SampleClass.new(8)]
+
+    end
+
+    it "should return an array of string" do
+      @coffee_table.keys.should be_an_instance_of Array
+      @coffee_table.keys.map{|key| key.should be_an_instance_of String}
+    end
+    it "should return key created without objects" do
+      @coffee_table.get_cache(:first_key) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key) do
+        "object3"
+      end
+
+      @coffee_table.keys.sort.should == ["first_key",
+                               "second_key",
+                               "third_key"].sort
+
+    end
+    it "should return key created with objects and ids" do
+      @coffee_table.get_cache(:first_key, @object1) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key, @object2) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key, @object3) do
+        "object3"
+      end
+      @coffee_table.keys.sort.should == ["first_key|sample_class[1]|sample_class[2]|sample_class[3]",
+                               "second_key|sample_class[4]|sample_class[2]|sample_class[5]",
+                               "third_key|sample_class[7]|sample_class[2]|sample_class[8]"].sort
+    end
+
   end
   
   describe "expire_for" do
+    before(:each) do
+      object1 = [SampleClass.new(1), SampleClass.new(2), SampleClass.new(3)]
+      object2 = [SampleClass.new(4), SampleClass.new(2), SampleClass.new(5)]
+      object3 = [SampleClass.new(7), SampleClass.new(2), SampleClass.new(8)]
+
+      @coffee_table.get_cache(:first_key, object1) do
+        "object1"
+      end
+      @coffee_table.get_cache(:second_key, object2) do
+        "object2"
+      end
+      @coffee_table.get_cache(:third_key, object3) do
+        "object3"
+      end
+    end
+
+    it "should expire based on the initial key" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for(:second_key)
+      @coffee_table.keys.count.should == 2
+    end
+
+    it "should expire based on a simple string" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for("sample_class[4]")
+      @coffee_table.keys.count.should == 2
+    end
+
+    it "should not expire based on a part match" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for("impl")
+      @coffee_table.keys.count.should == 3
+    end
+
+    it "should not delete any keys if object is not present" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for(SampleClass.new(18))
+      @coffee_table.keys.count.should == 3
+    end
+    it "should only delete keys that object is present in" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for(SampleClass.new(1))
+      @coffee_table.keys.count.should == 2
+    end
+
+    it "should delete a key if the object is at the end of they key" do
+      @coffee_table.keys.count.should == 3
+      @coffee_table.expire_for(SampleClass.new(3))
+      @coffee_table.keys.count.should == 2
+    end
+
+    it "should expire all keys relating to a class if uninitialised class is passed in" do
+      @coffee_table.get_cache(:fourth_key) do
+        "object4"
+      end
+      @coffee_table.keys.count.should == 4
+      @coffee_table.expire_for(SampleClass)
+      @coffee_table.keys.count.should == 1
+    end
   end
     
 end

data/spec/lib/sample_class.rb

@@ -1,5 +1,8 @@
 class SampleClass
+  def initialize(id)
+    @id = id
+  end
   def id
-    9939
+    @id
   end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/spec/lib/
 
 Spork.prefork do
   require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table.rb')
+  require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table/coffee_table_block_missing_error.rb')
+  require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table/coffee_table_invalid_object_error.rb')
 end
 
 Spork.each_run do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coffee_table
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-16 00:00:00.000000000 Z
-dependencies: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70181746090020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70181746090020
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70181746089420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70181746089420
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: &70181746088880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70181746088880
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70181746088280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70181746088280
 description: rails cache gem to fragment cache with smart cache key management
 email:
 - stewart@theizone.co.uk
@@ -21,10 +65,15 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
+- Gemfile.lock
+- README.textile
 - Rakefile
 - coffee_table.gemspec
 - lib/coffee_table.rb
+- lib/coffee_table/coffee_table_block_missing_error.rb
+- lib/coffee_table/coffee_table_invalid_object_error.rb
 - lib/coffee_table/version.rb
 - lib/utility.rb
 - spec/lib/coffee_table_spec.rb