constant_table_saver 2.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+constant_table_saver-*.gem
+Gemfile.lock
+test/constant_table_saver.db
+test/log/test.log

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in transaction_isolation_level.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug19', :require => 'ruby-debug'
+# gem 'ruby-debug'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Will Bryant, Sekuda Ltd
+
+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

@@ -0,0 +1,65 @@
+ConstantTableSaver
+==================
+
+Loads all records from the table on first use, and thereafter returns the
+cached (and frozen) records for all find calls.
+
+Optionally, creates class-level methods you can use to grab the records,
+named after the name field you specify.
+
+
+Compatibility
+=============
+
+Currently tested against Rails 2.3.14, 3.0.17, 3.1.8, and 3.2.8.
+
+
+Example
+=======
+
+Txn.all.each {|txn| .. do something with txn.txn_type ..}
+ - would load each txn_type individually
+
+Txn.all(:include => :txn_type).each {|txn| .. do something with txn.txn_type ..}
+ - would load the txn_types in one go after the txns query, but would still need
+   a query every time you load txns
+
+
+But if you use:
+
+  class TxnType
+    constant_table
+  end
+
+Txn.all.each {|txn| .. do something with txn.txn_type ..}
+  - no longer requires individual txn_type loads, just every time you start the
+    server (or every request, in development mode)
+
+TxnType.all
+  - also cached, but:
+
+TxnType.all(:conditions => "name LIKE '%foo%'")
+TxnType.find(2, :lock => true)
+  - all still result in traditional finds, since you gave options
+
+
+You can also use:
+
+  class TxnType
+    constant_table :name => :label
+  end
+
+Which if you have:
+
+  TxnType.create!(:label => "Customer Purchase")
+  TxnType.create!(:label => "Refund")
+
+Means you will also have methods returning those records:
+
+  TxnType.customer_purchase
+  TxnType.refund
+
+Optionally, you can specify a :name_prefix and/or :name_suffix.
+
+
+Copyright (c) 2010-2012 Will Bryant, Sekuda Ltd, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the constant_table_saver plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/constant_table_saver.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/constant_table_saver/version', __FILE__)
+
+spec = Gem::Specification.new do |gem|
+  gem.name         = 'constant_table_saver'
+  gem.version      = ConstantTableSaver::VERSION
+  gem.summary      = "Caches the records from fixed tables, and provides convenience methods to get them."
+  gem.description  = <<-EOF
+Loads all records from the table on first use, and thereafter returns the
+cached (and frozen) records for all find calls.
+
+Optionally, creates class-level methods you can use to grab the records,
+named after the name field you specify.
+
+
+Compatibility
+=============
+
+Currently tested against Rails 2.3.14, 3.0.17, 3.1.8, and 3.2.8.
+EOF
+  gem.has_rdoc     = false
+  gem.author       = "Will Bryant"
+  gem.email        = "will.bryant@gmail.com"
+  gem.homepage     = "http://github.com/willbryant/constant_table_saver"
+  
+  gem.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files        = `git ls-files`.split("\n")
+  gem.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_path = "lib"
+  
+  gem.add_dependency "activerecord"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "sqlite3"
+end

data/init.rb

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

data/lib/constant_table_saver/version.rb

@@ -0,0 +1,3 @@
+module ConstantTableSaver
+  VERSION = '2.0.0'
+end

data/lib/constant_table_saver.rb

