Make ParseableType into an interface

Author: Antoine Pelisse

internal/fixture/state.go

@@ -30,7 +30,7 @@ import (
 // any time that Live and Managers match the expectations.
 type State struct {
 	Live     *typed.TypedValue
-	Parser   *typed.ParseableType
+	Parser   typed.ParseableType
 	Managers fieldpath.ManagedFields
 	Updater  *merge.Updater
 }
@@ -228,7 +228,7 @@ type TestCase struct {
 }
 
 // Test runs the test-case using the given parser.
-func (tc TestCase) Test(parser *typed.ParseableType) error {
+func (tc TestCase) Test(parser typed.ParseableType) error {
 	state := State{
 		Updater: &merge.Updater{Converter: &dummyConverter{}},
 		Parser:  parser,

merge/leaf_test.go

@@ -25,7 +25,7 @@ import (
 	"sigs.k8s.io/structured-merge-diff/typed"
 )
 
-var leafFieldsParser = func() *typed.ParseableType {
+var leafFieldsParser = func() typed.ParseableType {
 	parser, err := typed.NewParser(`types:
 - name: leafFields
   struct:
@@ -262,7 +262,7 @@ func TestUpdateLeaf(t *testing.T) {
 				Apply{
 					Manager:    "default",
 					APIVersion: "v1",
-					Object: "",
+					Object:     "",
 				},
 			},
 			Object: `

merge/set_test.go

@@ -24,7 +24,7 @@ import (
 	"sigs.k8s.io/structured-merge-diff/typed"
 )
 
-var setFieldsParser = func() *typed.ParseableType {
+var setFieldsParser = func() typed.ParseableType {
 	parser, err := typed.NewParser(`types:
 - name: sets
   struct:

typed/parser.go

@@ -68,28 +68,36 @@ func (p *Parser) TypeNames() (names []string) {
 
 // Type returns a helper which can produce objects of the given type. Any
 // errors are deferred until a further function is called.
-func (p *Parser) Type(name string) *ParseableType {
-	return &ParseableType{
+func (p *Parser) Type(name string) ParseableType {
+	return &parseableType{
 		parser:   p,
 		typename: name,
 	}
 }
 
 // ParseableType allows for easy production of typed objects.
-type ParseableType struct {
+type ParseableType interface {
+	IsValid() bool
+	FromYAML(YAMLObject) (TypedValue, error)
+	FromUnstructured(interface{}) (TypedValue, error)
+}
+
+type parseableType struct {
 	parser   *Parser
 	typename string
 }
 
+var _ ParseableType = &parseableType{}
+
 // IsValid return true if p's schema and typename are valid.
-func (p *ParseableType) IsValid() bool {
+func (p *parseableType) IsValid() bool {
 	_, ok := p.parser.Schema.Resolve(schema.TypeRef{NamedType: &p.typename})
 	return ok
 }
 
 // FromYAML parses a yaml string into an object with the current schema
 // and the type "typename" or an error if validation fails.
-func (p *ParseableType) FromYAML(object YAMLObject) (TypedValue, error) {
+func (p *parseableType) FromYAML(object YAMLObject) (TypedValue, error) {
 	v, err := value.FromYAML([]byte(object))
 	if err != nil {
 		return TypedValue{}, err
@@ -99,7 +107,7 @@ func (p *ParseableType) FromYAML(object YAMLObject) (TypedValue, error) {
 
 // FromUnstructured converts a go interface to a TypedValue. It will return an
 // error if the resulting object fails schema validation.
-func (p *ParseableType) FromUnstructured(in interface{}) (TypedValue, error) {
+func (p *parseableType) FromUnstructured(in interface{}) (TypedValue, error) {
 	v, err := value.FromUnstructured(in)
 	if err != nil {
 		return TypedValue{}, err