Respect custom primary_key configurations in ActiveRecord models

Author: djmaze

CHANGELOG.rdoc

@@ -1,5 +1,6 @@
 == master
 
+* Respect custom primary_key configurations in ActiveRecord models [Martin Honermeyer]
 * Fix tests failing on Rails 2.3.3+
 * Release gems via rake-gemcutter instead of rubyforge
 

lib/enumerate_by.rb

@@ -265,29 +265,31 @@ module Bootstrapped
     # Otherwise, any changes to that column remain there.
     def bootstrap(*records)
       uncached do
+        primary_key = self.primary_key.to_sym
+        
         # Remove records that are no longer being used
         records.flatten!
-        ids = records.map {|record| record[:id]}.compact
-        delete_all(ids.any? ? ['id NOT IN (?)', ids] : nil)
+        ids = records.map {|record| record[primary_key]}.compact
+        delete_all(ids.any? ? ["#{primary_key} NOT IN (?)", ids] : nil)
 
         # Find remaining existing records (to be updated)
-        existing = all.inject({}) {|existing, record| existing[record.id] = record; existing}
+        existing = all.inject({}) {|existing, record| existing[record.send(primary_key)] = record; existing}
 
         records.map! do |attributes|
           attributes.symbolize_keys!
           defaults = attributes.delete(:defaults)
 
           # Update with new attributes
           record =
-            if record = existing[attributes[:id]]
+            if record = existing[attributes[primary_key]]
               attributes.merge!(defaults.delete_if {|attribute, value| record.send("#{attribute}?")}) if defaults
               record.attributes = attributes
               record
             else
               attributes.merge!(defaults) if defaults
               new(attributes)
             end
-          record.id = attributes[:id]
+          record.send("#{primary_key}=", attributes[primary_key])
 
           # Force failed saves to stop execution
           record.save!
@@ -317,27 +319,29 @@ def bootstrap(*records)
     # 
     # See EnumerateBy::Bootstrapped#bootstrap for information about usage.
     def fast_bootstrap(*records)
+      primary_key = self.primary_key.to_sym
+      
       # Remove records that are no longer being used
       records.flatten!
-      ids = records.map {|record| record[:id]}.compact
-      delete_all(ids.any? ? ['id NOT IN (?)', ids] : nil)
+      ids = records.map {|record| record[primary_key]}.compact
+      delete_all(ids.any? ? ["#{primary_key} NOT IN (?)", ids] : nil)
 
       # Find remaining existing records (to be updated)
       quoted_table_name = self.quoted_table_name
-      existing = connection.select_all("SELECT * FROM #{quoted_table_name}").inject({}) {|existing, record| existing[record['id'].to_i] = record; existing}
+      existing = connection.select_all("SELECT * FROM #{quoted_table_name}").inject({}) {|existing, record| existing[record[primary_key.to_s].to_i] = record; existing}
 
       records.each do |attributes|
         attributes.stringify_keys!
         if defaults = attributes.delete('defaults')
           defaults.stringify_keys!
         end
 
-        id = attributes['id']
+        id = attributes[primary_key.to_s]
         if existing_attributes = existing[id]
           # Record exists: Update attributes
-          attributes.delete('id')
+          attributes.delete(primary_key.to_s)
           attributes.merge!(defaults.delete_if {|attribute, value| !existing_attributes[attribute].nil?}) if defaults
-          update_all(attributes, :id => id)
+          update_all(attributes, primary_key => id)
         else
           # Record doesn't exist: create new one
           attributes.merge!(defaults) if defaults

lib/enumerate_by/extensions/associations.rb

@@ -75,18 +75,19 @@ def belongs_to_with_enumerations(association_id, options = {})
           primary_key_name = reflection.primary_key_name
           class_name = reflection.class_name
           klass = reflection.klass
