annotate --routes changes model files

[aminariana]

When I do a simple:
annotate --routes

I expect only the routes.rb file to change, not the model annotations. But they do.

My usage hasn't changed from previous versions of annotate. But going from v2.6.10 to v2.7, when I run the command, it overrides my existing model annotations with fresh ones, without the desired options such as annotating indexes that I otherwise specify in annotating models. Breaking change I think?

EDIT:

Downgrading to v2.6.10 fixes the problem.

[kamilbielawski]

I believe the behaviour you described is like that by design.
I've just made a small PR with additional option (--ignore-models) that will let you achieve desired behaviour. However, I'm not entirely sure if that's the right approach. It would be great to hear @ctran's opinion

[aminariana]

If by design, why inconsistent between two versions?

If I annotate routes, it violates my expectations to see model files modified.

[Hitabis]

Why not only annotating the routes when calling annotate --routes?
It would only be necessary to check the presence of the routes argument and the user would get the expected result. As simple as that.
This is the function causing the unexpected behavior:

annotate_models/lib/annotate.rb

Line 116 in 6775e4a

def self.include_models?

[ctran]

Ah, I misread the existing behavior.

[javierguajardo]

@aminariana I've tested your issue using:

• Rails 5.2.0
• Ruby 2.5.1
• Annotate 2.7.3

I ran annotate --routes and only the config/routes.rb file was changed. I believe this problem has been patched with 2.7.3.

Regards.