Remove deprecated support to extend Rails console through Rails::ConsoleMethods

Author: rafaelfranca

guides/source/8_0_release_notes.md

@@ -34,6 +34,8 @@ Please refer to the [Changelog][railties] for detailed changes.
 
 *   Remove deprecated file `rails/console/helpers`.
 
+*   Remove deprecated support to extend Rails console through `Rails::ConsoleMethods`.
+
 ### Deprecations
 
 ### Notable changes

railties/CHANGELOG.md

@@ -1,3 +1,7 @@
+*   Remove deprecated support to extend Rails console through `Rails::ConsoleMethods`.
+
+    *Rafael Mendonça França*
+
 *   Remove deprecated file `rails/console/helpers`.
 
     *Rafael Mendonça França*

railties/lib/rails/commands/console/irb_console.rb

@@ -6,7 +6,6 @@
 module Rails
   class Console
     class RailsHelperBase < IRB::HelperMethod::Base
-      include ConsoleMethods
     end
 
     class ControllerHelper < RailsHelperBase
@@ -61,8 +60,6 @@ def execute
     end
 
     class ReloadCommand < IRB::Command::Base
-      include ConsoleMethods
-
       category "Rails console"
       description "Reloads the Rails application."
 
@@ -120,10 +117,6 @@ def start
           end
         end
 
-        # Because some users/libs use Rails::ConsoleMethods to extend Rails console,
-        # we still include it for backward compatibility.
-        IRB::ExtendCommandBundle.include ConsoleMethods
-
         # Respect user's choice of prompt mode.
         IRB.conf[:PROMPT_MODE] = :RAILS_PROMPT if IRB.conf[:PROMPT_MODE] == :DEFAULT
         IRB::Irb.new.run(IRB.conf)

railties/lib/rails/console/methods.rb

@@ -1,23 +1,7 @@
 # frozen_string_literal: true
 
-module Rails
-  module ConsoleMethods
-    def self.include(_mod, ...)
-      raise_deprecation_warning
-      super
-    end
-
-    def self.method_added(_method_name)
-      raise_deprecation_warning
-      super
-    end
-
-    def self.raise_deprecation_warning
-      Rails.deprecator.warn(<<~MSG, caller_locations(2..2))
-        Extending Rails console through `Rails::ConsoleMethods` is deprecated and will be removed in Rails 8.0.
-        Please directly use IRB's extension API to add new commands or helpers to the console.
-        For more details, please visit: https://github.com/ruby/irb/blob/master/EXTEND_IRB.md
-      MSG
-    end
-  end
-end
+Rails.deprecator.warn(<<~MSG, caller_locations(0..1))
+`rails/console/methods` has been deprecated and will be removed in Rails 8.1.
+Please directly use IRB's extension API to add new commands or helpers to the console.
+For more details, please visit: https://github.com/ruby/irb/blob/master/EXTEND_IRB.md
+MSG

railties/lib/rails/engine.rb

@@ -452,7 +452,6 @@ def initialize
     # Load console and invoke the registered hooks.
     # Check Rails::Railtie.console for more info.
     def load_console(app = self)
-      require "rails/console/methods"
       run_console_blocks(app)
       self
     end

railties/test/application/console_test.rb

@@ -200,51 +200,6 @@ def test_reload_command_fires_preparation_and_cleanup_callbacks
     write_prompt "c", "=> 3"
   end
 
-  def test_rails_console_methods_patch_backward_compatibility_with_module_inclusion
-    add_to_config <<-RUBY
-      module MyConsole
-        def foo
-          "this is foo"
-        end
-      end
-
-      console do
-        ::Rails::ConsoleMethods.include(MyConsole)
-      end
-    RUBY
-
-    spawn_console("-e development", wait_for_prompt: false)
-
-    line_number = 0
-    app = File.readlines("#{app_path}/config/application.rb")
-    app.each_with_index do |line, index|
-      if line.include?("Rails::ConsoleMethods.include(MyConsole)")
-        line_number = index + 1
-      end
-    end
-
-    assert_output "Extending Rails console through `Rails::ConsoleMethods` is deprecated", @primary, 30
-    assert_output "(called from block in <class:Application> at #{app_path}/config/application.rb:#{line_number})", @primary, 30
-    write_prompt "foo", "=> \"this is foo\""
-  end
-
-  def test_rails_console_methods_patch_backward_compatibility_with_module_reopening
-    add_to_config <<-RUBY
-      console do
-        ::Rails::ConsoleMethods.module_eval do
-          def foo
-            "this is foo"
-          end
-        end
-      end
-    RUBY
-
-    spawn_console("-e development", wait_for_prompt: false)
-
-    assert_output "Extending Rails console through `Rails::ConsoleMethods` is deprecated", @primary, 30
-    write_prompt "foo", "=> \"this is foo\""
-  end
-
   def test_reload_command_reload_constants
     app_file "app/models/user.rb", <<-MODEL
       class User

railties/test/commands/console_test.rb

@@ -167,7 +167,6 @@ def config
         end
 
         def load_console
-          require "rails/console/methods"
         end
       end
       mocked_app.new(console)