[#499] Create a Rubocop cop for ordering instructions in class (e.g. Models)

[Goose97]

• Close Create a Rubocop cop for ordering instructions in class (e.g. Models) #499

What happened 👀

Enforce class template with custom Rubocop rule

https://nimblehq.co/compass/development/code-conventions/ruby/#convention-40

Insight 📝

The cop is divided into two phases:

1. Expression categorize phase: every expressions in the class body will classify into one of these categories. If none matches, it'll be :unknown
2. Validate the order of the class body expressions according to the template

Proof Of Work 📹

Project bootstrap

Untitled.mp4

Linter example

Screen-Recording-2024-03-29-at-1.35.03-PM.mp4

[malparty]

Sorry I was a bit busy. I'll try to review next Monday (I blocked some time in my calendar for it 🙇 )

[malparty]

Suggested change

	message: error_message(second[:category], expressions.pluck(:category))
	message: error_message(second[:category], expressions.map { |expression| expression[:category] })

I tried in the CX project, but it seems that the Rails helpers could not be loaded. More over, in case we want to reuse this cop in a non Rails project, it can be nice to use pure Ruby only :)

[Goose97]

Oh absolutely 👍 . Fixed in 8b5fce5

I didn't realize that :pluck is one of the niceties from Rails 🙈

[malparty]

So it's working well on my side 🥳

Just one question: do you think we can improve the message so that it points to the line of code (e.g. "...should come before audited associated_with: :tenant") 💭

Note that this suggestion can be done in a future PR, it's not a blocker 👍

Message	Code

[Goose97]

Just one question: do you think we can improve the message so that it points to the line of code (e.g. "...should come before audited associated_with: :tenant") 💭

Great suggestion. Added in f9fe5e6

Your example will now display this error instead:

[malparty]

Approved ahead, but we need to resolve the tests 🙇