Deprecate set_table_name in favour of self.table_name= or defining your own method.

Author: jonleighton

actionpack/test/activerecord/polymorphic_routes_test.rb

@@ -2,36 +2,36 @@
 require 'fixtures/project'
 
 class Task < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 class Step < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 class Bid < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 class Tax < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 class Fax < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 class Series < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
 end
 
 module Blog
   class Post < ActiveRecord::Base
-    set_table_name 'projects'
+    self.table_name = 'projects'
   end
 
   class Blog < ActiveRecord::Base
-    set_table_name 'projects'
+    self.table_name = 'projects'
   end
 
   def self.use_relative_model_naming?

actionpack/test/fixtures/developer.rb

@@ -5,5 +5,5 @@ class Developer < ActiveRecord::Base
 end
 
 class DeVeLoPeR < ActiveRecord::Base
-  set_table_name "developers"
+  self.table_name = "developers"
 end

activerecord/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## Rails 3.2.0 (unreleased) ##
 
+*   Deprecated `set_table_name`. Use `self.table_name=` instead, or define your own
+    `self.table_name` method:
+
+         class Project < ActiveRecord::Base
+           self.table_name = "project"
+         end
+
+         class Post < ActiveRecord::Base
+           def self.table_name
+             "special_" + super
+           end
+         end
+         Post.table_name # => "special_posts"
+
+    *Jon Leighton*
+
 *   Generated association methods are created within a separate module to allow overriding and
     composition using `super`. For a class named `MyModel`, the module is named
     `MyModel::GeneratedFeatureMethods`. It is included into the model class immediately after

activerecord/lib/active_record/base.rb

@@ -23,6 +23,7 @@
 require 'active_support/core_ext/module/introspection'
 require 'active_support/core_ext/object/duplicable'
 require 'active_support/core_ext/object/blank'
+require 'active_support/deprecation'
 require 'arel'
 require 'active_record/errors'
 require 'active_record/log_subscriber'
@@ -624,14 +625,61 @@ def serialize(attr_name, class_name = Object)
       # the table name guess for an Invoice class becomes "myapp_invoices".
       # Invoice::Lineitem becomes "myapp_invoice_lineitems".
       #
-      # You can also overwrite this class method to allow for unguessable
-      # links, such as a Mouse class with a link to a "mice" table. Example:
+      # You can also set your own table name explicitly:
       #
       #   class Mouse < ActiveRecord::Base
-      #     set_table_name "mice"
+      #     self.table_name = "mice"
       #   end
+      #
+      # Alternatively, you can override the table_name method to define your
+      # own computation. (Possibly using <tt>super</tt> to manipulate the default
+      # table name.) Example:
+      #
+      #   class Post < ActiveRecord::Base
+      #     def self.table_name
+      #       "special_" + super
+      #     end
+      #   end
+      #   Post.table_name # => "special_posts"
       def table_name
-        reset_table_name
+        reset_table_name unless defined?(@table_name)
+        @table_name
+      end
+
+      # Sets the table name explicitly. Example:
+      #
+      #   class Project < ActiveRecord::Base
+      #     self.table_name = "project"
+      #   end
+      #
+      # You can also just define your own <tt>self.table_name</tt> method; see
+      # the documentation for ActiveRecord::Base#table_name.
+      def table_name=(value)
+        @quoted_table_name = nil
+        @arel_table        = nil
+        @table_name        = value
+        @relation          = Relation.new(self, arel_table)
+      end
+
+      def set_table_name(value = nil, &block) #:nodoc:
+        if block
+          ActiveSupport::Deprecation.warn(
+            "Calling set_table_name is deprecated. If you need to lazily evaluate " \
+            "the table name, define your own `self.table_name` class method. You can use `super` " \
+            "to get the default table name where you would have called `original_table_name`."
+          )
+
+          @quoted_table_name = nil
+          define_attr_method :table_name, value, &block
+          @arel_table = nil
+          @relation = Relation.new(self, arel_table)
+        else
+          ActiveSupport::Deprecation.warn(
+            "Calling set_table_name is deprecated. Please use `self.table_name = 'the_name'` instead."
+          )
+
+          self.table_name = value
+        end
       end
 
       # Returns a quoted version of the table name, used to construct SQL statements.
@@ -641,9 +689,13 @@ def quoted_table_name
 
       # Computes the table name, (re)sets it internally, and returns it.
       def reset_table_name #:nodoc:
-        return if abstract_class?
-
-        self.table_name = compute_table_name
+        if superclass.abstract_class?
+          self.table_name = superclass.table_name || compute_table_name
+        elsif abstract_class?
+          self.table_name = superclass == Base ? nil : superclass.table_name
+        else
+          self.table_name = compute_table_name
+        end
       end
 
       def full_table_name_prefix #:nodoc:
@@ -668,21 +720,6 @@ def reset_sequence_name #:nodoc:
         default
       end
 
