Improve D&D validation reliability
This commit is contained in:
@@ -16,7 +16,7 @@ import (
|
||||
const (
|
||||
Key = "extract/dnd/item-occurrences/shape"
|
||||
ReasonCode = "invalid_item_occurrence_shape"
|
||||
policy = "dnd.item_occurrences.shape.v2"
|
||||
policy = "dnd.item_occurrences.shape.v3"
|
||||
)
|
||||
|
||||
type Options struct{}
|
||||
@@ -57,20 +57,12 @@ func Validate(value dnd.ItemOccurrenceList) error {
|
||||
}
|
||||
|
||||
type validationAssessment struct {
|
||||
operatorIssues []string
|
||||
correctionGroups []correctionGroup
|
||||
groupIndexes map[string]int
|
||||
}
|
||||
|
||||
type correctionGroup struct {
|
||||
label string
|
||||
rule string
|
||||
records []string
|
||||
recordsSeen map[string]struct{}
|
||||
operatorIssues []string
|
||||
corrections diagnostics.Corrections
|
||||
}
|
||||
|
||||
func assess(value dnd.ItemOccurrenceList) validationAssessment {
|
||||
assessment := validationAssessment{groupIndexes: make(map[string]int)}
|
||||
var assessment validationAssessment
|
||||
if value.Occurrences == nil {
|
||||
assessment.operatorIssues = append(assessment.operatorIssues, "occurrences must be present")
|
||||
assessment.addCorrection("occurrences", "item-occurrence list", "Return an `occurrences` array; use an empty array when the transcript establishes no occurrences.", "")
|
||||
@@ -107,20 +99,10 @@ func assess(value dnd.ItemOccurrenceList) validationAssessment {
|
||||
}
|
||||
|
||||
func (assessment *validationAssessment) addCorrection(key, label, rule, record string) {
|
||||
index, ok := assessment.groupIndexes[key]
|
||||
if !ok {
|
||||
index = len(assessment.correctionGroups)
|
||||
assessment.groupIndexes[key] = index
|
||||
assessment.correctionGroups = append(assessment.correctionGroups, correctionGroup{label: label, rule: rule, recordsSeen: make(map[string]struct{})})
|
||||
}
|
||||
if record != "" {
|
||||
group := &assessment.correctionGroups[index]
|
||||
if _, seen := group.recordsSeen[record]; seen {
|
||||
return
|
||||
}
|
||||
group.recordsSeen[record] = struct{}{}
|
||||
group.records = append(group.records, record)
|
||||
record = "Affected " + label + " record: " + record
|
||||
}
|
||||
assessment.corrections.Add(key, rule, record)
|
||||
}
|
||||
|
||||
func (assessment validationAssessment) operatorMessage() string {
|
||||
@@ -128,16 +110,7 @@ func (assessment validationAssessment) operatorMessage() string {
|
||||
}
|
||||
|
||||
func (assessment validationAssessment) correctionGuidance() string {
|
||||
issues := make([]string, 0, len(assessment.correctionGroups)+len(assessment.operatorIssues))
|
||||
for _, group := range assessment.correctionGroups {
|
||||
issues = append(issues, group.rule)
|
||||
}
|
||||
for _, group := range assessment.correctionGroups {
|
||||
for _, record := range group.records {
|
||||
issues = append(issues, "Affected "+group.label+" record: "+record)
|
||||
}
|
||||
}
|
||||
return diagnostics.Aggregate("Correct every rejected item occurrence and return the complete replacement list", issues)
|
||||
return assessment.corrections.Guidance("Correct every rejected item occurrence and return the complete replacement list")
|
||||
}
|
||||
|
||||
func holderOperatorIssue(occurrence dnd.ItemOccurrence) string {
|
||||
@@ -159,7 +132,7 @@ func holderExpectation(kind dnd.ItemOccurrenceKind) string {
|
||||
case dnd.ItemOccurrenceKindConsumed:
|
||||
return "from present and to absent"
|
||||
case dnd.ItemOccurrenceKindTransferred:
|
||||
return "distinct named non-party holders"
|
||||
return "distinct named party-member holders"
|
||||
default:
|
||||
return "a supported holder combination"
|
||||
}
|
||||
@@ -188,19 +161,7 @@ func occurrenceContext(occurrence dnd.ItemOccurrence) string {
|
||||
if name == "" {
|
||||
context = "item with a blank contextual name"
|
||||
}
|
||||
if len(occurrence.SourceRefs) == 0 {
|
||||
context += " without a cited source range"
|
||||
} else {
|
||||
ref := occurrence.SourceRefs[0]
|
||||
if ref.StartUnitID == ref.EndUnitID {
|
||||
context += fmt.Sprintf(" at source unit %d", ref.StartUnitID)
|
||||
} else {
|
||||
context += fmt.Sprintf(" at source units %d-%d", ref.StartUnitID, ref.EndUnitID)
|
||||
}
|
||||
if len(occurrence.SourceRefs) > 1 {
|
||||
context += fmt.Sprintf(" (first of %d cited ranges)", len(occurrence.SourceRefs))
|
||||
}
|
||||
}
|
||||
context += " " + diagnostics.SourceRange(occurrence.SourceRefs)
|
||||
return context + " with from " + holderDisplay(occurrence.From) + " and to " + holderDisplay(occurrence.To)
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user