v0.0.1

Author: why2go

README.md

@@ -1,2 +1,78 @@
-# csv_reader
-read csv file and unmarshal data to golang structs
+# csv_parser
+Csv parser can read from csv file and then parse record to golang structs.
+
+
+
+## Getting start
+
+### Installation
+
+```
+go get github.com/why2go/csv_parser
+```
+
+### Supported field types
+
+1. primitive types: bool, int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64, string.
+
+2. pointer of primitive types.
+
+3. slice: whose element's type is primitive type or pointer of primitive type.
+
+4. map: whose key's type is string and value's type is primitive type or pointer of primitive type.
+
+### Example
+
+```go
+package main
+
+import (
+	"bytes"
+	"context"
+	"encoding/csv"
+	"encoding/json"
+	"fmt"
+
+	"github.com/why2go/csv_parser"
+)
+
+func main() {
+	data := `name,{{attri:age}},{{attri:height}},[[msg]],[[msg]]
+Alice,20,,"Hi, I'm Alice.",Nice to meet you!
+Bob,21,175,"Hi, I'm Bob.",Nice to meet you!
+Candy,,189,"Hi, I'm Candy.",Nice to meet you!
+David,23,172,"Hi, I'm David.",Nice to meet you!
+`
+	type Demo struct {
+		Name  string            `csv:"name,required" json:"name"`
+		Attri map[string]*int16 `csv:"attri" json:"attri"`
+		Msg   []string          `csv:"msg" json:"msg"`
+	}
+
+	r := csv.NewReader(bytes.NewBufferString(data))
+	parser, err := csv_parser.NewCsvParser[Demo](r)  // create a csv parser
+	if err != nil {
+		panic(err)
+	}
+	defer parser.Close()	// close the parser
+
+  // get parsed data from channel
+	for dataWrapper := range parser.DataChan(context.Background()) {
+		if err != nil {
+			panic(err)
+		}
+		b, err := json.Marshal(dataWrapper.Data)
+		if err != nil {
+			panic(err)
+		}
+		fmt.Printf("demo: %s\n", string(b))
+	}
+
+	fmt.Printf("done\n")
+}
+```
+
+
+
+
+

doc.go

@@ -0,0 +1,7 @@
+// Copyright 2023 Sun Zhi. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+// The csv parser is used to parse a csv file into go structs.
+
+package csv_parser

go.mod

@@ -0,0 +1,11 @@
+module github.com/why2go/csv_parser
+
+go 1.21.5
+
+require github.com/stretchr/testify v1.8.4
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

go.sum

@@ -0,0 +1,10 @@
+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=
+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/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=