Merge pull request #34051 from gmcgibbon/module_parent_method_rename

Prefix Module#parent, Module#parents, and Module#parent_name with module

4 files changed, 73 insertions, 26 deletions

diff --git a/activesupport/CHANGELOG.md b/activesupport/CHANGELOG.md
index f36d740d81..586ed28693 100644
--- a/activesupport/CHANGELOG.md
+++ b/activesupport/CHANGELOG.md
@@ -1,3 +1,8 @@
+*   Rename `Module#parent`, `Module#parents`, and `Module#parent_name` to
+    `module_parent`, `module_parents`, and `module_parent_name`.
+
+    *Gannon McGibbon*
+
 *   Deprecate the use of `LoggerSilence` in favor of `ActiveSupport::LoggerSilence`
 
     *Edouard Chin*
diff --git a/activesupport/lib/active_support/core_ext/module/introspection.rb b/activesupport/lib/active_support/core_ext/module/introspection.rb
index c5bb598bd1..9b6df40596 100644
--- a/activesupport/lib/active_support/core_ext/module/introspection.rb
+++ b/activesupport/lib/active_support/core_ext/module/introspection.rb
@@ -5,8 +5,8 @@ require "active_support/inflector"
 class Module
   # Returns the name of the module containing this one.
   #
-  #   M::N.parent_name # => "M"
-  def parent_name
+  #   M::N.module_parent_name # => "M"
+  def module_parent_name
     if defined?(@parent_name)
       @parent_name
     else
@@ -16,6 +16,14 @@ class Module
     end
   end
 
+  def parent_name
+    ActiveSupport::Deprecation.warn(<<-MSG.squish)
+      `Module#parent_name` has been renamed to `module_parent_name`.
+      `parent_name` is deprecated and will be removed in Rails 6.1.
+    MSG
+    module_parent_name
+  end
+
   # Returns the module which contains this one according to its name.
   #
   #   module M
@@ -24,15 +32,23 @@ class Module
   #   end
   #   X = M::N
   #
-  #   M::N.parent # => M
-  #   X.parent    # => M
+  #   M::N.module_parent # => M
+  #   X.module_parent    # => M
   #
   # The parent of top-level and anonymous modules is Object.
   #
-  #   M.parent          # => Object
-  #   Module.new.parent # => Object
+  #   M.module_parent          # => Object
+  #   Module.new.module_parent # => Object
+  def module_parent
+    module_parent_name ? ActiveSupport::Inflector.constantize(module_parent_name) : Object
+  end
+
   def parent
-    parent_name ? ActiveSupport::Inflector.constantize(parent_name) : Object
+    ActiveSupport::Deprecation.warn(<<-MSG.squish)
+      `Module#parent` has been renamed to `module_parent`.
+      `parent` is deprecated and will be removed in Rails 6.1.
+    MSG
+    module_parent
   end
 
   # Returns all the parents of this module according to its name, ordered from
@@ -44,13 +60,13 @@ class Module
   #   end
   #   X = M::N
   #
-  #   M.parents    # => [Object]
-  #   M::N.parents # => [M, Object]
-  #   X.parents    # => [M, Object]
-  def parents
+  #   M.module_parents    # => [Object]
+  #   M::N.module_parents # => [M, Object]
+  #   X.module_parents    # => [M, Object]
+  def module_parents
     parents = []
-    if parent_name
-      parts = parent_name.split("::")
+    if module_parent_name
+      parts = module_parent_name.split("::")
       until parts.empty?
         parents << ActiveSupport::Inflector.constantize(parts * "::")
         parts.pop
@@ -59,4 +75,12 @@ class Module
     parents << Object unless parents.include? Object
     parents
   end
+
+  def parents
+    ActiveSupport::Deprecation.warn(<<-MSG.squish)
+      `Module#parents` has been renamed to `module_parents`.
+      `parents` is deprecated and will be removed in Rails 6.1.
+    MSG
+    module_parents
+  end
 end
diff --git a/activesupport/lib/active_support/dependencies.rb b/activesupport/lib/active_support/dependencies.rb
index 063d8d1587..66e0bea00e 100644
--- a/activesupport/lib/active_support/dependencies.rb
+++ b/activesupport/lib/active_support/dependencies.rb
@@ -521,8 +521,8 @@ module ActiveSupport #:nodoc:
         end
       elsif mod = autoload_module!(from_mod, const_name, qualified_name, path_suffix)
         return mod
-      elsif (parent = from_mod.parent) && parent != from_mod &&
-            ! from_mod.parents.any? { |p| p.const_defined?(const_name, false) }
+      elsif (parent = from_mod.module_parent) && parent != from_mod &&
+            ! from_mod.module_parents.any? { |p| p.const_defined?(const_name, false) }
         # If our parents do not have a constant named +const_name+ then we are free
         # to attempt to load upwards. If they do have such a constant, then this
         # const_missing must be due to from_mod::const_name, which should not
diff --git a/activesupport/test/core_ext/module/introspection_test.rb b/activesupport/test/core_ext/module/introspection_test.rb
index 76d3012239..d8409d5e44 100644
--- a/activesupport/test/core_ext/module/introspection_test.rb
+++ b/activesupport/test/core_ext/module/introspection_test.rb
@@ -15,25 +15,43 @@ module ParentA
 end
 
 class IntrospectionTest < ActiveSupport::TestCase
+  def test_module_parent_name
+    assert_equal "ParentA", ParentA::B.module_parent_name
+    assert_equal "ParentA::B", ParentA::B::C.module_parent_name
+    assert_nil ParentA.module_parent_name
+  end
+
+  def test_module_parent_name_when_frozen
+    assert_equal "ParentA", ParentA::FrozenB.module_parent_name
+    assert_equal "ParentA::B", ParentA::B::FrozenC.module_parent_name
+  end
+
   def test_parent_name
-    assert_equal "ParentA", ParentA::B.parent_name
-    assert_equal "ParentA::B", ParentA::B::C.parent_name
-    assert_nil ParentA.parent_name
+    assert_deprecated do
+      assert_equal "ParentA", ParentA::B.parent_name
+    end
   end
 
-  def test_parent_name_when_frozen
-    assert_equal "ParentA", ParentA::FrozenB.parent_name
-    assert_equal "ParentA::B", ParentA::B::FrozenC.parent_name
+  def test_module_parent
+    assert_equal ParentA::B, ParentA::B::C.module_parent
+    assert_equal ParentA, ParentA::B.module_parent
+    assert_equal Object, ParentA.module_parent
   end
 
   def test_parent
-    assert_equal ParentA::B, ParentA::B::C.parent
-    assert_equal ParentA, ParentA::B.parent
-    assert_equal Object, ParentA.parent
+    assert_deprecated do
+      assert_equal ParentA, ParentA::B.parent
+    end
+  end
+
+  def test_module_parents
+    assert_equal [ParentA::B, ParentA, Object], ParentA::B::C.module_parents
+    assert_equal [ParentA, Object], ParentA::B.module_parents
   end
 
   def test_parents
-    assert_equal [ParentA::B, ParentA, Object], ParentA::B::C.parents
-    assert_equal [ParentA, Object], ParentA::B.parents
+    assert_deprecated do
+      assert_equal [ParentA, Object], ParentA::B.parents
+    end
   end
 end