Set classified-sort option to false by default as it caused confusion

[hatsu38]

The classified-sort option was previously set to true by default, which led to confusion for many users. It wasn't an intentional decision, so we're updating the default to false to avoid unexpected column ordering.

Ref: #194

[drwl]

Hi @hatsu38 thank you for submitting a PR.

Can you help me understand this? In the old gem [1], was the default option for classified_sort false?

I think it's setting it to true by default in these 2 places:
https://github.com/ctran/annotate_models/blob/5d01c4171990c4fe7b9b0977b05ce14a98209e53/lib/tasks/annotate_models.rake#L46
https://github.com/ctran/annotate_models/blob/5d01c4171990c4fe7b9b0977b05ce14a98209e53/lib/generators/annotate/templates/auto_annotate_models.rake#L51

[1] https://github.com/search?q=repo%3Actran%2Fannotate_models%20classified_sort&type=code

[hatsu38]

@drwl

Ah, my previous explanation was a bit inaccurate — sorry about that.

In this pull request( ctran/annotate_models#542 ) , the default value for classified_sort was set to true.

Before this PR was merged, classified_sort didn’t have a default value, so options[:classified_sort] = Annotate::Helpers.true?(ENV['classified_sort']) evaluated to false.

This change might come down to personal preference. Personally, I prefer classified_sort to be false.

I noticed that someone else was also having trouble with this in an issue, so I decided to open a pull request.

What do you think?

[drwl]

Okay I think I understand now. I think we want to keep the CLI options to be the same to preserve the same functionality, but we can change the default here: lib/annotate_rb/options.rb:29

[drwl]

Thank you for investigating and helping me better understand the issue!

[hatsu38]

I'll fix the tests that are currently failing later!

[drwl]

I have some downtime and am tidying up the project. I'm going to close this PR for now since it's not in a mergable state, but feel free to re-open it if this is something you still want to try and get into the gem.