coffee_table 0.0.3 → 0.1.1

data/Gemfile

@@ -7,6 +7,7 @@ gem "redis"
 gem "awesome_print"
 gem "rufus-scheduler"
 gem "activesupport"
+gem "sourcify", :git => "git@github.com:stewartmckee/sourcify.git"
 
 group :test do
   gem "rspec"

data/Gemfile.lock

@@ -1,10 +1,21 @@
+GIT
+  remote: git@github.com:stewartmckee/sourcify.git
+  revision: cdef8e0b3b7017312407000985a279d6627c77e5
+  specs:
+    sourcify (0.6.0.rc3)
+      file-tail (~> 1.0.10)
+      ruby2ruby (~> 1.3.1)
+      ruby_parser (~> 2.3.1)
+      sexp_processor (~> 3.2.0)
+
 PATH
   remote: .
   specs:
-    coffee_table (0.0.2)
+    coffee_table (0.1.0)
       activesupport
       redis
       rufus-scheduler
+      sourcify
 
 GEM
   remote: http://rubygems.org/
@@ -14,6 +25,8 @@ GEM
       multi_json (~> 1.0)
     awesome_print (1.1.0)
     diff-lcs (1.1.3)
+    file-tail (1.0.12)
+      tins (~> 0.5)
     i18n (0.6.1)
     mock_redis (0.6.3)
     multi_json (1.0.4)
