ruby-grape / grape
97%
master: 97%

LAST BUILD BRANCH: mount-refresh-internal
DEFAULT BRANCH: master
Repo Added
Files 168
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH explicit-required-flag
branch: explicit-required-flag
CHANGE BRANCH
x

coverage: 96.991% (+0.003%) from 96.988%
33251775659

Pull #2865

github

ericproulx 
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>
Pull Request #2865: Pass `required` as an argument instead of writing a presence key

1243 of 1334 branches covered (93.18%)

Branch coverage included in aggregate %.

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

3883 of 3951 relevant lines covered (98.28%)

27122.66 hits per line

Relevant lines Covered
3951 RELEVANT LINES 3883 COVERED LINES
27122.66 HITS PER LINE
Source Files on explicit-required-flag

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
33251775659 explicit-required-flag 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 nothin... Pull #2865 ericproulx github
96.99
33251770064 explicit-required-flag 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 nothin... push ericproulx github
96.99
See All Builds (3539)