# frozen_string_literal: true require "isolation/abstract_unit" require "rails/command" require "rails/commands/routes/routes_command" require "io/console/size" class Rails::Command::RoutesTest < ActiveSupport::TestCase setup :build_app teardown :teardown_app test "singular resource output in rails routes" do app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do resource :post resource :user_permission end RUBY assert_equal <<~OUTPUT, run_routes_command([ "-c", "PostController" ]) Prefix Verb URI Pattern Controller#Action new_post GET /post/new(.:format) posts#new edit_post GET /post/edit(.:format) posts#edit post GET /post(.:format) posts#show PATCH /post(.:format) posts#update PUT /post(.:format) posts#update DELETE /post(.:format) posts#destroy POST /post(.:format) posts#create rails_postmark_inbound_emails POST /rails/action_mailbox/postmark/inbound_emails(.:format) action_mailbox/ingresses/postmark/inbound_emails#create OUTPUT assert_equal <<~OUTPUT, run_routes_command([ "-c", "UserPermissionController" ]) Prefix Verb URI Pattern Controller#Action new_user_permission GET /user_permission/new(.:format) user_permissions#new edit_user_permission GET /user_permission/edit(.:format) user_permissions#edit user_permission GET /user_permission(.:format) user_permissions#show PATCH /user_permission(.:format) user_permissions#update PUT /user_permission(.:format) user_permissions#update DELETE /user_permission(.:format) user_permissions#destroy POST /user_permission(.:format) user_permissions#create OUTPUT end test "rails routes with global search key" do app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do get '/cart', to: 'cart#show' post '/cart', to: 'cart#create' get '/basketballs', to: 'basketball#index' end RUBY assert_equal <<~MESSAGE, run_routes_command([ "-g", "show" ]) Prefix Verb URI Pattern Controller#Action cart GET /cart(.:format) cart#show rails_conductor_inbound_email GET /rails/conductor/action_mailbox/inbound_emails/:id(.:format) rails/conductor/action_mailbox/inbound_emails#show rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show MESSAGE assert_equal <<~MESSAGE, run_routes_command([ "-g", "POST" ]) Prefix Verb URI Pattern Controller#Action POST /cart(.:format) cart#create rails_mandrill_inbound_emails POST /rails/action_mailbox/mandrill/inbound_emails(.:format) action_mailbox/ingresses/mandrill/inbound_emails#create rails_postmark_inbound_emails POST /rails/action_mailbox/postmark/inbound_emails(.:format) action_mailbox/ingresses/postmark/inbound_emails#create rails_relay_inbound_emails POST /rails/action_mailbox/relay/inbound_emails(.:format) action_mailbox/ingresses/relay/inbound_emails#create rails_sendgrid_inbound_emails POST /rails/action_mailbox/sendgrid/inbound_emails(.:format) action_mailbox/ingresses/sendgrid/inbound_emails#create rails_mailgun_inbound_emails POST /rails/action_mailbox/mailgun/inbound_emails/mime(.:format) action_mailbox/ingresses/mailgun/inbound_emails#create POST /rails/conductor/action_mailbox/inbound_emails(.:format) rails/conductor/action_mailbox/inbound_emails#create rails_conductor_inbound_email_reroute POST /rails/conductor/action_mailbox/:inbound_email_id/reroute(.:format) rails/conductor/action_mailbox/reroutes#create rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create MESSAGE assert_equal <<~MESSAGE, run_routes_command([ "-g", "basketballs" ]) Prefix Verb URI Pattern Controller#Action basketballs GET /basketballs(.:format) basketball#index MESSAGE end test "rails routes with controller search key" do app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do get '/cart', to: 'cart#show' get '/basketball', to: 'basketball#index' get '/user_permission', to: 'user_permission#index' end RUBY expected_cart_output = "Prefix Verb URI Pattern Controller#Action\n cart GET /cart(.:format) cart#show\n" output = run_routes_command(["-c", "cart"]) assert_equal expected_cart_output, output output = run_routes_command(["-c", "Cart"]) assert_equal expected_cart_output, output output = run_routes_command(["-c", "CartController"]) assert_equal expected_cart_output, output expected_perm_output = [" Prefix Verb URI Pattern Controller#Action", "user_permission GET /user_permission(.:format) user_permission#index\n"].join("\n") output = run_routes_command(["-c", "user_permission"]) assert_equal expected_perm_output, output output = run_routes_command(["-c", "UserPermission"]) assert_equal expected_perm_output, output output = run_routes_command(["-c", "UserPermissionController"]) assert_equal expected_perm_output, output end test "rails routes with namespaced controller search key" do app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do namespace :admin do resource :post resource :user_permission end end RUBY assert_equal <<~OUTPUT, run_routes_command([ "-c", "Admin::PostController" ]) Prefix Verb URI Pattern Controller#Action new_admin_post GET /admin/post/new(.:format) admin/posts#new edit_admin_post GET /admin/post/edit(.:format) admin/posts#edit admin_post GET /admin/post(.:format) admin/posts#show PATCH /admin/post(.:format) admin/posts#update PUT /admin/post(.:format) admin/posts#update DELETE /admin/post(.:format) admin/posts#destroy POST /admin/post(.:format) admin/posts#create OUTPUT assert_equal <<~OUTPUT, run_routes_command([ "-c", "PostController" ]) Prefix Verb URI Pattern Controller#Action new_admin_post GET /admin/post/new(.:format) admin/posts#new edit_admin_post GET /admin/post/edit(.:format) admin/posts#edit admin_post GET /admin/post(.:format) admin/posts#show PATCH /admin/post(.:format) admin/posts#update PUT /admin/post(.:format) admin/posts#update DELETE /admin/post(.:format) admin/posts#destroy POST /admin/post(.:format) admin/posts#create rails_postmark_inbound_emails POST /rails/action_mailbox/postmark/inbound_emails(.:format) action_mailbox/ingresses/postmark/inbound_emails#create OUTPUT expected_permission_output = <<~OUTPUT Prefix Verb URI Pattern Controller#Action new_admin_user_permission GET /admin/user_permission/new(.:format) admin/user_permissions#new edit_admin_user_permission GET /admin/user_permission/edit(.:format) admin/user_permissions#edit admin_user_permission GET /admin/user_permission(.:format) admin/user_permissions#show PATCH /admin/user_permission(.:format) admin/user_permissions#update PUT /admin/user_permission(.:format) admin/user_permissions#update DELETE /admin/user_permission(.:format) admin/user_permissions#destroy POST /admin/user_permission(.:format) admin/user_permissions#create OUTPUT assert_equal expected_permission_output, run_routes_command([ "-c", "Admin::UserPermissionController" ]) assert_equal expected_permission_output, run_routes_command([ "-c", "UserPermissionController" ]) end test "rails routes displays message when no routes are defined" do app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do end RUBY assert_equal <<~MESSAGE, run_routes_command Prefix Verb URI Pattern Controller#Action rails_mandrill_inbound_emails POST /rails/action_mailbox/mandrill/inbound_emails(.:format) action_mailbox/ingresses/mandrill/inbound_emails#create rails_postmark_inbound_emails POST /rails/action_mailbox/postmark/inbound_emails(.:format) action_mailbox/ingresses/postmark/inbound_emails#create rails_relay_inbound_emails POST /rails/action_mailbox/relay/inbound_emails(.:format) action_mailbox/ingresses/relay/inbound_emails#create rails_sendgrid_inbound_emails POST /rails/action_mailbox/sendgrid/inbound_emails(.:format) action_mailbox/ingresses/sendgrid/inbound_emails#create rails_mailgun_inbound_emails POST /rails/action_mailbox/mailgun/inbound_emails/mime(.:format) action_mailbox/ingresses/mailgun/inbound_emails#create rails_conductor_inbound_emails GET /rails/conductor/action_mailbox/inbound_emails(.:format) rails/conductor/action_mailbox/inbound_emails#index POST /rails/conductor/action_mailbox/inbound_emails(.:format) rails/conductor/action_mailbox/inbound_emails#create new_rails_conductor_inbound_email GET /rails/conductor/action_mailbox/inbound_emails/new(.:format) rails/conductor/action_mailbox/inbound_emails#new edit_rails_conductor_inbound_email GET /rails/conductor/action_mailbox/inbound_emails/:id/edit(.:format) rails/conductor/action_mailbox/inbound_emails#edit rails_conductor_inbound_email GET /rails/conductor/action_mailbox/inbound_emails/:id(.:format) rails/conductor/action_mailbox/inbound_emails#show PATCH /rails/conductor/action_mailbox/inbound_emails/:id(.:format) rails/conductor/action_mailbox/inbound_emails#update PUT /rails/conductor/action_mailbox/inbound_emails/:id(.:format) rails/conductor/action_mailbox/inbound_emails#update DELETE /rails/conductor/action_mailbox/inbound_emails/:id(.:format) rails/conductor/action_mailbox/inbound_emails#destroy rails_conductor_inbound_email_reroute POST /rails/conductor/action_mailbox/:inbound_email_id/reroute(.:format) rails/conductor/action_mailbox/reroutes#create rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create MESSAGE end test "rails routes with expanded option" do previous_console_winsize = IO.console.winsize IO.console.winsize = [0, 27] app_file "config/routes.rb", <<-RUBY Rails.application.routes.draw do get '/cart', to: 'cart#show' end RUBY # rubocop:disable Layout/TrailingWhitespace assert_equal <<~MESSAGE, run_routes_command([ "--expanded" ]) --[ Route 1 ]-------------- Prefix | cart Verb | GET URI | /cart(.:format) Controller#Action | cart#show --[ Route 2 ]-------------- Prefix | rails_mandrill_inbound_emails Verb | POST URI | /rails/action_mailbox/mandrill/inbound_emails(.:format) Controller#Action | action_mailbox/ingresses/mandrill/inbound_emails#create --[ Route 3 ]-------------- Prefix | rails_postmark_inbound_emails Verb | POST URI | /rails/action_mailbox/postmark/inbound_emails(.:format) Controller#Action | action_mailbox/ingresses/postmark/inbound_emails#create --[ Route 4 ]-------------- Prefix | rails_relay_inbound_emails Verb | POST URI | /rails/action_mailbox/relay/inbound_emails(.:format) Controller#Action | action_mailbox/ingresses/relay/inbound_emails#create --[ Route 5 ]-------------- Prefix | rails_sendgrid_inbound_emails Verb | POST URI | /rails/action_mailbox/sendgrid/inbound_emails(.:format) Controller#Action | action_mailbox/ingresses/sendgrid/inbound_emails#create --[ Route 6 ]-------------- Prefix | rails_mailgun_inbound_emails Verb | POST URI | /rails/action_mailbox/mailgun/inbound_emails/mime(.:format) Controller#Action | action_mailbox/ingresses/mailgun/inbound_emails#create --[ Route 7 ]-------------- Prefix | rails_conductor_inbound_emails Verb | GET URI | /rails/conductor/action_mailbox/inbound_emails(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#index --[ Route 8 ]-------------- Prefix | Verb | POST URI | /rails/conductor/action_mailbox/inbound_emails(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#create --[ Route 9 ]-------------- Prefix | new_rails_conductor_inbound_email Verb | GET URI | /rails/conductor/action_mailbox/inbound_emails/new(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#new --[ Route 10 ]------------- Prefix | edit_rails_conductor_inbound_email Verb | GET URI | /rails/conductor/action_mailbox/inbound_emails/:id/edit(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#edit --[ Route 11 ]------------- Prefix | rails_conductor_inbound_email Verb | GET URI | /rails/conductor/action_mailbox/inbound_emails/:id(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#show --[ Route 12 ]------------- Prefix | Verb | PATCH URI | /rails/conductor/action_mailbox/inbound_emails/:id(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#update --[ Route 13 ]------------- Prefix | Verb | PUT URI | /rails/conductor/action_mailbox/inbound_emails/:id(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#update --[ Route 14 ]------------- Prefix | Verb | DELETE URI | /rails/conductor/action_mailbox/inbound_emails/:id(.:format) Controller#Action | rails/conductor/action_mailbox/inbound_emails#destroy --[ Route 15 ]------------- Prefix | rails_conductor_inbound_email_reroute Verb | POST URI | /rails/conductor/action_mailbox/:inbound_email_id/reroute(.:format) Controller#Action | rails/conductor/action_mailbox/reroutes#create --[ Route 16 ]------------- Prefix | rails_service_blob Verb | GET URI | /rails/active_storage/blobs/:signed_id/*filename(.:format) Controller#Action | active_storage/blobs#show --[ Route 17 ]------------- Prefix | rails_blob_representation Verb | GET URI | /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) Controller#Action | active_storage/representations#show --[ Route 18 ]------------- Prefix | rails_disk_service Verb | GET URI | /rails/active_storage/disk/:encoded_key/*filename(.:format) Controller#Action | active_storage/disk#show --[ Route 19 ]------------- Prefix | update_rails_disk_service Verb | PUT URI | /rails/active_storage/disk/:encoded_token(.:format) Controller#Action | active_storage/disk#update --[ Route 20 ]------------- Prefix | rails_direct_uploads Verb | POST URI | /rails/active_storage/direct_uploads(.:format) Controller#Action | active_storage/direct_uploads#create MESSAGE # rubocop:enable Layout/TrailingWhitespace ensure IO.console.winsize = previous_console_winsize end private def run_routes_command(args = []) rails "routes", args end end