ruby-grape / grape / 33554135201

97%

master: 99%

Pull #2880

github

Remove the versioner's pattern option

`Versioner::Path#version_from_first_segment` runs on every request of a
path-versioned API and tested the candidate segment against `pattern`:

    return unless potential_version.match?(pattern)

`pattern` defaulted to `/.*/i`, so unless an API supplied its own, that regexp
ran on every request to answer a question it could not answer with no.

Nothing supplies one. The option dates from the original versioner, added in
August 2010, where it was the whole mechanism:

    def default_options = { pattern: /.*/i }

    def before
      potential_version = env['PATH_INFO'].split('/')[1]
      if potential_version =~ options[:pattern]
        env['api.version'] = potential_version
        env['PATH_INFO'] = truncated_path
      end
    end

There was no declared version list then, so a regexp was the only way to decide
whether the first segment was a version. `versions:` took that job over — a
segment is checked against what the API declared, and an unrecognized one
answers 404 — and `pattern` was left behind. It was never connected to the
`version` DSL that arrived later: `DSL::Routing#version` does not accept the
keyword and `Endpoint#build_stack` never passed one, so the only way to reach
it was to insert the middleware yourself, which also meant forgoing what
`version` does for routing.

Fifteen years on, the two specs that kept it alive are still the two from that
2010 commit, asserting on the same `/v1/awesome` and `/awesome/radical`.

Remove the option, its delegator, the per-request test and those specs. Passing
`pattern:` now raises `ArgumentError: unknown keyword: :pattern` when the
middleware is built rather than being silently accepted, and
`Versioner::Base::DEFAULT_OPTIONS` no longer carries the key.

One behaviour goes with it, documented in UPGRADING: a hand-wired versioner
could use `pattern` to distinguish "this segment is not a version at all" —
leave `api.version` unset and let the request through ... (continued)

1236 of 1330 branches covered (92.93%)

Branch coverage included in aggregate %.

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

3913 of 3981 relevant lines covered (98.29%)

27277.15 hits per line