staugaard-magic_cache_keys 0.1.0

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/magic_cache_keys.rb

@@ -0,0 +1,58 @@
+ActiveRecord::Base.valid_keys_for_has_many_association << :cache_key
+
+module ActiveRecord
+  module CacheKeyCaching
+    module AssociationCollectionExtension
+      def cache_key
+        options = {:conditions => sanitize_sql({@reflection.primary_key_name => @owner.id})}
+        options[:conditions] << " AND (#{conditions})" if conditions
+        
+        if @reflection.options[:order]
+          options[:order] = @reflection.options[:order]
+        end
+        construct_find_options!(options)
+        merge_options_from_reflection!(options)
+
+        key = @reflection.klass.cache_key(options)
+
+        new_records_count = @target.select { |r| r.new_record? }.size
+        
+        if new_records_count > 0
+          key + "/#{new_records_count}new"
+        else
+          key.dup
+        end
+      end
+    end
+    
+  end
+  
+  class Base
+    def cache_key_with_associations(*include_associations)
+      parts = [cache_key_without_associations]
+      include_associations.sort! {|a1, a2| a1.to_s <=> a2.to_s}
+      parts += include_associations.map {|a| self.send(a).cache_key }
+      parts.join('/')
+    end
+    alias_method_chain :cache_key, :associations
+    
+    class << self
+      def cache_key(options = {})
+        order = options.delete(:order) || scope(:find, :order)
+        opts = {:select => "MD5(CONCAT(GROUP_CONCAT(CONV(id,10,36)#{ ' ORDER BY ' + order unless order.blank?}), MAX(updated_at))) as cached_key"}.reverse_merge(options)
+        
+        connection.execute('SET group_concat_max_len = 1048576')
+        "#{model_name.cache_key}/#{connection.select_value(construct_finder_sql(opts)) || 'empty'}"
+      end
+
+      def has_many_with_cache_key(association_id, options = {}, &extension)
+        options[:extend] ||= []
+        options[:extend] = [*options[:extend]]
+        options[:extend] << ActiveRecord::CacheKeyCaching::AssociationCollectionExtension
+        
+        has_many_without_cache_key(association_id, options, &extension)
+      end
+      alias_method_chain :has_many, :cache_key
+    end
+  end
+end

data/test/database.yml

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

data/test/fixtures/blogs.yml

@@ -0,0 +1,2 @@
+a_blog:
+  name: My 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,11 @@
+no_comments:
+  blog: a_blog
+  title: This post has no comments
+
+has_two_comments:
+  blog: a_blog
+  title: This post has a few comments
+
+has_many_comments:
+  blog: a_blog
+  title: A shit load of comments on this one

