Keep Rails::ConsoleMethods's module inclusion to IRB but raise deprecation warning

[st0012]

Motivation / Background

@carlosantoniodasilva suggested in this tweet that the Rails::ConsoleMethods extension approach should still be supported.

Detail

Due to some users/libs relying on Rails::ConsoleMethod to extend Rails console, we need to keep including it to IRB's internal.

But to prevent also adding app and helper methods to the console, which are already registered to IRB through its API, we need to remove them from the Rails::ConsoleMethods. Additionally, we should raise deprecation warning when users try to use Rails::ConsoleMethods in this way.

This commit:

• Removes all methods from Rails::ConsoleMethods that are already registered to IRB. So it's now essentially empty.
• Raises a deprecation warning when modules are included to Rails::ConsoleMethods or methods are added to it.
• Adds a test to ensure that the deprecation warning is raised and the methods are available in the console.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

• This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
• Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
• Tests are added or updated if you fix a bug or add a feature.
• CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

[ghiculescu]

FYI: basecamp/console1984#111

I imagine it's not the only gem that's requiring this file :/

[carlosantoniodasilva]

@st0012 thanks for the updates here! appreciate it.

While I think that expecting libraries / frameworks like Rails to extend the console via the new IRB API is fine/great, I'm afraid this might be too much to ask for app devs.

We might need to look into a simpler way to add methods to the console that doesn't require the extra plumbing of creating a class, adding a description, registering the command, etc... not sure.

@ghiculescu maybe we bring back those files and make them just require the new one? They could be removed with the deprecated stuff later.

[st0012]

We might need to look into a simpler way to add methods to the console that doesn't require the extra plumbing of creating a class, adding a description, registering the command, etc... not sure.

Users can already create IRB commands without specifying meta attributes with v1.13.1. But maybe Rails can provide APIs like: Rails::ConsoleCommand.register(:my_cmd, "optional description") { do_somthing) }, and automatically assign it the Rails console category?

@ghiculescu can you investigate what's causing the failure? My understanding is that the original app.rb and helper.rb were only expected to provide ConsoleMethods and its helper methods for the console block. And from the code you link to, I don't see anything reference to the methods that were in ConsoleMethods originally?

[ghiculescu]

It’s not my gem (I just use it) but I’ll have a look. I tend to agree with @carlosantoniodasilva though. It looks like things that are public API are just being deleted.

[ghiculescu]

@st0012 - https://github.com/basecamp/console1984/blob/215874e74daac9865ff09bf128be13b81b230c4f/lib/console1984/shield.rb#L37

This leads me to https://github.com/basecamp/console1984/blob/master/lib/console1984/ext/irb/commands.rb

Through looking into this I also found rails/mission_control-jobs#117. Would we need to do a similar PR here?

[st0012]

What I found after testing console1984 gem locally:

• Adding app.rb back to include methods.rb doesn't resolve the undefined method thread_mattr_accessor issue. The error requires requiring active_support/core_ext/module/attribute_accessors_per_thread to fix, so it seemed like the dependency is on app.rb's require "active_support/all", not the module itself.
• Even after addressing the above error, we'd still see errors related to test fixture methods, which also happens WITHOUT the IRB change too (e.g. against 549144b as well)

[st0012]

I'm 100% ok with adding app.rb back just to require methods.rb. However, console1984 should require active_support/all or active_support/core_ext/module/attribute_accessors_per_thread itself because it's a dependency of the gem and was just loaded by accident.

[ghiculescu]

I've opened basecamp/console1984#112 to address the missing require.

I'm 100% ok with adding app.rb back just to require methods.rb.

That would solve my problem in the short term so I am 😍 on this. Over the long term that gem would need to get updated to the new IRB API I guess.

[st0012]

@ghiculescu @carlosantoniodasilva I added the files back in #51839