Improve the derivation of HABTM assocation join table names

Improve the derivation of HABTM join table name to take account of nesting.
It now takes the table names of the two models, sorts them lexically and
then joins them, stripping any common prefix from the second table name.

Some examples:

  Top level models
  (Category <=> Product)
  Old: categories_products
  New: categories_products

  Top level models with a global table_name_prefix
  (Category <=> Product)
  Old: site_categories_products
  New: site_categories_products

  Nested models in a module without a table_name_prefix method
  (Admin::Category <=> Admin::Product)
  Old: categories_products
  New: categories_products

  Nested models in a module with a table_name_prefix method
  (Admin::Category <=> Admin::Product)
  Old: categories_products
  New: admin_categories_products

  Nested models in a parent model
  (Catalog::Category <=> Catalog::Product)
  Old: categories_products
  New: catalog_categories_products

  Nested models in different parent models
  (Catalog::Category <=> Content::Page)
  Old: categories_pages
  New: catalog_categories_content_pages

Also as part of this commit the validity checks for HABTM assocations have
been moved to ActiveRecord::Reflection One side effect of this is to move when
the exceptions are raised from the point of declaration to when the association
is built. This is consistant with other association validity checks.

6 files changed, 26 insertions, 18 deletions

diff --git a/activerecord/test/cases/adapters/mysql/reserved_word_test.rb b/activerecord/test/cases/adapters/mysql/reserved_word_test.rb
index 6faceaf7c0..8e3eeac81e 100644
--- a/activerecord/test/cases/adapters/mysql/reserved_word_test.rb
+++ b/activerecord/test/cases/adapters/mysql/reserved_word_test.rb
@@ -34,11 +34,11 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
       'select'=>'id int auto_increment primary key',
       'values'=>'id int auto_increment primary key, group_id int',
       'distinct'=>'id int auto_increment primary key',
-      'distincts_selects'=>'distinct_id int, select_id int'
+      'distinct_select'=>'distinct_id int, select_id int'
   end
 
   def teardown
-    drop_tables_directly ['group', 'select', 'values', 'distinct', 'distincts_selects', 'order']
+    drop_tables_directly ['group', 'select', 'values', 'distinct', 'distinct_select', 'order']
   end
 
   # create tables with reserved-word names and columns
@@ -80,7 +80,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   #activerecord model class with reserved-word table name
   def test_activerecord_model
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     x = nil
     assert_nothing_raised { x = Group.new }
     x.order = 'x'
@@ -94,7 +94,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # has_one association with reserved-word table name
   def test_has_one_associations
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     v = nil
     assert_nothing_raised { v = Group.find(1).values }
     assert_equal 2, v.id
@@ -102,7 +102,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # belongs_to association with reserved-word table name
   def test_belongs_to_associations
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     gs = nil
     assert_nothing_raised { gs = Select.find(2).groups }
     assert_equal gs.length, 2
@@ -111,7 +111,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # has_and_belongs_to_many with reserved-word table name
   def test_has_and_belongs_to_many
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     s = nil
     assert_nothing_raised { s = Distinct.find(1).selects }
     assert_equal s.length, 2
diff --git a/activerecord/test/cases/adapters/mysql2/reserved_word_test.rb b/activerecord/test/cases/adapters/mysql2/reserved_word_test.rb
index 32d4282623..5c2c113c78 100644
--- a/activerecord/test/cases/adapters/mysql2/reserved_word_test.rb
+++ b/activerecord/test/cases/adapters/mysql2/reserved_word_test.rb
@@ -34,11 +34,11 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
       'select'=>'id int auto_increment primary key',
       'values'=>'id int auto_increment primary key, group_id int',
       'distinct'=>'id int auto_increment primary key',
-      'distincts_selects'=>'distinct_id int, select_id int'
+      'distinct_select'=>'distinct_id int, select_id int'
   end
 
   def teardown