@@ -26,9 +39,16 @@ GEM
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.1)
+    ruby2ruby (1.3.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
     rufus-scheduler (2.0.17)
       tzinfo (>= 0.3.23)
+    sexp_processor (3.2.0)
     spork (0.9.2)
+    tins (0.7.0)
     tzinfo (0.3.35)
 
 PLATFORMS
@@ -42,4 +62,5 @@ DEPENDENCIES
   redis
   rspec
   rufus-scheduler
+  sourcify!
   spork

data/README.textile

@@ -1,15 +1,24 @@
 
-h1. CoffeeTable v0.0.3
+h1. CoffeeTable v0.1.1
 
-!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
+  CoffeeTable was born out of a frustration with the standard caching methods.  Maintaining the cache keys constantly was a headache and 'bet its a caching issue' was a phrase uttered way too much.  CoffeeTable was designed to take on the role of maintaining the cache keys for you, allowing you to concentrate on what is in the cache.  It works by maintaining a list of its keys in a known format and when expiry is required for an object it knows which ones to expire.  It also hopefully will be a perfromance boost for some cases where you are being overly cautious about clearing cache, a more targeted approach will improve performance.
     
 h3. Installation
 
+h4. Using Rails/Bundler
+
+Put the following in your Gemfile and run 'bundle'
+
+bc. gem 'coffee_table'
+
+h4. Straight Ruby
+
+Run the following at the command prompt
+
 bc. gem install coffee_table
 
 h2. Usage
@@ -18,12 +27,13 @@ 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.
+Creates a new cache object.  You can pass options into this method to modify the cache behaviour.
 
-  * :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
+  * :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 or other caches
   * :redis_server defaults to "127.0.0.1"
   * :redis_port defaults to 6789
+  * :ignore_code_changes defaults to false.  By default a md5 hash of the code in the block is included in the key, if you change the code, the key automatically invalidates.  This is to protect against code changes that won't be picked up due to the cache returning.
   
 
 h4. get_cache(initial_key, *related_objects, &block)
@@ -42,31 +52,23 @@ 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.
+This would be expired with 'expire_for(User)' which will clear all user cache items 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.
+This method clears the whole cache removing all cache items.
 
 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.
+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.  Can also be used for debug purposes when investigating an issue.
 
 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.
+This is the main expire method.  In order to expire a cache item, you pass in any objects that would be invalidated.  With the above example this would be as follows.
 
 bc. @coffee_table.expire_for(@user)
 
@@ -77,3 +79,7 @@ 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.
+
+The best practice for this is to be as specific as you can when creating the key.  Also creating more targeted cache items may be better in some situations than having one large cache fragment.
+
+

data/changelog.txt

@@ -0,0 +1,11 @@
+
+0.1.1
+  - updated documentation
+  - refacotred get_cache method to fetch
+
+0.1.0
+  
+  - Started a change log
+  - Added sourcify to md5 hash the contents of the block to remove issues around code changes not being used due to cache
+  - Added a key class to handle key generation and management
+

data/coffee_table.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |s|
   s.add_dependency "redis"
   s.add_dependency "rufus-scheduler"
   s.add_dependency "activesupport"
+  s.add_dependency "sourcify"
 
 end

data/lib/coffee_table.rb

@@ -1,14 +1,18 @@
 require "coffee_table/version"
-require "utility"
+require "coffee_table/utility"
 require "redis"
 require 'rufus/scheduler'
 require 'active_support/inflector'
+require "sourcify"
+require 'digest/md5'
 
 module CoffeeTable
   class Cache
 
     include CoffeeTable::Utility
 
+
+    # initialize for coffee_table.  takes options to setup behaviour of cache
     def initialize(options={})
       @options = options
 
@@ -16,13 +20,15 @@ module CoffeeTable
       default_redis_namespace_to :coffee_table
       default_redis_server_to "127.0.0.1"
       default_redis_port_to 6789
+      default_ignore_code_changes_to false
 
-      setup_redis
+      @redis = Redis.new({:server => @options[:redis_server], :port => @options[:redis_port]})
       @scheduler = Rufus::Scheduler.start_new
       
     end
 
-    def get_cache(initial_key, *related_objects, &block)
+    # main
+    def fetch(initial_key, *related_objects, &block)
 
       raise CoffeeTableBlockMissingError, "No block given to generate cache from" unless block_given?
 
@@ -36,12 +42,14 @@ module CoffeeTable
       # check objects are valid
       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
-      if related_objects.empty?
-        key = "#{initial_key}"
+      if @options[:ignore_code_changes]
+        block_key = ""
       else
-        key = "#{initial_key}|#{related_objects.flatten.map{|o| key_for_object(o)}.join("|")}"
+        block_key = Digest::MD5.hexdigest(block.to_source)
       end
+
+      # if first related_object is integer or fixnum it is used as an expiry time for the cache object
+      key = Key.new(initial_key, block_key, related_objects)
       
       if @options[:enable_cache]
         if options.has_key?(:expiry)
@@ -50,9 +58,9 @@ module CoffeeTable
           expiry = nil
         end
         
-        @redis.sadd "cache_keys", key unless @redis.sismember "cache_keys", key
-        if @redis.exists(key)
-          result = marshal_value(@redis.get(key))
+        @redis.sadd "cache_keys", key unless @redis.sismember "cache_keys", key.to_s
+        if @redis.exists(key.to_s)
+          result = marshal_value(@redis.get(key.to_s))
         else
           result = yield
           # if its a relation, call all to get an array to cache the result
@@ -60,11 +68,11 @@ module CoffeeTable
           #  @logger.debug "Expanding ActiveRecord::Relation..."
           #  result = result.all
           #end
-          @redis.set key, Marshal.dump(result)
+          @redis.set key.to_s, Marshal.dump(result)
           unless expiry.nil?
-            @redis.expire key, expiry
+            @redis.expire key.to_s, expiry
             @scheduler.in "#{expiry}s" do
-              @redis.srem "cache_keys", key
+              @redis.srem "cache_keys", key.to_s
             end
           end
         end
@@ -74,9 +82,11 @@ module CoffeeTable
       result
     end
   
-    def expire_key(key)
-      @redis.del(key)
-      @redis.srem "cache_keys", key
+    def expire_key(key_value)
+      keys.map{|k| Key.parse(k)}.select{|key| key.has_element?(key_value) || key.to_s == key_value }.each do |key|
+        @redis.del(key.to_s)
+        @redis.srem "cache_keys", key.to_s
+      end
     end
   
     def expire_all
@@ -84,7 +94,7 @@ module CoffeeTable
     end
   
     def keys
-      @redis.smembers "cache_keys"
+      @redis.smembers("cache_keys")
     end  
   
     def expire_for(*objects)
@@ -99,28 +109,27 @@ module CoffeeTable
       if perform_caching
         deleted_keys = []
         unless objects.count == 0
-          keys.each do |key|
+          keys.map{|k| Key.parse(k)}.each do |key|
             expire = true
             objects.each do |object|
-              mod_key = "|#{key}|"
               if object.class == String || object.class == Symbol
-                unless mod_key.include?("|#{object}|")
+                unless key.has_element?(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)}|")
+                unless key.has_element_type?(object_type) || key.has_element_type?(ActiveSupport::Inflector.pluralize(object_type))
                   expire = false
                 end
               else
                 object_type = underscore(object.class.to_s)
-                unless mod_key.include?("|#{object_type.to_sym}[#{object.id}]|") or mod_key.include?("|#{object_type}|")
+                unless key.has_element?("#{object_type.to_sym}[#{object.id}]") or key.has_element?(object_type)
                   expire = false
                 end
               end 
             end
             if expire
