refactor: reduce boiler plate on models when unmarshalling (#12)

Author: TristanSpeakEasy

arazzo/arazzo.go

@@ -14,6 +14,7 @@ import (
 
 	"github.com/speakeasy-api/openapi/arazzo/core"
 	"github.com/speakeasy-api/openapi/extensions"
+	"github.com/speakeasy-api/openapi/internal/interfaces"
 	"github.com/speakeasy-api/openapi/marshaller"
 	"github.com/speakeasy-api/openapi/validation"
 	"github.com/speakeasy-api/openapi/yml"
@@ -48,15 +49,15 @@ type Arazzo struct {
 	core core.Arazzo
 }
 
-var _ model[core.Arazzo] = (*Arazzo)(nil)
+var _ interfaces.Model[core.Arazzo] = (*Arazzo)(nil)
 
 type Option[T any] func(o *T)
 
 type unmarshalOptions struct {
 	skipValidation bool
 }
 
-// WithSkipValidation will skip validation of the Arazzo document during unmarshalling.
+// WithSkipValidation will skip validation of the Arazzo document during unmarshaling.
 // Useful to quickly load a document that will be mutated and validated later.
 func WithSkipValidation() Option[unmarshalOptions] {
 	return func(o *unmarshalOptions) {

arazzo/components.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/speakeasy-api/openapi/arazzo/core"
 	"github.com/speakeasy-api/openapi/extensions"
+	"github.com/speakeasy-api/openapi/internal/interfaces"
 	"github.com/speakeasy-api/openapi/jsonschema/oas31"
 	"github.com/speakeasy-api/openapi/sequencedmap"
 	"github.com/speakeasy-api/openapi/validation"
@@ -31,7 +32,7 @@ type Components struct {
 	core core.Components
 }
 
-var _ model[core.Components] = (*Components)(nil)
+var _ interfaces.Model[core.Components] = (*Components)(nil)
 
 // GetCore will return the low level representation of the components object.
 // Useful for accessing line and column numbers for various nodes in the backing yaml/json document.

arazzo/core/arazzo.go

@@ -25,8 +25,6 @@ type Arazzo struct {
 	Config   *yml.Config
 }
 
-var _ CoreModel = (*Arazzo)(nil)
-
 func Unmarshal(ctx context.Context, doc io.Reader) (*Arazzo, error) {
 	data, err := io.ReadAll(doc)
 	if err != nil {
@@ -52,12 +50,6 @@ func Unmarshal(ctx context.Context, doc io.Reader) (*Arazzo, error) {
 	return &arazzo, nil
 }
 
-func (a *Arazzo) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	a.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, a)
-}
-
 func (a *Arazzo) Marshal(ctx context.Context, w io.Writer) error {
 	cfg := yml.GetConfigFromContext(ctx)
 

arazzo/core/components.go

@@ -1,8 +1,6 @@
 package core
 
 import (
-	"context"
-
 	coreExtensions "github.com/speakeasy-api/openapi/extensions/core"
 	"github.com/speakeasy-api/openapi/jsonschema/oas31/core"
 	"github.com/speakeasy-api/openapi/marshaller"
@@ -19,11 +17,3 @@ type Components struct {
 
 	RootNode *yaml.Node
 }
-
-var _ CoreModel = (*Components)(nil)
-
-func (c *Components) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	c.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, c)
-}

arazzo/core/criterion.go

@@ -6,6 +6,7 @@ import (
 	"reflect"
 
 	"github.com/speakeasy-api/openapi/extensions/core"
+	"github.com/speakeasy-api/openapi/internal/interfaces"
 	"github.com/speakeasy-api/openapi/marshaller"
 	"gopkg.in/yaml.v3"
 )
@@ -17,22 +18,14 @@ type CriterionExpressionType struct {
 	RootNode *yaml.Node
 }
 
-var _ CoreModel = (*CriterionExpressionType)(nil)
-
-func (c *CriterionExpressionType) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	c.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, c)
-}
-
 type CriterionTypeUnion struct {
 	Type           *string
 	ExpressionType *CriterionExpressionType
 
 	RootNode *yaml.Node
 }
 
-var _ CoreModel = (*CriterionTypeUnion)(nil)
+var _ interfaces.CoreModel = (*CriterionTypeUnion)(nil)
 
 func (c *CriterionTypeUnion) Unmarshal(ctx context.Context, node *yaml.Node) error {
 	c.RootNode = node
@@ -44,7 +37,7 @@ func (c *CriterionTypeUnion) Unmarshal(ctx context.Context, node *yaml.Node) err
 		if c.ExpressionType == nil {
 			c.ExpressionType = &CriterionExpressionType{}
 		}
-		return marshaller.UnmarshalStruct(ctx, node, c.ExpressionType)
+		return marshaller.UnmarshalModel(ctx, node, c.ExpressionType)
 	default:
 		return fmt.Errorf("expected scalar or mapping node, got %v", node.Kind)
 	}
@@ -91,11 +84,3 @@ type Criterion struct {
 
 	RootNode *yaml.Node
 }
-
-var _ CoreModel = (*Criterion)(nil)
-
-func (c *Criterion) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	c.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, c)
-}

