ruby-grape / grape / 30206988366

97%

master: 97%

Pull #2822

github

Add a numericality validator

Grape has no built-in way to bound or shape-check a numeric parameter
beyond `values:` (a closed inclusive range or list). Users end up
reaching for a `values:` lambda or a full `contract_scope` schema for
something as simple as "must be a positive integer" or "0..100
inclusive with an exclusive upper bound", both of which are more
ceremony than the check deserves and produce weak error messages.

Add `NumericalityValidator`, registered as `numericality`, following
ActiveModel::Validations::NumericalityValidator's option naming for
familiarity: `greater_than`, `greater_than_or_equal_to`, `less_than`,
`less_than_or_equal_to`, `equal_to`, `other_than`, `only_integer`,
`odd`, `even`. Any combination can be supplied and each has its own
i18n message key (mirroring how `length` has separate `length_min`/
`length_max`/`length_is` keys).

Design notes:
- Non-Numeric values are skipped rather than erroring — numeric-ness
  is `type:`/coercion's job; this validator only owns bounds/parity,
  so it composes with `coerce` instead of duplicating it.
- Applied to a typed array (`type: [Integer]`), every element is
  checked individually (`Array.wrap`), matching how `values` already
  treats arrays — `length` is the one that owns the array's own size.
- `only_integer` accepts whole-numbered `Float`/`BigDecimal` too
  (`val == val.to_i`), not just literal `Integer`.
- Obviously contradictory option combinations (`greater_than` +
  `greater_than_or_equal_to`, `less_than` + `less_than_or_equal_to`,
  `odd` + `even`, `equal_to` + any other comparison, or a reversed
  lower/upper bound) raise `ArgumentError` at definition time, same
  as `length_validator`'s existing `min > max` guard.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

1170 of 1264 branches covered (92.56%)

Branch coverage included in aggregate %.

3798 of 3865 relevant lines covered (98.27%)

22764.66 hits per line