coffee_table 0.1.1 → 0.1.3

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+coffee_table

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/Gemfile

@@ -3,14 +3,15 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in coffee_table.gemspec
 gemspec
 
-gem "redis"
 gem "awesome_print"
 gem "rufus-scheduler"
 gem "activesupport"
 gem "sourcify", :git => "git@github.com:stewartmckee/sourcify.git"
+gem "gzip"
 
 group :test do
   gem "rspec"
   gem "mock_redis"
   gem "spork"
-end
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -11,8 +11,9 @@ GIT
 PATH
   remote: .
   specs:
-    coffee_table (0.1.0)
+    coffee_table (0.1.2)
       activesupport
+      gzip
       redis
       rufus-scheduler
       sourcify
@@ -20,36 +21,52 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     awesome_print (1.1.0)
-    diff-lcs (1.1.3)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
     file-tail (1.0.12)
       tins (~> 0.5)
-    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)
+    gzip (1.0)
+    i18n (0.6.4)
+    mime-types (1.23)
+    mock_redis (0.9.0)
+    multi_json (1.7.8)
+    redis (3.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.1)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
     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)
+    rufus-scheduler (2.0.23)
       tzinfo (>= 0.3.23)
     sexp_processor (3.2.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
     spork (0.9.2)
-    tins (0.7.0)
-    tzinfo (0.3.35)
+    thor (0.18.1)
+    tins (0.8.3)
+    tzinfo (1.0.1)
 
 PLATFORMS
   ruby
@@ -58,8 +75,9 @@ DEPENDENCIES
   activesupport
   awesome_print
   coffee_table!
+  coveralls
+  gzip
   mock_redis
-  redis
   rspec
   rufus-scheduler
   sourcify!

data/README.textile

@@ -1,11 +1,13 @@
 
 h1. CoffeeTable v0.1.1
 
+!https://badge.fury.io/rb/coffee_table.png!:http://badge.fury.io/rb/coffee_table
 !https://gemnasium.com/stewartmckee/coffee_table.png!
+!https://coveralls.io/repos/stewartmckee/coffee_table/badge.png?branch=master(Coverage Status)!:https://coveralls.io/r/stewartmckee/coffee_table
 
 h2. Intro 
   
-  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.
+  CoffeeTable is a smart fragment caching gem that 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
 
@@ -34,21 +36,23 @@ Creates a new cache object.  You can pass options into this method to modify the
   * :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.
+  * :compress_content defaults to true and sets whether large strings are compressed
+  * :compress_min_size defaults to 10240, which is 10k any strings larger than this are compressed before being stored
   
 
-h4. get_cache(initial_key, *related_objects, &block)
+h4. fetch(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
+bc. user_details = @coffee_table.fetch(: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.
+Each time this is ran when a cache item doesn't exist, a unique cache key is generated based on the data passed in, and the code block being executed.  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
+bc. user_details = @coffee_table.fetch(:user_detail, User) do
   @user.get_something_that_uses_all_users
 end
 

data/changelog.txt

@@ -1,7 +1,13 @@
 
+0.1.3
+  - added compression for string content over 10k in size, can be turned off and limit changed
+
+0.1.2
+  - added ObjectDefinition to allow hashes to be used in key (eg for params in the controller)
+
 0.1.1
   - updated documentation
-  - refacotred get_cache method to fetch
+  - refactored get_cache method to fetch
 
 0.1.0
   

data/coffee_table.gemspec

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

data/lib/coffee_table/block_missing_error.rb

@@ -0,0 +1,4 @@
+module CoffeeTable
+  class BlockMissingError < StandardError
+  end
+end

data/lib/coffee_table/invalid_object_error.rb

@@ -0,0 +1,5 @@
+module CoffeeTable
+  class InvalidObjectError < StandardError
+    
+  end
+end

data/lib/coffee_table/key.rb

@@ -5,15 +5,16 @@ module CoffeeTable
     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]
+      elements = string.split("|", -1).map{|e| decode_element(e) }
+      key = Key.new(elements[0], elements[1], Hash[elements.last.split("&").map{|kv| [kv.split("=")[0].to_sym, kv.split("=")[1]]}])
+      key.elements =  elements[2..-2]
       key
     end
 
-    def initialize(name, block_key, *objects)
+    def initialize(name, block_key, options, *objects)
       @name = name
       @block_key = block_key
+      @options = options
       @elements = objects.flatten.map{|o| key_for_object(o)}
     end
 
@@ -33,6 +34,14 @@ module CoffeeTable
       @block_key
     end
 
+    def options
+      @options
+    end
+
+    def add_flag(options)
+      @options.merge!(options)
+    end
+
     def elements
       @elements
     end
@@ -46,7 +55,7 @@ module CoffeeTable
     end
 
     def to_s
-      [encode_element(@name), encode_element(@block_key), @elements.map{|e| encode_element(e) }].flatten.join("|")
+      [encode_element(@name), encode_element(@block_key), @elements.map{|e| encode_element(e) }, encode_element(@options.map{|k,v| "#{k}=#{v}"}.join("&"))].flatten.join("|")
     end
 
     private
@@ -72,6 +81,8 @@ module CoffeeTable
         "#{ActiveSupport::Inflector.pluralize(underscore(o.to_s))}"
       elsif o.kind_of?(String) || o.kind_of?(Symbol)
         "#{underscore(o.to_s)}"
+      elsif o.class == CoffeeTable::ObjectDefinition
+        o.to_s
       else
         "#{underscore(o.class.to_s)}[#{o.id}]"
       end

data/lib/coffee_table/object_definition.rb

@@ -0,0 +1,18 @@
+module CoffeeTable
+  class ObjectDefinition
+
+    def initialize(klass, id)
+      @klass = klass
+      @id = id
+    end
+
+    def self.from_hash(hash)
+      hash.map {|k, v| ObjectDefinition.new(k, v)}
+    end
+
+    def to_s
+      "#{@klass.to_s}[#{@id.to_s}]"
+    end
+
+  end
+end

data/lib/coffee_table/version.rb

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

data/lib/coffee_table.rb

@@ -1,10 +1,15 @@
 require "coffee_table/version"
 require "coffee_table/utility"
+require "coffee_table/key"
+require "coffee_table/invalid_object_error"
+require "coffee_table/block_missing_error"
+require "coffee_table/object_definition"
 require "redis"
 require 'rufus/scheduler'
 require 'active_support/inflector'
-require "sourcify"
+require 'sourcify'
 require 'digest/md5'
+require 'gzip'
 
 module CoffeeTable
   class Cache
@@ -19,18 +24,18 @@ module CoffeeTable
       default_enable_cache_to true
       default_redis_namespace_to :coffee_table
       default_redis_server_to "127.0.0.1"
-      default_redis_port_to 6789
+      default_redis_port_to 6379
       default_ignore_code_changes_to false
-
+      default_compress_content_to true
+      default_compress_min_size_to 10240
       @redis = Redis.new({:server => @options[:redis_server], :port => @options[:redis_port]})
       @scheduler = Rufus::Scheduler.start_new
       
     end
 
-    # main
+      
     def fetch(initial_key, *related_objects, &block)
-
-      raise CoffeeTableBlockMissingError, "No block given to generate cache from" unless block_given?
+      raise CoffeeTable::BlockMissingError, "No block given to generate cache from" unless block_given?
 
       # extract the options hash if it is present
       options = {}
@@ -40,7 +45,7 @@ module CoffeeTable
       end
 
       # 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)}
+      related_objects.flatten.map{|o| raise CoffeeTable::InvalidObjectError, "Objects passed in must have an id method or be a class" unless object_valid?(o)}
 
       if @options[:ignore_code_changes]
         block_key = ""
@@ -48,8 +53,12 @@ module CoffeeTable
         block_key = Digest::MD5.hexdigest(block.to_source)
       end
 
+      flags = {}
+
+
+
       # 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)
+      key = CoffeeTable::Key.new(initial_key, block_key, flags, related_objects)
       
       if @options[:enable_cache]
         if options.has_key?(:expiry)
@@ -60,15 +69,23 @@ module CoffeeTable
         
         @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))
