Skip ApplicationRecord #10
Conversation
| @@ -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 | |||
There was a problem hiding this comment.
will this work if my ApplicationRecord is namespaced? Like MyFancy::Domain::ApplicationRecord?
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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"]
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Checked:
- If there are some annotations,
db:annottewon'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:annotatewould override my changes and add the error
Works well now
There was a problem hiding this comment.
- If there are some annotations,
db:annottewon'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.
There was a problem hiding this comment.
Yeah, that's alright. Pretty much expected it.
Thanks!
Depending on the resolution to #11 this may not be needed