Add new Rails/MigrationExecute cop#1589
Open
a-lavis wants to merge 1 commit intorubocop:masterfrom
Open
Conversation
f4fa7c3 to
e736031
Compare
e736031 to
65ab102
Compare
Rails/MigrationExecute cop
Member
Can you please give an example output? |
Author
For the migration: class AddNicknameToUsers < ActiveRecord::Migration[8.1]
def up
execute <<~SQL.squish
ALTER TABLE users
ALGORITHM=INSTANT,
ADD COLUMN nickname VARCHAR(255) NOT NULL DEFAULT '' AFTER email_address;
SQL
end
def down
execute <<~SQL.squish
ALTER TABLE users
ALGORITHM=INSTANT,
DROP COLUMN nickname;
SQL
end
endWhen running On the other hand, if you use class AddNicknameToUsers < ActiveRecord::Migration[8.1]
def up
connection.execute <<~SQL.squish
ALTER TABLE users
ALGORITHM=INSTANT,
ADD COLUMN nickname VARCHAR(255) NOT NULL DEFAULT '' AFTER email_address;
SQL
end
def down
connection.execute <<~SQL.squish
ALTER TABLE users
ALGORITHM=INSTANT,
DROP COLUMN nickname;
SQL
end
endthen you'll instead only see: As you can see, by using
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new cop I've titled
Rails/MigrationExecute(but feel free to suggest a better name!).This cop autocorrects
connection.executeto simplyexecutein migrations.I think this cop should exist because
executegives useful terminal output while the migration is running, whereasconnection.executedoes not.Corresponding Rails Style Guide PR: rubocop/rails-style-guide#376
Let me know if I should create a corresponding issue on this repo!
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.