Add new rails Schema Comment cop #568

vitormd · 2021-09-30T23:09:12Z

Hi, this is my first contribuiton here, so I'm sorry if got something wrong and I hope we can fix it together :)

The cop:

Some databases like MySQL and Postgres supports comments and Rails migrations also support adding it. Some teams follow the good practice of adding comments to new columns or tables whenever creating them. This cops enforces this behaviour, but is disabled by default since this practice may not be widely spread.

PS: If this cop is accepted, I will also create one for table comments

Before submitting the PR make sure the following are checked:

Wrote good commit messages.
Feature branch is up-to-date with master (if not - rebase it).
Squashed related commits together.
Added tests.
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.
Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.
If this is a new cop, consider making a corresponding update to the Rails Style Guide.

spec/rubocop/cop/rails/add_column_comment_spec.rb

lib/rubocop/cop/rails/add_column_comment.rb

config/default.yml

spec/rubocop/cop/rails/add_column_comment_spec.rb

andyw8 · 2021-10-01T01:29:22Z

Even though your team might add a comment to all columns, I'm wondering if for wider use there should be a configuration option to specify tables/columns to ignore.

vitormd · 2021-10-01T02:45:51Z

Even though your team might add a comment to all columns, I'm wondering if for wider use there should be a configuration option to specify tables/columns to ignore.

Makes sense, but I'm not sure how configurations get to the cop. I'll see if I figure it out in the next few days.
Do you think it'd make sense a configuration for ignoring certain column types?

Thanks for the review. I will fix the specs and description tomorrow.

koic · 2021-10-01T08:43:19Z

PS: If this cop is accepted, I will also create one for table comments

It may be preferable to make the inspection of table comments and column comments as one cop. Maybe that cop name like Rails/SchemaComment cop.

config/default.yml

vitormd · 2021-10-01T17:41:15Z

I think I made all the changes with the exception of the configuration options. I'll work on that

config/default.yml

lib/rubocop/cop/rails/schema_comment.rb

vitormd · 2021-10-04T20:50:05Z

Even though your team might add a comment to all columns, I'm wondering if for wider use there should be a configuration option to specify tables/columns to ignore.

@andyw8 do you think this configuration is essential for a first version or we could launch as it is and improve later?

andyw8 · 2021-10-04T22:41:27Z

No, not essential.

vitormd · 2021-10-05T18:11:46Z

Great. Just let me know if there is anything else that I missed that can be improved code, test or description wise :)

spec/rubocop/cop/rails/schema_comment_spec.rb

pirj

Notes are purely cosmetic, to make the code slightly (and subjectively) more readable. It's clean and readable as is. Good job!

I'll make a note for myself to explicitly enable the cop on my current project.
❤️ Thank you!

lib/rubocop/cop/rails/schema_comment.rb

spec/rubocop/cop/rails/schema_comment_spec.rb

lib/rubocop/cop/rails/schema_comment.rb

CHANGELOG.md

Add `Rails/AddColumnComment` cop Update config/default.yml Co-authored-by: Andy Waite <[email protected]> Update lib/rubocop/cop/rails/schema_comment.rb Co-authored-by: Andy Waite <[email protected]> Update Rails/SchemaComment doc Add more column types to Rails/SchemaComment Improve SchemaComment specs Remove uncessary safe project config for SchemaComment Augment rails schema definitions and use Set Change constant into def_node_matcher @SchemaComment

koic · 2021-11-08T03:44:01Z

Thanks!