act_as_cached 0.0.1 → 0.0.2

data/README.md

@@ -6,47 +6,103 @@
 [![Code Climate](https://codeclimate.com/github/ddl1st/act_as_cached.png)](https://codeclimate.com/github/ddl1st/act_as_cached)
 
 
-<tt>ActAsCached</tt> provides a lightweight seconds cached.
+<tt>ActAsCached</tt> provides a lightweight second level cache.
+
+## Supports 
+
+* ActiveRecord associations
+* ActtiveRecord::FinderMethods  (primary key only)
 
 ----------------------
 
 ## Install
 
-    gem "act_as_cached", "0.0.1"
+    gem "act_as_cached", "~> 0.0.2"
 
 ----------------------
 
 ### Options:
 
-* <tt>:prefix</tt> - Default is +aac+ .
+* <tt>:prefix</tt> - Default is `aac` .
 * <tt>:cache_store</tt> - Customize cache store.
-* <tt>:expires_time</tt> - Set cache expiration time.
-* <tt>:logger</tt> - Set outout file with log, default is +Rails.logger+ .
+* <tt>:expires_time</tt> - Set cache expiration time, default is one week.
+* <tt>:logger</tt> - Set output file with log, default is `Rails.logger` .
 
 ----------------------
 
 ## Usage
 
 ```ruby
-    class Account < ActiveRecord::Base
-      act_as_cached
-      has_many :users
-    end
 
-    Account.find 1  # Account Load (0.5ms)  SELECT `accounts`.* FROM `accounts` WHERE `accounts`.`id` = 1 LIMIT 1
-    Account.find 1  # NO SQL OUTPUT
+class Topic < ActiveRecord::Base
+  act_as_cached expires_time: 1.day
+  has_many :comments
+  belongs_to :user
+end
+
+class Comment < ActiveRecord::Base
+  act_as_cached expires_time: 2.days
+  belongs_to :topic
+  belongs_to :user
+end
+
+Topic.find(:first).comments.find(1).user
+  #  Topic Load (0.4ms)  SELECT `topics`.* FROM `topics` LIMIT 1
+  #  Comment Load (0.4ms)  SELECT `comments`.* FROM `comments` WHERE `comments`.`topic_id` = 1 AND `topics`.`id` = 1 LIMIT 1
+  #  User Load (0.4ms)  SELECT `users`.* FROM `users` WHERE `users`.`id` = 1 LIMIT 1
+
+=> #<User id: 1 ,name: 'foo'>
+
+Topic.find(:first)
+=> #<Topic id: 1 ,title: 'foo'>
+Comment.find(1)
+=> #<Comment id: 1, content: "xxxx">
+Comment.find(1).user
+=> #<User id: 1, name: 'foo'>
+
+Topic.find(:first).comments
+  #  Comment Load (0.4ms)  SELECT `comments`.* FROM `comments` WHERE `comments`.`topic_id` = 1 AND `topics`.`id` = 1 LIMIT 1
+=> [#<Comment id: 1, content: 'xxxx'>,#<Comment id: 2, content: "ooooooo">]
+
+Topic.find(:first).comments
+=> [#<Comment id: 1, content: 'xxxx'>,#<Comment id: 2, content: "ooooooo">]
+
+Topic.find(1)
+  #  Topic Load (0.4ms)  SELECT `topics`.* FROM `topics` WHERE `topics`.`id` = 1 LIMIT 1
+=> #<Topic id: 1 ,title: 'foo'>
+
+
+Topic.find(1).save  # After you changes the object which was cached yet expired, the cache of the very object will be destroyed but not its associations.
+
+Topic.find(1)
+  #  Topic Load (0.5ms)  SELECT `topics`.* FROM `topics` WHERE `topics`.`id` = 1 LIMIT 1
+=> #<Topic id: 1 title: 'foo'>
+
+```
+
+----------------------
+
+## Configure
+
+Global Settings
+
+```ruby
+
+ActAsCached.configure do
+  config.logger       = ::Rails.logger
+  config.cache_store  = ::Rails.cache
+  config.expires_time = 1.week
+  config.prefix       = 'aac'
+end
 
-    Account.find(1).users # Account Load (0.5ms)   SELECT `users`.* FROM `users` INNER JOIN `accounts_users` ON `users`.`id` = `accounts_users`.`user_id` WHERE `accounts_users`.`account_id` = 1
-    Account.find(1).users # NO SQL OUTPUT
-    
 ```
 
 ----------------------
 
 
-## Noties
+## Tips
 
-* Currently not supported <tt>ActiveRecord::Relation#find</tt> , If you wrote the +default_scope+ in your class, cache won't be enable.
+* Currently not support <tt>ActiveRecord::Relation#find</tt> , If you wrote the `default_scope` in your class, cache won't be enable.
 
 ----------------------
 
@@ -54,6 +110,7 @@
 
 * Expires cache
   * Add cache key rules
+* Add test
 
 ----------------------
 

data/lib/act_as_cached/active_record/actobserver.rb

@@ -15,7 +15,7 @@ module ActAsCached
       end
 
       def match_keys(object)
-        ["all","first","last",nil].collect{|x| [object.cache_name,x].compact.join("/")}.join("|") << "$"
+        ["all","first","last",object.to_param,nil].collect{|x| [object.cache_name,x].compact.join("/")}.join("|") << "$"
       end
     end
   end

data/lib/act_as_cached/mixin.rb

@@ -9,7 +9,7 @@ module ActAsCached
       #
       # === Example
       #
-      # class Blog < ActiveRecord::Base
+      # class Topic < ActiveRecord::Base
       #   act_as_cached expires_time: 1.day
       #   has_many :comments
       #   belongs_to :user

data/lib/act_as_cached/version.rb

@@ -1,3 +1,3 @@
 module ActAsCached
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_as_cached
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2013-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +52,6 @@ extra_rdoc_files: []
 files:
 - lib/act_as_cached/active_record/actobserver.rb
 - lib/act_as_cached/active_record/association.rb
-- lib/act_as_cached/active_record/association_reflection.rb
 - lib/act_as_cached/active_record/collection_association.rb
 - lib/act_as_cached/active_record/finder_methods.rb
 - lib/act_as_cached/active_record/has_many_through_association.rb

data/lib/act_as_cached/active_record/association_reflection.rb

@@ -1,13 +0,0 @@
-module ActAsCached
-  module ActiveRecord
-    module AssociationReflection
-      def path
-        klass.reflections
-      end
-
-      def reflections_path
-        reflections.map(&:path)
-      end
-    end
-  end
-end