kasket 0.5.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gemspec
+
+## PROJECT::SPECIFIC
+test/debug.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mick Staugaard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= kasket
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Mick Staugaard. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "kasket"
+    gem.summary = %Q{A write back caching layer on active record}
+    gem.description = %Q{A rewrite of cache money}
+    gem.email = "mick@staugaard.com"
+    gem.homepage = "http://github.com/staugaard/kasket"
+    gem.authors = ["Mick Staugaard"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.rcov_opts << "--exclude \"test/*,gems/*,/Library/Ruby/*,config/*\" --rails" 
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kasket #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.2

data/lib/kasket.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+
+require 'kasket/configuration_mixin'
+require 'kasket/reload_association_mixin'
+require 'kasket/cache'
+
+module Kasket
+  CONFIGURATION = {:max_collection_size => 100}
+
+  module_function
+
+  def cache
+    Thread.current["kasket_cache"] ||= Cache.new
+  end
+
+  def setup(options = {})
+    CONFIGURATION[:max_collection_size] = options[:max_collection_size] if options[:max_collection_size]
+
+    ActiveRecord::Base.extend(Kasket::ConfigurationMixin)
+    ActiveRecord::Associations::BelongsToAssociation.send(:include, Kasket::ReloadAssociationMixin)
+    ActiveRecord::Associations::BelongsToPolymorphicAssociation.send(:include, Kasket::ReloadAssociationMixin)
+    ActiveRecord::Associations::HasOneThroughAssociation.send(:include, Kasket::ReloadAssociationMixin)
+
+    #sets up local cache clearing after each request
+    begin
+      ApplicationController.after_filter do
+        Kasket.cache.clear_local
+      end
+    rescue NameError => e
+
+    end
+
+    #sets up local cache clearing after each test case
+    begin
+      ActiveSupport::TestCase.class_eval do
+        setup :clear_cache
+        def clear_cache
+          Kasket.cache.clear_local
+          Rails.cache.clear if Rails.cache.respond_to?(:clear)
+        end
+      end
+    rescue NameError => e
+    end
+  end
+end

data/lib/kasket/cache.rb

@@ -0,0 +1,82 @@
+module Kasket
+  class Cache
+    def initialize
+      clear_local
+    end
+
+    def read(*args)
+      result = @local_cache[args[0]] || Rails.cache.read(*args)
+      if result.is_a?(CachedModel)
+        result = result.instanciate_model
+      elsif result.is_a?(Array)
+        models = get_multi(result)
+        result = result.map { |key| models[key]}
+      end
+
+      @local_cache[args[0]] = result if result
+      result
+    end
+
+    def get_multi(keys)
+      map = Hash[keys.zip(keys.map { |key| @local_cache[key] })]
+      missing_keys = map.select { |key, value| value.nil? }.map(&:first)
+
+      unless missing_keys.empty?
+        if Rails.cache.respond_to?(:read_multi)
+          missing_map = Rails.cache.read_multi(missing_keys)
+          missing_map.each do |key, value|
+            value = value.instanciate_model if value.is_a?(CachedModel)
+            missing_map[key] = @local_cache[key] = value
+          end
+          map.merge!(missing_map)
+        else
+          missing_keys.each do |key|
+            map[key] = read(key)
+          end
+        end
+      end
+
+      map
+    end
+
+    def write(*args)
+      @local_cache[args[0]] = args[1]
+
+      if args[1].is_a?(ActiveRecord::Base)
+        args[1] = CachedModel.new(args[1])
+      end
+
+      Rails.cache.write(*args)
+    end
+
+    def delete(*args)
+      @local_cache.delete(args[0])
+      Rails.cache.delete(*args)
+    end
+
+    def delete_local(*keys)
+      keys.each do |key|
+        @local_cache.delete(key)
+      end
+    end
+
+    def delete_matched_local(matcher)
+      @local_cache.delete_if { |k,v| k =~ matcher }
+    end
+
+    def clear_local
+      @local_cache = {}
+    end
+
+    class CachedModel
+      def initialize(model)
+        @name = model.class.name
+        @attributes = model.instance_variable_get(:@attributes)
+      end
+
+      def instanciate_model
+        @name.constantize.send(:instantiate, @attributes)
+      end
+    end
+  end
+end

data/lib/kasket/conditions_parser.rb

@@ -0,0 +1,79 @@
+module Kasket
+  class ConditionsParser
+    def initialize(model_class)
+      @model_class = model_class
+    end
+
+    def attribute_value_pairs(options)
+      #pulls out the conditions from each hash
+      condition_fragments = [options[:conditions]]
+
+      #add the scope to the mix
+      if scope = @model_class.send(:scope, :find)
+        condition_fragments << scope[:conditions]
+      end
+
+      #add the type if we are on STI
+      condition_fragments << {:type => @model_class.name} if @model_class.finder_needs_type_condition?
+
+      condition_fragments.compact!
+
+      #parses each conditions fragment but bails if one of the did not parse
+      attributes_fragments = condition_fragments.map do |condition_fragment|
+        attributes_fragment = attributes_for_conditions(condition_fragment)
+        return nil unless attributes_fragment
+        attributes_fragment
+      end
+
+      #merges the hashes but bails if there is an overlap
+      attributes = attributes_fragments.inject({}) do |memo, attributes_fragment|
+        attributes_fragment.each do |attribute, value|
+          return nil if memo.has_key?(attribute)
+          memo[attribute] = value
+        end
+        memo
+      end
+
+      attributes.keys.sort.map { |attribute| [attribute.to_sym, attributes[attribute]] }
+    end
+
+    def attributes_for_conditions(conditions)
+      pairs = case conditions
+        when Hash
+          return conditions.stringify_keys
+        when String
+          parse_indices_from_condition(conditions)
+        when Array
+          parse_indices_from_condition(*conditions)
+        when NilClass
+          []
+      end
+
+      return nil unless pairs
+
+      pairs.inject({}) do |memo, pair|
+        return nil if memo.has_key?(pair[0])
+        memo[pair[0]] = pair[1]
+        memo
+      end
+    end
+
+    AND = /\s+AND\s+/i
+    TABLE_AND_COLUMN = /(?:(?:`|")?(\w+)(?:`|")?\.)?(?:`|")?(\w+)(?:`|")?/ # Matches: `users`.id, `users`.`id`, users.id, id
+    VALUE = /'?(\d+|\?|(?:(?:[^']|'')*))'?/                     # Matches: 123, ?, '123', '12''3'
+    KEY_EQ_VALUE = /^[\(\s]*#{TABLE_AND_COLUMN}\s+=\s+#{VALUE}[\)\s]*$/ # Matches: KEY = VALUE, (KEY = VALUE), ()(KEY = VALUE))
+
+    def parse_indices_from_condition(conditions = '', *values)
+      values = values.dup
+      conditions.split(AND).inject([]) do |indices, condition|
+        matched, table_name, column_name, sql_value = *(KEY_EQ_VALUE.match(condition))
+        if matched
+          value = sql_value == '?' ? values.shift : @model_class.columns_hash[column_name].type_cast(sql_value)
+          indices << [column_name, value]
+        else
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/kasket/configuration_mixin.rb

@@ -0,0 +1,49 @@
+require 'active_support'
+
+module Kasket
+  autoload :ReadMixin, 'kasket/read_mixin'
+  autoload :WriteMixin, 'kasket/write_mixin'
+  autoload :DirtyMixin, 'kasket/dirty_mixin'
+
+  module ConfigurationMixin
+    def kasket_key_prefix
+      @kasket_key_prefix ||= "kasket/#{table_name}/version=#{column_names.join.sum}/"
+    end
+
+    def kasket_key_for(attribute_value_pairs)
+      kasket_key_prefix + attribute_value_pairs.map {|attribute, value| attribute.to_s + '=' + value.to_s}.join('/')
+    end
+
+    def kasket_key_for_id(id)
+      kasket_key_for([['id', id]])
+    end
+
+    def kasket_indices
+      result = @kasket_indices || []
+      result += superclass.kasket_indices unless self == ActiveRecord::Base
+      result.uniq
+    end
+
+    def has_kasket_index_on?(sorted_attributes)
+      kasket_indices.include?(sorted_attributes)
+    end
+
+    def has_kasket(options = {})
+      has_kasket_on :id
+    end
+
+    def has_kasket_on(*args)
+      attributes = args.sort! { |x, y| x.to_s <=> y.to_s }
+      if attributes != [:id] && !kasket_indices.include?([:id])
+        has_kasket_on(:id)
+      end
+
+      @kasket_indices ||= []
+      @kasket_indices << attributes unless @kasket_indices.include?(attributes)
+
+      include WriteMixin unless instance_methods.include?('store_in_kasket')
+      extend ReadMixin unless methods.include?('without_kasket')
+      extend DirtyMixin unless methods.include?('kasket_dirty_methods')
+    end
+  end
+end

data/lib/kasket/dirty_mixin.rb

@@ -0,0 +1,18 @@
+module Kasket
+  module DirtyMixin
+    def kasket_dirty_methods(*method_names)
+      method_names.each do |method|
+        unless method_defined?("without_kasket_update_#{method}")
+          alias_method("without_kasket_update_#{method}", method)
+          define_method(method) do |*args|
+            result = send("without_kasket_update_#{method}", *args)
+            clear_kasket_indices
+            result
+          end
+        end
+      end
+    end
+
+    alias_method :kasket_dirty_method, :kasket_dirty_methods
+  end
+end

data/lib/kasket/read_mixin.rb

@@ -0,0 +1,92 @@
+require 'kasket/conditions_parser'
+
+module Kasket
+  module ReadMixin
+
+    def self.extended(model_class)
+      class << model_class
+        alias_method_chain :find_some, :kasket unless methods.include?('find_some_without_kasket')
+        alias_method_chain :find_every, :kasket unless methods.include?('find_every_without_kasket')
+      end
+    end
+
+    def without_kasket(&block)
+      old_value = @use_kasket || true
+      @use_kasket = false
+      yield
+    ensure
+      @use_kasket = old_value
+    end
+
+    def find_every_with_kasket(options)
+      attribute_value_pairs = kasket_conditions_parser.attribute_value_pairs(options) if cache_safe?(options)
+
+      limit = (options[:limit] || (scope(:find) || {})[:limit])
+
+      if (limit.nil? || limit == 1) && attribute_value_pairs && has_kasket_index_on?(attribute_value_pairs.map(&:first))
+        collection_key = kasket_key_for(attribute_value_pairs)
+        collection_key << '/first' if limit == 1
+        unless records = Kasket.cache.read(collection_key)
+          records = without_kasket do
+            find_every_without_kasket(options)
+          end
+
+          if records.size == 1
+            Kasket.cache.write(collection_key, records[0])
+          elsif records.size <= Kasket::CONFIGURATION[:max_collection_size]
+            records.each { |record| record.store_in_kasket if record }
+            Kasket.cache.write(collection_key, records.map(&:kasket_key))
+          end
+        end
+
+        Array(records)
+      else
+        without_kasket do
+          find_every_without_kasket(options)
+        end
+      end
+    end
+
+    def find_some_with_kasket(ids, options)
+      attribute_value_pairs = kasket_conditions_parser.attribute_value_pairs(options) if cache_safe?(options)
+      attribute_value_pairs << [:id, ids] if attribute_value_pairs
+
+      limit = (options[:limit] || (scope(:find) || {})[:limit])
+
+      if limit.nil? && attribute_value_pairs && has_kasket_index_on?(attribute_value_pairs.map(&:first))
+        id_to_key_map = Hash[ids.uniq.map { |id| [id, kasket_key_for_id(id)] }]
+        cached_record_map = Kasket.cache.get_multi(id_to_key_map.values)
+
+        missing_keys = Hash[cached_record_map.select { |key, record| record.nil? }].keys
+
+        return cached_record_map.values if missing_keys.empty?
+
+        missing_ids = Hash[id_to_key_map.invert.select { |key, id| missing_keys.include?(key) }].values
+
+        db_records = without_kasket do
+          find_some_without_kasket(missing_ids, options)
+        end
+        db_records.each { |record| record.store_in_kasket if record }
+
+        (cached_record_map.values + db_records).compact.uniq.sort { |x, y| x.id <=> y.id}
+      else
+        without_kasket do
+          find_some_without_kasket(ids, options)
+        end
+      end
+    end
+
+    private
+
+      def cache_safe?(options)
+        @use_kasket != false && [options, scope(:find) || {}].all? do |hash|
+          result = hash[:select].nil? && hash[:joins].nil? && hash[:order].nil? && hash[:offset].nil?
+          result && (options[:limit].nil? || options[:limit] == 1)
+        end
+      end
+
+      def kasket_conditions_parser
+        @kasket_conditions_parser ||= Kasket::ConditionsParser.new(self)
+      end
+  end
+end

data/lib/kasket/reload_association_mixin.rb

@@ -0,0 +1,19 @@
+module Kasket
+  module ReloadAssociationMixin
+    def reload_with_kasket_clearing(*args)
+      if loaded?
+        clear_local_kasket_indices if respond_to?(:clear_local_kasket_indices)
+      end
+
+      # or maybe something like this?
+      #target_class = proxy_reflection.options[:polymorphic] ? association_class : proxy_reflection.klass
+      #Kasket.cache.delete_matched_local(/^#{target_class.kasket_key_prefix}/) if target_class.respond_to?(:kasket_key_prefix)
+
+      reload_without_kasket_clearing(*args)
+    end
+
+    def self.included(base)
+      base.alias_method_chain :reload, :kasket_clearing
+    end
+  end
+end

data/lib/kasket/write_mixin.rb

@@ -0,0 +1,79 @@
+module Kasket
+  module WriteMixin
+    module ClassMethods
+      def remove_from_kasket(ids)
+        Array(ids).each do |id|
+          Kasket.cache.delete(kasket_key_for_id(id))
+        end
+      end
+
+      def update_counters_with_kasket_clearing(*args)
+        remove_from_kasket(args[0])
+        update_counters_without_kasket_clearing(*args)
+      end
+    end
+
+    module InstanceMethods
+      def kasket_key
+        @kasket_key ||= new_record? ? nil : self.class.kasket_key_for_id(id)
+      end
+
+      def store_in_kasket
+        if !readonly? && kasket_key
+          Kasket.cache.write(kasket_key, self)
+        end
+      end
+
+      def kasket_keys
+        attribute_sets = [attributes.symbolize_keys]
+
+        if changed?
+          old_attributes = Hash[changes.map {|attribute, values| [attribute, values[0]]}].symbolize_keys
+          attribute_sets << old_attributes.reverse_merge(attribute_sets[0])
+        end
+
+        keys = []
+        self.class.kasket_indices.each do |index|
+          keys += attribute_sets.map do |attribute_set|
+            self.class.kasket_key_for(index.map { |attribute| [attribute, attribute_set[attribute]]})
+          end
+        end
+
+        keys.uniq!
+        keys.map! {|key| [key, "#{key}/first"]}
+        keys.flatten!
+      end
+
+      def clear_kasket_indices
+        kasket_keys.each do |key|
+          Kasket.cache.delete(key)
+        end
+      end
+
+      def clear_local_kasket_indices
+        kasket_keys.each do |key|
+          Kasket.cache.delete_local(key)
+        end
+      end
+
+      def reload_with_kasket_clearing(*args)
+        clear_local_kasket_indices
+        reload_without_kasket_clearing(*args)
+      end
+    end
+
+    def self.included(model_class)
+      model_class.extend         ClassMethods
+      model_class.send :include, InstanceMethods
+
+      model_class.after_save :clear_kasket_indices
+      model_class.after_destroy :clear_kasket_indices
+
+      model_class.alias_method_chain :reload, :kasket_clearing
+
+      class << model_class
+        alias_method_chain :update_counters, :kasket_clearing
+      end
+    end
+  end
+end

data/test/cache_expiry_test.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/helper'
+
+class CacheExpiryTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts
+
+  Post.has_kasket
+  Post.has_kasket_on :title
+  Post.has_kasket_on :blog_id
+
+  context "a cached object" do
+    setup do
+      post = Post.first
+      @post = Post.find(post.id)
+      assert(Rails.cache.read(@post.kasket_key))
+    end
+
+    should "be removed from cache when deleted" do
+      @post.destroy
+      assert_nil(Rails.cache.read(@post.kasket_key))
+    end
+
+    should "clear all indices for instance when deleted" do
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "id=#{@post.id}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "id=#{@post.id}/first")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=#{@post.title}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=#{@post.title}/first")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "blog_id=#{@post.blog_id}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "blog_id=#{@post.blog_id}/first")
+      Kasket.cache.expects(:delete).never
+
+      @post.destroy
+    end
+
+    should "be removed from cache when updated" do
+      @post.title = "new title"
+      @post.save
+      assert_nil(Rails.cache.read(@post.kasket_key))
+    end
+
+    should "clear all indices for instance when updated" do
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "id=#{@post.id}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "id=#{@post.id}/first")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=#{@post.title}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=#{@post.title}/first")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=new title")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "title=new title/first")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "blog_id=#{@post.blog_id}")
+      Kasket.cache.expects(:delete).with(Post.kasket_key_prefix + "blog_id=#{@post.blog_id}/first")
+      Kasket.cache.expects(:delete).never
+
+      @post.title = "new title"
+      @post.save
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql
+  encoding: utf8
+  database: kasket_test
+  username: root
+  password:
+  socket: /tmp/mysql.sock

data/test/dirty_test.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/helper'
+
+class DirtyTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts
+
+  Post.has_kasket
+  Post.kasket_dirty_methods :make_dirty!
+
+  should "clear the indices when a dirty method is called" do
+    post = Post.first
+
+    pots = Post.find(post.id)
+    assert(Rails.cache.read(post.kasket_key))
+
+    post.make_dirty!
+
+    assert_nil(Rails.cache.read(post.kasket_key))
+  end
+end

data/test/find_one_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/helper'
+
+class FindOneTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts
+
+  Post.has_kasket
+
+  should "cache find(id) calls" do
+    post = Post.first
+    assert_nil(Rails.cache.read(post.kasket_key))
+    assert_equal(post, Post.find(post.id))
+    assert(Rails.cache.read(post.kasket_key))
+    Post.connection.expects(:select_all).never
+    assert_equal(post, Post.find(post.id))
+  end
+
+  should "not use cache when using the :select option" do
+    post = Post.first
+    assert_nil(Rails.cache.read(post.kasket_key))
+
+    Post.find(post.id, :select => 'title')
+    assert_nil(Rails.cache.read(post.kasket_key))
+
+    Post.find(post.id)
+    assert(Rails.cache.read(post.kasket_key))
+
+    Kasket.cache.expects(:read)
+    Post.find(post.id, :select => nil)
+
+    Kasket.cache.expects(:read).never
+    Post.find(post.id, :select => 'title')
+  end
+
+  should "respect scope" do
+    post = Post.find(Post.first.id)
+    other_blog = Blog.first(:conditions => "id != #{post.blog_id}")
+
+    assert(Rails.cache.read(post.kasket_key))
+
+    assert_raise(ActiveRecord::RecordNotFound) do
+      other_blog.posts.find(post.id)
+    end
+  end
+end

data/test/find_some_test.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/helper'
+
+class FindSomeTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts
+
+  Post.has_kasket
+  Post.has_kasket_on :blog_id
+
+  should "cache find(id, id) calls" do
+    post1 = Post.first
+    post2 = Post.last
+
+    assert_nil(Rails.cache.read(post1.kasket_key))
+    assert_nil(Rails.cache.read(post2.kasket_key))
+
+    Post.find(post1.id, post2.id)
+
+    assert(Rails.cache.read(post1.kasket_key))
+    assert(Rails.cache.read(post2.kasket_key))
+
+    Post.connection.expects(:select_all).never
+    Post.find(post1.id, post2.id)
+  end
+
+  should "only lookup the records that are not in the cache" do
+    post1 = Post.first
+    post2 = Post.last
+    assert_equal(post1, Post.find(post1.id))
+    assert(Rails.cache.read(post1.kasket_key))
+    assert_nil(Rails.cache.read(post2.kasket_key))
+
+    Post.expects(:find_some_without_kasket).with([post2.id], {}).returns([post2])
+    found_posts = Post.find(post1.id, post2.id)
+    assert_equal([post1, post2].map(&:id).sort, found_posts.map(&:id).sort)
+
+    Post.expects(:find_some_without_kasket).never
+    found_posts = Post.find(post1.id, post2.id)
+    assert_equal([post1, post2].map(&:id).sort, found_posts.map(&:id).sort)
+  end
+
+  should "cache on index other than primary key" do
+    blog = blogs(:a_blog)
+    posts = Post.find_all_by_blog_id(blog.id)
+
+    Post.expects(:find_every_without_kasket).never
+
+    assert_equal(posts, Post.find_all_by_blog_id(blog.id))
+  end
+end

data/test/fixtures/blogs.yml

@@ -0,0 +1,5 @@
+a_blog:
+  name: My Blog
+
+other_blog:
+  name: Some Other Blog

data/test/fixtures/comments.yml

@@ -0,0 +1,14 @@
+few_comments_1:
+  post: has_two_comments
+  body: what ever body 1
+
+few_comments_2:
+  post: has_two_comments
+  body: what ever body 2
+
+<% (1..10000).each do |i| %>
+many_comments_<%= i %>:
+  post: has_many_comments
+  body: what ever body <%= i %>
+<% end %>
+

data/test/fixtures/posts.yml

@@ -0,0 +1,15 @@
+no_comments:
+  blog: a_blog
+  title: This post has no comments
+
+has_two_comments:
+  blog: a_blog
+  title: This post has a few comments
+
+on_other_blog:
+  blog: other_blog
+  title: This post has no comments
+
+has_many_comments:
+  blog: a_blog
+  title: A shit load of comments on this one

data/test/helper.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+require 'active_support'
+require 'active_record'
+require 'active_record/fixtures'
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection('test')
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'kasket'
+
+Kasket.setup
+
+class ActiveSupport::TestCase
+  include ActiveRecord::TestFixtures
+
+  fixtures :all
+
+  def create_fixtures(*table_names)
+    if block_given?
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+    else
+      Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+    end
+  end
+
+  self.use_transactional_fixtures = true
+
+  self.use_instantiated_fixtures  = false
+end
+
+ActiveSupport::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(ActiveSupport::TestCase.fixture_path)
+
+module Rails
+  module_function
+  CACHE = ActiveSupport::Cache::MemoryStore.new
+
+  def cache
+    CACHE
+  end
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :blog
+  has_many :comments
+
+  def make_dirty!
+    self.updated_at = Time.now
+    self.connection.execute("UPDATE posts SET updated_at = '#{updated_at.utc.to_s(:db)}' WHERE id = #{id}")
+  end
+end
+
+class Blog < ActiveRecord::Base
+  has_many :posts
+end

data/test/schema.rb

@@ -0,0 +1,34 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file, 
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table "comments", :force => true do |t|
+    t.text     "body"
+    t.integer  "post_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.integer  "blog_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "blogs", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/serialization_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/helper'
+
+class SerializationTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts
+
+  Post.has_kasket
+
+  should "store a CachedModel" do
+    post = Post.first
+    post.store_in_kasket
+    assert_instance_of(Kasket::Cache::CachedModel, Rails.cache.read(post.kasket_key))
+  end
+
+  should "bring convert CachedModel to model instances" do
+    post = Post.first
+    post.store_in_kasket
+
+    post = Kasket.cache.read(post.kasket_key)
+    assert_instance_of(Post, post)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: kasket
+version: !ruby/object:Gem::Version 
+  version: 0.5.2
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-01 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A rewrite of cache money
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/kasket.rb
+- lib/kasket/cache.rb
+- lib/kasket/conditions_parser.rb
+- lib/kasket/configuration_mixin.rb
+- lib/kasket/dirty_mixin.rb
+- lib/kasket/read_mixin.rb
+- lib/kasket/reload_association_mixin.rb
+- lib/kasket/write_mixin.rb
+- test/cache_expiry_test.rb
+- test/database.yml
+- test/dirty_test.rb
+- test/find_one_test.rb
+- test/find_some_test.rb
+- test/fixtures/blogs.yml
+- test/fixtures/comments.yml
+- test/fixtures/posts.yml
+- test/helper.rb
+- test/schema.rb
+- test/serialization_test.rb
+has_rdoc: true
+homepage: http://github.com/staugaard/kasket
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A write back caching layer on active record
+test_files: 
+- test/cache_expiry_test.rb
+- test/dirty_test.rb
+- test/find_one_test.rb
+- test/find_some_test.rb
+- test/helper.rb
+- test/schema.rb
+- test/serialization_test.rb