New CsvOption - TagKey (#28)

* feat: add tag key option

* feat: default tag key const

* feat: add tag key info to readme

* feat: more consistent readme wording

README.md

@@ -46,6 +46,7 @@ err  := csvtag.LoadFromPath(
 	csvtag.CsvOptions{                            // Load your csv with optional options
 		Separator: ';',                           // changes the values separator, default to ','
 		Header: []string{"name", "ID", "number"}, // specify custom headers
+		TagKey: "csv",                            // specify a custom tag key, default to 'csv'
 })
 ```
 

csvtag.go

@@ -4,4 +4,7 @@ package csvtag
 type CsvOptions struct {
 	Separator rune
 	Header    []string
+	TagKey    string
 }
+
+const DefaultTagKey string = "csv"

csvtag_test.go

@@ -25,3 +25,24 @@ func TestDumpAndLoad(t *testing.T) {
 		t.Fail()
 	}
 }
+
+func TestDumpAndLoadTagKey(t *testing.T) {
+	str, err := DumpToString(tabTestTagKey, CsvOptions{TagKey: "json"})
+	if err != nil {
+		fmt.Println(err)
+		t.Fail()
+	}
+
+	tabT := []testTagKey{}
+	err = LoadFromString(str, &tabT, CsvOptions{TagKey: "json"})
+	if err != nil {
+		fmt.Println(err)
+		t.Fail()
+	}
+
+	if tabT[0].ID != tabTestTagKey[0].ID ||
+		tabT[0].Name != tabTestTagKey[0].Name ||
+		tabT[0].Num != tabTestTagKey[0].Num {
+		t.Fail()
+	}
+}

dump.go

@@ -30,10 +30,14 @@ func DumpToWriter(slice interface{}, writer io.Writer, options ...CsvOptions) er
 		option = options[0]
 	}
 
+	if option.TagKey == "" {
+		option.TagKey = DefaultTagKey
+	}
+
 	// Generate the header.
 	if option.Header == nil {
 		for i := 0; i < reflectedValue.Type().Elem().NumField(); i++ {
-			name := reflectedValue.Type().Elem().Field(i).Tag.Get("csv")
+			name := reflectedValue.Type().Elem().Field(i).Tag.Get(option.TagKey)
 			if name != "" {
 				option.Header = append(option.Header, name)
 			}
@@ -58,7 +62,7 @@ func DumpToWriter(slice interface{}, writer io.Writer, options ...CsvOptions) er
 		for j := 0; j < reflectedValue.Type().Elem().NumField(); j++ {
 			valueRv := reflectedValue.Index(i)
 			value := valueRv.Field(j)
-			tag := valueRv.Type().Field(j).Tag.Get("csv")
+			tag := valueRv.Type().Field(j).Tag.Get(option.TagKey)
 
 			if tag == "" {
 				continue

dump_test.go

@@ -10,6 +10,10 @@ var tabTest = []test{
 	{"name", 1, 0.000001},
 }
 
+var tabTestTagKey = []testTagKey{
+	{"name", 1, 0.000001},
+}
+
 var tabTestNoID = []testNoID{
 	{"name", 1, 0.000001},
 }

load.go

@@ -38,6 +38,10 @@ func LoadFromReader(file io.Reader, destination interface{}, options ...CsvOptio
 		option = options[0]
 	}
 
+	if option.TagKey == "" {
+		option.TagKey = DefaultTagKey
+	}
+
 	header, content, err := readFile(file, option.Separator, option.Header)
 	if err != nil {
 		return fmt.Errorf("error reading csv from io.Reader: %v", err)
@@ -48,7 +52,7 @@ func LoadFromReader(file io.Reader, destination interface{}, options ...CsvOptio
 		return nil
 	}
 
-	err = mapToDestination(header, content, destination)
+	err = mapToDestination(header, content, destination, option.TagKey)
 	if err != nil {
 		return fmt.Errorf("error mapping the content to the destination\n	==> %v", err)
 	}
@@ -166,7 +170,7 @@ func skipBOM(file io.Reader) io.Reader {
 // @param header: the csv header to match with the struct's tags.
 // @param content: the content to put in destination.
 // @param destination: the destination where to put the file's content.
-func mapToDestination(header []string, content [][]string, destination interface{}) error {
+func mapToDestination(header []string, content [][]string, destination interface{}, tagKey string) error {
 	if destination == nil {
 		return fmt.Errorf("destination slice is nil")
 	}
@@ -192,7 +196,7 @@ func mapToDestination(header []string, content [][]string, destination interface
 		emptyStruct := sliceRv.Index(i)
 
 		for j := 0; j < emptyStruct.NumField(); j++ {
-			propertyTag := emptyStruct.Type().Field(j).Tag.Get("csv")
+			propertyTag := emptyStruct.Type().Field(j).Tag.Get(tagKey)
 			if propertyTag == "" {
 				continue
 			}

load_test.go

@@ -10,6 +10,12 @@ type test struct {
 	Num  float64 `csv:"header3"`
 }
 
+type testTagKey struct {
+	Name string  `json:"header1"`
+	ID   int     `json:"header2"`
+	Num  float64 `json:"header3"`
+}
+
 type testNoID struct {
 	Name string `csv:"header1"`
 	ID   int