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

Only consider migration classes for MigrationClassName #657

Conversation

sunny
Copy link
Contributor

@sunny sunny commented Mar 15, 2022

Adds a fix to #644 when calling using multiple classes inside a migration.

Currently, when using the pattern of redefining ActiveRecord classes inside the migration in order not to depend on the app’s classes:

class UpdateLocaleOnArticles < ActiveRecord::Migration[6.1]
  class Article < ActiveRecord::Base
  end

  def up
    Article.update_all(locale: "fr")
  end
end

Produces:

db/migrate/20211025103032_update_locale_on_articles.rb:4:9: C: [Correctable] Rails/MigrationClassName: Replace with UpdateLocaleOnArticles that matches the file name.
  class Article < ActiveRecord::Base
        ^^^^^^^

Which autocorrects to:

db/migrate/20211025103032_update_locale_on_articles.rb:4:9: C: [Correctable] Rails/MigrationClassName: Replace with UpdateLocaleOnArticles that matches the file name.
  class UpdateLocaleOnArticles < ActiveRecord::Base
        ^^^^^^^^^^^^^^^^^^^^^^

This fix ignores classes included inside the migration.


Before submitting the PR make sure the following are checked:

  • [x ] 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.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

@sunny sunny force-pushed the migration-class-name-only-consider-migration-classes branch from c6a015e to ba2d060 Compare March 15, 2022 08:26
@koic koic merged commit c39bff3 into rubocop:master Mar 15, 2022
@koic
Copy link
Member

koic commented Mar 15, 2022

Nice!

@sunny sunny deleted the migration-class-name-only-consider-migration-classes branch March 16, 2022 10:23
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