arazzo/core/criterion_test.go

@@ -151,6 +151,12 @@ type:
 								ValueNode: testutils.CreateStringYamlNode("draft-goessner-dispatch-jsonpath-00", 5, 12),
 								Present:   true,
 							},
+							RootNode: testutils.CreateMapYamlNode([]*yaml.Node{
+								testutils.CreateStringYamlNode("type", 4, 3),
+								testutils.CreateStringYamlNode("jsonpath", 4, 9),
+								testutils.CreateStringYamlNode("version", 5, 3),
+								testutils.CreateStringYamlNode("draft-goessner-dispatch-jsonpath-00", 5, 12),
+							}, 4, 3),
 						}, RootNode: testutils.CreateMapYamlNode([]*yaml.Node{
 							testutils.CreateStringYamlNode("type", 4, 3),
 							testutils.CreateStringYamlNode("jsonpath", 4, 9),
@@ -189,7 +195,8 @@ type:
 			require.NoError(t, err)
 
 			c := Criterion{}
-			err = c.Unmarshal(context.Background(), doc.Content[0])
+
+			err = marshaller.Unmarshal(context.Background(), doc.Content[0], &c)
 			require.NoError(t, err)
 
 			require.Equal(t, tt.want, c)

arazzo/core/failureaction.go

@@ -1,8 +1,6 @@
 package core
 
 import (
-	"context"
-
 	"github.com/speakeasy-api/openapi/extensions/core"
 	"github.com/speakeasy-api/openapi/marshaller"
 	"gopkg.in/yaml.v3"
@@ -20,11 +18,3 @@ type FailureAction struct {
 
 	RootNode *yaml.Node
 }
-
-var _ CoreModel = (*FailureAction)(nil)
-
-func (f *FailureAction) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	f.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, f)
-}

arazzo/core/info.go

@@ -1,8 +1,6 @@
 package core
 
 import (
-	"context"
-
 	"github.com/speakeasy-api/openapi/extensions/core"
 	"github.com/speakeasy-api/openapi/marshaller"
 	"gopkg.in/yaml.v3"
@@ -17,11 +15,3 @@ type Info struct {
 
 	RootNode *yaml.Node
 }
-
-var _ CoreModel = (*Info)(nil)
-
-func (i *Info) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	i.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, i)
-}

arazzo/core/interfaces.go

@@ -1,8 +1,6 @@
 package core
 
 import (
-	"context"
-
 	"github.com/speakeasy-api/openapi/extensions/core"
 	"github.com/speakeasy-api/openapi/marshaller"
 	"gopkg.in/yaml.v3"
@@ -16,11 +14,3 @@ type Parameter struct {
 
 	RootNode *yaml.Node
 }
-
-var _ CoreModel = (*Parameter)(nil)
-
-func (p *Parameter) Unmarshal(ctx context.Context, node *yaml.Node) error {
-	p.RootNode = node
-
-	return marshaller.UnmarshalStruct(ctx, node, p)
-}