chore: update dependencies

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

README.md

@@ -16,6 +16,7 @@ of stricter parsers of similar form.
 
 [godoc-lexer]: https://pkg.go.dev/asciigoat.org/core/lexer
 [godoc-parser-parser]: https://pkg.go.dev/asciigoat.org/ini/parser#Parser
+[godoc-basic-parser]: https://pkg.go.dev/asciigoat.org/ini/basic#Decode
 
 [wikipedia-dosini]: https://en.wikipedia.org/wiki/INI_file
 
@@ -25,6 +26,15 @@ of stricter parsers of similar form.
 [`asciigoat`'s lexer][godoc-lexer] to process an `INI`-style document
 emiting tokens and errors via callbacks.
 
+## Basic Parser
+
+[`basic.Decode()`][godoc-basic-parser] provies a one-shot decoder
+that returns a structured document for you to post-process.
+
+To allow for correct handling of repetition of section and field names downstream,
+it uses arrays instead of maps, and makes almost no judgment
+about what section or field names are acceptable.
+
 ## Other Implementations
 
 Other implementations exist, and they are mature and feature-rich, but they

basic/basic.go

@@ -0,0 +1,24 @@
+// Package basic provides a basic representation of dosini-style documents
+package basic
+
+// Document represents an INI-style document
+type Document struct {
+	Global []Field
+
+	Sections []Section
+}
+
+// Section represents an INI-style section with optional GIT-style IDs
+type Section struct {
+	Key     string
+	ID      string
+	EmptyID bool
+
+	Fields []Field
+}
+
+// Field represents a key = value entry in an INI-style document
+type Field struct {
+	Key   string
+	Value string
+}

basic/decoder.go

@@ -0,0 +1,49 @@
+package basic
+
+import (
+	"bytes"
+	"io"
+	"io/fs"
+	"strings"
+
+	"asciigoat.org/ini/parser"
+)
+
+type decoder struct {
+	p   *parser.Parser
+	out *Document
+
+	queue   []*token
+	current *Section
+}
+
+// Decode attempts to decode an INI-style from an [io.Reader] array into a [Document]
+func Decode(r io.Reader) (*Document, error) {
+	var out Document
+
+	if r == nil {
+		return nil, fs.ErrNotExist
+	}
+
+	// parser
+	p := parser.NewParser(r)
+	// decoder
+	dec := decoder{p: p, out: &out}
+	// glue
+	p.OnToken = dec.OnToken
+	p.OnError = dec.OnError
+
+	// Go!
+	err := p.Run()
+	return &out, err
+}
+
+// DecodeBytes attempts to decode an INI-style bytes array into a [Document]
+func DecodeBytes(b []byte) (*Document, error) {
+	return Decode(bytes.NewReader(b))
+}
+
+// DecodeString attempts to decode an INI-style string into a [Document]
+func DecodeString(s string) (*Document, error) {
+	return Decode(strings.NewReader(s))
+}

basic/error.go

@@ -0,0 +1,33 @@
+package basic
+
+import (
+	"errors"
+
+	"asciigoat.org/core/lexer"
+)
+
+var (
+	errInvalidToken = errors.New("invalid token")
+)
+
+func newErrInvalidToken(t *token) *lexer.Error {
+	err := &lexer.Error{
+		Line:    t.pos.Line,
+		Column:  t.pos.Column,
+		Content: t.value,
+		Err:     errInvalidToken,
+	}
+	return err
+}
+
+func (dec *decoder) OnError(pos lexer.Position, content string, err error) error {
+	err = &lexer.Error{
+		Line:    pos.Line,
+		Column:  pos.Column,
+		Content: content,
+		Err:     err,
+	}
+
+	dec.executeFinal()
+	return err
+}

basic/token.go

@@ -0,0 +1,154 @@
+package basic
+
+import (
+	"fmt"
+
+	"asciigoat.org/core/lexer"
+	"asciigoat.org/ini/parser"
+)
+
+type token struct {
+	pos   lexer.Position
+	typ   parser.TokenType
+	value string
+}
+
+func (t token) String() string {
+	return fmt.Sprintf("%s %s: %q", t.pos, t.typ, t.value)
+}
+
+func (dec *decoder) executeFinal() {
+	if len(dec.queue) > 0 {
+		// we have unfinished businesses
+		switch dec.queue[0].typ {
+		case parser.TokenSectionStart:
+			dec.execute(parser.TokenSectionEnd)
+		case parser.TokenFieldKey:
+			dec.execute(parser.TokenFieldValue)
+		}
+	}
+}
+
+func (dec *decoder) execute(typ parser.TokenType) {
+	switch typ {
+	case parser.TokenSectionEnd:
+		name1, ok1 := dec.getValue(1, parser.TokenSectionName)
+
+		if ok1 {
+			name2, ok2 := dec.getValue(2, parser.TokenSectionSubname)
+
+			dec.addSection(name1, name2, ok2)
+		}
+
+		dec.reset()
+	case parser.TokenFieldValue:
+		key, _ := dec.getValue(0, parser.TokenFieldKey)
+		value, _ := dec.getValue(1, parser.TokenFieldValue)
+
+		dec.addField(key, value)
+		dec.reset()
+	}
+}
+
+func (dec *decoder) addSection(key, id string, allowEmptyID bool) {
+	emptyID := allowEmptyID && id == ""
+
+	// index for dec.current
+	n := len(dec.out.Sections)
+
+	// new section
+	dec.out.Sections = append(dec.out.Sections, Section{
+		Key:     key,
+		ID:      id,
+		EmptyID: emptyID,
+	})
+
+	// pointer to the latest section
+	dec.current = &dec.out.Sections[n]
+}
+
+func (dec *decoder) addField(key, value string) {
+	field := Field{
+		Key:   key,
+		Value: value,
+	}
+
+	if p := dec.current; p != nil {
+		// in section
+		p.Fields = append(p.Fields, field)
+	} else {
+		// global
+		dec.out.Global = append(dec.out.Global, field)
+	}
+}
+
+func (dec *decoder) getValue(idx int, typ parser.TokenType) (string, bool) {
+	switch {
+	case idx < 0 || idx >= len(dec.queue):
+		// out of range
+		return "", false
+	case dec.queue[idx].typ != typ:
+		// wrong type
+		return "", false
+	default:
+		return dec.queue[idx].value, true
+	}
+}
+
+func (dec *decoder) reset() {
+	dec.queue = dec.queue[:0]
+}
+
+func (dec *decoder) depth(depth int) bool {
+	return len(dec.queue) == depth
+}
+
+func (dec *decoder) depthAfter(depth int, typ parser.TokenType) bool {
+	_, ok := dec.getValue(depth-1, typ)
+	if ok {
+		return len(dec.queue) == depth
+	}
+	return false
+}
+
+func (dec *decoder) typeOK(typ parser.TokenType) bool {
+	switch typ {
+	case parser.TokenSectionStart, parser.TokenFieldKey:
+		// first token only
+		return dec.depth(0)
+	case parser.TokenSectionName:
+		// right after TokenSectionStart
+		return dec.depthAfter(1, parser.TokenSectionStart)
+	case parser.TokenSectionSubname:
+		// right after TokenSectionName
+		return dec.depthAfter(2, parser.TokenSectionName)
+	case parser.TokenSectionEnd:
+		// only on a section with name
+		_, ok := dec.getValue(1, parser.TokenSectionName)
+		return ok
+	case parser.TokenFieldValue:
+		// right after a TokenFieldKey
+		return dec.depthAfter(1, parser.TokenFieldKey)
+	default:
+		// never
+		return false
+	}
+}
+
+func (dec *decoder) OnToken(pos lexer.Position, typ parser.TokenType, value string) error {
+	t := &token{pos, typ, value}
+
+	switch {
+	case typ == parser.TokenComment:
+		// ignore comments
+		return nil
+	case dec.typeOK(typ):
+		// acceptable token
+		dec.queue = append(dec.queue, t)
+		dec.execute(typ)
+		return nil
+	default:
+		// unacceptable
+		return newErrInvalidToken(t)
+	}
+}

basic/write.go

@@ -0,0 +1,104 @@
+package basic
+
+import (
+	"bytes"
+	"fmt"
+	"io"
+
+	"asciigoat.org/ini/parser"
+)
+
+// WriteNewLine is the new line representation used by [doc.WriteTo]
+const WriteNewLine = "\n"
+
+// AsBuffer returns a INI representation of the document on
+// a memory buffer
+func (doc *Document) AsBuffer(nl string) *bytes.Buffer {
+	var buf bytes.Buffer
+
+	if len(doc.Global) > 0 {
+		_, _ = writeFieldsTo(&buf, doc.Global, nl)
+	}
+
+	for _, sec := range doc.Sections {
+		if buf.Len() > 0 {
+			_, _ = buf.WriteString(nl)
+		}
+
+		_ = writeSectionToBuffer(&buf, &sec, nl)
+	}
+
+	return &buf
+}
+
+func writeFieldsTo(w io.Writer, fields []Field, nl string) (int64, error) {
+	var written int
+	for _, field := range fields {
+		n, err := fmt.Fprintf(w, "%s = %q%s", field.Key, field.Value, nl)
+		switch {
+		case err != nil:
+			return int64(written), err
+		case n > 0:
+			written += n
+		}
+	}
+	return int64(written), nil
+}
+
+// String generates a string output for "%s"
+func (field Field) String() string {
+	var buf bytes.Buffer
+
+	_, _ = writeFieldsTo(&buf, []Field{field}, WriteNewLine)
+	return buf.String()
+}
+
+func writeSectionToBuffer(w *bytes.Buffer, sec *Section, nl string) int {
+	var written, n int
+
+	_, _ = w.WriteRune(parser.RuneSectionStart)
+	written++
+
+	n, _ = w.WriteString(sec.Key)
+	written += n
+
+	switch {
+	case sec.EmptyID:
+		n, _ = w.WriteString(" \"\"")
+		written += n
+	case sec.ID != "":
+		_, _ = w.WriteRune(' ')
+		n, _ = fmt.Fprintf(w, "%q", sec.ID)
+		written += n + 1
+	}
+
+	_, _ = w.WriteRune(parser.RuneSectionEnd)
+	written++
+
+	n, _ = w.WriteString(nl)
+	written += n
+
+	n64, _ := writeFieldsTo(w, sec.Fields, nl)
+	return written + int(n64)
+}
+
+// String generates a string output for "%s"
+func (sec *Section) String() string {
+	var buf bytes.Buffer
+
+	_ = writeSectionToBuffer(&buf, sec, WriteNewLine)
+	return buf.String()
+}
+
+// WriteTo writes a INI representation of the document
+// onto the provided writer.
+func (doc *Document) WriteTo(w io.Writer) (int64, error) {
+	buf := doc.AsBuffer(WriteNewLine)
+	return buf.WriteTo(w)
+}
+
+// String generates a string output for "%s"
+func (doc *Document) String() string {
+	buf := doc.AsBuffer(WriteNewLine)
+	return buf.String()
+}

go.mod

@@ -3,23 +3,24 @@ module asciigoat.org/ini
 go 1.19
 
 require (
-	asciigoat.org/core v0.3.6
+	asciigoat.org/core v0.3.7
 	github.com/mgechev/revive v1.3.3
 	golang.org/x/tools v0.12.0
 )
 
 require (
 	github.com/BurntSushi/toml v1.3.2 // indirect
-	github.com/chavacava/garif v0.0.0-20230608123814-4bd63c2919ab // indirect
+	github.com/chavacava/garif v0.1.0 // indirect
 	github.com/fatih/color v1.15.0 // indirect
 	github.com/fatih/structtag v1.2.0 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.19 // indirect
-	github.com/mattn/go-runewidth v0.0.9 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/mgechev/dots v0.0.0-20210922191527-e955255bf517 // indirect
 	github.com/mitchellh/go-homedir v1.1.0 // indirect
 	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/rivo/uniseg v0.4.4 // indirect
 	golang.org/x/mod v0.12.0 // indirect
 	golang.org/x/sys v0.11.0 // indirect
 )

go.sum

@@ -1,9 +1,9 @@
-asciigoat.org/core v0.3.6 h1:b1vL090OxylmSOwLQryjrmC8FhhCtktMyeJSy1e6LwI=
-asciigoat.org/core v0.3.6/go.mod h1:tXj+JUutxRbcO40ZQRuUVaZ4rnYz1kAZ0nblisV8u74=
+asciigoat.org/core v0.3.7 h1:tMasdvZgsMJJMVsZVfXXB5lqq82pFiCsyEmOEmcmAfI=
+asciigoat.org/core v0.3.7/go.mod h1:tXj+JUutxRbcO40ZQRuUVaZ4rnYz1kAZ0nblisV8u74=
 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.0.0-20230608123814-4bd63c2919ab h1:5JxePczlyGAtj6R1MUEFZ/UFud6FfsOejq7xLC2ZIb0=
-github.com/chavacava/garif v0.0.0-20230608123814-4bd63c2919ab/go.mod h1:XMyYCkEL58DF0oyW4qDjjnPWONs2HBqYKI+UIPD+Gww=
+github.com/chavacava/garif v0.1.0 h1:2JHa3hbYf5D9dsgseMKAmc/MZ109otzgNFk5s87H9Pc=
+github.com/chavacava/garif v0.1.0/go.mod h1:XMyYCkEL58DF0oyW4qDjjnPWONs2HBqYKI+UIPD+Gww=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -16,8 +16,9 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
-github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
 github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/mattn/go-runewidth v0.0.15 h1:UNAjwbU9l54TA3KzvqLGxwWjHmMgBUVhBiTjelZgg3U=
+github.com/mattn/go-runewidth v0.0.15/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/mgechev/dots v0.0.0-20210922191527-e955255bf517 h1:zpIH83+oKzcpryru8ceC6BxnoG8TBrhgAvRg8obzup0=
 github.com/mgechev/dots v0.0.0-20210922191527-e955255bf517/go.mod h1:KQ7+USdGKfpPjXk4Ga+5XxQM4Lm4e3gAogrreFAYpOg=
 github.com/mgechev/revive v1.3.3 h1:GUWzV3g185agbHN4ZdaQvR6zrLVYTUSA2ktvIinivK0=
@@ -30,6 +31,9 @@ github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis=
+github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=