+          if key.options[:compressed]
+            result = marshal_value(@redis.get(key.to_s).gunzip)
+          else
+            result = marshal_value(@redis.get(key.to_s))
+          end
         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.to_s, Marshal.dump(result)
+
+          compress_result = @options[:compress_content] && result.kind_of?(String) && result.length > @options[:compress_min_size]
+
+          if compress_result
+            key.add_flag(:compressed => true)
+            @redis.set key.to_s, Marshal.dump(result.gzip)
+          else
+            @redis.set key.to_s, Marshal.dump(result)
+          end
+
           unless expiry.nil?
             @redis.expire key.to_s, expiry
             @scheduler.in "#{expiry}s" do
@@ -83,7 +100,7 @@ module CoffeeTable
     end
   
     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|
+      keys.map{|k| CoffeeTable::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
@@ -109,7 +126,7 @@ module CoffeeTable
       if perform_caching
         deleted_keys = []
         unless objects.count == 0
-          keys.map{|k| Key.parse(k)}.each do |key|
+          keys.map{|k| CoffeeTable::Key.parse(k)}.each do |key|
             expire = true
             objects.each do |object|
               if object.class == String || object.class == Symbol
@@ -154,6 +171,5 @@ module CoffeeTable
     def object_valid?(o)
       o.respond_to?(:id) || o.class == Class
     end
-
   end
 end

data/spec/lib/coffee_table_spec.rb

@@ -18,13 +18,13 @@ describe CoffeeTable::Cache 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 CoffeeTableBlockMissingError
+      lambda{CoffeeTable::Cache.new}.should_not raise_exception
     end
   end
   
   describe "fetch" do
     it "should raise an exception when block not given" do
-      lambda{@coffee_table.fetch("asdf")}.should raise_exception CoffeeTableBlockMissingError
+      lambda{@coffee_table.fetch("asdf")}.should raise_exception CoffeeTable::BlockMissingError
     end
     it "should execute block when cache value not available" do
       result = @coffee_table.fetch("asdf") do
@@ -47,6 +47,73 @@ describe CoffeeTable::Cache do
       
     end
 
+    context "compressing" do
+
+      before(:each) do
+        @redis = Redis.new({:server => "127.0.0.1", :port => 6379})
+
+      end
+
+      it "compresses on strings greater than limit" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_min_size => 20)
+        zipped_content = "this string should be long".gzip
+        result = @coffee_table.fetch(:test_key) do
+          "this string should be long"
+        end
+        result.should eql "this string should be long"
+        @redis.get("test_key|1bdc7485920d15e21276c0c54cdb5bcf|compressed=true").should eql Marshal.dump(zipped_content)
+      end
+      it "does not compress on non strings" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_min_size => 20)
+        result = @coffee_table.fetch(:test_key) do
+          {:test => "this value is a decent length to trigger compress"}
+        end
+        result.should eql ({:test => "this value is a decent length to trigger compress"})
+        @redis.get("test_key|9e6b3fa8a7fd45acb4734946faf5b61c|").should eql "\x04\b{\x06:\ttestI\"6this value is a decent length to trigger compress\x06:\x06EF"
+      end
+
+      it "does not compress when turned off" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_content => false)
+        result = @coffee_table.fetch(:test_key) do
+          "this string should be long"
+        end
+        result.should eql "this string should be long"
+        @redis.get("test_key|1bdc7485920d15e21276c0c54cdb5bcf|").should eql "\x04\bI\"\x1Fthis string should be long\x06:\x06EF"
+      end
+      it "does not compress on strings below limit" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_min_size => 20)
+        result = @coffee_table.fetch(:test_key) do
+          "short"
+        end
+        result.should eql "short"
+        @redis.get("test_key|73a95ee5162c38b2ebda1f70a3ab5893|").should eql "\x04\bI\"\nshort\x06:\x06EF"
+      end
+      it "decompresses compressed value" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_min_size => 20)
+        @coffee_table.fetch(:test_key) do
+          "this string should be long"
+        end
+        result = @coffee_table.fetch(:test_key) do
+          "this string should be long"
+        end
+        result.class.should eql String
+        result.should eql "this string should be long"
+
+      end
+      it "does not decompress a non compressed value" do
+        @coffee_table = CoffeeTable::Cache.new(:compress_min_size => 20)
+        @coffee_table.fetch(:test_key) do
+          "short"
+        end
+        result = @coffee_table.fetch(:test_key) do
+          "short"
+        end
+        result.should eql "short"
+      end
+
+
+    end
+
     context "keys" do
       it "should create a key with just the initial key" do
         md5 = md5_block do
