ruby-grape / grape / 35471845819

99%

master: 99%

push

github

Correct the README where its examples and claims do not match Grape

A read-through of the whole README, with every Ruby block parsed and
every checkable claim run against master.

Examples that raised or misbehaved as written: `Grape::Types::InvalidValue`
(gone since 2.x), the cookie counter (a returned cookie is a String, so
the second request raised TypeError, and `cookies.delete` answers a Set
of names rather than the value), a custom validator named `Length` (it
replaces the built-in `length` validator for the whole process), `auth`
with a positional options Hash (removed in 4.0) whose block read an
undefined `username`, `e.status`/`e.errors` on plain StandardError
subclasses, `error!` with no arguments, a middleware calling a `logger`
Grape::Middleware::Base does not have, an error formatter returning a
Hash as the response body, `except_values` over a Range with no `type:`,
`regexp: /w+/` missing its backslash, and `route.params[params[:id]]`,
which is always nil.

Eight blocks did not parse: `params:` as a label in a `desc` block, the
deprecated `default` key written as a block, a class missing its `end`,
an endless range at the end of a line swallowing the next one,
`present { ... }` parsed as a block, and a Hash without commas.

Claims that no longer hold, or never did: the Ruby floor (3.3.1 since
#2966), the `param_builder` default and the two settings missing from
the list, a block's `type` "defaulting" to Array (required since #722),
a default outside `values:` failing per request rather than at
definition, `requires` with `default:`, the `Allow` header without HEAD,
the 405 and OPTIONS callback lists without `finally`, an exception
raised in `rescue_from` being "handled outside Grape",
`default_error_formatter` replacing a built-in format's error formatter,
a 400 where the declared type makes it a 404, a version inside a
resource routing as /foo/v1, header `strict:` needing `cascade: false`
for its 406, the body-carrying methods, and hea... (continued)

1445 of 1501 branches covered (96.27%)

Branch coverage included in aggregate %.

4301 of 4301 relevant lines covered (100.0%)

28821.13 hits per line