-              expire_key(key)
+              expire_key(key.to_s)
               deleted_keys << key
             end
           end
@@ -128,6 +137,8 @@ module CoffeeTable
         deleted_keys
       end
     end
+
+    alias :get_cache :fetch
   
     private
     def marshal_value(value)
@@ -140,18 +151,9 @@ module CoffeeTable
       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
     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/key.rb

@@ -0,0 +1,80 @@
+require "coffee_table/utility"
+
+module CoffeeTable
+  class Key
+    include CoffeeTable::Utility
+
+    def self.parse(string)
+      elements = string.split("|").map{|e| decode_element(e) }
+      key = Key.new(elements[0], elements[1])
+      key.elements =  elements[2..-1]
+      key
+    end
+
+    def initialize(name, block_key, *objects)
+      @name = name
+      @block_key = block_key
+      @elements = objects.flatten.map{|o| key_for_object(o)}
+    end
+
+    def has_element?(element)
+      matches?(element.to_s)
+    end
+
+    def has_element_type?(element)
+      matches?(element.to_s + "[", :match => :start)
+    end
+
+    def name
+      @name
+    end
+
+    def code_hash
+      @block_key
+    end
+
+    def elements
+      @elements
+    end
+
+    def elements=(elements)
+      @elements = elements
+    end
+
+    def <=>(o)
+      self.to_s <=> o.to_s
+    end
+
+    def to_s
+      [encode_element(@name), encode_element(@block_key), @elements.map{|e| encode_element(e) }].flatten.join("|")
+    end
+
+    private
+
+    def matches?(fragment, options={})
+      if options[:match] == :start
+        @name == fragment || !@elements.select{|e| e =~ /^#{Regexp.escape(fragment)}/ }.empty?
+      else
+        @name == fragment || @elements.include?(fragment)
+      end
+    end
+
+    def encode_element(element)
+      element.to_s.gsub("&", "&amp;").gsub("|", "&#124;")
+    end
+
+    def self.decode_element(element)
+      element.to_s.gsub("&#124;", "|").gsub("&amp;", "&")
+    end
+
+    def key_for_object(o)
+      if o.class == Class
+        "#{ActiveSupport::Inflector.pluralize(underscore(o.to_s))}"
+      elsif o.kind_of?(String) || o.kind_of?(Symbol)
+        "#{underscore(o.to_s)}"
+      else
+        "#{underscore(o.class.to_s)}[#{o.id}]"
+      end
+    end
+  end
+end

data/lib/coffee_table/version.rb

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

data/spec/lib/coffee_table_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe CoffeeTable do
+describe CoffeeTable::Cache 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 :fetch}
   specify { @coffee_table.should respond_to :expire_key}
   specify { @coffee_table.should respond_to :expire_all}
   specify { @coffee_table.should respond_to :keys}
@@ -22,69 +22,70 @@ describe CoffeeTable do
     end
   end
   
-  describe "get_cache" do
+  describe "fetch" do
     it "should raise an exception when block not given" do
-      lambda{@coffee_table.get_cache("asdf")}.should raise_exception CoffeeTableBlockMissingError
+      lambda{@coffee_table.fetch("asdf")}.should raise_exception CoffeeTableBlockMissingError
     end
     it "should execute block when cache value not available" do
-      result = @coffee_table.get_cache("asdf") do
+      result = @coffee_table.fetch("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"
+      value = "this is a value"
+      @coffee_table.fetch("asdf") do
+        value
       end
-      result = @coffee_table.get_cache("asdf") do
-        "this is a changed value"
+      value = "this is a changed value"
+      result = @coffee_table.fetch("asdf") do
+        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 "keys" do
       it "should create a key with just the initial key" do
-        result = @coffee_table.get_cache(:test_key) do
+        md5 = md5_block do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key"]
+        result = @coffee_table.fetch(:test_key) do
+          "this is a changed value"
+        end
+        @coffee_table.keys.should == ["test_key|#{md5}"]
       end
 
       it "should create key from class" do
-        result = @coffee_table.get_cache(:test_key, SampleClass) do
+        md5 = md5_block do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|sample_classes"]
+        result = @coffee_table.fetch(:test_key, SampleClass) do
+          "this is a changed value"
+        end
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_classes"]
       end
       
       it "should use class name for keys" do
-        result = @coffee_table.get_cache(:test_key, SampleClass.new(2)) do
+        md5 = md5_block do
+          "this is a changed value"
+        end
+        result = @coffee_table.fetch(:test_key, SampleClass.new(2)) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|sample_class[2]"]
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]"]
       end
 
       it "should use id from class in key" do
