Better error when using route helpers incorrectly

[matthewmcgarvey]

Purpose

Fixes #1005

Description

There's an implementation Lucky::Routable.route that handles correct usage but when the method is called incorrectly it provides a confusing error message. We're seeing people assume it was a problem in their action and not where the error actually is, where they try to create a link or something using the action class name.

Before

After

I'm still kind of disappointed with the error message. I was hoping that by adding the compilation error it would point towards the usage site but it still doesn't.

Checklist

• - An issue already exists detailing the issue/or feature request that this PR fixes
• - All specs are formatted with crystal tool format spec src
• - Inline documentation has been added and/or updated
• - Lucky builds on docker with ./script/setup
• - All builds and specs pass on docker with ./script/test

[robacarp]

This is a big area of confusion for me, and rendering an error which is more helpful than Crystal will help a ton. For me it goes like this:

• Edit the need of an action (ohh how easy it is to just add a need! just so easy! spill the bucket of red paint on the floor)
• Edit "the page that uses the action"
• See this opaque error
• Open up terminal and start grepping for other uses of the ActionName
• Clean up the mess with a mop until the floor is clean enough to compile again

[robacarp]

Could this list be formatted more like a method call, or terminal documentation?

A stab in the dark: {{ @type }}.with( {{ required things }}, [ {{ optional things }} ] ) or something? It's confusing to me to see the arguments broken out in a bulleted list like this.

[matthewmcgarvey]

I looked into doing something like this but I'd be afraid that if I put that in the error message that it would be an indication of the correct way to call it but the [ {{ optional }} ] part is not right.

[jwoertink]

Just a few comments.

[robacarp]

this will save me buckets of time, thanks @matthewmcgarvey

[jwoertink]

👍