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.

Sign up for GitHub

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

Skip ApplicationRecord #10

Closed
wants to merge 1 commit into from
Closed

Skip ApplicationRecord #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/active_record/annotate.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ def models

klass = class_name_for(short_path)
next unless klass < ActiveRecord::Base # collect only AR::Base descendants
next if klass.name == "ApplicationRecord" # skip ApplicationRecord
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will this work if my ApplicationRecord is namespaced? Like MyFancy::Domain::ApplicationRecord?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure but im sure this is a silly PR as it has such a limited reach.

We need some other way to ignore certain files. Maybe we could have an .annotate_ignore file in the project root where we list these?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe that we don't need much configuration, but it would be nice to ignore conventional stuff like ApplicationRecord

Also,

irb(main):019:0> Foo::Bar::Quux.name
=> "Foo::Bar::Quux"

So we could replace it with:

irb(main):020:0> *, name = "Foo::Bar::Quux".split(':')
=> ["Foo", "", "Bar", "", "Quux"]
irb(main):023:0> *, name = "Quux".split(':')
=> ["Quux"]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah but what happens if someone names an actual model application record then we have an issue. I would prefer something like described in #13

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder how many people actually see this problem

I can tell that my project only has two application records at this moment. Both are called ApplicationRecord

A simple fix should suffice for a while. Better cover 95% of use cases while we think about custom configuration

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a plan

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed that in 560af45. @westonganger @Morozzzko please try gem 'active_record-annotate', github: '7even/active_record-annotate' in your apps to confirm it's working.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked:

  • If there are some annotations, db:annotte won't remove them
  • If I remove them manually and re-run db:annotate, the gem won't add them
  • If I rollback to the previous version, db:annotate would override my changes and add the error

Works well now

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • If there are some annotations, db:annotte won't remove them

Yep, that's expected behavior - it only touches the files it is going to annotate, and now this process completely ignores abstract classes. You'll have to manually remove old buggy annotations.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's alright. Pretty much expected it.

Thanks!


models[klass.table_name] << [path, klass]
end
Expand Down