+          klass_primary_key = klass.primary_key.to_sym
 
           # Inclusion scopes
           %W(with_#{name} with_#{name.to_s.pluralize}).each do |scope_name|
             named_scope scope_name.to_sym, lambda {|*enumerators| {
-              :conditions => {primary_key_name => klass.find_all_by_enumerator!(enumerators).map(&:id)}
+              :conditions => {primary_key_name => klass.find_all_by_enumerator!(enumerators).map(&klass_primary_key)}
             }}
           end
 
           # Exclusion scopes
           %W(without_#{name} without_#{name.to_s.pluralize}).each do |scope_name|
             named_scope scope_name.to_sym, lambda {|*enumerators| {
-              :conditions => ["#{primary_key_name} NOT IN (?)", klass.find_all_by_enumerator!(enumerators).map(&:id)]
+              :conditions => ["#{primary_key_name} NOT IN (?)", klass.find_all_by_enumerator!(enumerators).map(&klass_primary_key)]
             }}
           end
 

lib/enumerate_by/extensions/base_conditions.rb

@@ -104,11 +104,12 @@ def replace_enumerations_in_hash(attrs, allow_multiple = true) #:nodoc:
         def enumerator_options_for(name, enumerator, allow_multiple = true)
           if reflection = reflect_on_enumeration(name)
             klass = reflection.klass
+            klass_primary_key = klass.primary_key.to_sym
             attribute = reflection.primary_key_name
             id = if allow_multiple && enumerator.is_a?(Array)
-              klass.find_all_by_enumerator!(enumerator).map(&:id)
+              klass.find_all_by_enumerator!(enumerator).map(&klass_primary_key)
             else
-              klass.find_by_enumerator!(enumerator).id
+              klass.find_by_enumerator!(enumerator).send(klass_primary_key)
             end
 
             {attribute => id}

test/app_root/app/models/car.rb

@@ -1,4 +1,5 @@
 class Car < ActiveRecord::Base
   belongs_to :color
+  belongs_to :legacy_color
   belongs_to :feature, :polymorphic => true
 end

test/app_root/app/models/legacy_color.rb

@@ -0,0 +1,5 @@
+class LegacyColor < ActiveRecord::Base
+  set_primary_key :uid
+  
+  enumerate_by :name
+end

test/app_root/db/migrate/002_create_cars.rb

@@ -2,7 +2,7 @@ class CreateCars < ActiveRecord::Migration
   def self.up
     create_table :cars do |t|
       t.string :name
-      t.references :color
+      t.references :color, :legacy_color
       t.references :feature, :class_name => 'Color', :polymorphic => true
     end
   end

test/app_root/db/migrate/005_create_legacy_colors.rb

@@ -0,0 +1,12 @@
+class CreateLegacyColors < ActiveRecord::Migration
+  def self.up
+    create_table :legacy_colors, :primary_key => 'uid' do |t|
+      t.string :name, :null => false
+      t.string :html
+    end
+  end
+  
+  def self.down
+    drop_table :legacy_colors
+  end
+end

test/factory.rb

@@ -34,7 +34,6 @@ def create_record(model, *args)
   end
 
   build Car do |attributes|
-    attributes[:color] = create_color unless attributes.include?(:color)
     attributes.reverse_merge!(
       :name => 'Ford Mustang'
     )
@@ -52,6 +51,12 @@ def create_record(model, *args)
     )
   end
 
+  build LegacyColor do |attributes|
+    attributes.reverse_merge!(
+      :name => 'red'
+    )
+  end
+  
   build Order do |attributes|
     attributes[:car_part] = create_car_part unless attributes.include?(:car_part)
     attributes.reverse_merge!(

test/unit/assocations_test.rb

@@ -33,7 +33,7 @@ def test_should_allow_nil
   end
 
   def test_should_track_associations
-    expected = {'color_id' => 'color'}
+    expected = {'color_id' => 'color', 'legacy_color_id' => 'legacy_color'}
     assert_equal expected, Car.enumeration_associations
   end
 end
@@ -73,3 +73,30 @@ def test_should_not_create_named_scopes
     assert !Car.respond_to?(:without_features)
   end
 end
+
+class ModelWithEnumerationScopesUsingCustomPrimaryKeyTest < ActiveRecord::TestCase
+  def setup
+    @red = create_legacy_color(:name => 'red')
+    @blue = create_legacy_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :legacy_color => @red)
+    @blue_car = create_car(:name => 'Ford Mustang', :legacy_color => @blue)
+  end
+  
+  def test_should_have_inclusion_scope_for_single_enumerator
+    assert_equal [@red_car], Car.with_legacy_color('red')
+    assert_equal [@blue_car], Car.with_legacy_color('blue')
+  end
+  
+  def test_should_have_inclusion_scope_for_multiple_enumerators
+    assert_equal [@red_car, @blue_car], Car.with_legacy_color('red', 'blue')
+  end
+  
+  def test_should_have_exclusion_scope_for_single_enumerator
+    assert_equal [@blue_car], Car.without_legacy_color('red')
+    assert_equal [@red_car], Car.without_legacy_color('blue')
+  end
+  
+  def test_should_have_exclusion_scope_for_multiple_enumerators
+    assert_equal [], Car.without_legacy_colors('red', 'blue')
+  end
+end

test/unit/base_conditions_test.rb

@@ -57,6 +57,23 @@ def test_should_still_allow_multiple_non_enumerations_in_find_conditions
   end
 end
 
+class EnumerationWithCustomPrimaryKeyAndFinderConditionsTest < ActiveRecord::TestCase
+  def setup
+    @red = create_legacy_color(:name => 'red')
+    @blue = create_legacy_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :legacy_color => @red)
+    @blue_car = create_car(:name => 'Ford Mustang', :legacy_color => @blue)
+  end
+  
+  def test_should_replace_enumerations_in_dynamic_finders
+    assert_equal @red_car, Car.find_by_legacy_color('red')
+  end
+  
+  def test_should_replace_enumerations_in_find_conditions
+    assert_equal @red_car, Car.first(:conditions => {:legacy_color => 'red'})
+  end
+end
+
 class EnumerationWithFinderUpdatesTest < ActiveRecord::TestCase
   def setup
     @red = create_color(:name => 'red')
