not working in Rails 6.1

[joschl]

In rails 6.1, routes command moved from rake to rails (rails routes vs. rake routes )

bundle exec rake annotate_routes
rake aborted!
Don't know how to build task 'routes' (See the list of available tasks with `rake --tasks`)

Version

• annotate version git master
• rails version 6.1.0
• ruby version 2.7.2

[joschl]

you get the old behaviour with sth like that:

  task :routes do
    require 'rails/commands/routes/routes_command'
    Rails.application.require_environment!
    cmd = Rails::Command::RoutesCommand.new
    cmd.perform
  end

[choilive]

I'm using annotate on 6.1 just fine, although I havn't used the routes annotations. It looks like this issue is affecting just routes.

[dcangulo]

#843 Will fix this issue. In my case, I currently used my forked version: https://github.com/dcangulo/annotate_models

[prem-prakash]

Same problem here

[tugayac]

This is the workaround I use:

task routes: :environment do
  puts `bundle exec rails routes`
end

[overdrivemachines]

This is the workaround I use:

task routes: :environment do
  puts `bundle exec rails routes`
end

Where do I put this code?

[overdrivemachines]

When will this be fixed?

[tugayac]

@overdrivemachines You can put it in any rake file you want (probably in routes.rake in this case). Think of it just like any other rake task you'd create.

[SystemNinja]

For those who are confused where to add code that tugayac posted and those that are following Getting Started with Rails - blog app, do following:

1. Open your project folder
2. Navigate to lib/tasks
3. Create file called routes.rake
4. Paste @tugayac 's workaround

[overdrivemachines]

The annotated routes file has a lot of unwanted routes in my opinion. So came up with a fix. My lib/tasts/routes.rake file looks like:

task routes: :environment do
  puts `bundle exec rails routes | awk '!/active_storage/ && !/action_mailbox/ && !/turbo_/' | sed 's/                           / /'`
end

The routes file gets annotated perfectly. Active Storage, Action Mail and Turbo routes are omitted which makes the annotated routes much cleaner. The awk command removes those unwanted routes. The sed command moves fixes the spacing.

[LimeBlast]

The snippet supplied by @overdrivemachines messes up the output of the annotation in the routes.rb file:

# == Route Map
#
#                           Prefix Verb   URI Pattern         Controller#Action
#                        passwords POST   /passwords(.:format)                          clearance/passwords#create
#                     new_password GET    /passwords/new(.:format)                      clearance/passwords#new
#                          session POST   /session(.:format)  clearance/sessions#create
#               edit_user_password GET    /users/:user_id/password/edit(.:format)       clearance/passwords#edit
#                    user_password PATCH  /users/:user_id/password(.:format)            clearance/passwords#update
#        PUT    /users/:user_id/password(.:format)            clearance/passwords#update
#        POST   /users/:user_id/password(.:format)            clearance/passwords#create
#  users POST   /users(.:format)                              clearance/users#create
#                          sign_in GET    /sign_in(.:format)  clearance/sessions#new
#                         sign_out DELETE /sign_out(.:format) clearance/sessions#destroy
# autocomplete_client_name_clients GET    /clients/autocomplete_client_name(.:format)   clients#autocomplete_client_name
#                      client_jobs POST   /clients/:client_id/jobs(.:format)            jobs#create
#                   new_client_job GET    /clients/:client_id/jobs/new(.:format)        jobs#new
#                client_agreements POST   /clients/:client_id/agreements(.:format)      agreements#create
#             new_client_agreement GET    /clients/:client_id/agreements/new(.:format)  agreements#new
#                          clients GET    /clients(.:format)  clients#index
#        POST   /clients(.:format)                            clients#create
#                       new_client GET    /clients/new(.:format)                        clients#new
#                           client GET    /clients/:id(.:format)                        clients#show
#        PATCH  /clients/:id(.:format)                        clients#update
#        PUT    /clients/:id(.:format)                        clients#update
#               reports_agreements GET    /reports/agreements(.:format)                 reports/agreements#index
#    job GET    /jobs/:id(.:format)                           jobs#show
#        PATCH  /jobs/:id(.:format)                           jobs#update
#        PUT    /jobs/:id(.:format)                           jobs#update
#                  agreement_terms POST   /agreements/:agreement_id/terms(.:format)     terms#create
#               new_agreement_term GET    /agreements/:agreement_id/terms/new(.:format) terms#new
#                        agreement GET    /agreements/:id(.:format)                     agreements#show
#        PATCH  /agreements/:id(.:format)                     agreements#update
#        PUT    /agreements/:id(.:format)                     agreements#update
#   term GET    /terms/:id(.:format)                          terms#show
#        PATCH  /terms/:id(.:format)                          terms#update
#        PUT    /terms/:id(.:format)                          terms#update
#                   support_timers GET    /support_timers(.:format)                     support_timers#index
#                         web_apps GET    /web_apps(.:format) web_apps#index
#                     api_web_apps GET    /api/web_apps(.:format)                       api/web_apps#index
#        POST   /api/web_apps(.:format)                       api/web_apps#create
#   home GET    /home(.:format)                               redirect(301, /)
#   root GET    /                                             high_voltage/pages#show {:id=>"home"}
#   page GET    /pages/*id                                    high_voltage/pages#show

