feat(configio): make Representation private

- configio.Representation -> configio.representation
- make all representation methods private

Author: GregoryAlbouy

configio/builder.go

@@ -33,7 +33,7 @@ func (b *Builder) WriteYAML(in []byte) error {
 }
 
 func (b *Builder) decodeAndWrite(in []byte, format Format) error {
-	repr := Representation{}
+	repr := representation{}
 	if err := DecoderOf(format, in).Decode(&repr); err != nil {
 		return err
 	}
@@ -43,7 +43,7 @@ func (b *Builder) decodeAndWrite(in []byte, format Format) error {
 	}
 	b.append(func(dst *benchttp.Runner) {
 		// err is already checked via repr.validate(), so nil is expected.
-		if err := repr.Into(dst); err != nil {
+		if err := repr.parseAndMutate(dst); err != nil {
 			panicInternal("Builder.decodeAndWrite", "unexpected error: "+err.Error())
 		}
 	})

configio/decoder.go

@@ -8,7 +8,7 @@ import (
 )
 
 type Decoder interface {
-	Decode(dst *Representation) error
+	Decode(dst *representation) error
 	DecodeRunner(dst *benchttp.Runner) error
 }
 

configio/file.go

@@ -49,7 +49,7 @@ func UnmarshalFile(filename string, dst *benchttp.Runner) error {
 type file struct {
 	prev *file
 	path string
-	repr Representation
+	repr representation
 }
 
 // decodeAll reads f.path as a file and decodes it into f.repr.
@@ -122,7 +122,7 @@ func (f file) seen(p string) bool {
 // reprs returns a slice of Representation, starting with the receiver
 // and ending with the last child.
 func (f file) reprs() representations {
-	reprs := []Representation{f.repr}
+	reprs := []representation{f.repr}
 	if f.prev != nil {
 		reprs = append(reprs, f.prev.reprs()...)
 	}

configio/json.go

@@ -13,7 +13,7 @@ import (
 
 // UnmarshalJSON parses the JSON-encoded data and stores the result
 // in the Representation pointed to by dst.
-func UnmarshalJSON(in []byte, dst *Representation) error {
+func UnmarshalJSON(in []byte, dst *representation) error {
 	dec := NewJSONDecoder(bytes.NewReader(in))
 	return dec.Decode(dst)
 }
@@ -34,7 +34,7 @@ func NewJSONDecoder(r io.Reader) JSONDecoder {
 
 // Decode reads the next JSON-encoded value from its input
 // and stores it in the Representation pointed to by dst.
-func (d JSONDecoder) Decode(dst *Representation) error {
+func (d JSONDecoder) Decode(dst *representation) error {
 	decoder := json.NewDecoder(d.r)
 	decoder.DisallowUnknownFields()
 	return d.handleError(decoder.Decode(dst))
@@ -43,11 +43,11 @@ func (d JSONDecoder) Decode(dst *Representation) error {
 // Decode reads the next JSON-encoded value from its input
 // and stores it in the benchttp.Runner pointed to by dst.
 func (d JSONDecoder) DecodeRunner(dst *benchttp.Runner) error {
-	repr := Representation{}
+	repr := representation{}
 	if err := d.Decode(&repr); err != nil {
 		return err
 	}
-	return repr.Into(dst)
+	return repr.parseAndMutate(dst)
 }
 
 // handleError handles an error from package json,

configio/representation.go

@@ -14,12 +14,12 @@ import (
 	"github.com/benchttp/sdk/internal/errorutil"
 )
 
-// Representation is a raw data model for formatted runner config (json, yaml).
+// representation is a raw data model for formatted runner config (json, yaml).
 // It serves as a receiver for unmarshaling processes and for that reason
 // its types are kept simple (certain types are incompatible with certain
 // unmarshalers).
 // It exposes a method Unmarshal to convert its values into a runner.Config.
-type Representation struct {
+type representation struct {
 	Extends *string `yaml:"extends" json:"extends"`
 
 	Request struct {
@@ -49,14 +49,14 @@ type Representation struct {
 	} `yaml:"tests" json:"tests"`
 }
 
-func (repr Representation) validate() error {
-	return repr.Into(&benchttp.Runner{})
+func (repr representation) validate() error {
+	return repr.parseAndMutate(&benchttp.Runner{})
 }
 
-// Into parses the Representation receiver as a benchttp.Runner
+// parseAndMutate parses the Representation receiver as a benchttp.Runner
 // and stores any non-nil field value into the corresponding field
 // of dst.
-func (repr Representation) Into(dst *benchttp.Runner) error {
+func (repr representation) parseAndMutate(dst *benchttp.Runner) error {
 	if err := repr.parseRequestInto(dst); err != nil {
 		return err
 	}
@@ -66,7 +66,7 @@ func (repr Representation) Into(dst *benchttp.Runner) error {
 	return repr.parseTestsInto(dst)
 }
 
-func (repr Representation) parseRequestInto(dst *benchttp.Runner) error {
+func (repr representation) parseRequestInto(dst *benchttp.Runner) error {
 	if dst.Request == nil {
 		dst.Request = &http.Request{}
 	}
@@ -103,7 +103,7 @@ func (repr Representation) parseRequestInto(dst *benchttp.Runner) error {
 	return nil
 }
 
-func (repr Representation) parseRunnerInto(dst *benchttp.Runner) error {
+func (repr representation) parseRunnerInto(dst *benchttp.Runner) error {
 	if requests := repr.Runner.Requests; requests != nil {
 		dst.Requests = *requests
 	}
@@ -139,7 +139,7 @@ func (repr Representation) parseRunnerInto(dst *benchttp.Runner) error {
 	return nil
 }
 
-func (repr Representation) parseTestsInto(dst *benchttp.Runner) error {
+func (repr representation) parseTestsInto(dst *benchttp.Runner) error {
 	testSuite := repr.Tests
 	if len(testSuite) == 0 {
 		return nil
@@ -254,7 +254,7 @@ func requireConfigFields(fields map[string]interface{}) error {
 	return nil
 }
 
-type representations []Representation
+type representations []representation
 
 // mergeInto successively parses the given representations into dst.
 //
@@ -265,7 +265,7 @@ func (reprs representations) mergeInto(dst *benchttp.Runner) error {
 	}
 
 	for _, repr := range reprs {
-		if err := repr.Into(dst); err != nil {
+		if err := repr.parseAndMutate(dst); err != nil {
 			return errorutil.WithDetails(ErrFileParse, err)
 		}
 	}

configio/yaml.go

@@ -14,7 +14,7 @@ import (
 
 // UnmarshalYAML parses the YAML-encoded data and stores the result
 // in the Representation pointed to by dst.
-func UnmarshalYAML(in []byte, dst *Representation) error {
+func UnmarshalYAML(in []byte, dst *representation) error {
 	dec := NewYAMLDecoder(bytes.NewReader(in))
 	return dec.Decode(dst)
 }
@@ -35,7 +35,7 @@ func NewYAMLDecoder(r io.Reader) YAMLDecoder {
 
 // Decode reads the next YAML-encoded value from its input
 // and stores it in the Representation pointed to by dst.
-func (d YAMLDecoder) Decode(dst *Representation) error {
+func (d YAMLDecoder) Decode(dst *representation) error {
 	decoder := yaml.NewDecoder(d.r)
 	decoder.KnownFields(true)
 	return d.handleError(decoder.Decode(dst))
@@ -44,11 +44,11 @@ func (d YAMLDecoder) Decode(dst *Representation) error {
 // Decode reads the next YAML-encoded value from its input
 // and stores it in the benchttp.Runner pointed to by dst.
 func (d YAMLDecoder) DecodeRunner(dst *benchttp.Runner) error {
-	repr := Representation{}
+	repr := representation{}
 	if err := d.Decode(&repr); err != nil {
 		return err
 	}
-	return repr.Into(dst)
+	return repr.parseAndMutate(dst)
 }
 
 // handleError handles a raw yaml decoder.Decode error, filters it,