static_record_cache 0.2.0

data/lib/static_active_record_context.rb

@@ -0,0 +1,60 @@
+# ==StaticActiveRecordContext
+# Simple module to extends technoweenie's rad ActiveRecordContext plugin
+# http://svn.techno-weenie.net/projects/plugins/active_record_context/
+# to permanently cache active record data for the life of the class
+#
+# As with active_record_context, only finds based on ids are cache hits, however
+# id finders are the majority of calls from associations. If cache hits on
+# fields and methods are needed, refer to acts_as_static_record[link:files/acts_as_static_record_rb.html]
+#
+#  class TelephoneCarriers < ActiveRecord::Base
+#    extend StaticActiveRecordContext
+#    has_many :phone_numbers
+#  end
+#  
+# The following would exercise a cache hit
+#  phone_number.telephone_carrier
+#
+#
+# The static cache is available both inside and outside +with_context+ block, where as
+# the cache for typical records the context is only with the block.
+#
+#  PhoneNumber.with_context {
+#    PhoneNumber.find :all
+#    TelephoneCarriers.find :all
+#  }
+#
+#  phone = PhoneNumber.find_by_id(1)             # not a cache hit
+#  phone.telephone_carrier                       # cache hit
+#  telephone_carrier = TelephoneCarrier.find(1)  # cache hit
+#
+# === Developers
+# * Blythe Dunham http://snowgiraffe.com
+#
+# === Homepage
+# * Rdoc: http://snowgiraffe.com/rdocs/static_record_cache/
+# * Github Project: http://github.com/blythedunham/static_record_cache/tree/master
+# * Install:  <tt>script/plugin install git://github.com/blythedunham/static_record_cache.git</tt>
+module StaticActiveRecordContext
+  def self.extended(base)#:nodoc
+    base.class_inheritable_accessor :static_record_context
+  end
+
+  def context_cache#:nodoc:
+    self.static_record_context ||= {}
+  end
+
+  def context_cache=(map)#:nodoc:
+    self.static_record_context = map unless map.nil?
+  end
+
+  # Reload the cache for this class only
+  def reload_context_cache
+    self.static_record_context = {}
+  end
+
+  # Call ActiveRecord::Base to cache the other objects
+  def with_context(&block)#:nodoc:
+    ActiveRecord::Base.with_context(&block)
+  end
+end

data/lib/static_record_cache.rb

@@ -0,0 +1,5 @@
+require 'ostruct'
+begin ; require 'active_record' ; rescue LoadError; require 'rubygems'; require 'active_record'; end
+
+require File.join( File.dirname(__FILE__), "acts_as_static_record" )
+require File.join( File.dirname(__FILE__), "static_active_record_context" )

data/static_record_cache.gemspec