unlike what I get when using @tugayac's code:

# == Route Map
#
#                           Prefix Verb   URI Pattern                                   Controller#Action
#                        passwords POST   /passwords(.:format)                          clearance/passwords#create
#                     new_password GET    /passwords/new(.:format)                      clearance/passwords#new
#                          session POST   /session(.:format)                            clearance/sessions#create
#               edit_user_password GET    /users/:user_id/password/edit(.:format)       clearance/passwords#edit
#                    user_password PATCH  /users/:user_id/password(.:format)            clearance/passwords#update
#                                  PUT    /users/:user_id/password(.:format)            clearance/passwords#update
#                                  POST   /users/:user_id/password(.:format)            clearance/passwords#create
#                            users POST   /users(.:format)                              clearance/users#create
#                          sign_in GET    /sign_in(.:format)                            clearance/sessions#new
#                         sign_out DELETE /sign_out(.:format)                           clearance/sessions#destroy
# autocomplete_client_name_clients GET    /clients/autocomplete_client_name(.:format)   clients#autocomplete_client_name
#                      client_jobs POST   /clients/:client_id/jobs(.:format)            jobs#create
#                   new_client_job GET    /clients/:client_id/jobs/new(.:format)        jobs#new
#                client_agreements POST   /clients/:client_id/agreements(.:format)      agreements#create
#             new_client_agreement GET    /clients/:client_id/agreements/new(.:format)  agreements#new
#                          clients GET    /clients(.:format)                            clients#index
#                                  POST   /clients(.:format)                            clients#create
#                       new_client GET    /clients/new(.:format)                        clients#new
#                           client GET    /clients/:id(.:format)                        clients#show
#                                  PATCH  /clients/:id(.:format)                        clients#update
#                                  PUT    /clients/:id(.:format)                        clients#update
#               reports_agreements GET    /reports/agreements(.:format)                 reports/agreements#index
#                              job GET    /jobs/:id(.:format)                           jobs#show
#                                  PATCH  /jobs/:id(.:format)                           jobs#update
#                                  PUT    /jobs/:id(.:format)                           jobs#update
#                  agreement_terms POST   /agreements/:agreement_id/terms(.:format)     terms#create
#               new_agreement_term GET    /agreements/:agreement_id/terms/new(.:format) terms#new
#                        agreement GET    /agreements/:id(.:format)                     agreements#show
#                                  PATCH  /agreements/:id(.:format)                     agreements#update
#                                  PUT    /agreements/:id(.:format)                     agreements#update
#                             term GET    /terms/:id(.:format)                          terms#show
#                                  PATCH  /terms/:id(.:format)                          terms#update
#                                  PUT    /terms/:id(.:format)                          terms#update
#                   support_timers GET    /support_timers(.:format)                     support_timers#index
#                         web_apps GET    /web_apps(.:format)                           web_apps#index
#                     api_web_apps GET    /api/web_apps(.:format)                       api/web_apps#index
#                                  POST   /api/web_apps(.:format)                       api/web_apps#create
#                             home GET    /home(.:format)                               redirect(301, /)
#                             root GET    /                                             high_voltage/pages#show {:id=>"home"}
#                             page GET    /pages/*id                                    high_voltage/pages#show

I just figured you'd like to know - thank you to both for providing a fix to this issue.

[JohnPettigrew]

The fix from @overdrivemachines works well for me (with the sed command to fix the spacing). I've added /admin/ to the excluded routes because I use ActiveAdmin, which produces a load of its own routes that I don't need to see here! Thanks for the tip.

[LucasBrandt]

The fix from @overdrivemachines mostly worked for me in rails 7, but spacing wasn't quite right even with the sed command. It might be because I don't have many routes currently. If anyone else has the same trouble, using grep instead worked:

task routes: :environment do
  puts `bundle exec rails routes | grep --invert-match --extended-regexp 'turbo\/native\|\/action_mailbox\/\|\/active_storage\/'`
end

[austin-wang]

just use rails routes /NOT/ rake routes its working

Thanks @Nourfaress — that worked perfectly. bundle exec rails routes