chore: update dependencies

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

basic/basic.go

@@ -1,2 +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/token.go

@@ -50,15 +50,17 @@ func (dec *decoder) execute(typ parser.TokenType) {
 	}
 }
 
-func (dec *decoder) addSection(name, key string, hadKey bool) {
+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{
-		Name:   name,
-		Key:    key,
-		HadKey: hadKey,
+		Key:     key,
+		ID:      id,
+		EmptyID: emptyID,
 	})
 
 	// pointer to the latest section

basic/types.go

@@ -1,23 +0,0 @@
-package basic
-
-// Document ...
-type Document struct {
-	Global []Field
-
-	Sections []Section
-}
-
-// Section ...
-type Section struct {
-	Name   string
-	Key    string
-	HadKey bool
-
-	Fields []Field
-}
-
-// Field ...
-type Field struct {
-	Key   string
-	Value string
-}

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()
+}

decoder.go

@@ -1,49 +0,0 @@
-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,8 +2,6 @@ module asciigoat.org/ini
 
 go 1.19
 
-replace asciigoat.org/core => ../core
-
 require (
 	asciigoat.org/core v0.3.7
 	github.com/mgechev/revive v1.3.3
@@ -12,16 +10,17 @@ require (
 
 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,7 +1,9 @@
+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=
@@ -14,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=
@@ -28,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=

unmarshal.go

@@ -1,15 +0,0 @@
-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()
-}