align terminology with the one used in encoding/csv

Author: Stefan Tudose

README.md

@@ -21,8 +21,8 @@ Csvdecoder supports converting columns read from the source file into the follow
 - `*uint`, `*uint8`, `*uint16`, `*uint32`, `*uint64`
 - `*bool`
 - `*float32`, `*float64`
-- a slice of values. Note that the CSV record must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
-- an array of values. Note that the CSV record must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
+- a slice of values. Note that the CSV field must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
+- an array of values. Note that the CSV field must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
 - a pointer to any type implementing the `csvdecoder.Interface` interface
 
 ## Usage
@@ -91,7 +91,7 @@ See also the example files for more usage examples.
 The behavior of the decoder can be configured by passing one of following options when creating the decoder:
 - Comma: the character that separates values. Default value is comma.
 - IgnoreHeaders: if set to true, the first line will be ignored. This is useful when the CSV file contains a header line.
-- IgnoreUnmatchingFields: if set to true, the number of records and scan targets are allowed to be different. By default, if they don't match exactly it will cause an error.
+- IgnoreUnmatchingFields: if set to true, the number of fields and scan targets are allowed to be different. By default, if they don't match exactly it will cause an error.
 
 ```golang
 	decoder, err := csvdecoder.NewWithConfig(file, csvdecoder.Config{Comma: ';', IgnoreHeaders: true})

convert.go

@@ -27,7 +27,7 @@ func convertAssignValue(dest interface{}, src string) error {
 
 	// check if the destination implements the Decoder interface
 	if decoder, ok := dest.(Interface); ok {
-		return decoder.DecodeRecord(src)
+		return decoder.DecodeField(src)
 	}
 
 	var sv reflect.Value

decoder.go

@@ -18,7 +18,7 @@ type Decoder struct {
 type Config struct {
 	Comma                  rune // the character that separates values. Default value is comma.
 	IgnoreHeaders          bool // if set to true, the first line will be ignored
-	IgnoreUnmatchingFields bool // if set to true, the number of records and scan targets are allowed to be different
+	IgnoreUnmatchingFields bool // if set to true, the number of fields and scan targets are allowed to be different
 }
 
 // New returns a new CSV decoder that reads from r.
@@ -57,7 +57,7 @@ func newDecoder(reader io.Reader, config Config) (*Decoder, error) {
 // at by dest.
 // With the default behavior, it will throw an error if the number of values in dest
 // is different from the number of values. If the `IgnoreUnmatchingFields` flag is
-// set, it will ignore the records and the arguments that have no match.
+// set, it will ignore the fields and the arguments that have no match.
 //
 // Scan converts columns read from the source into the following
 // types:
@@ -80,15 +80,15 @@ func (p *Decoder) Scan(dest ...interface{}) error {
 	case p.currentRowValues == nil:
 		return ErrNextNotCalled
 	case !p.config.IgnoreUnmatchingFields && len(p.currentRowValues) != len(dest):
-		return fmt.Errorf("%w: got %d scan targets and %d records",
+		return fmt.Errorf("%w: got %d scan targets and %d fields",
 			ErrScanTargetsNotMatch,
 			len(dest),
 			len(p.currentRowValues),
 		)
 	}
 	for i, val := range p.currentRowValues {
 		if i >= len(dest) {
-			// ignore the remaining records as they have no scan target
+			// ignore the remaining fields as they have no scan target
 			break
 		}
 		err := convertAssignValue(dest[i], val)

decoder_interface_test.go

@@ -9,7 +9,7 @@ type MyDecoder struct {
 	value string
 }
 
-func (d *MyDecoder) DecodeRecord(value string) error {
+func (d *MyDecoder) DecodeField(value string) error {
 	d.value = value + "!"
 	return nil
 }
@@ -33,8 +33,8 @@ func TestDecoderStruct(t *testing.T) {
 		{
 			name:     "should work for a struct using the Decoder interface",
 			dest:     MyDecoder{},
-			data:     "record1\n",
-			expected: "record1!",
+			data:     "field1\n",
+			expected: "field1!",
 		},
 	} {
 		tc := tc
@@ -69,8 +69,8 @@ func TestDecoderPointer(t *testing.T) {
 		{
 			name:     "should work for a struct holding a pointer to a decoder",
 			dest:     &MyDecoder{},
-			data:     "record1\n",
-			expected: "record1!",
+			data:     "field1\n",
+			expected: "field1!",
 		},
 	} {
 		tc := tc
@@ -106,8 +106,8 @@ func TestDecoderDoublePointer(t *testing.T) {
 		{
 			name:     "should work for a struct holding a double pointer to a decoder",
 			dest:     &myDec,
-			data:     "record1\n",
-			expected: "record1!",
+			data:     "field1\n",
+			expected: "field1!",
 		},
 	} {
 		tc := tc
@@ -142,8 +142,8 @@ func TestDecoderInterface(t *testing.T) {
 		{
 			name:     "should work for a struct using the Decoder interface",
 			dest:     &MyDecoder{},
-			data:     "record1\n",
-			expected: "record1!",
+			data:     "field1\n",
+			expected: "field1!",
 		},
 	} {
 		tc := tc

decoder_test.go

@@ -53,7 +53,7 @@ func TestIgnoreUnmatchingFields(t *testing.T) {
 			expectedError: nil,
 		},
 		{
-			name: "should work with more records when the flag is true",
+			name: "should work with more fields when the flag is true",
 			config: Config{
 				IgnoreUnmatchingFields: true,
 			},
@@ -71,7 +71,7 @@ func TestIgnoreUnmatchingFields(t *testing.T) {
 			expectedError: ErrScanTargetsNotMatch,
 		},
 		{
-			name: "should fail with more records when the flag is false",
+			name: "should fail with more fields when the flag is false",
 			config: Config{
 				IgnoreUnmatchingFields: false,
 			},
@@ -87,7 +87,7 @@ func TestIgnoreUnmatchingFields(t *testing.T) {
 			expectedError: ErrScanTargetsNotMatch,
 		},
 		{
-			name:          "should fail with more records with the default config",
+			name:          "should fail with more fields with the default config",
 			config:        Config{},
 			data:          "rec,2\n",
 			scanTargets:   []interface{}{&strVal},

doc.go

@@ -12,8 +12,8 @@
 // - `*uint`, `*uint8`, `*uint16`, `*uint32`, `*uint64`
 // - `*bool`
 // - `*float32`, `*float64`
-// - a slice of values. Note that the CSV record must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
-// - an array of values. Note that the CSV record must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
+// - a slice of values. Note that the CSV field must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
+// - an array of values. Note that the CSV field must be a valid JSON array. If not a JSON array, a custom decoder implementing the `csvdecoder.Interface` interface must be implemented.
 // - a pointer to any type implementing the `csvdecoder.Interface` interface
 
 // csvdecoder uses the same terminology as package encoding/csv:
@@ -26,7 +26,7 @@
 // The behavior of the decoder can be configured by passing one of following options when creating the decoder:
 // - Comma: the character that separates values. The default value is comma.
 // - IgnoreHeaders: if set to true, the first line will be ignored. This is useful when the CSV file contains a header line.
-// - IgnoreUnmatchingFields: if set to true, the number of records and scan targets are allowed to be different. By default, if they don't match exactly it will cause an error.
+// - IgnoreUnmatchingFields: if set to true, the number of fields and scan targets are allowed to be different. By default, if they don't match exactly it will cause an error.
 
 // See README.md for more info.
 package csvdecoder

errors.go

@@ -6,7 +6,7 @@ import (
 
 var (
 	ErrEOF                 = errors.New("end of file reached") // ErrEOF is thrown if the EOF is reached by the Next method.
-	ErrScanTargetsNotMatch = errors.New("the number of scan targets does not match the number of csv records")
+	ErrScanTargetsNotMatch = errors.New("the number of scan targets does not match the number of csv fields")
 	ErrReadingOccurred     = errors.New("can't continue after a reading error")
 	ErrNextNotCalled       = errors.New("scan called without calling Next")
 

example_custom_decoder_test.go

@@ -13,14 +13,14 @@ type Point struct {
 	Y int
 }
 
-// DecodeRecord implements the csvdecoder.Interface type
-func (p *Point) DecodeRecord(record string) error {
+// DecodeField implements the csvdecoder.Interface type
+func (p *Point) DecodeField(field string) error {
 	// the decode code is specific to the way the object is serialized.
 	// in this example the point is encoded as a JSON array with two values
 
 	data := make([]int, 2)
-	if err := json.NewDecoder(strings.NewReader(record)).Decode(&data); err != nil {
-		return fmt.Errorf("could not parse %s as JSON array: %w", record, err)
+	if err := json.NewDecoder(strings.NewReader(field)).Decode(&data); err != nil {
+		return fmt.Errorf("could not parse %s as JSON array: %w", field, err)
 	}
 
 	(*p).X = data[0]

data/simple.csv example_data/simple.csvdata/simple.csv renamed to example_data/simple.csv

@@ -19,7 +19,7 @@ func Example_simple() {
 	//john,44,true
 	//lucy,48,false
 	//mr hyde,34,true
-	file, err := os.Open("./data/simple.csv")
+	file, err := os.Open("./example_data/simple.csv")
 	if err != nil {
 		// handle error
 		return