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

Ignore gem name in path for MigrationClassName #655

Merged

Conversation

sunny
Copy link
Contributor

@sunny sunny commented Mar 15, 2022

Closes #656

Adds a fix to #644 when running the cop on migrations generated by Rails that contain the Rails module name, such as.active_storage.rb.

Currently:

db/migrate/20210217092104_add_service_name_to_active_storage_blobs.active_storage.rb:4:7: C: [Corrected] Rails/MigrationClassName: Replace with AddServiceNameToActiveStorageBlobs.activeStorage that matches the file name.
class AddServiceNameToActiveStorageBlobs < ActiveRecord::Migration[6.0]
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
db/migrate/20210217092105_create_active_storage_variant_records.active_storage.rb:4:7: C: [Corrected] Rails/MigrationClassName: Replace with CreateActiveStorageVariantRecords.activeStorage that matches the file name.
class CreateActiveStorageVariantRecords < ActiveRecord::Migration[6.0]
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This ends up autocorrecting to the following:

# This migration comes from active_storage (originally 20191206030411)
class CreateActiveStorageVariantRecords.activeStorage < ActiveRecord::Migration[6.0]
  # …
end

This fix ignores the suffix (here .active_storage).


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.
  • 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-ignores-gem-name-in-path branch from 8b2ca60 to b51856a Compare March 15, 2022 07:55
@sunny sunny force-pushed the migration-class-name-ignores-gem-name-in-path branch from b51856a to 77436c6 Compare March 15, 2022 08:44
@sunny sunny force-pushed the migration-class-name-ignores-gem-name-in-path branch from 77436c6 to 7ec5f36 Compare March 15, 2022 11:17
@koic koic merged commit 60f0e8d into rubocop:master Mar 15, 2022
@koic
Copy link
Member

koic commented Mar 15, 2022

Thanks!

@sunny sunny deleted the migration-class-name-ignores-gem-name-in-path branch March 16, 2022 10:24
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.

Rails/MigrationClassName issue with rails ActiveStorage
2 participants