@@ -55,7 +122,7 @@ describe CoffeeTable::Cache do
         result = @coffee_table.fetch(:test_key) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|#{md5}"]
+        @coffee_table.keys.should == ["test_key|#{md5}|"]
       end
 
       it "should create key from class" do
@@ -65,7 +132,7 @@ describe CoffeeTable::Cache do
         result = @coffee_table.fetch(:test_key, SampleClass) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|#{md5}|sample_classes"]
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_classes|"]
       end
       
       it "should use class name for keys" do
@@ -75,7 +142,7 @@ describe CoffeeTable::Cache do
         result = @coffee_table.fetch(:test_key, SampleClass.new(2)) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]"]
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]|"]
       end
 
       it "should use id from class in key" do
@@ -85,7 +152,7 @@ describe CoffeeTable::Cache do
         result = @coffee_table.fetch(:test_key, SampleClass.new(2)) do
           "this is a changed value"
         end
-        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]"]
+        @coffee_table.keys.should == ["test_key|#{md5}|sample_class[2]|"]
       end
 
     end
@@ -101,7 +168,7 @@ describe CoffeeTable::Cache do
           "this is a changed value"
         end
         
-        @coffee_table.keys.should include "test_key|#{md5}|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
@@ -111,7 +178,7 @@ describe CoffeeTable::Cache 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"
+        }.should raise_exception CoffeeTable::InvalidObjectError, "Objects passed in must have an id method or be a class"
         
       end
 