-        result = @coffee_table.get_cache(:test_key, SampleClass.new(2)) do
+        md5 = md5_block do
+          "this is a changed value"
+        end
+        result = @coffee_table.fetch(:test_key, SampleClass.new(2)) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|sample_class[2]"]
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]"]
       end
 
     end
@@ -93,18 +94,21 @@ describe CoffeeTable do
     context "with related objects" do
       it "should create a key from the id's of the related objects" do
         test_object = SampleClass.new(9938)
-        result = @coffee_table.get_cache(:test_key, test_object) do
+        md5 = md5_block do
+          "this is a changed value"
+        end
+        result = @coffee_table.fetch(:test_key, test_object) do
           "this is a changed value"
         end
         
-        @coffee_table.keys.should include "test_key|sample_class[9938]"
+        @coffee_table.keys.should include "test_key|#{md5}|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.fetch(: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"
@@ -112,18 +116,21 @@ describe CoffeeTable do
       end
 
       it "should create a universal key if the objects passed in are an uninitialised class" do
+        md5 = md5_block do
+          "this is a changed value"
+        end
 
-        result = @coffee_table.get_cache(:test_key, SampleClass) do
+        result = @coffee_table.fetch(:test_key, SampleClass) do
           "this is a changed value"
         end
         
-        @coffee_table.keys.should include "test_key|sample_classes"          
+        @coffee_table.keys.should include "test_key|#{md5}|sample_classes"          
       end
 
     end
     context "with expiry" do
       it "keys should update when cache expires" do
-        @coffee_table.get_cache(:test_key, :expiry => 0.2) do
+        @coffee_table.fetch(:test_key, :expiry => 0.2) do
           "object1"
         end
         @coffee_table.keys.count.should == 1
@@ -131,21 +138,23 @@ describe CoffeeTable do
         @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"
+        value = 'this is a value'
+        @coffee_table.fetch("asdf", :expiry => 1) do
+          value
         end
-        result = @coffee_table.get_cache("asdf") do
-          "this is a changed value"
+        value = 'this is a changed value'
+        result = @coffee_table.fetch("asdf") do
+          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
+        @coffee_table.fetch("asdf", :expiry => 1) do
           "this is a value"
         end
         sleep 2
-        result = @coffee_table.get_cache("asdf") do
+        result = @coffee_table.fetch("asdf") do
           "this is a changed value"
         end      
         result.should == "this is a changed value"      
@@ -154,38 +163,129 @@ describe CoffeeTable do
   end
   
   describe "expire_key" do
+
+    before(:each) do
+      @proc_md51 = md5_block do
+        "object1"
+      end
+      @proc_md52 = md5_block do
+        "object2"
+      end
+      @proc_md53 = md5_block do
+        "object3"
+      end
+    end
+
     it "should expire the specified key" do
-      @coffee_table.get_cache(:first_key) do
+      @coffee_table.fetch(:first_key) do
         "object1"
       end
-      @coffee_table.get_cache(:second_key) do
+      @coffee_table.fetch(:second_key) do
         "object2"
       end
-      @coffee_table.get_cache(:third_key) do
+      @coffee_table.fetch(:third_key) do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].sort
       @coffee_table.expire_key("second_key")
-      @coffee_table.keys.sort.should == ["first_key", "third_key"].sort
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "third_key|#{@proc_md53}"].sort
 
     end
     it "should not expire anything if no matches" do
-      @coffee_table.get_cache(:first_key) do
+      @proc_md51 = md5_block do
         "object1"
       end
-      @coffee_table.get_cache(:second_key) do
+      @proc_md52 = md5_block do
         "object2"
       end
-      @coffee_table.get_cache(:third_key) do
+      @proc_md53 = md5_block do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+      @coffee_table.fetch(:first_key) do
+        "object1"
+      end
+      @coffee_table.fetch(:second_key) do
+        "object2"
+      end
+      @coffee_table.fetch(:third_key) do
+        "object3"
+      end
+
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].sort
       @coffee_table.expire_key("fourth_key")
-      @coffee_table.keys.sort.should == ["first_key", "second_key", "third_key"].sort
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].sort
 
     end
