dry-rb/dry-validation

errors(full: true), for nested input, could be better

Open

#731 opened on Jul 26, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Ruby (193 forks)github user discovery
bughelp wanted

Repository metrics

Stars
 (1,421 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug

result = contract.call(params)

# errors(full: false) works fine ..
result.errors.to_h.to_json
# "{\"items\":{\"0\":{\"weight\":{\"unit\":[\"must be one of: g, kg, lb, oz\"]}}}}"

# errors(full: true), for nested input, could be better
result.errors(full: true).to_h.values.join(', ')
# "{0=\u003e{:weight=\u003e{:unit=\u003e[\"unit must be one of: g, kg, lb, oz\"]}}}"

I'm happy to attempt a PR, if requested.

To Reproduce

Call a Contract that validates nested input, as shown above. If the above is unclear, I'm happy to provide more detail.

Expected behavior

It'd be great to have better output. For example:

result.errors(full: true).to_h.values.join(', ')
# "items 0 weight unit must be one of: g, kg, lb, oz"

My environment

  • Affects my production application: No, because I guess I won't be using errors(full: true) in production .. :)
  • Ruby version: 2.7
  • OS: N/A

Contributor guide

Research direction
Examine the dry validation source code to understand how `errors(full: true)` builds error messages for nested input. Look for how the key paths are concatenated and how full messages are generated.
Tech stack
ruby
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Ruby
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40