Remove LayoutNotFoundError and raise TemplateNotFoundError in all cases #247
Conversation
Remove the specialized LayoutNotFoundError, because this was raising incorrect error if there were _missing partials_ being rendered inside the layout. It is better that we raise a genuine, non-misleading error in these cases. The LayoutNotFoundError only provided marginal utility anyway, and the inclusion of the “layouts/“ prefix for a TemplateNotFoundError raised for a missing layout will still make it clear where the template was being looked for.
|
The LayoutNotFoundError was introduced in #191 and has never been formally released, so it is safe to remove here. |
timriley
changed the title
| config.template = "missing_template" | ||
| }.new | ||
|
|
||
| expect { view.() }.to raise_error Hanami::View::TemplateNotFoundError, /Template `missing_template' for format `html' could not be found/ |
There was a problem hiding this comment.
@timriley In case of Hanami app, will the real error message appear with the relative path of the template?
Example:
Template `app/templates/layouts/foo.html.erb' for format `html' could not be found
As a dev, I can just copy and paste the path and create the missing template.
There was a problem hiding this comment.
@jodosha Here's the exact error:
Hanami::View::TemplateNotFoundError:
Template `layouts/app' for format `html' could not be found in paths:
- /Users/tim/Source/scratch/bookshelf/app/templates
So yes, you could join layouts/app onto /Users/tim/Source/scratch/bookshelf/app/templates and there you have the correct path to use (minus the file extension).
We can't put an exact file extension on this because we do support fuzzy loading e.g. from any *.html.* template files.
I think we could probably finesse this error message to make it even nicer. For example, if there's only one path configured, then we could make the error a lot closer to your example.
However, I'd like to leave that as an exercise for a future enhancement rather than block on this now. This would be a great first issue for a potential Hanami contributor, for example 😄
Remove the specialized LayoutNotFoundError, because this was raising incorrect error if there were missing partials being rendered inside the layout.
It is better that we raise a genuine, non-misleading error in these cases. The LayoutNotFoundError only provided marginal utility anyway, and the inclusion of the “layouts/“ prefix for a TemplateNotFoundError raised for a missing layout will still make it clear where the template was being looked for.
Fixes #246.