ruby-grape / grape / 25609232382

97%

master: 97%

Pull #2705

github

Add Grape.config.warn_on_helper_overrides

A helper method defined via `helpers do; def foo; end; end` is mixed
into the endpoint's singleton class and therefore takes precedence
over `Grape::Endpoint#foo` if one exists. That's the documented and
correct behaviour, but it's silent — when the framework gains a new
method (e.g. `Grape::Endpoint#logger`) and a user already defined a
helper of the same name, nothing tells them their helper now masks
the framework implementation.

Adds an opt-in dev-time signal:

    # config/environments/development.rb (or equivalent)
    Grape.config.warn_on_helper_overrides = true

When enabled, defining a `helpers` module — either via a block or by
passing an external module to `helpers SomeModule` — emits one
warning to `$stderr` per helper method that masks a `Grape::Endpoint`
instance method. Off by default; zero cost in production.

Enabled in `spec_helper.rb` so future test additions that
accidentally mask `Endpoint` methods via helpers surface as warnings
during CI.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

1087 of 1171 branches covered (92.83%)

Branch coverage included in aggregate %.

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

3427 of 3483 relevant lines covered (98.39%)

32141.9 hits per line