-    drop_tables_directly ['group', 'select', 'values', 'distinct', 'distincts_selects', 'order']
+    drop_tables_directly ['group', 'select', 'values', 'distinct', 'distinct_select', 'order']
   end
 
   # create tables with reserved-word names and columns
@@ -80,7 +80,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   #activerecord model class with reserved-word table name
   def test_activerecord_model
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     x = nil
     assert_nothing_raised { x = Group.new }
     x.order = 'x'
@@ -94,7 +94,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # has_one association with reserved-word table name
   def test_has_one_associations
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     v = nil
     assert_nothing_raised { v = Group.find(1).values }
     assert_equal 2, v.id
@@ -102,7 +102,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # belongs_to association with reserved-word table name
   def test_belongs_to_associations
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     gs = nil
     assert_nothing_raised { gs = Select.find(2).groups }
     assert_equal gs.length, 2
@@ -111,7 +111,7 @@ class MysqlReservedWordTest < ActiveRecord::TestCase
 
   # has_and_belongs_to_many with reserved-word table name
   def test_has_and_belongs_to_many
-    create_test_fixtures :select, :distinct, :group, :values, :distincts_selects
+    create_test_fixtures :select, :distinct, :group, :values, :distinct_select
     s = nil
     assert_nothing_raised { s = Distinct.find(1).selects }
     assert_equal s.length, 2
diff --git a/activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb b/activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb
index 9d693bae0c..24bb4adf0a 100644
--- a/activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb
+++ b/activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb
@@ -773,9 +773,7 @@ class HasAndBelongsToManyAssociationsTest < ActiveRecord::TestCase
 
   def test_self_referential_habtm_without_foreign_key_set_should_raise_exception
     assert_raise(ActiveRecord::HasAndBelongsToManyAssociationForeignKeyNeeded) {
-      Member.class_eval do
-        has_and_belongs_to_many :friends, :class_name => "Member", :join_table => "member_friends"
-      end
+      SelfMember.new.friends
     }
   end
 
diff --git a/activerecord/test/fixtures/reserved_words/distincts_selects.yml b/activerecord/test/fixtures/reserved_words/distinct_select.yml
index 90e8c95fef..d96779ade4 100644
--- a/activerecord/test/fixtures/reserved_words/distincts_selects.yml
+++ b/activerecord/test/fixtures/reserved_words/distinct_select.yml
@@ -1,11 +1,11 @@
-distincts_selects1:
+distinct_select1:
   distinct_id: 1
   select_id: 1
 
-distincts_selects2:
+distinct_select2:
   distinct_id: 1
   select_id: 2
 
-distincts_selects3:
+distinct_select3:
   distinct_id: 2
   select_id: 3
diff --git a/activerecord/test/models/member.rb b/activerecord/test/models/member.rb
index 11a0f4ff63..1f719b0858 100644
--- a/activerecord/test/models/member.rb
+++ b/activerecord/test/models/member.rb
@@ -30,3 +30,8 @@ class Member < ActiveRecord::Base
   has_many :current_memberships, :conditions => { :favourite => true }
   has_many :clubs, :through => :current_memberships
 end
+
+class SelfMember < ActiveRecord::Base
+  self.table_name = "members"
+  has_and_belongs_to_many :friends, :class_name => "SelfMember", :join_table => "member_friends"
+end
diff --git a/activerecord/test/schema/schema.rb b/activerecord/test/schema/schema.rb
index 5bcb9652cd..ba01ef35f0 100644
--- a/activerecord/test/schema/schema.rb
+++ b/activerecord/test/schema/schema.rb
@@ -361,6 +361,11 @@ ActiveRecord::Schema.define do
     t.string :extra_data
   end
 
+  create_table :member_friends, :force => true, :id => false do |t|
+    t.integer :member_id
+    t.integer :friend_id
+  end
+
   create_table :memberships, :force => true do |t|
     t.datetime :joined_on
     t.integer :club_id, :member_id