returning directly a pointer

manuelarte · Nov 12, 2024 · 7b6cda2 · 7b6cda2
1 parent 3d0e11d
commit 7b6cda2
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -13,9 +13,8 @@ Gorm plugin to add pagination to your select queries
 ```go
 DB.Use(pagorminator.PaGormMinator{})
 var products []*Products
-// give me the first 10 products
-pageRequest, err := pagorminator.PageRequest(0, 1)
-DB.Clauses(&pageRequest).First(&products)
+pageRequest, err := pagorminator.PageRequest(0, 10)
+DB.Clauses(pageRequest).First(&products)
 ```
 
 The plugin will calculate the total amount of elements so then the fields `total amounts` and `total pages` can be used too.

diff --git a/examples/simple/main.go b/examples/simple/main.go
@@ -33,7 +33,7 @@ func main() {
 	// Read
 	var products []*Product
 	pageRequest, _ := pagorminator.PageRequest(0, 1)
-	db.Clauses(&pageRequest).First(&products)
+	db.Clauses(pageRequest).First(&products)
 	for _, product := range products {
 		fmt.Printf("PageRequest: {Page: %d, Size: %d, TotalElements: %d, TotalPages: %d\n",
 			pageRequest.GetPage(), pageRequest.GetSize(), pageRequest.GetTotalElements(), pageRequest.GetTotalPages())

diff --git a/model.go b/model.go
@@ -19,22 +19,22 @@ var _ clause.Expression = new(Pagination)
 var _ gorm.StatementModifier = new(Pagination)
 
 // PageRequest Create page to query the database
-func PageRequest(page, size int) (Pagination, error) {
+func PageRequest(page, size int) (*Pagination, error) {
 	if page < 0 {
-		return Pagination{}, ErrPageCantBeNegative
+		return nil, ErrPageCantBeNegative
 	}
 	if size < 0 {
-		return Pagination{}, ErrSizeCantBeNegative
+		return nil, ErrSizeCantBeNegative
 	}
 	if page > 0 && size == 0 {
-		return Pagination{}, ErrSizeNotAllowed
+		return nil, ErrSizeNotAllowed
 	}
-	return Pagination{page: page, size: size}, nil
+	return &Pagination{page: page, size: size}, nil
 }
 
 // UnPaged Create an unpaged request (no pagination is applied)
-func UnPaged() Pagination {
-	return Pagination{page: 0, size: 0}
+func UnPaged() *Pagination {
+	return &Pagination{page: 0, size: 0}
 }
 
 // Pagination Clause to apply pagination

diff --git a/pagorminator_test.go b/pagorminator_test.go
@@ -17,15 +17,15 @@ func TestPaginationScopeMetadata_NoWhere(t *testing.T) {
 	t.Parallel()
 	tests := map[string]struct {
 		toMigrate    []*TestStruct
-		pageRequest  Pagination
-		expectedPage Pagination
+		pageRequest  *Pagination
+		expectedPage *Pagination
 	}{
 		"UnPaged one item": {
 			toMigrate: []*TestStruct{
 				{Code: "1"},
 			},
 			pageRequest: UnPaged(),
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          0,
 				totalElements: 1,
@@ -36,7 +36,7 @@ func TestPaginationScopeMetadata_NoWhere(t *testing.T) {
 				{Code: "1", Price: 1}, {Code: "2", Price: 2},
 			},
 			pageRequest: UnPaged(),
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          0,
 				totalElements: 2,
@@ -47,7 +47,7 @@ func TestPaginationScopeMetadata_NoWhere(t *testing.T) {
 				{Code: "1", Price: 1}, {Code: "2", Price: 2},
 			},
 			pageRequest: mustPageRequestOf(1, 1),
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          1,
 				size:          1,
 				totalElements: 2,
@@ -63,7 +63,7 @@ func TestPaginationScopeMetadata_NoWhere(t *testing.T) {
 			// Read
 			var products []*TestStruct
 
-			db.Clauses(&test.pageRequest).Find(&products) // find product with integer primary key
+			db.Clauses(test.pageRequest).Find(&products) // find product with integer primary key
 			if !equalPageRequests(test.pageRequest, test.expectedPage) {
 				t.Fatalf("expected page to be %d, got %d", test.expectedPage, test.pageRequest)
 			}
@@ -75,17 +75,17 @@ func TestPaginationScopeMetadata_Where(t *testing.T) {
 	t.Parallel()
 	tests := map[string]struct {
 		toMigrate    []*TestStruct
-		pageRequest  Pagination
+		pageRequest  *Pagination
 		where        string
-		expectedPage Pagination
+		expectedPage *Pagination
 	}{
 		"UnPaged one item, not filtered": {
 			toMigrate: []*TestStruct{
 				{Code: "1", Price: 1},
 			},
 			pageRequest: UnPaged(),
 			where:       "price < 100",
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          0,
 				totalElements: 1,
@@ -97,7 +97,7 @@ func TestPaginationScopeMetadata_Where(t *testing.T) {
 			},
 			pageRequest: UnPaged(),
 			where:       "price > 100",
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          0,
 				totalElements: 0,
@@ -109,7 +109,7 @@ func TestPaginationScopeMetadata_Where(t *testing.T) {
 			},
 			pageRequest: UnPaged(),
 			where:       "price > 50",
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          0,
 				totalElements: 1,
@@ -122,7 +122,7 @@ func TestPaginationScopeMetadata_Where(t *testing.T) {
 			},
 			pageRequest: mustPageRequestOf(0, 1),
 			where:       "price > 50",
-			expectedPage: Pagination{
+			expectedPage: &Pagination{
 				page:          0,
 				size:          1,
 				totalElements: 2,
@@ -138,7 +138,7 @@ func TestPaginationScopeMetadata_Where(t *testing.T) {
 			// Read
 			var products []*TestStruct
 
-			db.Clauses(&test.pageRequest).Where(test.where).Find(&products)
+			db.Clauses(test.pageRequest).Where(test.where).Find(&products)
 			if !equalPageRequests(test.pageRequest, test.expectedPage) {
 				t.Fatalf("expected page to be %d, got %d", test.expectedPage, test.pageRequest)
 			}
@@ -165,12 +165,12 @@ func setupDb(t *testing.T, name string) *gorm.DB {
 	return db
 }
 
-func mustPageRequestOf(page, size int) Pagination {
+func mustPageRequestOf(page, size int) *Pagination {
 	toReturn, _ := PageRequest(page, size)
 	return toReturn
 }
 
-func equalPageRequests(p1, p2 Pagination) bool {
+func equalPageRequests(p1, p2 *Pagination) bool {
 	return p1.page == p2.page &&
 		p1.size == p2.size &&
 		p1.totalElements == p2.totalElements &&