enumerate_by 0.4.0

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+# Mixin the factory helper
+require File.expand_path("#{File.dirname(__FILE__)}/factory")
+Test::Unit::TestCase.class_eval do
+  include Factory
+end
+
+# Add query counter
+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/]
+  
+  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
+
+EnumerateBy.perform_caching = false

data/test/unit/assocations_test.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ModelWithBelongsToAssociationTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @green = create_color(:name => 'green')
+    @car = create_car(:name => 'Ford Mustang', :color => nil)
+  end
+  
+  def test_should_find_association_from_id
+    @car.color_id = @red.id
+    assert_equal @red, @car.color
+  end
+  
+  def test_should_find_association_from_enumerator
+    @car.color = 'green'
+    assert_equal @green, @car.color
+  end
+  
+  def test_should_find_assocation_from_record
+    @car.color = @green
+    assert_equal @green, @car.color
+  end
+  
+  def test_should_use_nil_if_enumeration_does_not_exist
+    @car.color = 'blue'
+    assert_nil @car.color
+  end
+  
+  def test_should_track_associations
+    expected = {'color_id' => 'color'}
+    assert_equal expected, Car.enumeration_associations
+  end
+end
+
+class ModelWithEnumerationScopesTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @blue = create_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :color => @red)
+    @blue_car = create_car(:name => 'Ford Mustang', :color => @blue)
+  end
+  
+  def test_should_have_inclusion_scope_for_single_enumerator
+    assert_equal [@red_car], Car.with_color('red')
+    assert_equal [@blue_car], Car.with_color('blue')
+  end
+  
+  def test_should_have_inclusion_scope_for_multiple_enumerators
+    assert_equal [@red_car, @blue_car], Car.with_color('red', 'blue')
+  end
+  
+  def test_should_have_exclusion_scope_for_single_enumerator
+    assert_equal [@blue_car], Car.without_color('red')
+    assert_equal [@red_car], Car.without_color('blue')
+  end
+  
+  def test_should_have_exclusion_scope_for_multiple_enumerators
+    assert_equal [], Car.without_colors('red', 'blue')
+  end
+end
+
+class ModelWithPolymorphicBelongsToAssociationTest < ActiveRecord::TestCase
+  def test_should_not_create_named_scopes
+    assert !Car.respond_to?(:with_feature)
+    assert !Car.respond_to?(:with_features)
+    assert !Car.respond_to?(:without_feature)
+    assert !Car.respond_to?(:without_features)
+  end
+end

data/test/unit/base_conditions_test.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class EnumerationWithFinderConditionsTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @blue = create_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :color => @red)
+    @blue_car = create_car(:name => 'Ford Mustang', :color => @blue)
+  end
+  
+  def test_should_replace_enumerations_in_dynamic_finders
+    assert_equal @red_car, Car.find_by_color('red')
+  end
+  
+  def test_should_replace_multiple_enumerations_in_dynamic_finders
+    assert_equal [@red_car, @blue_car], Car.find_all_by_color(%w(red blue))
+  end
+  
+  def test_should_replace_enumerations_in_find_conditions
+    assert_equal @red_car, Car.first(:conditions => {:color => 'red'})
+  end
+  
+  def test_should_replace_multiple_enumerations_in_find_conditions
+    assert_equal [@red_car, @blue_car], Car.all(:conditions => {:color => %w(red blue)})
+  end
+end
+
+class EnumerationWithFinderUpdatesTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @blue = create_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :color => @red)
+  end
+  
+  def test_should_replace_enumerations_in_update_conditions
+    Car.update_all({:color => 'blue'}, :name => 'Ford Mustang')
+    @red_car.reload
+    assert_equal @blue, @red_car.color
+  end
+  
+  def test_should_not_replace_multiple_enumerations_in_update_conditions
+    Car.update_all({:color => %w(red blue)}, :name => 'Ford Mustang')
+    @red_car.reload
+    assert_equal @red, @red_car.color
+  end
+end

data/test/unit/enumerate_by_test.rb

