Add "rails routes --expanded" mode by benoittgt · Pull Request #32130 · rails/rails

benoittgt · 2018-02-27T20:55:45Z

Summary

When using rails routes with small terminal or complicated routes it can be very difficult to understand where a specific element is, especially when using header. psql had the same issue, that's why they created "expanded mode" long time ago that you can
switch using \x or by starting psql with

-x
--expanded

    Turn on the expanded table formatting mode. This is equivalent to the \x command.

The output is similar to one implemented here for rails routes:

db_user-# \du
List of roles
-[ RECORD 1 ]----------------------------------------------
Role name  | super
Attributes | Superuser, Create role, Create DB
Member of  | {}
-[ RECORD 2 ]----------------------------------------------
Role name  | role
Attributes | Superuser, Create role, Create DB, Replication
Member of  | {}

Here is an output expanded mode (I removed active storage routes):

$ rails routes --expanded
--[ Route 1 ]------------------------------------------------------------
Prefix            | high_scores
Verb              | GET
URI               | /high_scores(.:format)
Controller#Action | high_scores#index
--[ Route 2 ]------------------------------------------------------------
Prefix            | new_high_score
Verb              | GET
URI               | /high_scores/new(.:format)
Controller#Action | high_scores#new
--[ Route 3 ]------------------------------------------------------------
Prefix            | blog
Verb              |
URI               | /blog
Controller#Action | Blog::Engine

[ Routes for Blog::Engine ]
--[ Route 1 ]------------------------------------------------------------
Prefix            | cart
Verb              | GET
URI               | /cart(.:format)
Controller#Action | cart#show

Other Information

I didn't add an entry to changelog because it seems too early for me. Also, I didn't know where you want this to be targeted if it was approved.
App used to display routes

rails-bot · 2018-02-27T20:55:49Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @georgeclaghorn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

jaredbeck · 2018-02-27T21:06:00Z

Good idea Benoit, this will be helpful. It'll be harder to grep this format, but we can't have everything. :)

benoittgt · 2018-02-27T21:11:24Z

@jaredbeck you can still use '-c controller' or '-g pattern'

rails routes -g high --expanded
--[ Route 1 ]------------------------------------------------------------
Prefix            | high_scores
Verb              | GET
URI               | /high_scores(.:format)
Controller#Action | high_scores#index
--[ Route 2 ]------------------------------------------------------------
Prefix            | new_high_score
Verb              | GET
URI               | /high_scores/new(.:format)
Controller#Action | high_scores#new

jaredbeck · 2018-02-27T22:35:53Z

@jaredbeck you can still use '-c controller' or '-g pattern'

Awesome. I had no idea about either of those, thanks.

rafaelfranca

Looks good to me. Can you add a CHANGELOG entry to the railties changelog?

yskkin · 2018-02-28T08:27:07Z

railties/lib/rails/commands/routes/routes_command.rb

I believe that desc should be rewrited.

ouppps correct

benoittgt · 2018-02-28T08:56:42Z

When it's good I can squash. Thanks to all of you for the reviews. 🤙🏻

When using rails routes with small terminal or complicated routes it can be very difficult to understand where is the element listed in header. psql had the same issue, that's why they created "expanded mode" you can switch using `\x` or by starting psql with ``` -x --expanded Turn on the expanded table formatting mode. This is equivalent to the \x command. ``` The output is similar to one implemented here for rails routes: db_user-# \du List of roles -[ RECORD 1 ]---------------------------------------------- Role name | super Attributes | Superuser, Create role, Create DB Member of | {} -[ RECORD 2 ]---------------------------------------------- Role name | role Attributes | Superuser, Create role, Create DB, Replication Member of | {}

benoittgt · 2018-02-28T21:33:41Z

Squashed 🎉

Schwad · 2018-03-01T09:52:05Z

Really excited for this feature, thank you so much for your work. 🎆

…--expanded` In order to get width of console use `IO::console_size`, See https://ruby-doc.org/stdlib-2.4.1/libdoc/io/console/rdoc/IO.html#method-c-console_size Related to rails#32130

- Create `Base` and inherit `Sheet` and `Expanded` in order to - prevent code duplication. - Remove trailing "\n" for components of `Expanded`. - There is no need for `Expanded#header` to return `@buffer` so return `nil` instead. - Change `no_routes` message "No routes were found for this controller" since if use `-g`, it sounds incorrect. - Display `No routes were found for this controller.` if apply `-c`. - Display `No routes were found for this grep pattern.` if apply `-g`. Related to rails#32130

rails-bot assigned georgeclaghorn Feb 27, 2018

rafaelfranca reviewed Feb 28, 2018

View reviewed changes

yskkin reviewed Feb 28, 2018

View reviewed changes

benoittgt force-pushed the rake-routes-compact-mode branch from 35d6798 to c6d928f Compare February 28, 2018 21:33

rafaelfranca merged commit c9fa561 into rails:master Feb 28, 2018

benoittgt deleted the rake-routes-compact-mode branch March 1, 2018 08:33

bogdanvlviv mentioned this pull request Mar 2, 2018

Change message on the empty result of searching routes by rails routes with -c or -g #32153

Merged

bogdanvlviv mentioned this pull request Mar 3, 2018

Draw line of a route name to the end of row console on rails routes --expanded #32160

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "rails routes --expanded" mode#32130

Add "rails routes --expanded" mode#32130
rafaelfranca merged 1 commit intorails:masterfrom
benoittgt:rake-routes-compact-mode

benoittgt commented Feb 27, 2018 •

edited

Loading

Uh oh!

rails-bot commented Feb 27, 2018

Uh oh!

jaredbeck commented Feb 27, 2018

Uh oh!

benoittgt commented Feb 27, 2018

Uh oh!

jaredbeck commented Feb 27, 2018

Uh oh!

rafaelfranca left a comment

Uh oh!

yskkin Feb 28, 2018

Uh oh!

benoittgt Feb 28, 2018

Uh oh!

benoittgt commented Feb 28, 2018 •

edited

Loading

Uh oh!

benoittgt commented Feb 28, 2018

Uh oh!

Schwad commented Mar 1, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Conversation

benoittgt commented Feb 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Other Information

Uh oh!

rails-bot commented Feb 27, 2018

Uh oh!

jaredbeck commented Feb 27, 2018

Uh oh!

benoittgt commented Feb 27, 2018

Uh oh!

jaredbeck commented Feb 27, 2018

Uh oh!

rafaelfranca left a comment

Choose a reason for hiding this comment

Uh oh!

yskkin Feb 28, 2018

Choose a reason for hiding this comment

Uh oh!

benoittgt Feb 28, 2018

Choose a reason for hiding this comment

Uh oh!

benoittgt commented Feb 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benoittgt commented Feb 28, 2018

Uh oh!

Schwad commented Mar 1, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

benoittgt commented Feb 27, 2018 •

edited

Loading

benoittgt commented Feb 28, 2018 •

edited

Loading