ruby-grape / grape / 42520755555

100%

push

github

Make a helper reach the routes declared above it in its scope (#3061)

An endpoint is built from a point-in-time copy of its scope's settings.
The copy keeps the scope's own helpers as they were at the route, but
links to the enclosing scopes live. So a `helpers` declared further
down the same scope never reached the route, and calling it raised
NameError. One declared further down an enclosing scope, or after
`mount`, did reach it.

The endpoint now also keeps the live settings of its scope and reads
the helpers from them when it compiles, by which time the whole class
body has run. A helper declared in a sibling namespace still doesn't
reach the route.

A helper defined twice in one scope therefore answers with its last
definition in every route of that scope, including those declared
between the two definitions. UPGRADING describes that change.

Since that change is silent, the endpoint warns about it when it
compiles, until 5.0. Its settings copy still holds the helpers the
route reached before, so it can tell exactly which methods a helper
declared further down now answers in their place. It warns only for
those: a helper that only adds methods doesn't warn, nor does a
redefinition in an enclosing scope, which already reached the route. The
warning lives in Endpoint::RedefinedHelpersWarning, to be deleted with
it in 5.0, which also keeps Endpoint under its ClassLength limit. The
README no longer lists `helpers` among the declarations that must come
above the routes they cover. `use`, `rescue_from` and the callbacks are
unchanged.

The route endpoint gains a sixth ivar. Per-request copies hold eight,
so their 80-byte slot is unchanged.

Fixes #34

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

1579 of 1579 branches covered (100.0%)

Branch coverage included in aggregate %.

22 of 22 new or added lines in 2 files covered. (100.0%)

4661 of 4661 relevant lines covered (100.0%)

19218.55 hits per line