data/test/magic_cache_keys_test.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :blog
+  has_many :comments, :cache_key => true
+  named_scope :orderd1, {:order => 'title DESC'}
+  named_scope :orderd2, {:order => 'title ASC'}
+end
+
+class Blog < ActiveRecord::Base
+  has_many :posts
+  has_many :posts_orderd1, :class_name => 'Post', :order => 'title DESC'
+  has_many :posts_orderd2, :class_name => 'Post', :order => 'title ASC'
+  has_many :posts_conditioned, :class_name => 'Post', :conditions => {:title => 'This post has a few comments'}
+end
+
+class MagicCacheKeysTest < ActiveSupport::TestCase
+  fixtures :blogs, :posts, :comments
+  
+  test "Base class generates a collection cache key" do
+    assert_not_nil(Comment.cache_key)
+    assert_not_nil(Post.cache_key)
+  end
+  
+  test "Base class generates a new cache keys when you add an item" do
+    key1 = Comment.cache_key.to_s
+    Comment.create(:post_id => posts(:has_many_comments).id, :body => 'yay another comment')
+    key2 = Comment.cache_key.to_s
+    
+    assert_not_equal(key1, key2)
+  end
+  
+  test "Base class generates a new cache keys when you remove an item" do
+    key1 = Comment.cache_key.to_s
+    assert_equal(Comment.delete_all(:body => 'what ever body 5000'), 1)
+    key2 = Comment.cache_key.to_s
+    
+    assert_not_equal(key1, key2)
+  end
+  
+  test "has_many associations generates a cache key" do
+    assert_not_nil(blogs(:a_blog).posts.cache_key)
+  end
+  
+  test "generates different cache keys on different ordering" do
+    key1 = Comment.cache_key(:order => 'id DESC')
+    key2 = Comment.cache_key(:order => 'id ASC')
+    
+    assert_not_equal(key1, key2)
+
+    key1 = blogs(:a_blog).posts_orderd1.cache_key
+    key2 = blogs(:a_blog).posts_orderd2.cache_key
+    
+    assert_not_equal(key1, key2)
+  end
+  
+  test "generated different cache key when conditioned" do
+    key1 = Comment.cache_key
+    key2 = Comment.cache_key(:conditions => {:body => comments(:few_comments_1).body})
+    
+    assert_not_equal(key1, key2)
+
+    key1 = blogs(:a_blog).posts.cache_key
+    key2 = blogs(:a_blog).posts_conditioned.cache_key
+    
+    assert_not_equal(key1, key2)
+  end
+  
+  test "generated the correct keys for names scopes" do
+    key1 = Post.orderd1.cache_key
+    key2 = Post.orderd2.cache_key
+    
+    assert_not_equal(key1, key2)
+
+    key1 = Post.orderd1.cache_key
+    key2 = Post.cache_key(:order => 'title DESC')
+    
+    assert_equal(key1, key2)
+
+    key1 = Post.orderd2.cache_key
+    key2 = Post.cache_key(:order => 'title ASC')
+    
+    assert_equal(key1, key2)
+  end
+
+  test "includes info about new records" do
+    key1 = blogs(:a_blog).posts.cache_key
+    blogs(:a_blog).posts.build(:title => 'new blog post')
+    key2 = blogs(:a_blog).posts.cache_key
+    
+    assert_not_equal(key1, key2)
+  end
+
+  test "includes association cache key when asked to" do
+    key1 = blogs(:a_blog).cache_key
+    key2 = blogs(:a_blog).cache_key(:posts)
+    assert_not_equal(key1, key2)
+  end
+  
+  test "includes multiple association cache keys when asked to" do
+    key1 = blogs(:a_blog).cache_key(:posts)
+    key2 = blogs(:a_blog).cache_key(:posts, :posts_orderd1)
+    assert_not_equal(key1, key2)
+  end
+  
+  test "the order of the association cache keys should not matter" do
+    key1 = blogs(:a_blog).cache_key(:posts_orderd1, :posts)
+    key2 = blogs(:a_blog).cache_key(:posts, :posts_orderd1)
+    assert_equal(key1, key2)
+  end
+end

data/test/schema.rb

@@ -0,0 +1,35 @@
+# 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.string   "comments_cache_key"
+    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/test_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'test/unit'
+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.dirname(__FILE__))
+require 'magic_cache_keys'
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures/"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+ 
+class Test::Unit::TestCase #:nodoc:
+  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
+ 
+  # Turn off transactional fixtures if you're working with MyISAM tables in MySQL
+  self.use_transactional_fixtures = true
+  
+  # Instantiated fixtures are slow, but give you @david where you otherwise would need people(:david)
+  self.use_instantiated_fixtures  = false
+ 
+  # Add more helper methods to be used by all tests here...
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: staugaard-magic_cache_keys
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mick Staugaard
+- Morten Primdahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: An extension of ActiveRecord adding database side generated cache keys for collections
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- lib/magic_cache_keys.rb
+- test/database.yml
+- test/debug.log
+- test/fixtures
+- test/fixtures/blogs.yml
+- test/fixtures/comments.yml
+- test/fixtures/posts.yml
+- test/magic_cache_keys_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/staugaard/magic_cache_keys
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: An extension of ActiveRecord adding database side generated cache keys for collections
+test_files: []
+