Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new Rails/MultipleRoutePaths cop #1407

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

koic
Copy link
Member

@koic koic commented Jan 7, 2025

This PR adds new Rails/MultipleRoutePaths cop that checks for mapping a route with multiple paths, which is deprecated and will be removed in Rails 8.1.

# bad
get '/users', '/other_path', to: 'users#index'

# good
get '/users', to: 'users#index'
get '/other_path', to: 'users#index'

This provides a migration path for the following warning added in rails/rails#52409.

DEPRECATION WARNING: Mapping a route with multiple paths is deprecated and will be removed in Rails 8.1.
Please use multiple method calls instead. ...

Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@koic koic force-pushed the add_new_rails_multiple_route_paths_cop branch 7 times, most recently from 5e178f2 to 8cb2bdd Compare January 8, 2025 02:55
module RuboCop
module Cop
module Rails
# Checks if mapping a route with multiple paths is deprecated and will be removed in Rails 8.1.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Checks if mapping a route with multiple paths is deprecated and will be removed in Rails 8.1.
# Checks for mapping a route with multiple paths, which is deprecated and will be removed in Rails 8.1.

@koic koic force-pushed the add_new_rails_multiple_route_paths_cop branch from 8cb2bdd to 1c4df27 Compare January 8, 2025 06:03
This PR adds new `Rails/MultipleRoutePaths` cop that
checks for mapping a route with multiple paths, which is deprecated and will be removed in Rails 8.1.

```ruby
# bad
get '/users', '/other_path', to: 'users#index'

# good
get '/users', to: 'users#index'
get '/other_path', to: 'users#index'
```

This provides a migration path for the following warning added in rails/rails#52409.

```consle
DEPRECATION WARNING: Mapping a route with multiple paths is deprecated and will be removed in Rails 8.1.
Please use multiple method calls instead. ...
```
@koic koic force-pushed the add_new_rails_multiple_route_paths_cop branch from 1c4df27 to f305297 Compare January 8, 2025 06:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants