Cop Idea: Controller Action Order

[mollerhoj]

The default order of controller actions in rails scaffolds are:

index show new edit create update destroy

I often see controllers where this order is not followed. For consistency's sake, I'd like to have a cop to enforce this ordering of the public methods in my controllers.

[andyw8]

I'd suggest first opening a PR to add this to https://github.com/rubocop/rails-style-guide, and then adding it here if there's consensus.

[mollerhoj]

Done: rubocop/rails-style-guide#289

[pirj]

Even though (https://docs.rubocop.org/rubocop-rails/):

RuboCop Rails [ is ] A RuboCop extension focused on enforcing Rails best practices and coding conventions.

and (https://docs.rubocop.org/rubocop/1.20/index.html#overview):

A long-term goal of RuboCop (and its core extensions) is to cover with cops all the guidelines from the community style guides.

https://docs.rubocop.org/rubocop/1.20/index.html#philosophy

While we still believe that there’s a lot of merit to just sticking to the community style guides, we acknowledge that Ruby is all about diversity and doing things the way that makes you happy. Whatever style preferences you have RuboCop is there for you.

Having such a cop would be nice.

I'd suggest using https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/layout/class_structure.rb as a reference and make the cop configurable and flexible to meet other styles.

[dvandersluis]

+1 for a cop with a configurable order.

[mollerhoj]

All I need is a go from a core member that the cop would be merged, and I'll make a PR😊

[andyw8]

I'm in favour of it as long as:

• It's disabled by default
• The order is configurable
• There is a default ordering (i..e. when enabled, the cop will work without configuration). I think following the Rails convention would be the least controversial default

[pirj]

Go!

[koic]

I often see a method called confirm. Such methods that are not included in the default configuration (i.e. result code of scaffold) will need to be ignored.

[mollerhoj]

confirm

Huh? Can you elaborate? I've never seen a "confirm" method in a controller?

I'd suggest only ignoring private methods - I hope to influence people to only use the default methods: https://www.youtube.com/watch?v=HctYHe-YjnE

[andyw8]

Not just private methods, it should ignore any that aren't part of the standard 7, and should allow non-standard methods to exist before, after, or intermingled with the standard 7.

[andyw8]

I hope to influence people to only use the default methods

I think that should be treated as a separate cop from the action ordering.

[dvandersluis]

Yeah, whether or not a controller "should" have non-restful actions, a large percentage of them do. This cop should not consider them at all.

[mollerhoj]

I hope to influence people to only use the default methods

I think that should be treated as a separate cop from the action ordering.

Let's see if I can convince the masters of the style guide rubocop/rails-style-guide#290