ruby-grape / grape / 42591433311

100%

push

github

Raise ArgumentError on a version that is not a String, Symbol or Integer (#3060)

Since #2618 replaced extract_options! with keyword arguments (3.0.0), a
trailing braced options Hash such as

    version 'v1', { using: :header, vendor: 'acme' }

lands in the splat. Grape registered a version literally named
`{using: :header, vendor: "acme"}` and kept the API on the default :path
strategy, with no warning.

Raise ArgumentError instead, as auth, http_basic and desc have done
since 4.0.0. Redispatching the Hash as keywords, as #2853 did for
requires, optional and use, would quietly move an API that has been
serving /v1/... since 3.0 onto header versioning in a minor release.
Raising stops it at boot and points at the line.

Every other version was stringified too, so check them all against an
explicit set: a non-empty String, Symbol or Integer. A Float drops its
trailing zeros (1.10 registered "1.1"), and nil, an empty name or any
other object registered a version no request could reach. The
arguments are flattened before the check, so a Hash or nil inside an
Array of versions raises as well, as does an empty Array.

UPGRADING notes the break and how to keep path versioning.

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

1587 of 1587 branches covered (100.0%)

Branch coverage included in aggregate %.

11 of 11 new or added lines in 1 file covered. (100.0%)

4672 of 4672 relevant lines covered (100.0%)

19306.42 hits per line