thisisdato-va_cache 1.0.0 → 1.0.1

data/Manifest

@@ -5,9 +5,11 @@ lib/virtual_attribute_cache/version.rb
 lib/virtual_attribute_cache/class_methods.rb
 Rakefile
 LICENSE.txt
+init.rb
 README.rdoc
 spec/virtual_attribute_cache/class_methods_spec.rb
 spec/virtual_attribute_cache/version_spec.rb
 spec/blueprints.rb
 spec/spec_helper.rb
 Manifest
+va_cache.gemspec

data/README.rdoc

@@ -14,27 +14,17 @@ As a Rails plugin:
 
 == Usage
 
-The basic concept of Virtual Attribute Cache is as follows: If you have a
-+Person+ model with +first_name+, +last_name+, and +full_name+ columns and a
-+full_name+ method (virtual attribute), and the +full_name+ column is blank in
-the database, the +full_name+ method will not be overridden by Active Record.
-However, if the +full_name+ column is not blank, Active Record will override the
-+full_name+ method to return that.
-
-This behaviour allows you to cache virtual attributes simply by having a
-database column of the same name and use Virtual Attribute Cache to expire the
-cache as neseccary.
-
-Virtual Attribute Cache extends Active Record with a caches_virtual_attribute
+Virtual Attribute Cache extends Active Record with a +cached_virtual_attribute+
 method for you to use in your models. Provide the name of the virtual attribute
 to be cached and a proc, symbol, or string indicating when to expire the cache:
 
-  caches_virtual_attribute :full_name, :expire_if => { |p| p.first_name_changed? || p.last_name_changed? }
+  cached_virtual_attribute :full_name, :expire_if => { |p| p.first_name_changed? || p.last_name_changed? }
 
-In the following case, if <tt>body_textile_changed?</tt> returns true, the cache
-will be expired:
+All you need is a column of the same name as the virtual attribute. In the
+following case, if <tt>body_textile_changed?</tt> returns true, the cache will
+be expired:
 
-  caches_virtual_attribute :body, :expire_if => :body_textile_changed
+  cached_virtual_attribute :body, :expire_if => :body_textile_changed
 
 Note: Virtual Attribute Cache will suffix the question mark (?) automatically.
 

data/init.rb

@@ -0,0 +1 @@
+require 'va_cache'

data/lib/virtual_attribute_cache.rb

@@ -1,2 +1,3 @@
+require File.join(File.dirname(__FILE__), 'virtual_attribute_cache', 'version')
 require File.join(File.dirname(__FILE__), 'virtual_attribute_cache', 'class_methods')
 ActiveRecord::Base.extend(VirtualAttributeCache::ClassMethods)

data/lib/virtual_attribute_cache/class_methods.rb

@@ -6,18 +6,27 @@ module VirtualAttributeCache
     # proc that returns true with that particular record as argument, the cache
     # will be expired:
     #
-    #   caches_virtual_attribute :full_name, :expire_if => Proc.new { |p| p.first_name_changed? || p.last_name_changed? }
+    #   cached_virtual_attribute :full_name, :expire_if => Proc.new { |p| p.first_name_changed? || p.last_name_changed? }
     #
     # If it's not a proc, it will be converted to a string, suffixed with a
     # question mark (?), and if that method returns true, the cache will be
     # expired:
     #
-    #   caches_virtual_attribute :body, :expire_if => :body_textile_changed
-    def caches_virtual_attribute(attribute, options = {})
+    #   cached_virtual_attribute :body, :expire_if => :body_textile_changed
+    #
+    # The cache will be stored in whatever database column that matches the
+    # virtual attribute's name. So you need one corresponding column for each
+    # virtual attribute you want to cache.
+    def cached_virtual_attribute(attribute, options = {}, &block)
+      define_method attribute do
+        self[attribute] || instance_eval(&block)
+      end
+
       before_save do |record|
         if (!record.attribute_present?(attribute)) ||
            (options[:expire_if].is_a?(Proc) && options[:expire_if].call(record)) ||
            (record.send "#{options[:expire_if]}?")