@@ -124,7 +191,7 @@ describe CoffeeTable::Cache do
           "this is a changed value"
         end
         
-        @coffee_table.keys.should include "test_key|#{md5}|sample_classes"          
+        @coffee_table.keys.should include "test_key|#{md5}|sample_classes|"          
       end
 
     end
@@ -160,6 +227,29 @@ describe CoffeeTable::Cache do
         result.should == "this is a changed value"      
       end
     end
+
+    context "changing block" do
+      it "should not change key with same code" do
+        object = "object1"
+        @coffee_table.get_cache(:test_key) do
+          object
+        end
+        object = "object2"
+        result = @coffee_table.get_cache(:test_key) do
+          object
+        end
+        result.should == "object1"
+      end
+      it "should change key with changed code" do
+        @coffee_table.get_cache(:test_key) do
+          "object1"
+        end
+        result = @coffee_table.get_cache(:test_key) do
+          "object2"
+        end
+        result.should == "object2"
+      end
+    end
   end
   
   describe "expire_key" do
@@ -187,9 +277,9 @@ describe CoffeeTable::Cache do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].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|#{@proc_md51}", "third_key|#{@proc_md53}"].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
@@ -213,9 +303,9 @@ describe CoffeeTable::Cache do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].sort
+      @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|#{@proc_md51}", "second_key|#{@proc_md52}", "third_key|#{@proc_md53}"].sort
+      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}|", "second_key|#{@proc_md52}|", "third_key|#{@proc_md53}|"].sort
 
     end
 
@@ -353,9 +443,9 @@ describe CoffeeTable::Cache do
         "object3"
       end
 
-      @coffee_table.keys.sort.should == ["first_key|#{@proc_md51}",
-                               "second_key|#{@proc_md52}",
-                               "third_key|#{@proc_md53}"].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
@@ -368,9 +458,9 @@ describe CoffeeTable::Cache do
       @coffee_table.fetch(:third_key, @object3) do
         "object3"
       end
-      @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
+      @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

data/spec/lib/key_spec.rb

@@ -7,16 +7,16 @@ describe CoffeeTable::Key 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?
+      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?
+      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 = CoffeeTable::Key.parse("test|asdf|sample_class|")
 
 
       key.elements.count.should == 1
@@ -26,7 +26,7 @@ describe CoffeeTable::Key do
 
     end
     it "should decode encoded elements" do
-      key = CoffeeTable::Key.parse("te|s&t|asdf|s&|sample_|s&class")
+      key = CoffeeTable::Key.parse("te|s&t|asdf|s&|sample_|s&class|")
 
 
       key.elements.count.should == 1
