va_cache 1.0.2

data/.gitignore

@@ -0,0 +1,3 @@
+coverage
+doc
+pkg

data/CHANGELOG.rdoc

@@ -0,0 +1,12 @@
+=== 1.0.2 (January 6th, 2010)
+
+* Fixed two severe bugs.
+* Refactored tests.
+
+=== 1.0.1 (August 6th, 2009)
+
+* Renamed method to cached_virtual_attribute and made it accept a block.
+
+=== 1.0.0 (August 5th, 2009)
+
+* Initial release.

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 David Trasbo
+
+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.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Virtual Attribute Cache
+
+The ultimate way to cache Active Record virtual attributes.
+
+== Installation
+
+As a RubyGem:
+
+  gem install thisisdato-va_cache
+
+(Note: GitHub still hosts va_cache with my old username.)
+
+As a Rails plugin:
+
+  script/plugin install git://github.com/dtrasbo/va_cache.git
+
+== Usage
+
+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:
+
+  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
+
+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:
+
+  cached_virtual_attribute(:body, :expire_if => :body_textile_changed) do
+    RedCloth.new(body_textile).to_html
+  end
+
+Note: Virtual Attribute Cache will suffix the question mark (?) automatically.
+
+== Copyright
+
+Copyright (c) 2010 David Trasbo. Virtual Attribute Cache is released under the
+terms of the MIT License. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "va_cache"
+    gemspec.summary = "The ultimate way to cache Active Record virtual attributes."
+    gemspec.email = "thisisdato@gmail.com"
+    gemspec.homepage = "http://github.com/dtrasbo/va_cache"
+    gemspec.authors = ["David Trasbo"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/init.rb

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

data/lib/va_cache.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'virtual_attribute_cache')

data/lib/virtual_attribute_cache/class_methods.rb

@@ -0,0 +1,39 @@
+module VirtualAttributeCache
+  module ClassMethods
+    # Sets up a +before_save+ callback that will cache (or expire the cache of)
+    # the virtual attribute indicated by +attribute+. Use the
+    # <tt>:expire_if</tt> to specify when the cache will be expired. If it's a
+    # proc that returns true with that particular record as argument, the cache
+    # will be expired:
+    #
+    #   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
+    #
+    # 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:
+    #
+    #   cached_virtual_attribute(:body, :expire_if => :body_textile_changed) do
+    #     RedCloth.new(body_textile).to_html
+    #   end
+    #
+    # 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) && record.send("#{options[:expire_if]}?")) ||
+           (options[:expire_if].is_a?(Proc) && options[:expire_if].call(record))
+          record[attribute] = nil
+          record.send "#{attribute}=", record.send(attribute)
+        end
+      end
+    end
+  end
+end

data/lib/virtual_attribute_cache/version.rb

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

data/lib/virtual_attribute_cache.rb

@@ -0,0 +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/spec/blueprints.rb

@@ -0,0 +1,11 @@
+require 'machinist'
+require 'machinist/active_record'
+
+Person.blueprint do
+  first_name 'John'
+  last_name  'Smith' 
+end
+
+Post.blueprint do
+  body_textile '_Hello_ *Textile!*'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'activerecord'
+require 'RedCloth'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'va_cache')
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+ActiveRecord::Schema.define do
+  suppress_messages do
+    create_table :people do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :full_name
+    end
+
+    create_table :posts do |t|
+      t.string :body_textile
+      t.string :body
+    end
+  end
+end
+
+class Person < ActiveRecord::Base
+  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
+  cached_virtual_attribute(:body, :expire_if => :body_textile_changed) do
+    RedCloth.new(body_textile).to_html
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'blueprints')

data/spec/virtual_attribute_cache/class_methods_spec.rb

@@ -0,0 +1,47 @@
+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
+      person.save
+      person.attribute_present?(:full_name).should be_true
+      person.full_name.should == person[:full_name]
+    end
+
+    it 'should expire the cache if :expire_if option is a proc and returns true' do
+      person = Person.make
+      person.first_name = 'James'
+      person.last_name = 'Williams'
+      person.save
+      person[:full_name].should == [person.first_name, person.last_name].join(' ')
+    end
+
+    it 'should expire the cache if method indicated in :expire_if option returns true' do
+      post = Post.make
+      post.body_textile = 'Hello _again,_ *Textile!*'
+      post.save
+      post[:body].should == '<p>Hello <em>again,</em> <strong>Textile!</strong></p>'
+    end
+
+    it 'should not try to send "#{options[:expire_if]}?" when it is a Proc' do
+      person = Person.make
+      person.first_name = 'John'
+      person.last_name = 'Smith'
+      person.save
+    end
+
+    it 'should not try to #call a symbol' do
+      post = Post.make
+      post.body_textile = '_Hello_ *Textile!*'
+      post.save
+    end
+  end
+end

data/spec/virtual_attribute_cache/version_spec.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module VirtualAttributeCache
+  describe Version do
+    it 'should join major, minor, and tiny revisions' do
+      Version::STRING.should == [Version::MAJOR, Version::MINOR, Version::TINY].join('.')
+    end
+  end
+end

data/va_cache.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{va_cache}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Trasbo"]
+  s.date = %q{2010-01-06}
+  s.email = %q{thisisdato@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/va_cache.rb",
+     "lib/virtual_attribute_cache.rb",
+     "lib/virtual_attribute_cache/class_methods.rb",
+     "lib/virtual_attribute_cache/version.rb",
+     "spec/blueprints.rb",
+     "spec/spec_helper.rb",
+     "spec/virtual_attribute_cache/class_methods_spec.rb",
+     "spec/virtual_attribute_cache/version_spec.rb",
+     "va_cache.gemspec"
+  ]
+  s.homepage = %q{http://github.com/dtrasbo/va_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{The ultimate way to cache Active Record virtual attributes.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/blueprints.rb",
+     "spec/virtual_attribute_cache/version_spec.rb",
+     "spec/virtual_attribute_cache/class_methods_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: va_cache
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- David Trasbo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: thisisdato@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/va_cache.rb
+- lib/virtual_attribute_cache.rb
+- lib/virtual_attribute_cache/class_methods.rb
+- lib/virtual_attribute_cache/version.rb
+- spec/blueprints.rb
+- spec/spec_helper.rb
+- spec/virtual_attribute_cache/class_methods_spec.rb
+- spec/virtual_attribute_cache/version_spec.rb
+- va_cache.gemspec
+has_rdoc: true
+homepage: http://github.com/dtrasbo/va_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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.3.5
+signing_key: 
+specification_version: 3
+summary: The ultimate way to cache Active Record virtual attributes.
+test_files: 
+- spec/spec_helper.rb
+- spec/blueprints.rb
+- spec/virtual_attribute_cache/version_spec.rb
+- spec/virtual_attribute_cache/class_methods_spec.rb