@@ -86,3 +103,17 @@ def test_should_not_replace_multiple_enumerations_in_update_conditions
     assert_equal @red, @red_car.color
   end
 end
+
+class EnumerationWithCustomPrimaryKeyAndFinderUpdatesTest < ActiveRecord::TestCase
+  def setup
+    @red = create_legacy_color(:name => 'red')
+    @blue = create_legacy_color(:name => 'blue')
+    @red_car = create_car(:name => 'Ford Mustang', :legacy_color => @red)
+  end
+  
+  def test_should_replace_enumerations_in_update_conditions
+    Car.update_all({:legacy_color => 'blue'}, :name => 'Ford Mustang')
+    @red_car.reload
+    assert_equal @blue, @red_car.legacy_color
+  end
+end

test/unit/enumerate_by_test.rb

@@ -448,6 +448,28 @@ def test_should_update_default_attributes_if_not_defined
   end
 end
 
+class EnumerationWithCustomPrimaryKeyBootstrappedTest < ActiveRecord::TestCase
+  def setup
+    @red, @green = LegacyColor.bootstrap(
+      {:uid => 1, :name => 'red'},
+      {:uid => 2, :name => 'green'}
+    )
+  end
+  
+  def test_should_not_raise_exception_if_primary_key_not_specified
+    assert_nothing_raised { LegacyColor.bootstrap({:name => 'red'}, {:name => 'green'}) }
+    assert_equal 2, LegacyColor.count
+  end
+  
+  def test_should_create_records
+    assert_equal @red, LegacyColor.find(1)
+    assert_equal 'red', @red.name
+    
+    assert_equal @green, LegacyColor.find(2)
+    assert_equal 'green', @green.name
+  end
+end
+
 class EnumerationFastBootstrappedTest < ActiveRecord::TestCase
   def setup
     @result = Color.fast_bootstrap(
@@ -546,3 +568,23 @@ def test_should_update_default_attributes_if_not_defined
     assert_equal '#00ff00', @green.html
   end
 end
+
+class EnumerationWithCustomPrimaryKeyFastBootstrappedTest < ActiveRecord::TestCase
+  def setup
+    @result = LegacyColor.fast_bootstrap(
+      {:uid => 1, :name => 'red'},
+      {:uid => 2, :name => 'green'}
+    )
+  end
+  
+  def test_should_not_raise_exception_if_primary_key_not_specified
+    assert_nothing_raised { LegacyColor.fast_bootstrap({:name => 'red'}, {:name => 'green'}) }
+    assert_equal 2, LegacyColor.count
+  end
+  
+  def test_should_create_records
+    assert @result
+    assert_not_nil LegacyColor.find_by_name('red')
+    assert_not_nil LegacyColor.find_by_name('green')
+  end
+end

test/unit/serializer_test.rb

@@ -8,14 +8,15 @@ def setup
   end
 
   def test_should_include_enumerations_in_serializable_attribute_names
-    assert_equal %w(color feature_id feature_type id name), @serializer.serializable_attribute_names
+    assert_equal %w(color feature_id feature_type id legacy_color name), @serializer.serializable_attribute_names
   end
 
   def test_should_typecast_serializable_record
     expected = {
       'color' => 'red',
       'feature_id' => nil,
       'feature_type' => nil,
+      'legacy_color' => nil,
       'id' => @car.id,
       'name' => 'Ford Mustang'
     }
@@ -32,14 +33,15 @@ def setup
   end
 
   def test_should_not_include_enumerations_in_serializable_attribute_names
-    assert_equal %w(color_id feature_id feature_type id name), @serializer.serializable_attribute_names
+    assert_equal %w(color_id feature_id feature_type id legacy_color_id name), @serializer.serializable_attribute_names
   end
 
   def test_should_not_typecast_serializable_record
     expected = {
       'color_id' => @red.id,
       'feature_id' => nil,
       'feature_type' => nil,
+      'legacy_color_id' => nil,
       'id' => @car.id,
       'name' => 'Ford Mustang'
     }
@@ -98,13 +100,14 @@ def setup
   end
 
   def test_should_not_include_enumeration_in_serializable_attribute_names
-    assert_equal %w(feature_id feature_type id name), @serializer.serializable_attribute_names
+    assert_equal %w(feature_id feature_type id legacy_color name), @serializer.serializable_attribute_names
   end
 
   def test_should_not_include_enumeration_in_serializable_record
     expected = {
       'feature_id' => nil,
       'feature_type' => nil,
+      'legacy_color' => nil,
       'id' => @car.id,
       'name' => 'Ford Mustang'
     }
@@ -121,13 +124,14 @@ def setup
   end
 
   def test_should_not_include_enumeration_in_serializable_attribute_names
-    assert_equal %w(feature_id feature_type id name), @serializer.serializable_attribute_names
+    assert_equal %w(feature_id feature_type id legacy_color name), @serializer.serializable_attribute_names
   end
 
   def test_should_not_include_enumeration_in_serializable_record
     expected = {
       'feature_id' => nil,
       'feature_type' => nil,
+      'legacy_color' => nil,
       'id' => @car.id,
       'name' => 'Ford Mustang'
     }
@@ -144,7 +148,7 @@ def setup
   end
 
   def test_should_not_include_enumeration_in_serializable_attribute_names
-    assert_equal %w(color_id feature_id feature_type id name), @serializer.serializable_attribute_names
+    assert_equal %w(color_id feature_id feature_type id legacy_color name), @serializer.serializable_attribute_names
   end
 
   def test_should_include_entire_enumeration_in_serializable_record
@@ -157,6 +161,7 @@ def test_should_include_entire_enumeration_in_serializable_record
       'color_id' => @red.id,
       'feature_id' => nil,
       'feature_type' => nil,
+      'legacy_color' => nil,
       'id' => @car.id,
       'name' => 'Ford Mustang'
     }

test/unit/xml_serializer_test.rb

@@ -62,6 +62,7 @@ def test_should_be_able_to_convert_to_xml
   <feature-id type="integer" nil="true"></feature-id>
   <feature-type nil="true"></feature-type>
   <id type="integer">#{@car.id}</id>
+  <legacy-color nil="true"></legacy-color>
   <name>Ford Mustang</name>
 </car>
     eos