ruby-grape / grape / 26371140112 / 34

97%

master: 97%

Pull #2746

github

Hoist `using:` / `except:` to explicit kwargs on requires / optional

`Grape::DSL::Parameters#requires` and `#optional` both treat `:using`
(and the `:except` it pairs with) as a method-local early-return signal:
when `:using` is set, the method returns through
`require_required_and_optional_fields` / `require_optional_fields` and
the keys never flow into `validate_attributes` or the validator/scope
machinery.

Promote them out of the `**opts` Hash into explicit kwargs:

  def requires(*attrs, using: nil, except: nil, **opts, &block)
  def optional(*attrs, using: nil, except: nil, **opts, &block)

The signature now self-documents the using/except contract instead of
burying it in opts, the `if using` guard drops one Hash lookup, and the
`opts` Hash that flows into `validate_attributes` is "validator-bound
kwargs only" — easier to reason about what propagates downstream.

Fully back-compat: Ruby kwarg matching captures `using:` / `except:`
before the `**opts` splat, so existing call sites (`requires :all,
using: docs`, `optional :all, except: %i[…], using: docs`, etc.) keep
working unchanged. The unrelated `:except_values` validator option
(consumed by `Grape::Validations::ValidationsSpec`) is a different key
and is unaffected.

Matches the recent kwargs-hoisting pattern in #2723 (`desc`) and #2728
(`auth` / `http_basic` / `http_digest`).

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

1064 of 1173 branches covered (90.71%)

Branch coverage included in aggregate %.

3492 of 3586 relevant lines covered (97.38%)

988.88 hits per line