Fix linter complaints

contracts.go

@@ -5,11 +5,11 @@ import (
 	"fmt"
 )
 
-// EntityNotFoundErr ...
+// ErrRecordNotFound ...
-var EntityNotFoundErr error = fmt.Errorf("kissorm: the query returned no results")
+var ErrRecordNotFound error = fmt.Errorf("kissorm: the query returned no results")
 
-// AbortIteration ...
+// ErrAbortIteration ...
-var AbortIteration error = fmt.Errorf("kissorm: abort iteration, should only be used inside QueryChunks function")
+var ErrAbortIteration error = fmt.Errorf("kissorm: abort iteration, should only be used inside QueryChunks function")
 
 // ORMProvider describes the public behavior of this ORM
 type ORMProvider interface {
@@ -22,6 +22,7 @@ type ORMProvider interface {
 	QueryChunks(ctx context.Context, parser ChunkParser) error
 }
 
+// ChunkParser stores the arguments of the QueryChunks function
 type ChunkParser struct {
 	// The Query and Params are used together to build a query with
 	// protection from injection, just like when using the Find function.

kiss_orm.go

@@ -82,7 +82,7 @@ func (c Client) Query(
 // the input struct must be passed by reference
 // and the query should return only one result.
 //
-// QueryOne returns a EntityNotFoundErr if
+// QueryOne returns a ErrRecordNotFound if
 // the query returns no results.
 func (c Client) QueryOne(
 	ctx context.Context,
@@ -105,7 +105,7 @@ func (c Client) QueryOne(
 	}
 	it = it.Scan(record)
 	if it.Error != nil && it.Error.Error() == "record not found" {
-		return EntityNotFoundErr
+		return ErrRecordNotFound
 	}
 	return it.Error
 }
@@ -173,7 +173,7 @@ func (c Client) QueryChunks(
 		sliceRef.Elem().Set(slice)
 		err = parser.ForEachChunk()
 		if err != nil {
-			if err == AbortIteration {
+			if err == ErrAbortIteration {
 				return nil
 			}
 			return err
@@ -186,7 +186,7 @@ func (c Client) QueryChunks(
 		sliceRef.Elem().Set(slice.Slice(0, idx))
 		err = parser.ForEachChunk()
 		if err != nil {
-			if err == AbortIteration {
+			if err == ErrAbortIteration {
 				return nil
 			}
 			return err
@@ -336,14 +336,14 @@ func getTagNames(t reflect.Type) structInfo {
 // The first argument is any struct you are passing to a kissorm func,
 // and the second is a map representing a database row you want
 // to use to update this struct.
-func FillStructWith(entity interface{}, dbRow map[string]interface{}) error {
+func FillStructWith(record interface{}, dbRow map[string]interface{}) error {
-	v := reflect.ValueOf(entity)
+	v := reflect.ValueOf(record)
 	t := v.Type()
 
 	if t.Kind() != reflect.Ptr {
 		return fmt.Errorf(
 			"FillStructWith: expected input to be a pointer to struct but got %T",
-			entity,
+			record,
 		)
 	}
 
@@ -353,7 +353,7 @@ func FillStructWith(entity interface{}, dbRow map[string]interface{}) error {
 	if t.Kind() != reflect.Struct {
 		return fmt.Errorf(
 			"FillStructWith: expected input kind to be a struct but got %T",
-			entity,
+			record,
 		)
 	}
 
@@ -373,7 +373,7 @@ func FillStructWith(entity interface{}, dbRow map[string]interface{}) error {
 				"FillStructWith: cannot convert atribute %s of type %v to type %T",
 				colName,
 				fieldType,
-				entity,
+				record,
 			)
 		}
 		field.Set(attrValue.Convert(fieldType))

kiss_orm_test.go

@@ -125,7 +125,7 @@ func TestQueryOne(t *testing.T) {
 		t.Fatal("could not create test table!")
 	}
 
-	t.Run("should return EntityNotFoundErr when there are no results", func(t *testing.T) {
+	t.Run("should return RecordNotFoundErr when there are no results", func(t *testing.T) {
 		db := connectDB(t)
 		defer db.Close()
 
@@ -136,7 +136,7 @@ func TestQueryOne(t *testing.T) {
 		}
 		u := User{}
 		err := c.QueryOne(ctx, &u, `SELECT * FROM users WHERE id=1;`)
-		assert.Equal(t, EntityNotFoundErr, err)
+		assert.Equal(t, ErrRecordNotFound, err)
 	})
 
 	t.Run("should return a user correctly", func(t *testing.T) {
@@ -573,7 +573,7 @@ func TestQueryChunks(t *testing.T) {
 		assert.Equal(t, []int{2, 1}, lengths)
 	})
 
-	t.Run("should abort the first iteration when the callback returns an AbortIteration", func(t *testing.T) {
+	t.Run("should abort the first iteration when the callback returns an ErrAbortIteration", func(t *testing.T) {
 		err := createTable()
 		if err != nil {
 			t.Fatal("could not create test table!")
@@ -604,7 +604,7 @@ func TestQueryChunks(t *testing.T) {
 			ForEachChunk: func() error {
 				lengths = append(lengths, len(buffer))
 				users = append(users, buffer...)
-				return AbortIteration
+				return ErrAbortIteration
 			},
 		})
 
@@ -617,7 +617,7 @@ func TestQueryChunks(t *testing.T) {
 		assert.Equal(t, []int{2}, lengths)
 	})
 
-	t.Run("should abort the last iteration when the callback returns an AbortIteration", func(t *testing.T) {
+	t.Run("should abort the last iteration when the callback returns an ErrAbortIteration", func(t *testing.T) {
 		err := createTable()
 		if err != nil {
 			t.Fatal("could not create test table!")
@@ -636,7 +636,7 @@ func TestQueryChunks(t *testing.T) {
 		_ = c.Insert(ctx, &User{Name: "User2"})
 		_ = c.Insert(ctx, &User{Name: "User3"})
 
-		returnVals := []error{nil, AbortIteration}
+		returnVals := []error{nil, ErrAbortIteration}
 		var lengths []int
 		var users []User
 		var buffer []User