+
+  end
+
+  context "monitoring code changes in block" do
+    context "changed block" do
+
+      it "should invalidate cache when block has changed" do
+        @coffee_table.fetch(:test_key) do
+          "object1"
+        end
+
+        result = @coffee_table.fetch(:test_key) do
+          "object2"
+        end
+
+        result.should == "object2"
+      end
+
+      it "should not invalidate block when block has not changed" do
+        object = "object1"
+        @coffee_table.fetch(:test_key) do
+          object
+        end
+
+        object = "object2"
+        result = @coffee_table.fetch(:test_key) do
+          object
+        end
+
+        result.should == "object1"
+      end
+
+      it "should not be affected by whitespace only changes" do
+        object = "object1"
+        @coffee_table.fetch(:test_key) do
+          object
+        end
+
+        object = "object2"
+        result = @coffee_table.fetch(:test_key) do
+
+                  object
+
+        end
+
+        result.should == "object1"
+      end
+
+    end
+
+    context "ignoring code changes" do
+
+      before(:each) do
+        @coffee_table = CoffeeTable::Cache.new(:ignore_code_changes => true)
+      end
+
+      it "should not invalidate cache when block has changed" do
+        @coffee_table.fetch(:test_key) do
+          "object1"
+        end
+
+        result = @coffee_table.fetch(:test_key) do
+          "object2"
+        end
+
+        result.should == "object1"
+      end
+    end
   end
   
   describe "expire_all" do
@@ -195,13 +295,13 @@ describe CoffeeTable do
       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
+      @coffee_table.fetch(:first_key) do
         "object1"
       end
-      @coffee_table.get_cache(:second_key) do
+      @coffee_table.fetch(:second_key) do
         "object2"
       end
-      @coffee_table.get_cache(:third_key) do
+      @coffee_table.fetch(:third_key) do
         "object3"
       end
     end
@@ -211,7 +311,7 @@ describe CoffeeTable do
       @coffee_table.expire_all
       @coffee_table.keys.count.should == 0
 
-      result = @coffee_table.get_cache(:first_key) do
+      result = @coffee_table.fetch(:first_key) do
         "changed value"
       end
 
@@ -226,6 +326,16 @@ describe CoffeeTable do
       @object2 = [SampleClass.new(4), SampleClass.new(2), SampleClass.new(5)]
       @object3 = [SampleClass.new(7), SampleClass.new(2), SampleClass.new(8)]
 
+      @proc_md51 = md5_block do
+        "object1"
+      end
+      @proc_md52 = md5_block do
+        "object2"
+      end
+      @proc_md53 = md5_block do
+        "object3"
+      end
+
     end
 
     it "should return an array of string" do
@@ -233,34 +343,34 @@ describe CoffeeTable do
       @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
+      @coffee_table.fetch(:first_key) do
         "object1"
       end
-      @coffee_table.get_cache(:second_key) do
+      @coffee_table.fetch(:second_key) do
         "object2"
       end
-      @coffee_table.get_cache(:third_key) do
+      @coffee_table.fetch(:third_key) do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key",
-                               "second_key",
-                               "third_key"].sort
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}",
+                               "second_key|#{@proc_md52}",
+                               "third_key|#{@proc_md53}"].sort
 
     end
     it "should return key created with objects and ids" do
-      @coffee_table.get_cache(:first_key, @object1) do
+      @coffee_table.fetch(:first_key, @object1) do
         "object1"
       end
-      @coffee_table.get_cache(:second_key, @object2) do
+      @coffee_table.fetch(:second_key, @object2) do
         "object2"
       end
-      @coffee_table.get_cache(:third_key, @object3) do
+      @coffee_table.fetch(: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
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}|sample_class[1]|sample_class[2]|sample_class[3]",
+                               "second_key|#{@proc_md52}|sample_class[4]|sample_class[2]|sample_class[5]",
+                               "third_key|#{@proc_md53}|sample_class[7]|sample_class[2]|sample_class[8]"].sort
     end
 
   end
@@ -271,13 +381,13 @@ describe CoffeeTable do
       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
+      @coffee_table.fetch(:first_key, object1) do
         "object1"
       end
-      @coffee_table.get_cache(:second_key, object2) do
+      @coffee_table.fetch(:second_key, object2) do
         "object2"
       end
-      @coffee_table.get_cache(:third_key, object3) do
+      @coffee_table.fetch(:third_key, object3) do
         "object3"
       end
     end
@@ -318,7 +428,7 @@ describe CoffeeTable do
     end
 
     it "should expire all keys relating to a class if uninitialised class is passed in" do
-      @coffee_table.get_cache(:fourth_key) do
+      @coffee_table.fetch(:fourth_key) do
         "object4"
       end
       @coffee_table.keys.count.should == 4

