Merge pull request #40 from elcengine/test/increase-coverage

fix: increased test coverage and improved filter query perf

Author: Akalanka47000

core/cluster.go

@@ -1,3 +1,5 @@
+//go:build nocover
+
 package elemental
 
 import (
@@ -105,3 +107,8 @@ func (c ClusterOp[T]) Exec() any {
 	}
 	return **c.result
 }
+
+// This feature is still experimental and not fully implemented.
+func (m Model[T]) UseCluster(connection *string) ClusterOp[T] {
+	return Cluster(&m, connection)
+}

core/cluster_utils.go

@@ -1,3 +1,5 @@
+//go:build nocover
+
 package elemental
 
 import (

core/model.go

@@ -2,11 +2,12 @@ package elemental
 
 import (
 	"context"
-	"github.com/elcengine/elemental/utils"
-	"github.com/spf13/cast"
 	"reflect"
 	"strings"
 
+	"github.com/elcengine/elemental/utils"
+	"github.com/spf13/cast"
+
 	"github.com/gertd/go-pluralize"
 	"github.com/samber/lo"
 	"go.mongodb.org/mongo-driver/bson"
@@ -234,30 +235,27 @@ func (m Model[T]) Sort(args ...any) Model[T] {
 // Extends the query with a projection stage.
 // The projection stage is used to specify which fields to include or exclude from the results.
 func (m Model[T]) Select(fields ...any) Model[T] {
+	inputType := reflect.TypeOf(fields[0]).Kind()
+	if inputType == reflect.Map {
+		m.pipeline = append(m.pipeline, bson.D{{Key: "$project", Value: fields[0]}})
+		return m
+	}
 	var selection []string
 	switch {
-	case len(fields) == 1 && reflect.TypeOf(fields[0]).Kind() == reflect.String:
+	case inputType == reflect.Slice:
+		selection = fields[0].([]string)
+	case len(fields) == 1 && inputType == reflect.String:
 		selection = strings.FieldsFunc(fields[0].(string), func(r rune) bool {
 			return r == ',' || r == ' '
 		})
 	case len(fields) > 1:
-		selection = utils.CastSlice[string](fields)
-	case reflect.TypeOf(fields[0]).Kind() == reflect.Slice:
-		selection = fields[0].([]string)
+		selection = cast.ToStringSlice(fields)
 	}
-
-	switch {
-	case len(selection) > 0:
-		for _, field := range selection {
-			if strings.HasPrefix(field, "-") {
-				m = m.addToPipeline("$project", field[1:], 0)
-			} else {
-				m = m.addToPipeline("$project", field, 1)
-			}
-		}
-	case reflect.TypeOf(fields[0]).Kind() == reflect.Map:
-		for field, value := range utils.Cast[primitive.M](fields[0]) {
-			m = m.addToPipeline("$project", field, value)
+	for _, field := range selection {
+		if strings.HasPrefix(field, "-") {
+			m = m.addToPipeline("$project", field[1:], 0)
+		} else {
+			m = m.addToPipeline("$project", field, 1)
 		}
 	}
 	return m
@@ -286,8 +284,3 @@ func (m Model[T]) Clone() Model[T] {
 		deletedAtFieldName:  m.deletedAtFieldName,
 	}
 }
-
-// This feature is still experimental and not fully implemented.
-func (m Model[T]) UseCluster(connection *string) ClusterOp[T] {
-	return Cluster(&m, connection)
-}

core/model_query_delete.go

@@ -121,18 +121,16 @@ func (m Model[T]) DeleteMany(query ...primitive.M) Model[T] {
 }
 
 // Enables soft delete for the model.
-func (m Model[T]) EnableSoftDelete() Model[T] {
+func (m *Model[T]) EnableSoftDelete() {
+	m.deletedAtFieldName = "deleted_at"
 	m.softDeleteEnabled = true
-	return m
 }
 
 // Disables soft delete for the model.
-func (m Model[T]) DisableSoftDelete() Model[T] {
+func (m *Model[T]) DisableSoftDelete() {
 	m.softDeleteEnabled = false
-	return m
 }
 
 func (m Model[T]) softDeletePayload() primitive.M {
-	m.deletedAtFieldName = "deleted_at"
 	return primitive.M{m.deletedAtFieldName: time.Now().Format(time.RFC3339)}
 }

plugins/filterquery/filterquery.go

@@ -36,7 +36,7 @@ func Parse(qs string) Result {
 		}
 		pair := strings.Split(query, "=")
 		key := pair[0]
-		value := pair[1]
+		value := strings.Join(pair[1:], "=")
 		if strings.Contains(key, "filter") {
 			if filterKey := extractFieldName(key); filterKey != "" {
 				result.Filters[filterKey] = value

plugins/filterquery/util.go

@@ -25,26 +25,20 @@ func replaceOperator(value string, operator string) string {
 }
 
 func parseOperatorValue(value any, operator string) any {
+	strVal := cast.ToString(value)
 	if operator != "" {
-		value = replaceOperator(cast.ToString(value), operator)
+		strVal = replaceOperator(strVal, operator)
 	}
-	if regexp.MustCompile(`^[0-9]+$`).MatchString(cast.ToString(value)) {
-		value = cast.ToFloat64(value)
-	} else {
-		time, err := cast.ToTimeE(value)
-		switch {
-		case err == nil:
-			value = time
-		case regexp.MustCompile(`^[0-9a-fA-F]{24}$`).MatchString(cast.ToString(value)):
-			value, err = primitive.ObjectIDFromHex(cast.ToString(value))
-			if err != nil {
-				value = cast.ToString(value)
-			}
-		default:
-			value = cast.ToString(value)
-		}
+	if f, err := cast.ToFloat64E(strVal); err == nil {
+		return f
+	}
+	if oid, err := primitive.ObjectIDFromHex(strVal); err == nil {
+		return oid
+	}
+	if t, err := cast.ToTimeE(strVal); err == nil {
+		return t
 	}
-	return value
+	return strVal
 }
 
 func mapValue(value any) any {

tests/core_delete_test.go

@@ -1,6 +1,7 @@
 package tests
 
 import (
+	"context"
 	"testing"
 
 	"go.mongodb.org/mongo-driver/bson/primitive"
@@ -52,6 +53,18 @@ func TestCoreDelete(t *testing.T) {
 			UserModel.DeleteByID(user.ID).Exec()
 			So(UserModel.FindByID(user.ID).Exec(), ShouldBeNil)
 		})
+		Convey("Soft delete a user", func() {
+			UserModel.EnableSoftDelete()
+			defer UserModel.DisableSoftDelete()
+
+			user := UserModel.FindOne(primitive.M{"name": mocks.Vesemir.Name}).ExecPtr()
+			UserModel.DeleteByID(user.ID).Exec()
+			So(UserModel.FindByID(user.ID).Exec(), ShouldBeNil)
+
+			rawUser := map[string]any{}
+			UserModel.Collection().FindOne(context.Background(), primitive.M{"_id": user.ID}).Decode(&rawUser)
+			So(rawUser["deleted_at"], ShouldNotBeNil)
+		})
 		Convey("Delete all remaining users", func() {
 			UserModel.DeleteMany().Exec()
 			So(UserModel.Find().Exec(), ShouldBeEmpty)

tests/core_read_ops_test.go

@@ -66,6 +66,10 @@ func TestCoreReadOps(t *testing.T) {
 				users := UserModel.Where("age").GreaterThanOrEquals(90).Where("age").LessThanOrEquals(110).ExecTT()
 				So(len(users), ShouldEqual, 2)
 				So(users[0].Name, ShouldEqual, mocks.Geralt.Name)
+
+				users = UserModel.Where("age").GreaterThan(89).Where("age").LessThan(111).ExecTT()
+				So(len(users), ShouldEqual, 2)
+				So(users[0].Name, ShouldEqual, mocks.Geralt.Name)
 			})
 			Convey("In conjuntion with between", func() {
 				users := UserModel.Where("age").Between(90, 110).ExecTT()
@@ -132,6 +136,12 @@ func TestCoreReadOps(t *testing.T) {
 				So(users[0].Name, ShouldEqual, mocks.Geralt.Name)
 				So(users[1].Name, ShouldEqual, mocks.Imlerith.Name)
 			})
+			Convey("In conjuntion with has", func() {
+				users := UserModel.Where("weapons").Has("Battle Axe").ExecTT()
+				So(len(users), ShouldEqual, 2)
+				So(users[0].Name, ShouldEqual, mocks.Geralt.Name)
+				So(users[1].Name, ShouldEqual, mocks.Imlerith.Name)
+			})
 		})
 		Convey(fmt.Sprintf("Find where weapon count is %d", len(mocks.Geralt.Weapons)), func() {
 			users := UserModel.Where("weapons").Size(len(mocks.Geralt.Weapons)).ExecTT()

tests/core_read_select_test.go

@@ -67,6 +67,10 @@ func TestCoreReadSelect(t *testing.T) {
 				users := UserModel.Find().Select("name, -_id").Limit(limit).ExecTT()
 				assert(users)
 			})
+			Convey("In conjunction with variadic arguments", func() {
+				users := UserModel.Find().Select("name", "-_id").Limit(limit).ExecTT()
+				assert(users)
+			})
 		})
 		Convey(fmt.Sprintf("%d user names and ages", limit), func() {
 			assert := func(users []User) {

tests/core_read_test.go

@@ -95,6 +95,11 @@ func TestCoreRead(t *testing.T) {
 				So(userById, ShouldNotBeNil)
 				So(userById.Name, ShouldEqual, mocks.Ciri.Name)
 			})
+			Convey("Find user by ID (Object ID pointer)", func() {
+				userById := UserModel.FindByID(&user.ID).ExecPtr()
+				So(userById, ShouldNotBeNil)
+				So(userById.Name, ShouldEqual, mocks.Ciri.Name)
+			})
 		})
 		Convey("Count users", func() {
 			count := UserModel.CountDocuments().ExecInt()