121 lines
4.7 KiB
Go
121 lines
4.7 KiB
Go
// Package shape validates required D&D location occurrence candidate fields.
|
|
package shape
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
|
|
"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
|
|
"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
|
|
"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/shared/diagnostics"
|
|
)
|
|
|
|
const (
|
|
Key = "extract/dnd/location-occurrences/shape"
|
|
ReasonCode = "invalid_location_occurrence_shape"
|
|
policy = "dnd.location_occurrences.validator.shape.v2"
|
|
)
|
|
|
|
type Options struct{}
|
|
type Validator struct{}
|
|
|
|
var _ contracts.TypedValidator[dnd.LocationOccurrenceList] = (*Validator)(nil)
|
|
var _ pipeline.CheckpointFingerprintProvider = (*Validator)(nil)
|
|
|
|
func New(Options) *Validator { return &Validator{} }
|
|
func (v *Validator) Name() string { return Key }
|
|
func (v *Validator) ExecutionClass() contracts.ExecutionClass {
|
|
return contracts.ExecutionClassDeterministic
|
|
}
|
|
func (v *Validator) CheckpointFingerprints() []pipeline.CheckpointFingerprint {
|
|
return []pipeline.CheckpointFingerprint{{Name: "policy", Value: policy}}
|
|
}
|
|
|
|
func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationRequest[dnd.LocationOccurrenceList]) (contracts.ValidationResult, error) {
|
|
issues, corrections := assess(req.Value)
|
|
if len(issues) != 0 {
|
|
return contracts.ValidationResult{
|
|
Approved: false,
|
|
ReasonCode: ReasonCode,
|
|
Message: diagnostics.Aggregate("invalid location occurrence shape", issues),
|
|
CorrectionGuidance: corrections.Guidance("Correct every rejected location occurrence and return the complete replacement occurrence list"),
|
|
}, nil
|
|
}
|
|
return contracts.ValidationResult{Approved: true}, nil
|
|
}
|
|
|
|
func Validate(value dnd.LocationOccurrenceList) error {
|
|
issues, _ := assess(value)
|
|
if len(issues) == 0 {
|
|
return nil
|
|
}
|
|
return fmt.Errorf("%s", diagnostics.Aggregate("invalid location occurrence shape", issues))
|
|
}
|
|
|
|
func assess(value dnd.LocationOccurrenceList) ([]string, diagnostics.Corrections) {
|
|
var corrections diagnostics.Corrections
|
|
if value.Occurrences == nil {
|
|
corrections.Add("list", "Return an `occurrences` array; use an empty array when the transcript establishes no location occurrences.", "")
|
|
return []string{"occurrences must be present"}, corrections
|
|
}
|
|
issues := make([]string, 0)
|
|
for index, occurrence := range value.Occurrences {
|
|
prefix := fmt.Sprintf("occurrences[%d]", index)
|
|
record := fmt.Sprintf("Affected %s occurrence for location %s %s.", diagnostics.Quote(string(occurrence.Kind)), diagnostics.Quote(strings.TrimSpace(occurrence.Name)), diagnostics.SourceRange(occurrence.SourceRefs))
|
|
if strings.TrimSpace(occurrence.LocationID) == "" {
|
|
issues = append(issues, prefix+".location_id must not be empty")
|
|
corrections.Add("name", "Select a nonblank proper location name from the supplied registry for every occurrence.", record)
|
|
}
|
|
if strings.TrimSpace(occurrence.Name) == "" {
|
|
issues = append(issues, prefix+".name must not be empty")
|
|
corrections.Add("name", "Select a nonblank proper location name from the supplied registry for every occurrence.", record)
|
|
}
|
|
if !validKind(occurrence.Kind) {
|
|
issues = append(issues, prefix+".kind is unsupported: "+diagnostics.Quote(string(occurrence.Kind)))
|
|
corrections.Add("kind", "Set `kind` to exactly one of `visited`, `planned`, `recalled`, or `mentioned`.", record)
|
|
}
|
|
if len(occurrence.SourceRefs) == 0 {
|
|
issues = append(issues, prefix+".source_refs must contain at least one reference")
|
|
corrections.Add("source-refs", "Provide at least one transcript source range that directly supports every location occurrence.", record)
|
|
}
|
|
}
|
|
return issues, corrections
|
|
}
|
|
|
|
func validKind(value dnd.LocationOccurrenceKind) bool {
|
|
switch value {
|
|
case dnd.LocationOccurrenceKindVisited,
|
|
dnd.LocationOccurrenceKindPlanned,
|
|
dnd.LocationOccurrenceKindRecalled,
|
|
dnd.LocationOccurrenceKindMentioned:
|
|
return true
|
|
default:
|
|
return false
|
|
}
|
|
}
|
|
|
|
func Spec() pipeline.ValidatorSpec {
|
|
return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic}
|
|
}
|
|
|
|
func Register(registry *pipeline.ValidatorRegistry) error {
|
|
return pipeline.RegisterTypedValidatorBuilder(registry, dnd.LocationOccurrenceListKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.LocationOccurrenceList], error) {
|
|
options, err := DecodeOptions(request.Options)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return New(options), nil
|
|
})
|
|
}
|
|
|
|
func DecodeOptions(options map[string]any) (Options, error) {
|
|
if err := pipeline.RejectUnknownOptions(options); err != nil {
|
|
return Options{}, err
|
|
}
|
|
return Options{}, nil
|
|
}
|
|
|
|
func validateOptions(options map[string]any) error { _, err := DecodeOptions(options); return err }
|