-      # Sets the table name. If the value is nil or false then the value returned by the given
-      # block is used.
-      #
-      #   class Project < ActiveRecord::Base
-      #     set_table_name "project"
-      #   end
-      def set_table_name(value = nil, &block)
-        @quoted_table_name = nil
-        define_attr_method :table_name, value, &block
-        @arel_table = nil
-
-        @relation = Relation.new(self, arel_table)
-      end
-      alias :table_name= :set_table_name
-
       # Sets the name of the inheritance column to use to the given value,
       # or (if the value # is nil or false) to the value returned by the
       # given block.

activerecord/test/cases/adapters/mysql/schema_test.rb

@@ -14,7 +14,7 @@ def setup
         @db_name    = db
 
         @omgpost = Class.new(ActiveRecord::Base) do
-          set_table_name "#{db}.#{table}"
+          self.table_name = "#{db}.#{table}"
           def self.name; 'Post'; end
         end
       end

activerecord/test/cases/adapters/mysql2/schema_test.rb

@@ -14,7 +14,7 @@ def setup
         @db_name    = db
 
         @omgpost = Class.new(ActiveRecord::Base) do
-          set_table_name "#{db}.#{table}"
+          self.table_name = "#{db}.#{table}"
           def self.name; 'Post'; end
         end
       end

activerecord/test/cases/adapters/postgresql/schema_test.rb

@@ -26,23 +26,23 @@ class SchemaTest < ActiveRecord::TestCase
   PK_TABLE_NAME = 'table_with_pk'
 
   class Thing1 < ActiveRecord::Base
-    set_table_name "test_schema.things"
+    self.table_name = "test_schema.things"
   end
 
   class Thing2 < ActiveRecord::Base
-    set_table_name "test_schema2.things"
+    self.table_name = "test_schema2.things"
   end
 
   class Thing3 < ActiveRecord::Base
-    set_table_name 'test_schema."things.table"'
+    self.table_name = 'test_schema."things.table"'
   end
 
   class Thing4 < ActiveRecord::Base
-    set_table_name 'test_schema."Things"'
+    self.table_name = 'test_schema."Things"'
   end
 
   class Thing5 < ActiveRecord::Base
-    set_table_name 'things'
+    self.table_name = 'things'
   end
 
   def setup

activerecord/test/cases/adapters/postgresql/view_test.rb

@@ -14,7 +14,7 @@ class ViewTest < ActiveRecord::TestCase
   ]
 
   class ThingView < ActiveRecord::Base
-    set_table_name 'test_schema.view_things'
+    self.table_name = 'test_schema.view_things'
   end
 
   def setup

activerecord/test/cases/associations/eager_load_includes_full_sti_class_test.rb

@@ -4,7 +4,7 @@
 
 module Namespaced
   class Post < ActiveRecord::Base
-    set_table_name 'posts'
+    self.table_name = 'posts'
     has_one :tagging, :as => :taggable, :class_name => 'Tagging'
   end
 end

activerecord/test/cases/associations/has_and_belongs_to_many_associations_test.rb

@@ -23,7 +23,7 @@
 require 'active_support/core_ext/string/conversions'
 
 class ProjectWithAfterCreateHook < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
   has_and_belongs_to_many :developers,
     :class_name => "DeveloperForProjectWithAfterCreateHook",
     :join_table => "developers_projects",
@@ -39,7 +39,7 @@ def add_david
 end
 
 class DeveloperForProjectWithAfterCreateHook < ActiveRecord::Base
-  set_table_name 'developers'
+  self.table_name = 'developers'
   has_and_belongs_to_many :projects,
     :class_name => "ProjectWithAfterCreateHook",
     :join_table => "developers_projects",
@@ -48,7 +48,7 @@ class DeveloperForProjectWithAfterCreateHook < ActiveRecord::Base
 end
 
 class ProjectWithSymbolsForKeys < ActiveRecord::Base
-  set_table_name 'projects'
+  self.table_name = 'projects'
   has_and_belongs_to_many :developers,
     :class_name => "DeveloperWithSymbolsForKeys",
     :join_table => :developers_projects,
@@ -57,7 +57,7 @@ class ProjectWithSymbolsForKeys < ActiveRecord::Base
 end
 
 class DeveloperWithSymbolsForKeys < ActiveRecord::Base
-  set_table_name 'developers'
+  self.table_name = 'developers'
   has_and_belongs_to_many :projects,
     :class_name => "ProjectWithSymbolsForKeys",
     :join_table => :developers_projects,
@@ -66,7 +66,7 @@ class DeveloperWithSymbolsForKeys < ActiveRecord::Base
 end
 
 class DeveloperWithCounterSQL < ActiveRecord::Base
-  set_table_name 'developers'
+  self.table_name = 'developers'
   has_and_belongs_to_many :projects,
     :class_name => "DeveloperWithCounterSQL",
     :join_table => "developers_projects",