Build Rails console on top of IRB's latest official APIs #51705
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
st0012
force-pushed
the
update-irb
branch
3 times, most recently
from
35a1f74 to
af860c5
Compare
This will greatly increase the visibility of Rails console commands and helpers, and stop rely on IRB's internal components. Extension API reference: https://github.com/ruby/irb/blob/master/EXTEND_IRB.md And because we need to create new classes to use the new APIs, I also moved all the IRB-specific code to a new file, `irb_console.rb`. Use IRB.conf[:BACKTRACE_FILTER] for backtrace filtering in console This change uses the new `IRB.conf[:BACKTRACE_FILTER]` to inject the backtrace filtering logic into IRB. This avoids the need to patch IRB's internal WorkSpace class. Update changelog
|
Cool! |
4 tasks
st0012
added a commit
to st0012/mission_control-jobs
that referenced
this pull request
May 5, 2024
After rails/rails#51705, the current way to add commands to the console will no longer work as `Rails::ConsoleMethods` will not be directly included in the IRB internal anymore. So this commit uses the new IRB extension API to add commands instead, which would also bring a few benefits: - Commands can be displayed in IRB's help message to make them easier to discover. - The parameter of `connect_to` doesn't need to be a string anymore as registered commands aren't treated as Ruby methods.
st0012
added a commit
to st0012/mission_control-jobs
that referenced
this pull request
May 7, 2024
After rails/rails#51705, the current way to add commands to the console will no longer work as `Rails::ConsoleMethods` will not be directly included in the IRB internal anymore. So this commit uses the new IRB extension API to add commands instead, which would also bring a few benefits: - Commands can be displayed in IRB's help message to make them easier to discover. - The parameter of `connect_to` doesn't need to be a string anymore as registered commands aren't treated as Ruby methods.
melopilosyan
added a commit
to melopilosyan/pry-rails
that referenced
this pull request
May 10, 2024
After upgrading [Rails console using IRB's latest official extension APIs](rails/rails#51705) pry-rails is failing to open the console. This change takes Rails' console helper methods defined in IRB::HelperMethod.helper_methods and adds to the main object.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Background
Due to the lack of extension APIs from IRB, Rails console currently relies on patching its private components to provide features like backtrace filtering, additional commands & helpers...etc. This has a few problems:
Detail
IRB.conf[:BACKTRACE_FILTER]config instead of by patching its privateWorkSpaceclass.railtiesnow need to require IRBv1.13.0.v1.13.0should still work with older versions of Rails as isIRBConsoleclass to a new dedicated file.Result
Now Rails' console helpers/commands will be displayed in IRB's help message.
Additional information
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]