ruby-grape / grape / 33321531189

97%

push

github

Extract the shared body of `requires` and `optional` (#2867)

* Pass `required` as an argument instead of writing a presence key

`requires` announced that a parameter is required by writing
`opts[:presence]` into the options Hash it had just been handed, and
`optional` announced the opposite by writing nothing. That put an internal
signal in the same namespace as an API's own options, and the two shared a
key: `requires` silently overwrote a user-supplied `presence:`, while
`optional` silently honoured one and turned an optional parameter into a
required one through a key nothing documents.

    requires :a, presence: false   # ignored, :a is still required
    optional :a, presence: true    # honoured, :a is actually required

Pass the flag as an argument — `required: true` from `requires`, false from
`optional` — down to `validates`, which builds the presence entry itself.
The key stops being something the DSL writes into the caller's Hash.

The entry is now built after the caller has merged in any enclosing `with`
attributes, which fixes a second bug: `opts[:presence]` was assembled from
`opts[:message]` before that merge, so a group-level `message:` never
reached the presence validator.

A `presence:` supplied by an API still decides the outcome exactly as it
did, and warns, so nothing changes for code that relies on it until the key
is ignored outright.

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

* Extract the shared body of `requires` and `optional`

With the group-type check unified (#2864), requiredness passed as an
argument (#2865) and `as` taken as a keyword (#2866), the two methods differ
only in the name they redispatch a legacy Hash under and in whether what
they declare is required. Everything else — the group merge, the `using:`
handover, the attribute validation, the choice between a nested scope and a
leaf declaration — was written twice.

Move it into one private `declare`, leaving each DSL method a single
dispatch. `opt... (continued)

1240 of 1332 branches covered (93.09%)

Branch coverage included in aggregate %.

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

3898 of 3966 relevant lines covered (98.29%)

27180.01 hits per line