data/spec/lib/key_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CoffeeTable::Key do
+  
+  context "has correct methods" do
+    it "should have a parse class method" do
+      CoffeeTable::Key.should respond_to :parse
+    end
+    it "should have a has_element? instance method" do
+      CoffeeTable::Key.new("name", "key").should respond_to :has_element?
+    end
+    it "should have a has_element_type? instance method" do
+      CoffeeTable::Key.new("name", "key").should respond_to :has_element_type?
+    end
+  end
+
+  context "parsing a string" do
+    it "should parse a string into its elements" do
+      key = CoffeeTable::Key.parse("test|asdf|sample_class")
+
+
+      key.elements.count.should == 1
+      key.name.should == "test"
+      key.code_hash.should == "asdf"
+      key.elements[0].should == "sample_class"
+
+    end
+    it "should decode encoded elements" do
+      key = CoffeeTable::Key.parse("te|s&t|asdf|s&|sample_|s&class")
+
+
+      key.elements.count.should == 1
+      key.name.should == "te|s&t"
+      key.code_hash.should == "asdf|s&"
+      key.elements[0].should == "sample_|s&class"
+    end
+    it "should encode the key data" do
+
+      key = CoffeeTable::Key.new("te|s&t", "asdf|s&", "sample_|s&class")
+
+      key.name.should == "te|s&t"
+      key.code_hash.should == "asdf|s&"
+      key.elements[0].should == "sample_|s&class"
+
+      key.to_s.should == "te|s&t|asdf|s&|sample_|s&class"
+    
+    end
+  end
+
+  context "matching keys" do
+    it "should match a key on its name" do
+      key = CoffeeTable::Key.new("name", "key", "value", ["value1", "value2"])
+      key.has_element?("name").should be_true
+      key.has_element?("key").should be_false
+    end
+    it "should match a key on its data" do
+      key = CoffeeTable::Key.new("name", "key", "value", ["value1", "value2"])
+      key.has_element?("key").should be_false
+      key.has_element?("value").should be_true
+      key.has_element?("value1").should be_true
+      key.has_element?("value2").should be_true
+    end
+    it "should match a key on a class type" do
+      key = CoffeeTable::Key.new("name", "key", "sample_class[3]", ["value1", "value2"])
+      key.has_element?("key").should be_false
+      key.has_element_type?("sample_class").should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,7 @@
 require 'rubygems'
+require 'bundler/setup'
+
+require 'digest/md5'
 require 'spork'
 require 'mock_redis'
 require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/spec/lib/sample_class')
@@ -6,6 +9,7 @@ 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/key.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
@@ -35,3 +39,6 @@ def load_binary_sample(filename)
   File.open(File.dirname(__FILE__) + "/samples/" + filename, 'rb')
 end
 
+def md5_block(&block)
+  Digest::MD5.hexdigest(block.to_source)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coffee_table
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-17 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70181746090020 !ruby/object:Gem::Requirement
+  requirement: &70278554140820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70181746090020
+  version_requirements: *70278554140820
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70181746089420 !ruby/object:Gem::Requirement
+  requirement: &70278554140260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70181746089420
+  version_requirements: *70278554140260
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
-  requirement: &70181746088880 !ruby/object:Gem::Requirement
+  requirement: &70278554139760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70181746088880
+  version_requirements: *70278554139760
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70181746088280 !ruby/object:Gem::Requirement
+  requirement: &70278554139200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70181746088280
+  version_requirements: *70278554139200
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: &70278554138660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70278554138660
 description: rails cache gem to fragment cache with smart cache key management
 email:
 - stewart@theizone.co.uk
@@ -70,13 +81,16 @@ files:
 - Gemfile.lock
 - README.textile
 - Rakefile
+- changelog.txt
 - 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/key.rb
+- lib/coffee_table/utility.rb
 - lib/coffee_table/version.rb
-- lib/utility.rb
 - spec/lib/coffee_table_spec.rb
+- spec/lib/key_spec.rb
 - spec/lib/sample_class.rb
 - spec/lib/sample_class_without_id.rb
 - spec/spec_helper.rb
@@ -106,6 +120,7 @@ specification_version: 3
 summary: Gem to manage cache stored in redis
 test_files:
 - spec/lib/coffee_table_spec.rb
+- spec/lib/key_spec.rb
 - spec/lib/sample_class.rb
 - spec/lib/sample_class_without_id.rb
 - spec/spec_helper.rb