Introduce Hanami::Middleware::BodyParser::Parser
#189
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Introduce
Hanami::Middleware::BodyParser::Parser
as superclass for body parsersWhy?
By reviewing this documentation fix, I've recognized that in
unstable
branch the superclass for body parsers is gone.Since 1.3, we put in place a mechanism to check if a given body parser respond to the required methods (see #182). In a language with missing interfaces, this is the best that we can do.
However, we cannot easily document the behavior of these methods.
For instance, we currently assert that a parser responds to
#mime_types
, but we can't document that we expect an array of strings as returning value.Same thing goes for
#parse
, which is even more complex due to the expected exception to be raised.How?
The superclass is used by our only body parser for JSON.
It doesn't change the current possibility of having a body parser that implicitly inherits from
Object
. This PR only indicates the preferred way.