@@ -0,0 +1,209 @@
+require 'active_record/fixtures' # so we can hook it & reset our cache afterwards
+
+module ConstantTableSaver
+  module BaseMethods
+    def constant_table(options = {})
+      options.assert_valid_keys(:name, :name_prefix, :name_suffix)
+      class_attribute :constant_table_options, :instance_writer => false
+      self.constant_table_options = options
+      
+      if ActiveRecord::VERSION::MAJOR > 2
+        require 'active_support/core_ext/object/to_param'
+        extend ActiveRecord3ClassMethods
+      else
+        extend ActiveRecord2ClassMethods
+      end
+      extend ClassMethods
+      extend NameClassMethods if constant_table_options[:name]
+      
+      klass = defined?(Fixtures) ? Fixtures : ActiveRecord::Fixtures
+      class <<klass
+        # normally, create_fixtures method gets called exactly once - but unfortunately, it
+        # loads the class and does a #respond_to?, which causes us to load and cache before
+        # the new records are added, so we need to reset our cache afterwards.
+        def create_fixtures_with_constant_tables(*args)
+          create_fixtures_without_constant_tables(*args).tap { ConstantTableSaver.reset_all_caches }
+        end
+        def reset_cache_with_constant_tables(*args)
+          reset_cache_without_constant_tables(*args).tap     { ConstantTableSaver.reset_all_caches }
+        end
+        alias_method_chain :create_fixtures, :constant_tables
+        alias_method_chain :reset_cache,     :constant_tables
+      end unless klass.respond_to?(:create_fixtures_with_constant_tables)
+    end
+  end
+
+  def self.reset_all_caches
+    klasses = ActiveRecord::Base.respond_to?(:descendants) ? ActiveRecord::Base.descendants : ActiveRecord::Base.send(:subclasses)
+    klasses.each {|klass| klass.reset_constant_record_cache! if klass.respond_to?(:reset_constant_record_cache!)}
+  end
+  
+  module ClassMethods
+    # Resets the cached records.  Remember that this only affects this process, so while this
+    # is useful for running tests, it's unlikely that you can use this in production - you
+    # would need to call it on every Rails instance on every Rails server.  Don't use this
+    # plugin on if the table isn't really constant!
+    def reset_constant_record_cache!
+      @constant_record_methods.each {|method_id| (class << self; self; end;).send(:remove_method, method_id)} if @constant_record_methods
+      @cached_records = @cached_records_by_id = @constant_record_methods = @cached_blank_scope = nil
+    end
+  end
+
+  module ActiveRecord3ClassMethods
+    def scoped(options = nil)
+      return super if options
+      return super if respond_to?(:current_scoped_methods) && current_scoped_methods
+      return super if respond_to?(:current_scope) && current_scope
+      @cached_blank_scope ||= super.tap do |s|
+        class << s
+          def to_a
+            return @records if loaded?
+            super.each(&:freeze)
+          end
+          
+          def find(*args)
+            # annoyingly, the call to find to load a belongs_to passes :conditions => nil, which causes
+            # the base find method to apply_finder_options and construct an entire new scope, which is
+            # unnecessary and also means that it bypasses our find_one implementation (we don't interfere
+            # with scopes or finds that actually do apply conditions etc.), so we check as a special case
+            return find_with_ids(args.first) if args.length == 2 && args.last == {:conditions => nil}
+            super
+          end
+      
+          def find_first
+            # the normal scope implementation would cache this anyway, but we force a load of all records,
+            # since otherwise if the app used .first before using .all there'd be unnecessary queries
+            to_a.first
+          end
+        
+          def find_last
+            # as for find_first
+            to_a.last
+          end
+        
+          def find_one(id)
+            # see below re to_param
+            cached_records_by_id[id.to_param] || raise(::ActiveRecord::RecordNotFound, "Couldn't find #{name} with ID=#{id}")
+          end
+          
+          def find_some(ids)
+            # see below re to_param
+            ids.collect {|id| cached_records_by_id[id.to_param]}.tap do |results| # obviously since find_one caches efficiently, this isn't inefficient as it would be for real finds
+              results.compact!
+              raise(::ActiveRecord::RecordNotFound, "Couldn't find all #{name.pluralize} with IDs #{ids.join ','} (found #{results.size} results, but was looking for #{ids.size}") unless results.size == ids.size
+            end
+          end
+
+          # in Rails 3.1 the associations code was rewritten to generalise its sql generation to support
+          # more complex relationships (eg. nested :through associations).  however unfortunately, during
+          # this work the implementation of belongs_to associations was changed so that it no longer calls
+          # one of the basic find_ methods above; instead a vanilla target scope is constructed, a where()
+          # scope to add the constraint that the primary key = the FK value is constructed, the two are
+          # merged, and then #first is called on that scope.  frustratingly, all this complexity means that
+          # our find_ hooks above are no longer called when dereferencing a belongs_to association; they
+          # work fine and are used elsewhere, but we have to explicitly handle belongs_to target scope
+          # merging to avoid those querying, which is a huge PITA.  because we want to ensure that we don't
+          # end up accidentally caching other scope requests, we explicitly build a list of the possible
+          # ARel constrained scopes - indexing them by their expression in SQL so that we don't need to
+          # code in the list of all the possible ARel terms.  we then go one step further and make this
+          # cached scope pre-loaded using the record we already have - there's sadly no external way to do
+          # this so we have to shove in the instance variables.
+          #
+          # it will be clear that this was a very problematic ActiveRecord refactoring.
+          if ActiveRecord::VERSION::MINOR > 0
+            def belongs_to_record_scopes
+              @belongs_to_record_scopes ||= to_a.each_with_object({}) do |record, results|
+                scope_that_belongs_to_will_want = where(table[primary_key].eq(record.id))
+                scope_that_belongs_to_will_want.instance_variable_set("@loaded", true)
+                scope_that_belongs_to_will_want.instance_variable_set("@records", [record])
+                results[scope_that_belongs_to_will_want.to_sql] = scope_that_belongs_to_will_want
+              end.freeze
+            end
+
+            def merge(other)
+              if belongs_to_record_scope = belongs_to_record_scopes[other.to_sql]
+                return belongs_to_record_scope
+              end
+
+              super other
+            end
+          end
+        
+        private
+          def cached_records_by_id
+            # we'd like to use the same as ActiveRecord's finder_methods.rb, which uses:
+            #  id = id.id if ActiveRecord::Base === id
+            # but referencing ActiveRecord::Base here segfaults my ruby 1.8.7
+            # (2009-06-12 patchlevel 174) [universal-darwin10.0]!  instead we use to_param.
+            @cached_records_by_id ||= all.index_by {|record| record.id.to_param}
+          end
+        end
+      end
+    end
+  end
+  
+  module ActiveRecord2ClassMethods
+    def find(*args)
+      options = args.last if args.last.is_a?(Hash)
+      return super unless options.blank? || options.all? {|k, v| v.nil?}
+      scope_options = scope(:find)
+      return super unless scope_options.blank? || scope_options.all? {|k, v| v.nil?}
+
+      args.pop unless options.nil?
+
+      @cached_records ||= super(:all, :order => primary_key).each(&:freeze)
+      @cached_records_by_id ||= @cached_records.index_by {|record| record.id.to_param}
+
+      case args.first
+        when :first then @cached_records.first
+        when :last  then @cached_records.last
+        when :all   then @cached_records.dup # shallow copy of the array
+        else
+          expects_array = args.first.kind_of?(Array)
+          return args.first if expects_array && args.first.empty?
+          ids = expects_array ? args.first : args
+          ids = ids.flatten.compact.uniq
+
+          case ids.size
+            when 0
+              raise ::ActiveRecord::RecordNotFound, "Couldn't find #{name} without an ID"
+            when 1
+              result = @cached_records_by_id[ids.first.to_param] || raise(::ActiveRecord::RecordNotFound, "Couldn't find #{name} with ID=#{ids.first}")
+              expects_array ? [result] : result
+            else
+              ids.collect {|id| @cached_records_by_id[id.to_param]}.tap do |results|
+                results.compact!
+                raise(::ActiveRecord::RecordNotFound, "Couldn't find all #{name.pluralize} with IDs #{ids.join ','} (found #{results.size} results, but was looking for #{ids.size}") unless results.size == ids.size
+              end
+          end
+      end
+    end
+  end
+  
+  module NameClassMethods
+    def define_named_record_methods
+      @constant_record_methods = [] # dummy so respond_to? & method_missing don't call us again if reading an attribute causes another method_missing
+      @constant_record_methods = all.collect do |record|
+        method_name = "#{constant_table_options[:name_prefix]}#{record[constant_table_options[:name]].downcase.gsub(/\W+/, '_')}#{constant_table_options[:name_suffix]}"
+        next if method_name.blank?
+        (class << self; self; end;).instance_eval { define_method(method_name) { record } }
+        method_name.to_sym
+      end.compact.uniq
+    end
+    
+    def respond_to?(method_id, include_private = false)
+      super || (@constant_record_methods.nil? && define_named_record_methods && super)
+    end
+    
+    def method_missing(method_id, *arguments, &block)
+      if @constant_record_methods.nil?
+        define_named_record_methods
+        send(method_id, *arguments, &block) # retry
+      else
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, ConstantTableSaver::BaseMethods)

