OpenSlides/docs/modelsvalidator/models/models.go

package models

import (
	"fmt"
	"io"
	"strings"

	"gopkg.in/yaml.v3"
)

// Unmarshal parses the content of models.yml to a datastruct.q
func Unmarshal(r io.Reader) (map[string]Model, error) {
	var m map[string]Model
	if err := yaml.NewDecoder(r).Decode(&m); err != nil {
		return nil, fmt.Errorf("decoding models: %w", err)
	}
	return m, nil
}

// Model replresents one model from models.yml.
type Model struct {
	Fields map[string]Field
}

// UnmarshalYAML decodes a yaml model to models.Model.
func (m *Model) UnmarshalYAML(node *yaml.Node) error {
	return node.Decode(&m.Fields)
}

// Field of a model.
type Field struct {
	Type     string
	relation Relation
	template *AttributeTemplate
}

// Relation returns the relation object if the Field is a relation or a
// template with a relation. In other cases, it returns nil.
func (a *Field) Relation() Relation {
	if a.relation != nil {
		return a.relation
	}

	if a.template != nil && a.template.Fields.relation != nil {
		return a.template.Fields.relation
	}
	return nil
}

// UnmarshalYAML decodes a model attribute from yaml.
func (a *Field) UnmarshalYAML(value *yaml.Node) error {
	var s string
	if err := value.Decode(&s); err == nil {
		a.Type = s
		return nil
	}

	var typer struct {
		Type string `yaml:"type"`
	}
	if err := value.Decode(&typer); err != nil {
		return fmt.Errorf("field object without type: %w", err)
	}

	a.Type = typer.Type
	switch typer.Type {
	case "relation":
		fallthrough
	case "relation-list":
		var relation AttributeRelation
		if err := value.Decode(&relation); err != nil {
			return fmt.Errorf("invalid object of type %s at line %d object: %w", typer.Type, value.Line, err)
		}
		a.relation = &relation
	case "generic-relation":
		fallthrough
	case "generic-relation-list":
		var relation AttributeGenericRelation
		if err := value.Decode(&relation); err != nil {
			return fmt.Errorf("invalid object of type %s at line %d object: %w", typer.Type, value.Line, err)
		}
		a.relation = &relation
	case "template":
		var template AttributeTemplate
		if err := value.Decode(&template); err != nil {
			return fmt.Errorf("invalid object of type template object in line %d: %w", value.Line, err)
		}
		a.template = &template
	}
	return nil
}

// Relation represents some kind of relation between fields.
type Relation interface {
	ToCollections() []ToCollectionField
}

// ToCollectionField represents a field and a collection
type ToCollectionField struct {
	Collection string  `yaml:"collection"`
	ToField    ToField `yaml:"field"`
}

// UnmarshalYAML decodes the models.yml to a To object.
func (t *ToCollectionField) UnmarshalYAML(value *yaml.Node) error {
	var s string
	if err := value.Decode(&s); err == nil {
		cf := strings.Split(s, "/")
		if len(cf) != 2 {
			return fmt.Errorf("invalid value of `to` in line %d, expected one `/`: %s", value.Line, s)
		}
		t.Collection = cf[0]
		t.ToField.Name = cf[1]
		return nil
	}

	var d struct {
		Collection string  `yaml:"collection"`
		Field      ToField `yaml:"field"`
	}
	if err := value.Decode(&d); err != nil {
		return fmt.Errorf("decoding to collection field at line %d: %w", value.Line, err)
	}
	t.Collection = d.Collection
	t.ToField = d.Field
	return nil
}

type ToField struct {
	Name string `yaml:"name"`
	Type string `yaml:"type"`
}

// UnmarshalYAML decodes the models.yml to a ToField object.
func (t *ToField) UnmarshalYAML(value *yaml.Node) error {
	var s string
	if err := value.Decode(&s); err == nil {
		t.Name = s
		t.Type = "normal"
		return nil
	}

	var d struct {
		Name string `yaml:"name"`
		Type string `yaml:"type"`
	}
	if err := value.Decode(&d); err != nil {
		return fmt.Errorf("decoding to field at line %d: %w", value.Line, err)
	}
	t.Name = d.Name
	t.Type = d.Type
	return nil
}

// AttributeRelation is a relation or relation-list field.
type AttributeRelation struct {
	To To `yaml:"to"`
}

// ToCollection returns the names of the collections there the attribute points
// to. It is allways a slice with one element.
func (r AttributeRelation) ToCollections() []ToCollectionField {
	return []ToCollectionField{r.To.CollectionField}
}

// To is shows a Relation where to point to.
type To struct {
	CollectionField ToCollectionField
}

// UnmarshalYAML decodes the models.yml to a To object.
func (t *To) UnmarshalYAML(value *yaml.Node) error {
	var s string
	if err := value.Decode(&s); err == nil {
		cf := strings.Split(s, "/")
		if len(cf) != 2 {
			return fmt.Errorf("invalid value of `to` in line %d, expected one `/`: %s", value.Line, s)
		}
		t.CollectionField.Collection = cf[0]
		t.CollectionField.ToField.Name = cf[1]
		return nil
	}

	if err := value.Decode(&(t.CollectionField)); err != nil {
		return fmt.Errorf("decoding to field at line %d: %w", value.Line, err)
	}
	return nil
}

// AttributeGenericRelation is a generic-relation or generic-relation-list field.
type AttributeGenericRelation struct {
	To ToGeneric `yaml:"to"`
}

// ToCollections returns all collection, where the generic field could point to.
func (r AttributeGenericRelation) ToCollections() []ToCollectionField {
	return r.To.CollectionFields
}

// AttributeTemplate represents a template field.
type AttributeTemplate struct {
	Replacement string `yaml:"replacement"`
	Fields      Field  `yaml:"fields"`
}

// ToGeneric is like a To object, but for generic relations.
type ToGeneric struct {
	CollectionFields []ToCollectionField
}

func (t *ToGeneric) UnmarshalYAML(value *yaml.Node) error {
	var d struct {
		Collections []string `yaml:"collections"`
		Field       ToField  `yaml:"field"`
	}
	if err := value.Decode(&d); err == nil {
		t.CollectionFields = make([]ToCollectionField, len(d.Collections))
		for i, collection := range d.Collections {
			t.CollectionFields[i].Collection = collection
			t.CollectionFields[i].ToField = d.Field
		}
		return nil
	}

	var e struct {
		CollectionFields []ToCollectionField `yaml:"collections"`
	}
	if err := value.Decode(&e); err != nil {
		return fmt.Errorf("decoding to generic field at line %d: %w", value.Line, err)
	}
	t.CollectionFields = e.CollectionFields
	return nil
}