@@ -36,34 +36,81 @@ describe CoffeeTable::Key do
     end
     it "should encode the key data" do
 
-      key = CoffeeTable::Key.new("te|s&t", "asdf|s&", "sample_|s&class")
+      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"
+      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 = 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 = 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 = 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
+
+  context "storing options" do
+
+    before(:each) do
+      @obj1 = CoffeeTable::ObjectDefinition.new(:test, 1)
+      @obj2 = CoffeeTable::ObjectDefinition.new(:test, 2)
+      @obj3 = CoffeeTable::ObjectDefinition.new(:test, 3)
+    end
+
+    it "should encode options into key" do
+      key = CoffeeTable::Key.new("name", "key", {:option => "value", :option2 => "value2"})
+      key.to_s.should eql "name|key|option=value&option2=value2"
+    end
+    it "should parse back options out of key" do
+      key = CoffeeTable::Key.parse("name|block|key=value")
+      key.options.should eql ({:key => "value"})
+
+    end
+    it "should handle no options" do
+      key = CoffeeTable::Key.new("name", "key", {})
+      key.to_s.should eql "name|key|"
+    end
+
+    it "should handle one option" do
+      key = CoffeeTable::Key.new("name", "key", {:option => "value"})
+      key.to_s.should eql "name|key|option=value"
+    end
+    it "should handle multiple options" do
+      key = CoffeeTable::Key.new("name", "key", {:option => "value", :option2 => "value2"})
+      key.to_s.should eql "name|key|option=value&option2=value2"
+    end
+
+    it "matches regardless of flags" do
+      key = CoffeeTable::Key.new("name", "key", {:option => "value", :option2 => "value2"}, @obj1, @obj2, @obj3)
+      key.has_element?("test[1]").should be_true
+      key.has_element?("test[2]").should be_true
+      key.has_element?("test[3]").should be_true
+      key.has_element?("test[4]").should be_false
+    end
+
+    it "does not match on flag values" do
+      key = CoffeeTable::Key.new("name", "key", {:option => "value", :option2 => "value2"}, @obj1, @obj2, @obj3)
+      key.has_element?("option=value&option2=value2").should be_false
+      
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,17 +1,21 @@
 require 'rubygems'
 require 'bundler/setup'
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'digest/md5'
 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')
+  require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table/block_missing_error.rb')
+  require File.expand_path(File.dirname(__FILE__) + '/../../coffee_table/lib/coffee_table/invalid_object_error.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
 
 Spork.each_run do
@@ -19,8 +23,8 @@ Spork.each_run do
     config.before(:each) {
       
       
-      redis = mock(:redis)
-      Redis.stub!(:new).and_return(MockRedis.new)
+      redis = double(:redis)
+      Redis.stub(:new).and_return(MockRedis.new)
       CoffeeTable::Cache.new.expire_all
       
     }
@@ -30,8 +34,6 @@ Spork.each_run do
   end  
 end
 
-
-
 def load_sample(filename)
   File.open(File.dirname(__FILE__) + "/samples/" + filename).map { |line| line}.join("\n")  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coffee_table
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70278554140820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70278554140820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70278554140260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278554140260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
-  requirement: &70278554139760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278554139760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70278554139200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278554139200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sourcify
-  requirement: &70278554138660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,28 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70278554138660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: rails cache gem to fragment cache with smart cache key management
 email:
 - stewart@theizone.co.uk
@@ -75,7 +116,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
+- .ruby-gemset
+- .ruby-version
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -84,9 +126,10 @@ files:
 - 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/block_missing_error.rb
+- lib/coffee_table/invalid_object_error.rb
 - lib/coffee_table/key.rb
+- lib/coffee_table/object_definition.rb
 - lib/coffee_table/utility.rb
 - lib/coffee_table/version.rb
 - spec/lib/coffee_table_spec.rb
@@ -114,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: coffee_table
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Gem to manage cache stored in redis

data/.rvmrc

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

data/lib/coffee_table/coffee_table_block_missing_error.rb

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

data/lib/coffee_table/coffee_table_invalid_object_error.rb

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