@@ -0,0 +1,350 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class EnumerateByTest < ActiveRecord::TestCase
+  def test_should_raise_exception_if_invalid_option_specified
+    assert_raise(ArgumentError) { Color.enumerate_by(:id, :invalid => true) }
+  end
+end
+
+class ModelWithoutEnumerationTest < ActiveRecord::TestCase
+  def test_should_not_be_an_enumeration
+    assert !Car.enumeration?
+  end
+  
+  def test_should_be_able_to_bootstrap
+    Car.class_eval do
+      extend EnumerateBy::Bootstrapped
+    end
+    
+    Car.bootstrap(
+      {:id => 1, :name => 'Ford Mustang'},
+      {:id => 2, :name => 'Ford Explorer'}
+    )
+    
+    assert_equal 2, Car.count
+  end
+end
+
+class EnumerationByDefaultTest < ActiveRecord::TestCase
+  def setup
+    @color = Color.new
+  end
+  
+  def test_should_not_have_an_id
+    assert @color.id.blank?
+  end
+  
+  def test_should_not_have_a_name
+    assert @color.name.blank?
+  end
+  
+  def test_should_not_have_an_enumerator
+    assert @color.enumerator.blank?
+  end
+  
+  def test_should_have_empty_stringify
+    assert_equal '', @color.to_s
+  end
+end
+
+class EnumerationTest < ActiveRecord::TestCase
+  def test_should_be_an_enumeration
+    assert Color.enumeration?
+  end
+  
+  def test_should_have_an_enumerator_attribute
+    assert_equal :name, Color.enumerator_attribute
+  end
+  
+  def test_should_perform_caching
+    assert Color.perform_enumerator_caching
+  end
+  
+  def test_should_have_a_cache_store
+    assert_instance_of ActiveSupport::Cache::MemoryStore, Color.enumerator_cache_store
+  end
+  
+  def test_should_require_a_name
+    color = new_color(:name => nil)
+    assert !color.valid?
+    assert color.errors.invalid?(:name)
+  end
+  
+  def test_should_require_a_unique_name
+    color = create_color(:name => 'red')
+    
+    second_color = new_color(:name => 'red')
+    assert !second_color.valid?
+    assert second_color.errors.invalid?(:name)
+  end
+end
+
+class EnumerationWithRecordsTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @green = create_color(:name => 'green')
+  end
+  
+  def test_should_index_by_enumerator
+    assert_equal @red, Color['red']
+  end
+  
+  def test_should_allow_finding_by_enumerator
+    assert_equal @red, Color.find_by_enumerator('red')
+  end
+  
+  def test_should_allow_finding_by_enumerator_with_nil
+    assert_nil Color.find_by_enumerator(nil)
+  end
+  
+  def test_should_find_nothing_if_finding_by_unknown_enumerator
+    assert_nil Color.find_by_enumerator('invalid')
+  end
+  
+  def test_should_raise_exception_for_invalid_index
+    assert_raise(ActiveRecord::RecordNotFound) {Color['white']}
+  end
+  
+  def test_should_allow_finding_all_by_enumerator
+    assert_equal [@red, @green], Color.find_all_by_enumerator(['red', 'green'])
+  end
+  
+  def test_should_allow_finding_all_by_enumerator_with_nil
+    assert_equal [], Color.find_all_by_enumerator(nil)
+  end
+  
+  def test_should_find_nothing_if_finding_all_by_unknown_enumerator
+    assert_equal [], Color.find_all_by_enumerator('invalid')
+  end
+  
+  def test_should_raise_exception_find_finding_all_by_unknown_enumerator!
+    assert_raise(ActiveRecord::RecordNotFound) { Color.find_all_by_enumerator!('invalid') }
+  end
+  
+  def test_should_raise_exception_if_only_some_found_when_finding_all_by_enumerator!
+    assert_raise(ActiveRecord::RecordNotFound) { Color.find_all_by_enumerator!(['red', 'invalid']) }
+  end
+end
+
+class EnumerationAfterBeingCreatedTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    @green = create_color(:name => 'green')
+    @blue = create_color(:name => 'blue')
+  end
+  
+  def test_should_have_an_enumerator
+    assert_equal 'red', @red.enumerator
+  end
+  
+  def test_should_allow_equality_with_enumerator
+    assert @red == 'red'
+  end
+  
+  def test_should_allow_equality_with_record
+    assert @red == @red
+  end
+  
+  def test_should_allow_equality_with_strings
+    assert 'red' == @red
+  end
+  
+  def test_should_raise_exception_on_quality_with_invalid_enumerator
+    assert_raise(ActiveRecord::RecordNotFound) {@red == 'invalid'}
+  end
+  
+  def test_should_be_found_in_a_list_of_valid_names
+    assert @red.in?('red')
+  end
+  
+  def test_should_not_be_found_in_a_list_of_invalid_names
+    assert !@red.in?('blue', 'green')
+  end
+  
+  def test_should_stringify_enumerator
+    assert_equal 'red', @red.to_s
+    assert_equal 'red', @red.to_str
+  end
+end
+
+class EnumerationWithCachingTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    
+    EnumerateBy.perform_caching = true
+  end
+  
+  def test_should_perform_enumerator_caching
+    assert Color.perform_enumerator_caching
+  end
+  
+  def test_should_cache_all_finder_queries
+   assert_queries(1) { Color.find(@red.id) }
+   assert_queries(0) { Color.find(@red.id) }
+   
+   assert_queries(1) { Color.all }
+   assert_queries(0) { Color.all }
+  end
+  
+  def test_should_cache_exist_queries
+    assert_queries(1) { Color.exists?(:name => 'red') }
+    assert_queries(0) { Color.exists?(:name => 'red') }
+  end
+  
+  def test_should_cache_calculate_queries
+    assert_queries(1) { Color.minimum('id') }
+    assert_queries(0) { Color.minimum('id') }
+  end
+  
+  def test_should_skip_cache_when_in_uncached_block
+    Color.uncached do
+     assert_queries(1) { Color.find(@red.id) }
+     assert_queries(1) { Color.find(@red.id) }
+    end
+  end
+  
+  def teardown
+    EnumerateBy.perform_caching = false
+  end
+end
+
+class EnumerationWithoutCachingTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'red')
+    
+    EnumerateBy.perform_caching = true
+    @original_perform_caching = Color.perform_enumerator_caching
+    Color.perform_enumerator_caching = false
+  end
+  
+  def test_should_not_cache_finder_queries
+   assert_queries(1) { Color.find(@red.id) }
+   assert_queries(1) { Color.find(@red.id) }
+   
+   assert_queries(1) { Color.all }
+   assert_queries(1) { Color.all }
+  end
+  
+  def test_should_not_cache_exist_queries
+    assert_queries(1) { Color.exists?(:name => 'red') }
+    assert_queries(1) { Color.exists?(:name => 'red') }
+  end
+  
+  def test_should_not_cache_calculate_queries
+    assert_queries(1) { Color.minimum('id') }
+    assert_queries(1) { Color.minimum('id') }
+  end
+  
+  def teardown
+    EnumerateBy.perform_caching = false
+    Color.perform_enumerator_caching = @original_perform_caching
+  end
+end
+
+class EnumerationBootstrappedTest < ActiveRecord::TestCase
+  def setup
+    @red, @green = Color.bootstrap(
+      {:id => 1, :name => 'red'},
+      {:id => 2, :name => 'green'}
+    )
+  end
+  
+  def test_should_not_raise_exception_if_id_not_specified
+    assert_nothing_raised { Color.bootstrap({:name => 'red'}, {:name => 'green'}) }
+    assert_equal 2, Color.count
+  end
+  
+  def test_should_raise_exception_if_validation_fails
+    assert_raise(ActiveRecord::RecordInvalid) { Color.bootstrap({:id => 1, :name => nil}, {:id => 2, :name => 'green'}) }
+  end
+  
+  def test_should_flatten_bootstrap_records
+    Color.bootstrap(
+      [{:id => 1, :name => 'red'}],
+      [{:id => 2, :name => 'green'}]
+    )
+    assert_equal 2, Color.count
+  end
+  
+  def test_should_create_records
+    assert_equal @red, Color.find(1)
+    assert_equal 'red', @red.name
+    
+    assert_equal @green, Color.find(2)
+    assert_equal 'green', @green.name
+  end
+end
+
+class EnumerationBootstrappedWithExistingRecordsTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'RED')
+    @green = create_color(:name => 'GREEN')
+  
+    Color.bootstrap(
+      {:id => @red.id, :name => 'red'},
+      {:id => @green.id, :name => 'green'}
+    )
+    
+    @red.reload
+    @green.reload
+  end
+  
+  def test_should_synchronize_all_attributes
+    assert_equal 'red', @red.name
+    assert_equal 'green', @green.name
+  end
+end
+
+class EnumerationBootstrappedWithDefaultsTest < ActiveRecord::TestCase
+  def setup
+    @red = create_color(:name => 'RED', :html => '#f00')
+    @green = create_color(:name => 'GREEN')
+  
+    Color.bootstrap(
+      {:id => @red.id, :name => 'red', :defaults => {:html => '#ff0000'}},
+      {:id => @green.id, :name => 'green', :defaults => {:html => '#00ff00'}}
+    )
+    
+    @red.reload
+    @green.reload
+  end
+  
+  def test_should_update_all_non_default_attributes
+    assert_equal 'red', @red.name
+    assert_equal 'green', @green.name
+  end
+  
+  def test_should_not_update_default_attributes_if_defined
+    assert_equal '#f00', @red.html
+  end
+  
+  def test_should_update_default_attributes_if_not_defined
+    assert_equal '#00ff00', @green.html
+  end
+end
+
+class EnumerationFastBootstrappedTest < ActiveRecord::TestCase
+  def test_should_not_run_validations
+    assert_raise(ActiveRecord::StatementInvalid) { Color.fast_bootstrap({:id => 1, :name => nil}) }
+  end
+  
+  def test_should_still_record_timestamps_after_bootstrap
+    Color.fast_bootstrap({:id => 1, :name => 'red'})
+    assert Color.record_timestamps
+  end
+  
+  def test_should_still_run_validations_after_bootstrap
+    Color.fast_bootstrap({:id => 1, :name => 'red'})
+    
+    color = Color.new
+    assert !color.save
+    assert_raise(ActiveRecord::RecordInvalid) { color.save! }
+  end
+  
+  def test_should_still_track_changed_attributes_after_bootstrap
+    Color.fast_bootstrap({:id => 1, :name => 'red'})
+    
+    color = Color.new(:name => 'red')
+    assert color.changed?
+  end
+end