Skip to content

Add ConstantInRoutes Cop #1492

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

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

Conversation

skipkayhil
Copy link

In applications with large route files, its common to have a desire to extract regexes, constraints, etc. that are used multiple times to prevent duplication. If the value is never going to change, extracting the value to a constant would be a very normal thing to do in typical Ruby classes/modules. However, the config/routes.rb file is reloadable, so a constant defined there will causing a constant redefinition warning when/if the routes are reloaded (typically during development or test, especially if using Spring).

This commit adds a ConstantInRoutes Cop to prevent constants from being defined in config/routes.rb files.


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.

In applications with large route files, its common to have a desire to
extract regexes, constraints, etc. that are used multiple times to
prevent duplication. If the value is never going to change, extracting
the value to a constant would be a very normal thing to do in typical
Ruby classes/modules. However, the `config/routes.rb` file is
reloadable, so a constant defined there will causing a constant
redefinition warning when/if the routes are reloaded (typically during
development or test, especially if using Spring).

This commit adds a ConstantInRoutes Cop to prevent constants from being
defined in `config/routes.rb` files.
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.

1 participant