+          record[attribute] = nil
           record.send "#{attribute}=", record.send(attribute)
         end
       end

data/lib/virtual_attribute_cache/version.rb

@@ -2,7 +2,7 @@ module VirtualAttributeCache
   module Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/spec_helper.rb

@@ -21,17 +21,13 @@ ActiveRecord::Schema.define do
 end
 
 class Person < ActiveRecord::Base
-  caches_virtual_attribute :full_name, :expire_if => Proc.new { |p| p.first_name_changed? || p.last_name_changed? }
-
-  def full_name
+  cached_virtual_attribute(:full_name, :expire_if => Proc.new { |p| p.first_name_changed? || p.last_name_changed? }) do
     [first_name, last_name].join(' ')
   end
 end
 
 class Post < ActiveRecord::Base
-  caches_virtual_attribute :body, :expire_if => :body_textile_changed
-
-  def body
+  cached_virtual_attribute(:body, :expire_if => :body_textile_changed) do
     RedCloth.new(body_textile)
   end
 end

data/spec/virtual_attribute_cache/class_methods_spec.rb

@@ -2,13 +2,18 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 module VirtualAttributeCache
   describe ClassMethods do
+    it 'should override the virtual attribute to use cached version if present' do
+      person = Person.make
+      person.should_not_receive(:instance_eval)
+      person.full_name
+    end
+
     it 'should cache the virtual attribute' do
       person = Person.make_unsaved
       person.attribute_present?(:full_name).should be_false
-      full_name = person.full_name
       person.save
       person.attribute_present?(:full_name).should be_true
-      person.full_name.should == full_name
+      person.full_name.should == person[:full_name]
     end
 
     it 'should expire the cache if :expire_if option is a proc and returns true' do

data/va_cache.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{va_cache}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Trasbo"]
-  s.date = %q{2009-08-05}
+  s.date = %q{2009-08-06}
   s.description = %q{The ultimate way to cache Active Record virtual attributes.}
   s.email = %q{thisisdato@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/va_cache.rb", "lib/virtual_attribute_cache.rb", "lib/virtual_attribute_cache/version.rb", "lib/virtual_attribute_cache/class_methods.rb", "LICENSE.txt", "README.rdoc"]
-  s.files = ["CHANGELOG.rdoc", "lib/va_cache.rb", "lib/virtual_attribute_cache.rb", "lib/virtual_attribute_cache/version.rb", "lib/virtual_attribute_cache/class_methods.rb", "Rakefile", "LICENSE.txt", "README.rdoc", "spec/virtual_attribute_cache/class_methods_spec.rb", "spec/virtual_attribute_cache/version_spec.rb", "spec/blueprints.rb", "spec/spec_helper.rb", "Manifest", "va_cache.gemspec"]
+  s.files = ["CHANGELOG.rdoc", "lib/va_cache.rb", "lib/virtual_attribute_cache.rb", "lib/virtual_attribute_cache/version.rb", "lib/virtual_attribute_cache/class_methods.rb", "Rakefile", "LICENSE.txt", "init.rb", "README.rdoc", "spec/virtual_attribute_cache/class_methods_spec.rb", "spec/virtual_attribute_cache/version_spec.rb", "spec/blueprints.rb", "spec/spec_helper.rb", "Manifest", "va_cache.gemspec"]
   s.homepage = %q{http://github.com/thisisdato/va_cache/tree/master}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Va_cache", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thisisdato-va_cache
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - David Trasbo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-05 00:00:00 -07:00
+date: 2009-08-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - lib/virtual_attribute_cache/class_methods.rb
 - Rakefile
 - LICENSE.txt
+- init.rb
 - README.rdoc
 - spec/virtual_attribute_cache/class_methods_spec.rb
 - spec/virtual_attribute_cache/version_spec.rb