@@ -0,0 +1,70 @@
+# 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{static_record_cache}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blythe Dunham"]
+  s.date = %q{2009-12-31}
+  s.description = %q{Permanently caches subclasses of ActiveRecord in memory. }
+  s.email = %q{blythe@snowgiraffe.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/acts_as_static_record.rb",
+     "lib/static_active_record_context.rb",
+     "lib/static_record_cache.rb",
+     "static_record_cache.gemspec",
+     "tasks/static_record_cache_tasks.rake",
+     "test/acts_as_static_record_test.rb",
+     "test/db/schema.rb",
+     "test/fixtures/carriers.yml",
+     "test/fixtures/phone_numbers.yml",
+     "test/models/carrier.rb",
+     "test/models/context_carrier.rb",
+     "test/models/phone_number.rb",
+     "test/static_active_record_context_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/blythedunham/static_record_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Permanently caches subclasses of ActiveRecord in memory.}
+  s.test_files = [
+    "test/acts_as_static_record_test.rb",
+     "test/db/schema.rb",
+     "test/models/carrier.rb",
+     "test/models/context_carrier.rb",
+     "test/models/phone_number.rb",
+     "test/static_active_record_context_test.rb",
+     "test/test_helper.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
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/tasks/static_record_cache_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :static_record_cache do
+#   # Task goes here
+# end

data/test/acts_as_static_record_test.rb

@@ -0,0 +1,146 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class StaticActiveRecordContextTest < TestCaseSuperClass
+  self.fixtures :carriers, :phone_numbers
+
+
+  def setup
+    super
+    StaticCarrierWithKey.clear_static_record_cache
+    StaticCarrier.clear_static_record_cache
+    StaticCarrierWithNonColumnKey.clear_static_record_cache
+  end
+  
+  def test_should_load_all_records
+    StaticCarrier.find :all
+    assert_equal Carrier.count, cache_instance(StaticCarrier)[:primary_key].size
+  end
+
+  def test_should_load_all_records_with_key
+    StaticCarrierWithKey.find :all
+    assert_equal Carrier.count, cache_instance(StaticCarrierWithKey)[:primary_key].size
+    assert_equal Carrier.count, cache_instance(StaticCarrierWithKey)[:key].size
+
+    #cached on key
+    cache_instance(StaticCarrierWithKey)[:key].each {|cache_key, cache_item|
+      assert(cache_key, cache_item.name)
+    }
+  end
+
+  def test_should_load_all_records_with_non_column_key
+    StaticCarrierWithNonColumnKey.find :all
+    assert_equal Carrier.count, cache_instance(StaticCarrierWithNonColumnKey)[:primary_key].size
+    assert_equal Carrier.count, cache_instance(StaticCarrierWithNonColumnKey)[:key].size
+
+    #cached on key
+    cache_instance(StaticCarrierWithNonColumnKey)[:key].each {|cache_key, cache_item|
+      assert(cache_key, cache_item.non_column)
+    }
+  end
+
+  def test_should_not_load_cache_with_conditions
+    StaticCarrier.find :all, :conditions => 'id is not null'
+    assert_nil cache_instance(StaticCarrier)
+  end
+
+  def test_should_load_all_when_accessing_one_record
+    phone = phone_numbers(:phone_number_1)
+    phone.static_carrier
+    phone.reload
+    assert_queries(0){
+     phone.static_carrier
+    }
+    assert_equal Carrier.count, cache_instance(StaticCarrier)[:primary_key].size
+    assert_equal 0, cache_instance(StaticCarrier)[:key].size
+  end
+
+  def test_should_define_method_for_non_column_key
+    assert StaticCarrierWithNonColumnKey.respond_to?(:find_by_non_column)
+
+    record = StaticCarrierWithNonColumnKey.find_by_non_column('NONCOLUMN: 1')
+    assert(1, record.to_param)
+  end
+
+
+  def test_finders_for_column_key
+
+    assert_queries(1) {
+      record = StaticCarrierWithKey.find_by_name_and_id('Verizon', 1)
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+
+      record = StaticCarrierWithKey.find_by_name_and_id('Verizon', 2)
+      assert_nil(record)
+    }
+  end
+
+  def test_finders_for_primary_key_id
+
+    StaticCarrierWithKey.find :all
+    assert_queries(0) {
+      record = StaticCarrierWithKey.find_by_id(1)
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+    }
+    
+    assert_queries(1) {
+      record = StaticCarrierWithKey.find_by_id(2, :conditions => 'id = 1')
+      assert_nil(record)
+    }
+  end
+
+  def test_finders_for_column_key_base
+
+    StaticCarrierWithKey.find :all
+    assert_queries(0) {
+      record = StaticCarrierWithKey.find_by_name('Verizon')
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+    }
+    assert_queries(1) {
+      record = StaticCarrierWithKey.find_by_name('Verizondd', :conditions => 'id is not null')
+      assert_nil(record)
+    }
+  end
+
+
+  def test_finders_for_column_key_with_conditions
+    #load up the cache
+    StaticCarrierWithKey.find :all
+    
+    assert_queries(1) {
+      #This performs one query because the conditions are not nil
+      record = StaticCarrierWithKey.find_by_name_and_id('Verizon', 1, :conditions => 'id is not null')
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+
+      #This should use the cache
+      record = StaticCarrierWithKey.find_by_name_and_id('Verizon', 1)
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+    }
+    
+    #This should use the newly defined method and run it since there are conditions
+    assert_queries(1) {
+      #This performs one query because the conditions are not nil
+      record = StaticCarrierWithKey.find_by_name_and_id('Verizon', 1, :conditions => 'id is not null')
+      assert(record)
+      assert_equal('Verizon', record.name)
+      assert_equal("1", record.to_param)
+    }
+  end
+
+
+  protected
+
+  #calling static_record_cache invokes the cache
+  def cache_instance(klass)
+    klass.instance_variable_get('@static_record_cache')
+  end
+
+end

data/test/db/schema.rb

@@ -0,0 +1,20 @@
+ActiveRecord::Schema.define do
+
+  create_table :phone_numbers, :force => true do |t|
+    t.column :number, :string, :length => 20, :null => false
+    t.column :carrier_id, :integer, :default => nil
+    t.column :owner_id, :integer, :default => nil
+    t.column :country_code, :integer, :length => 5, :default => 1
+    t.column :notes, :string, :default => nil
+  end
+
+  add_index :phone_numbers, :number, :unique => 'true', :name => 'uk_phone_numbers_number'
+
+  create_table :carriers, :force => true do |t|
+    t.column :name, :string, :length => 100
+    t.column :email_domain, :string, :length => 100, :default => nil
+    t.column :options, :string, :default => nil
+  end
+  add_index :carriers, :name, :unique => 'true', :name => 'uk_carriers_name'
+
+end

data/test/fixtures/carriers.yml

@@ -0,0 +1,65 @@
+carrier_1:
+  id: "1"
+  name: Verizon
+  email_domain: "vtext.com"
+
+carrier_2:
+  id: "2"
+  name: Alltel
+  email_domain: "message.alltel.com"
+
+carrier_3:
+  id: "3"
+  name: mmode
+  email_domain: "mmode.com"
+
+carrier_4:
+  id: "4"
+  name: Cellular One
+  email_domain: "mobile.celloneusa.com"
+
+carrier_5:
+  id: "5"
+  name: AT&T (Cingular)
+  email_domain: "txt.att.net"
+
+carrier_6:
+  id: "6"
+  name: Nextel
+  email_domain: "page.nextel.com"
+
+carrier_7:
+  id: "7"
+  name: OmnipointPCS
+  email_domain: "omnipointpcs.com"
+
+carrier_8:
+  id: "8"
+  name: Qwest
+  email_domain: "qwestmp.com"
+
+carrier_9:
+  id: "9"
+  name: Sprint
+  email_domain: "messaging.sprintpcs.com"
+
+carrier_10:
+  id: "10"
+  name: T-Mobile
+  email_domain: "tmomail.net"
+
+carrier_11:
+  id: "11"
+  name: Virgin Mobile
+  email_domain: "vmobl.com"
+
+carrier_12:
+  id: "12"
+  name: US Cellular
+  email_domain: "email.uscc.com"
+
+carrier_13:
+  id: "13"
+  name: Amp'd
+  email_domain: "ampdpix.com"
+

data/test/fixtures/phone_numbers.yml

@@ -0,0 +1,36 @@
+#add 2 phones of each carrier
+<% 1.upto(26) do |count| %>
+phone_number_<%=count %>:
+  id: <%=count %>
+  number: <%= "120655500#{'%02d' % count}"%>
+  carrier_id: <%=count % 13 %>
+  notes: <%= "Note #{count}"%>
+<% end %>
+
+
+phone_number_101:
+  id: 101
+  number: 12065551111
+  carrier_id: 1
+
+phone_number_201:
+  id: 201
+  number: 12065552222
+  carrier_id: 2
+
+phone_number_301:
+  id: 301
+  number: 12065553333
+  carrier_id: 3
+  notes: likes grapes
+
+phone_number_401:
+  id: 401
+  number: 12065554444
+  carrier_id: 4
+
+phone_number_501:
+  id: 501
+  number: 12065555555
+  carrier_id: 5
+  notes: iPhone

data/test/models/carrier.rb

@@ -0,0 +1,28 @@
+class Carrier < ActiveRecord::Base
+  has_many :phone_numbers
+end
+
+
+
+class StaticCarrier < ActiveRecord::Base
+  set_table_name 'carriers'
+  acts_as_static_record
+  has_many :phone_numbers, :foreign_key => :carrier_id
+end
+
+
+class StaticCarrierWithKey < ActiveRecord::Base
+  set_table_name 'carriers'
+  acts_as_static_record :key => :name
+  has_many :phone_numbers, :foreign_key => :carrier_id
+end
+
+class StaticCarrierWithNonColumnKey < ActiveRecord::Base
+  set_table_name 'carriers'
+  acts_as_static_record :key => :non_column
+  has_many :phone_numbers, :foreign_key => :carrier_id
+
+  def non_column
+    "NONCOLUMN: " + self.to_param.to_s
+  end
+end