basic: GoStringer [WIP]

Signed-off-by: Alejandro Mery <amery@jpi.io>

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "cSpell.words": [
+        "asciigoat",
+        "Subname",
+        "unescapes"
+    ]
+}

basic/error.go

@@ -4,19 +4,28 @@ import (
 	"errors"
 
 	"asciigoat.org/core/lexer"
-	"asciigoat.org/ini/parser"
 )
 
 var (
 	errInvalidToken = errors.New("invalid token")
 )
 
+func newError(pos lexer.Position, content, hint string, err error) *lexer.Error {
+	return &lexer.Error{
+		Line:    pos.Line,
+		Column:  pos.Column,
+		Content: content,
+		Hint:    hint,
+		Err:     err,
+	}
+}
+
 func newErrInvalidToken(t *token) *lexer.Error {
-	return parser.NewError(t.pos, t.value, "", errInvalidToken)
+	return newError(t.pos, t.value, "", errInvalidToken)
 }
 
 func (dec *decoder) OnError(pos lexer.Position, content string, err error) error {
-	err = parser.NewError(pos, content, "", err)
+	err = newError(pos, content, "", err)
 	dec.executeFinal()
 	return err
 }

basic/write.go

@@ -53,6 +53,12 @@ func (field Field) String() string {
 	return buf.String()
 }
 
+// GoString generates a string output for "%#v"
+func (*Field) GoString() string {
+	var buf bytes.Buffer
+	return buf.String()
+}
+
 func writeSectionToBuffer(w *bytes.Buffer, sec *Section, nl string) int {
 	var written, n int
 
@@ -90,6 +96,12 @@ func (sec *Section) String() string {
 	return buf.String()
 }
 
+// GoString generates a string output for "%#v"
+func (*Section) GoString() string {
+	var buf bytes.Buffer
+	return buf.String()
+}
+
 // WriteTo writes a INI representation of the document
 // onto the provided writer.
 func (doc *Document) WriteTo(w io.Writer) (int64, error) {
@@ -102,3 +114,9 @@ func (doc *Document) String() string {
 	buf := doc.AsBuffer(WriteNewLine)
 	return buf.String()
 }
+
+// GoString generates a string output for "%#v"
+func (Document) GoString() string {
+	var buf bytes.Buffer
+	return buf.String()
+}

decoder.go

@@ -0,0 +1,49 @@
+package ini
+
+import (
+	"bytes"
+	"io"
+	"strings"
+
+	"asciigoat.org/core"
+	"asciigoat.org/ini/parser"
+)
+
+// Decoder ...
+type Decoder struct {
+	io.Closer
+
+	p *parser.Parser
+}
+
+// Decode ...
+func (dec *Decoder) Decode() error {
+	defer dec.Close()
+
+	return dec.p.Run()
+}
+
+// NewDecoder creates a Decoder over the provided [io.Reader]
+func NewDecoder(r io.Reader) *Decoder {
+	rc := core.NewReadCloser(r)
+	switch {
+	case rc == nil:
+		return nil
+	default:
+		dec := &Decoder{
+			p:      parser.NewParser(rc),
+			Closer: rc,
+		}
+		return dec
+	}
+}
+
+// NewDecoderBytes creates a Decoder over a provided bytes array
+func NewDecoderBytes(b []byte) *Decoder {
+	return NewDecoder(bytes.NewReader(b))
+}
+
+// NewDecoderString creates a Decoder over a provided string of data
+func NewDecoderString(s string) *Decoder {
+	return NewDecoder(strings.NewReader(s))
+}

go.mod

@@ -2,6 +2,11 @@ module asciigoat.org/ini
 
 go 1.19
 
+replace (
+	asciigoat.org/core => ../core
+	darvaza.org/core => ../../darvaza.org/core
+)
+
 require (
 	asciigoat.org/core v0.3.9
 	github.com/mgechev/revive v1.3.3

go.sum

@@ -1,5 +1,3 @@
-asciigoat.org/core v0.3.9 h1:hgDDz4ecm3ZvehX++m8A/IzAt+B5oDPiRtxatzfUHPQ=
-asciigoat.org/core v0.3.9/go.mod h1:CAaHwyw8MpAq4a1MYtN2dxJrsK+hmIdW50OndaQZYPI=
 github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/chavacava/garif v0.1.0 h1:2JHa3hbYf5D9dsgseMKAmc/MZ109otzgNFk5s87H9Pc=

parser/error.go

@@ -1,27 +0,0 @@
-package parser
-
-import (
-	"asciigoat.org/core/lexer"
-)
-
-// NewError creates a lexer.Error using a lexer.Position
-func NewError(pos lexer.Position, content, hint string, err error) *lexer.Error {
-	return &lexer.Error{
-		Line:    pos.Line,
-		Column:  pos.Column,
-		Content: content,
-		Hint:    hint,
-		Err:     err,
-	}
-}
-
-// ErrPlusPosition returns a copy of the given [lexer.Error]
-// offsetting the Line/Column information.
-func ErrPlusPosition(pos lexer.Position, e *lexer.Error) *lexer.Error {
-	pos.Add(lexer.Position{
-		Line:   e.Line,
-		Column: e.Column,
-	})
-
-	return NewError(pos, e.Content, e.Hint, e.Err)
-}

parser/parser.go

@@ -31,7 +31,13 @@ func defaultOnToken(pos lexer.Position, typ TokenType, value string) error {
 func defaultOnError(pos lexer.Position, content string, err error) error {
 	log.Printf("%s:%v:%v: %q: %s", "error", pos.Line, pos.Column, content, err)
 
-	return NewError(pos, content, "", err)
+	return lexer.Error{
+		Line:   pos.Line,
+		Column: pos.Column,
+
+		Content: content,
+		Err:     err,
+	}
 }
 
 func (p *Parser) setDefaults() {

unmarshal.go

@@ -0,0 +1,15 @@
+package ini
+
+import "io"
+
+// ReadInto ...
+func ReadInto(v any, r io.Reader) error {
+	dec := NewDecoder(r)
+
+	return dec.Unmarshal(v)
+}
+
+// Unmarshal ...
+func (dec *Decoder) Unmarshal(any) error {
+	return dec.p.Run()
+}