cached_belongs_to 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# CachedBelongsTo
+# Cached belongs_to
 
 [![Build Status](https://secure.travis-ci.org/crowdint/cached_belongs_to.png)](http://travis-ci.org/crowdint/cached_belongs_to)
 
@@ -27,18 +27,25 @@ Or install it yourself as:
 
 ## Usage
 
-Just use it as you would use `belongs_to`. Add the `:caches` option to specify the
+Currently, it works with a traditional `belongs_to` - `has_many` associations
+between two models.
+
+Just use it as you would normally use `belongs_to`. Add the `:caches` option to specify the
 fields in the association that you want to cache.
 
     #
     # table: authors
-    #
-    # name:string
+    #   name:string
     #
     class Author
       has_many :books
     end
 
+    #
+    # table: books
+    #   author_id:integer
+    #   author_name:string
+    #
     class Book
       cached_belongs_to :author, :caches => :name
     end

data/lib/cached_belongs_to/version.rb

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

data/lib/cached_belongs_to.rb

@@ -3,35 +3,47 @@ require 'active_record'
 
 module CachedBelongsTo
   module ClassMethods
+    #
+    # Creates a many to one association between two models. Works
+    # exactly as ActiveRecord's belongs_to, except that it adds
+    # caching to it.
+    #
+    # Usage:
+    #
+    #   class Book < ActiveRecord::Base
+    #     cached_belongs_to :author, :caches => :name
+    #   end
+    #
     def cached_belongs_to(*args)
       caches = Array(args[1].delete(:caches))
       klass  = args[0]
 
       belongs_to(*args)
-      children_hook_name = "cached_belongs_to_#{name.underscore}_after_save".to_sym
-      create_cached_belongs_to_child_hooks(caches, klass, children_hook_name)
-      create_cached_belongs_to_parent_hooks(caches, klass, children_hook_name)
+      children_callback_name = "cached_belongs_to_#{name.underscore}_callback".to_sym
+      create_cached_belongs_to_child_callbacks(caches, klass, children_callback_name)
+      create_cached_belongs_to_parent_callbacks(caches, klass, children_callback_name)
     end
 
-    def create_cached_belongs_to_child_hooks(*args, caches, klass, children_hook_name)
-      define_method children_hook_name do
+    private
+    def create_cached_belongs_to_child_callbacks(caches, klass, children_callback_name)
+      define_method children_callback_name do
         caches.each do |attr|
           send("#{klass}_#{attr}=", send(klass).send(attr)) if send(klass)
         end
       end
 
-      before_save children_hook_name
+      before_save children_callback_name
     end
 
-    def create_cached_belongs_to_parent_hooks(caches, parent_class_name, children_hook_name)
-      method_name = "cached_belongs_to_#{parent_class_name}_after_save".to_sym
+    def create_cached_belongs_to_parent_callbacks(caches, parent_class_name, children_callback_name)
+      method_name = "cached_belongs_to_#{parent_class_name}_callback".to_sym
       has_many_association = self.name.underscore.pluralize.to_sym
       parent_class = parent_class_name.to_s.camelize.constantize
 
       parent_class.send(:define_method, method_name) do
         send(has_many_association).reload.each do |child|
           caches.each do |attr|
-            child.send(children_hook_name)
+            child.send(children_callback_name)
             child.save
           end
         end

data/spec/cached_belongs_to_spec.rb

@@ -30,16 +30,16 @@ describe CachedBelongsTo do
       book_class.new.should respond_to(:author)
     end
 
-    it "defines the cached_belongs_to_book_after_save" do
-      book_class.new.should respond_to(:cached_belongs_to_book_after_save)
+    it "defines the cached_belongs_to_book_callback" do
+      book_class.new.should respond_to(:cached_belongs_to_book_callback)
     end
 
-    it "defines the cached_belongs_to_author_after_save" do
-      author_class.new.should respond_to(:cached_belongs_to_author_after_save)
+    it "defines the cached_belongs_to_author_callback" do
+      author_class.new.should respond_to(:cached_belongs_to_author_callback)
     end
   end
 
-  context "cached_belongs_to_book_after_save" do
+  context "cached_belongs_to_book_callback" do
     before do
       book_class.send(:cached_belongs_to, :author, { :caches => :name })
     end
@@ -51,12 +51,12 @@ describe CachedBelongsTo do
 
       book.stub(:author).and_return author
 
-      book.cached_belongs_to_book_after_save
+      book.cached_belongs_to_book_callback
       book.author_name.should eq author.name
     end
   end
 
-  context "cached_belongs_to_author_after_save" do
+  context "cached_belongs_to_author_callback" do
     before do
       book_class.send(:cached_belongs_to, :author, { :caches => :name })
       author_class.send(:has_many, :books)
@@ -67,10 +67,10 @@ describe CachedBelongsTo do
       book   = book_class.new
 
       author.stub_chain(:books, :reload).and_return([ book ])
-      book.should_receive(:cached_belongs_to_book_after_save)
+      book.should_receive(:cached_belongs_to_book_callback)
       book.should_receive :save
 
-      author.cached_belongs_to_author_after_save
+      author.cached_belongs_to_author_callback
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cached_belongs_to
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -165,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -552693176683226932
+      hash: -1027759858126045779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -552693176683226932
+      hash: -1027759858126045779
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23