ruby-grape / grape / 25863247528

97%

master: 97%

Pull #2716

github

Refactor DSL::Routing#version: guard clause, explicit kwargs, value object

Three changes that touch the same method:

1. Lift the body out of `if args.any? ... end` into a
   `return @versions&.last if args.empty?` guard.

2. Replace `**options` with explicit kwargs `(using:, cascade:,
   parameter:, strict:, vendor:)` and bake the defaults into the
   signature (matching `Versioner::Base::DEFAULT_OPTIONS`). The
   per-call `reverse_merge(using: :path)` is gone.

3. Store a `Grape::DSL::VersionOptions` value object (built on
   `Data.define`) on the inheritable setting instead of a Hash. The
   public `.version` DSL still accepts and resolves kwargs the same
   way — the value object is an internal-only representation. Internal
   readers (`Path`, `Endpoint#build_stack`, `API::Instance#cascade?`)
   read fields by accessor; the versioner middleware boundary still
   takes a Hash, so we call `.to_h` on the way in. The middleware's
   own `DEFAULT_OPTIONS[:version_options]` is left untouched so
   direct-mount callers (some middleware specs) still get the same
   safe defaults.

`version_options` is read for exactly these five keys across the
codebase: `:using` (endpoint.rb, path.rb), and
`:cascade`/`:parameter`/`:strict`/`:vendor`
(Versioner::Base#initialize, plus `:cascade` in API::Instance#cascade?).
Any other kwarg passed to `.version` was previously swallowed by the
splat with no effect.

Spec fixtures updated:

- `spec/shared/versioning_examples.rb`: 14 call sites changed
  `**macro_options` → `**macro_options.except(:format)`. The `:format`
  key stays in `macro_options` so the test helper
  (`versioned_helpers.rb`) can still build the `HTTP_ACCEPT` header.
- `spec/grape/exceptions/invalid_accept_header_spec.rb`: dropped
  `format: :json` from 8 direct `.version` calls (never read on the
  lib side).
- `spec/grape/dsl/routing_spec.rb`: the `:version_options` assertion
  now expects a `VersionOptions` instance with the full default set.
- `spec/g... (continued)

1072 of 1155 branches covered (92.81%)

Branch coverage included in aggregate %.

27 of 27 new or added lines in 6 files covered. (100.0%)

3471 of 3527 relevant lines covered (98.41%)

32101.18 hits per line