thisisdato-va_cache 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+=== 1.0.0 (August 5th, 2009)
+
+* Initial release.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2009 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/Manifest

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

data/README.rdoc

@@ -0,0 +1,44 @@
+= Virtual Attribute Cache
+
+The ultimate way to cache Active Record virtual attributes.
+
+== Installation
+
+As a RubyGem:
+
+  gem install thisisdato-va_cache
+
+As a Rails plugin:
+
+  script/plugin install git://github.com/thisisdato/va_cache.git
+
+== 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
+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? }
+
+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
+
+Note: Virtual Attribute Cache will suffix the question mark (?) automatically.
+
+== Copyright
+
+Copyright (c) 2009 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,17 @@
+require 'rubygems'
+require 'echoe'
+require File.join(File.dirname(__FILE__), 'lib', 'virtual_attribute_cache', 'version')
+require 'spec/rake/spectask'
+
+Echoe.new('va_cache', VirtualAttributeCache::Version::STRING) do |s|
+  s.summary = 'The ultimate way to cache Active Record virtual attributes.'
+  s.url     = 'http://github.com/thisisdato/va_cache/tree/master'
+  s.author  = 'David Trasbo'
+  s.email   = 'thisisdato@gmail.com'
+end
+
+Spec::Rake::SpecTask.new
+
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.rcov = true
+end

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,26 @@
+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:
+    #
+    #   caches_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 = {})
+      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.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  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/virtual_attribute_cache.rb

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

data/spec/blueprints.rb

@@ -0,0 +1,12 @@
+require 'machinist'
+require 'machinist/active_record'
+require 'faker'
+
+Person.blueprint do
+  first_name { Faker::Name.first_name }
+  last_name  { Faker::Name.last_name  }
+end
+
+Post.blueprint do
+  body_textile '_Hello_ *Textile!*'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+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
+  caches_virtual_attribute :full_name, :expire_if => Proc.new { |p| p.first_name_changed? || p.last_name_changed? }
+
+  def full_name
+    [first_name, last_name].join(' ')
+  end
+end
+
+class Post < ActiveRecord::Base
+  caches_virtual_attribute :body, :expire_if => :body_textile_changed
+
+  def body
+    RedCloth.new(body_textile)
+  end
+end
+
+require File.join(File.dirname(__FILE__), 'blueprints')

data/spec/virtual_attribute_cache/class_methods_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module VirtualAttributeCache
+  describe ClassMethods do
+    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
+    end
+
+    it 'should expire the cache if :expire_if option is a proc and returns true' do
+      person = Person.make
+      person.first_name = Faker::Name.first_name
+      person.last_name = Faker::Name.last_name
+      person.save
+      person.attribute_present?(:full_name).should be_true
+      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.attribute_present?(:body).should be_true
+      post.body.should == RedCloth.new(post.body_textile)
+    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,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{va_cache}
+  s.version = "1.0.0"
+
+  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.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.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"]
+  s.rubyforge_project = %q{va_cache}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{The ultimate way to cache Active Record virtual attributes.}
+
+  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,78 @@
+--- !ruby/object:Gem::Specification 
+name: thisisdato-va_cache
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Trasbo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: The ultimate way to cache Active Record virtual attributes.
+email: thisisdato@gmail.com
+executables: []
+
+extensions: []
+
+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
+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
+has_rdoc: false
+homepage: http://github.com/thisisdato/va_cache/tree/master
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Va_cache
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: va_cache
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: The ultimate way to cache Active Record virtual attributes.
+test_files: []
+