kasket 0.7.5 → 0.7.6

data/README.rdoc

@@ -1,17 +1,143 @@
-= kasket
+= Kasket
+=== Puts a cap on your queries
+A caching layer for ActiveRecord
 
-Description goes here.
+Developed and used on http://zendesk.com.
+
+== Sponsored by Zendesk - Enlightened Customer Support
+
+== Description
+
+Kasket is a safe way to cache your database queries in memcached.
+Designed to be as small and simple as possible, and to get out of the way when it is not safe to cache.
+
+You can configure exactly what models to cache and what type of queries to cache.
+
+=== Features
+
+* Declarative configuration
+* Collection caching as well as caching of single instances
+* Automatic cache expiry on database migration
+* Automatic cache expiry in Kasket udates
+* Very small code base
+
+== Setting up Kasket
+
+Kasket is set up by simply calling Kasket.setup in an initializer script.
+This will include the required modules into the ActiveRecord
+
+=== Options
+
+By default, Kasket will cache instance collection with a maximum length of 100.
+You can everride this by passing the :max_collection_size option to the Kasket.setup call:
+
+  Kasket.setup(:max_collection_size => 50)
+
+== Configuring caching of your models
+
+You can configure Kasket for any ActiveRecord model, and subclasses will automatically inherit the caching
+configuration.
+
+If you have an Account model, you can can do the simplest caching configuration like:
+
+  Account.has_kasket
+
+This will add a caching index on the id attribute of the Account model,
+and will make sure that all your calls like Account.find(1) and Account.find_by_id(1) will be cached.
+All other calls ( say Account.find_by_subdomain('zendesk') ) are untouched.
+
+If you wanted to configure a caching index on the subdomain attribute of the Account model, you would simply write
+
+  Account.has_kasket_on :subdomain
+
+This would add caching to calls like:
+* Account.find_by_subdomain('zendesk')
+* Account.find_all_by_subdomain('zendesk')
+
+and all other ways of expressing lookups on subdomain.
+
+== Cache expiry
+
+The goal of Kasket is to be as safe as possible to use, so the cache is expired in a number of situations
+* When you save a model instance
+* When your database schema changes
+* When you install a new version of Kasket
+* When you ask it to
+
+=== Cahce expiry on instance save
+
+When you save a model instance, Kasket will calculate the cache entries to expire.
+
+=== Cache expiry on database schema changes
+
+All Kasket cache keys contain a hash of the column names of the table associated with the model.
+If you somehow change your table schema, all cache entries for that table will automatically expire
+
+=== Cache expiry on Kasket upgrades
+
+All Kasket cache keys contain the Kasket version number, so upgrading Kasket will expire all Kasket cache entries.
+
+=== Manually expiring caches
+
+If you have model methods that update the database behind the back of ActiveRecord, you need to mark these methods
+as beeing dirty.
+
+  Account.kasket_dirty_methods :update_last_action
+
+This will make sure the clear the cache entries for the current instance when you call update_last_action
+
+== How does this work?
+
+== Known issues
+
+We have only used and tested Kasket on MySql.
+
+Let us know if you find any.
+
+== Requirements
+
+* ActiveRecord 2.3.x
+
+== Isn't this what Cache Money does?
+
+Absolutely, but cache money does so much more.
+
+* Cache Money has way more features than what we need
+* The Cache Money code is overly complex
+* Cache Monet seems abandoned 
 
 == 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.
+* 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
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Zendesk
+
+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.
 
-Copyright (c) 2009 Mick Staugaard. See LICENSE for details.
+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/lib/kasket.rb

@@ -7,7 +7,6 @@ require 'kasket/active_record_patches'
 module Kasket
   autoload :ConfigurationMixin, 'kasket/configuration_mixin'
   autoload :ReloadAssociationMixin, 'kasket/reload_association_mixin'
-  autoload :RackMiddleware, 'kasket/rack_middleware'
   autoload :Query, 'kasket/query'
 
   CONFIGURATION = {:max_collection_size => 100}
@@ -15,7 +14,7 @@ module Kasket
   class Version
     MAJOR = 0
     MINOR = 7
-    PATCH = 5
+    PATCH = 6
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 

data/lib/kasket/configuration_mixin.rb

@@ -9,15 +9,15 @@ module Kasket
   module ConfigurationMixin
 
     def without_kasket(&block)
-      old_value = @use_kasket
-      @use_kasket = false
+      old_value = Thread.current['kasket_disabled'] || false
+      Thread.current['kasket_disabled'] = true
       yield
     ensure
-      @use_kasket = old_value
+      Thread.current['kasket_disabled'] = old_value
     end
 
     def use_kasket?
-      @use_kasket == true
+      !Thread.current['kasket_disabled']
     end
 
     def kasket_parser
@@ -69,7 +69,6 @@ module Kasket
     end
 
     def has_kasket_on(*args)
-      @use_kasket = true
       attributes = args.sort! { |x, y| x.to_s <=> y.to_s }
       if attributes != [:id] && !kasket_indices.include?([:id])
         has_kasket_on(:id)

data/test/transaction_test.rb

@@ -15,7 +15,7 @@ class TransactionTest < ActiveSupport::TestCase
     setup { Comment.has_kasket } 
     should "disable kasket" do 
       Post.transaction do
-        assert_equal true,  Comment.use_kasket?
+        assert_equal false,  Comment.use_kasket?
         assert_equal false, Post.use_kasket?
         Comment.transaction do
           assert_equal false, Post.use_kasket?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kasket
 version: !ruby/object:Gem::Version 
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors: 
 - Mick Staugaard
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -08:00
+date: 2010-02-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,12 +70,10 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
 files: 
 - .document
 - .gitignore
-- LICENSE
 - README.rdoc
 - Rakefile
 - lib/kasket.rb

data/LICENSE

@@ -1,20 +0,0 @@
-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.