data/test/activerecord_count_queries.rb

@@ -0,0 +1,70 @@
+if ActiveRecord::VERSION::MAJOR < 3 || (ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR < 1)
+  # proudly stolen from ActiveRecord's test suite, with addition of BEGIN and COMMIT
+  ActiveRecord::Base.connection.class.class_eval do
+    IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /SHOW FIELDS/, /^BEGIN$/, /^COMMIT$/]
+
+    def execute_with_query_record(sql, name = nil, &block)
+      $queries_executed ||= []
+      $queries_executed << sql unless IGNORED_SQL.any? { |r| sql =~ r }
+      execute_without_query_record(sql, name, &block)
+    end
+
+    alias_method_chain :execute, :query_record
+  end
+elsif ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR < 2
+  # this is from 3.1's test suite.  ugly.
+  class ActiveRecord::SQLCounter
+    cattr_accessor :ignored_sql
+    self.ignored_sql = [/^PRAGMA (?!(table_info))/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL.  This ignored SQL is for Oracle.
+    ignored_sql.concat [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
+
+    def initialize
+      $queries_executed = []
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      unless ['CACHE', 'SCHEMA'].include?(values[:name]) # we have altered this from the original, to exclude SCHEMA as well
+        # debugger if sql =~ /^PRAGMA table_info/ && Kernel.caller.any? {|i| i.include?('test_it_creates_named_class_methods_if_a_')}
+        $queries_executed << sql unless self.class.ignored_sql.any? { |r| sql =~ r }
+      end
+    end
+  end
+  ActiveSupport::Notifications.subscribe('sql.active_record', ActiveRecord::SQLCounter.new)
+else
+  # this is from 3.2's test suite.  ugly.
+  class ActiveRecord::SQLCounter
+    cattr_accessor :ignored_sql
+    self.ignored_sql = [/^PRAGMA (?!(table_info))/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL.  This ignored SQL is for Oracle.
+    ignored_sql.concat [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
+
+    cattr_accessor :log
+    self.log = []
+
+    attr_reader :ignore
+
+    def initialize(ignore = self.class.ignored_sql)
+      @ignore   = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name] || ignore.any? { |x| x =~ sql }
+      self.class.log << sql
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe('sql.active_record', ActiveRecord::SQLCounter.new)
+end

data/test/constant_table_saver_test.rb

@@ -0,0 +1,230 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'activerecord_count_queries'))
+
+class StandardPie < ActiveRecord::Base
+  set_table_name "pies"
+end
+
+class ConstantPie < ActiveRecord::Base
+  set_table_name "pies"
+  constant_table
+  
+  if defined?(named_scope)
+    named_scope :filled_with_unicorn, :conditions => {:filling => 'unicorn'}
+  else
+    scope :filled_with_unicorn, :conditions => {:filling => 'unicorn'}
+  end
+  
+  def self.with_unicorn_filling_scope
+    with_scope(:find => {:conditions => {:filling => 'unicorn'}}) { yield }
+  end
+end
+
+class ConstantNamedPie < ActiveRecord::Base
+  set_table_name "pies"
+  constant_table :name => :filling
+end
+
+class ConstantLongNamedPie < ActiveRecord::Base
+  set_table_name "pies"
+  constant_table :name => :filling, :name_prefix => "a_", :name_suffix => "_pie"
+end
+
+class IngredientForStandardPie < ActiveRecord::Base
+  set_table_name "ingredients"
+  belongs_to :pie, :class_name => "StandardPie"
+end
+
+class IngredientForConstantPie < ActiveRecord::Base
+  set_table_name "ingredients"
+  belongs_to :pie, :class_name => "ConstantPie"
+end
+
+class ConstantTableSaverTest < ActiveRecord::TestCase
+  fixtures :all
+  
+  setup do
+    ConstantPie.reset_constant_record_cache!
+  end
+
+  test "it caches find(:all) results" do
+    @pies = StandardPie.find(:all)
+    assert_queries(1) do
+      assert_equal @pies.collect(&:attributes), ConstantPie.find(:all).collect(&:attributes)
+    end
+    assert_no_queries do
+      assert_equal @pies.collect(&:attributes), ConstantPie.find(:all).collect(&:attributes)
+    end
+  end
+
+  test "it caches all() results" do
+    @pies = StandardPie.all
+    assert_queries(1) do
+      assert_equal @pies.collect(&:attributes), ConstantPie.all.collect(&:attributes)
+    end
+    assert_no_queries do
+      assert_equal @pies.collect(&:attributes), ConstantPie.all.collect(&:attributes)
+    end
+  end
+
+  test "it caches find(id) results" do
+    @pie = StandardPie.find(1)
+    assert_queries(1) do
+      assert_equal @pie.attributes, ConstantPie.find(1).attributes
+    end
+    assert_no_queries do
+      assert_equal @pie.attributes, ConstantPie.find(1).attributes
+    end
+  end
+
+  test "it caches find(ids) results" do
+    @pie1 = StandardPie.find(1)
+    @pie2 = StandardPie.find(2)
+    assert_queries(1) do
+      assert_equal [@pie1.attributes, @pie2.attributes], ConstantPie.find([1, 2]).collect(&:attributes)
+    end
+    assert_no_queries do
+      assert_equal [@pie1.attributes, @pie2.attributes], ConstantPie.find([1, 2]).collect(&:attributes)
+    end
+  end
+
+  test "it caches find(:first) results" do
+    @pie = StandardPie.find(:first)
+    assert_queries(1) do
+      assert_equal @pie.attributes, ConstantPie.find(:first).attributes
+    end
+    assert_no_queries do
+      assert_equal @pie.attributes, ConstantPie.find(:first).attributes
+    end
+  end
+
+  test "it caches first() results" do
+    @pie = StandardPie.first
+    assert_queries(1) do
+      assert_equal @pie.attributes, ConstantPie.first.attributes
+    end
+    assert_no_queries do
+      assert_equal @pie.attributes, ConstantPie.first.attributes
+    end
+  end
+
+  test "it caches find(:last) results" do
+    @pie = StandardPie.find(:last)
+    assert_queries(1) do
+      assert_equal @pie.attributes, ConstantPie.find(:last).attributes
+    end
+    assert_no_queries do
+      assert_equal @pie.attributes, ConstantPie.find(:last).attributes
+    end
+  end
+  
+  test "it caches last() results" do
+    @pie = StandardPie.last
+    assert_queries(1) do
+      assert_equal @pie.attributes, ConstantPie.last.attributes
+    end
+    assert_no_queries do
+      assert_equal @pie.attributes, ConstantPie.last.attributes
+    end
+  end
+  
+  test "it caches belongs_to association find queries" do
+    @standard_pie_ingredients = IngredientForStandardPie.all
+    @standard_pies = @standard_pie_ingredients.collect(&:pie)
+    @constant_pie_ingredients = IngredientForConstantPie.all
+    assert_queries(1) do # doesn't need to make 3 queries for 3 pie assocations!
+      assert_equal @standard_pies.collect(&:attributes), @constant_pie_ingredients.collect(&:pie).collect(&:attributes)
+    end
+    assert_no_queries do # and once cached, needs no more
+      assert_equal @standard_pies.collect(&:attributes), @constant_pie_ingredients.collect(&:pie).collect(&:attributes)
+    end
+  end
+  
+  test "it isn't affected by scopes active at the time of first load" do
+    assert_equal 0, ConstantPie.filled_with_unicorn.all.size
+    assert_equal 0, ConstantPie.with_unicorn_filling_scope { ConstantPie.all.length }
+    assert_equal StandardPie.all.size, ConstantPie.all.size
+  end
+  
+  test "it isn't affected by relational algebra active at the time of first load" do
+    assert_equal 0, ConstantPie.filled_with_unicorn.all.size
+    assert_equal 0, ConstantPie.where(:filling => 'unicorn').all.length
+    assert_equal 2, ConstantPie.where("filling LIKE 'Tasty%'").all.length
+    assert_equal StandardPie.all.size, ConstantPie.all.size
+  end if ActiveRecord::VERSION::MAJOR > 2
+  
+  test "prevents the returned records from modification" do
+    @pie = ConstantPie.find(:first)
+    assert @pie.frozen?
+    assert !StandardPie.find(:first).frozen?
+  end
+  
+  test "isn't affected by modifying the returned result arrays" do
+    @pies = ConstantPie.all
+    @pies.reject! {|pie| pie.filling =~ /Steak/}
+    assert_equal StandardPie.all.collect(&:attributes), ConstantPie.all.collect(&:attributes)
+  end
+  
+  test "it doesn't cache find queries with options" do
+    @pies = StandardPie.find(:all, :lock => true)
+    @pie = StandardPie.find(1, :lock => true)
+    assert_queries(2) do
+      assert_equal @pies.collect(&:attributes), ConstantPie.find(:all, :lock => true).collect(&:attributes)
+      assert_equal @pie.attributes, ConstantPie.find(1, :lock => true).attributes
+    end
+    assert_queries(2) do
+      assert_equal @pies.collect(&:attributes), ConstantPie.find(:all, :lock => true).collect(&:attributes)
+      assert_equal @pie.attributes, ConstantPie.find(1, :lock => true).attributes
+    end
+  end
+  
+  test "it passes the options preventing caching to the underlying query methods" do
+    assert_equal nil, ConstantPie.find(:first, :conditions => {:filling => 'unicorn'})
+    assert_equal [],  ConstantPie.find(:all,   :conditions => {:filling => 'unicorn'})
+  end
+  
+  test "it creates named class methods if a :name option is given" do
+    @steak_pie = StandardPie.find_by_filling("Tasty beef steak")
+    @mushroom_pie = StandardPie.find_by_filling("Tasty mushrooms with tarragon")
+    @mince_pie = StandardPie.find_by_filling("Mince")
+    assert_queries(1) do
+      assert_equal @steak_pie.attributes, ConstantNamedPie.tasty_beef_steak.attributes
+      assert_equal @mushroom_pie.attributes, ConstantNamedPie.tasty_mushrooms_with_tarragon.attributes
+      assert_equal @mince_pie.attributes, ConstantNamedPie.mince.attributes
+    end
+    assert_raises(NoMethodError) do
+      ConstantNamedPie.unicorn_and_thyme
+    end
+    assert_raises(NoMethodError) do
+      ConstantPie.tasty_beef_steak
+    end
+    assert_raises(NoMethodError) do
+      ActiveRecord::Base.tasty_beef_steak
+    end
+  end
+  
+  test "it supports :name_prefix and :name_suffix options" do
+    @steak_pie = StandardPie.find_by_filling("Tasty beef steak")
+    assert_equal @steak_pie.attributes, ConstantLongNamedPie.a_tasty_beef_steak_pie.attributes
+  end
+  
+  test "it raises the usual exception if asked for a record with id nil" do
+    assert_raises ActiveRecord::RecordNotFound do
+      ConstantPie.find(nil)
+    end
+  end
+  
+  test "it raises the usual exception if asked for a nonexistant records" do
+    max_id = ConstantPie.all.collect(&:id).max
+    assert_raises ActiveRecord::RecordNotFound do
+      ConstantPie.find(max_id + 1)
+    end
+  end
+  
+  test "it raises the usual exception if asked for a mixture of present records and nonexistant records" do
+    max_id = ConstantPie.all.collect(&:id).max
+    assert_raises ActiveRecord::RecordNotFound do
+      ConstantPie.find([max_id, max_id + 1])
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: test/constant_table_saver.db

data/test/fixtures/ingredients.yml

@@ -0,0 +1,12 @@
+steak:
+  id: 1
+  pie_id: 1
+  name: Steak
+mushrooms:
+  id: 2
+  pie_id: 2
+  name: Mushrooms
+tarragon:
+  id: 3
+  pie_id: 2
+  name: Tarragon

data/test/fixtures/pies.yml

@@ -0,0 +1,9 @@
+steak:
+  id: 1
+  filling: Tasty beef steak
+mushroom_and_tarragon:
+  id: 2
+  filling: Tasty mushrooms with tarragon
+mince:
+  id: 3
+  filling: Mince

data/test/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :pies, :force => true do |t|
+    t.string   :filling, :null => false
+  end
+  
+  create_table :ingredients, :force => true do |t|
+    t.integer  :pie_id, :null => false
+    t.string   :name,   :null => false
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+if File.exist?("../../../config/boot.rb")
+  require "../../../config/boot.rb"
+else
+  require 'rubygems'
+end
+
+gem 'activesupport', ENV['RAILS_VERSION']
+gem 'activerecord',  ENV['RAILS_VERSION']
+
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'
+
+begin
+  require 'ruby-debug'
+  Debugger.start
+rescue LoadError
+  # ruby-debug not installed, no debugging for you
+end
+
+RAILS_ENV = ENV['RAILS_ENV'] ||= 'test'
+
+ActiveRecord::Base.configurations = YAML::load(IO.read(File.join(File.dirname(__FILE__), "database.yml")))
+ActiveRecord::Base.establish_connection ActiveRecord::Base.configurations[ENV['RAILS_ENV']]
+load(File.join(File.dirname(__FILE__), "/schema.rb"))
+ActiveSupport::TestCase.send(:include, ActiveRecord::TestFixtures) if ActiveRecord.const_defined?('TestFixtures')
+ActiveSupport::TestCase.fixture_path = File.join(File.dirname(__FILE__), "fixtures")
+
+require File.expand_path(File.join(File.dirname(__FILE__), '../init')) # load the plugin

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: constant_table_saver
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Will Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: |
+  Loads all records from the table on first use, and thereafter returns the
+  cached (and frozen) records for all find calls.
+  
+  Optionally, creates class-level methods you can use to grab the records,
+  named after the name field you specify.
+  
+  
+  Compatibility
+  =============
+  
+  Currently tested against Rails 2.3.14, 3.0.17, 3.1.8, and 3.2.8.
+
+email: will.bryant@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- constant_table_saver.gemspec
+- init.rb
+- lib/constant_table_saver.rb
+- lib/constant_table_saver/version.rb
+- test/activerecord_count_queries.rb
+- test/constant_table_saver_test.rb
+- test/database.yml
+- test/fixtures/ingredients.yml
+- test/fixtures/pies.yml
+- test/schema.rb
+- test/test_helper.rb
+homepage: http://github.com/willbryant/constant_table_saver
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Caches the records from fixed tables, and provides convenience methods to get them.
+test_files: 
+- test/activerecord_count_queries.rb
+- test/constant_table_saver_test.rb
+- test/database.yml
+- test/fixtures/ingredients.yml
+- test/fixtures/pies.yml
+- test/schema.rb
+- test/test_helper.rb