Paginator getters

Author: n-r-w

select.go

@@ -18,28 +18,28 @@ const (
 	Desc
 )
 
-type paginatorType int
+type PaginatorType int
 
 const (
-	paginatorUndefined paginatorType = iota
-	paginatorByPage
-	paginatorByID
+	PaginatorTypeUndefined PaginatorType = iota
+	PaginatorTypeByPage
+	PaginatorTypeByID
 )
 
 // Paginator is a helper object to paginate results.
 type Paginator struct {
 	limit  uint64
 	page   uint64
 	lastID int64
-	pType  paginatorType
+	pType  PaginatorType
 }
 
 // PaginatorByPage creates a new Paginator for pagination by page.
-func PaginatorByPage(limit, page uint64) Paginator {
+func PaginatorByPage(pageSize, pageNum uint64) Paginator {
 	return Paginator{
-		limit: limit,
-		page:  page,
-		pType: paginatorByPage,
+		limit: pageSize,
+		page:  pageNum,
+		pType: PaginatorTypeByPage,
 	}
 }
 
@@ -48,10 +48,35 @@ func PaginatorByID(limit uint64, lastID int64) Paginator {
 	return Paginator{
 		limit:  limit,
 		lastID: lastID,
-		pType:  paginatorByID,
+		pType:  PaginatorTypeByID,
 	}
 }
 
+// PageSize returns the page size for PaginatorTypeByPage
+func (p Paginator) PageSize() uint64 {
+	return p.limit
+}
+
+// PageNumber returns the page number for PaginatorTypeByPage
+func (p Paginator) PageNumber() uint64 {
+	return p.page
+}
+
+// Limit returns the limit for PaginatorTypeByID
+func (p Paginator) Limit() uint64 {
+	return p.limit
+}
+
+// LastID returns the last ID for PaginatorTypeByID
+func (p Paginator) LastID() int64 {
+	return p.lastID
+}
+
+// Type returns the type of the paginator.
+func (p Paginator) Type() PaginatorType {
+	return p.pType
+}
+
 // String returns the string representation of the direction.
 func (d Direction) String() string {
 	if d == Asc {
@@ -144,7 +169,7 @@ func (d *selectData) toSqlRaw() (sqlStr string, args []any, err error) {
 	whereParts := make([]Sqlizer, len(d.WhereParts))
 	copy(whereParts, d.WhereParts)
 
-	if d.Paginator.pType == paginatorByID {
+	if d.Paginator.pType == PaginatorTypeByID {
 		if d.IDColumn == "" {
 			return "", nil, fmt.Errorf("IDColumn is required for pagination by ID")
 		}
@@ -182,7 +207,7 @@ func (d *selectData) toSqlRaw() (sqlStr string, args []any, err error) {
 	}
 
 	if len(d.Limit) > 0 {
-		if d.Paginator.pType != paginatorUndefined {
+		if d.Paginator.pType != PaginatorTypeUndefined {
 			return "", nil, fmt.Errorf("limit and paginator cannot be used together")
 		}
 
@@ -191,20 +216,20 @@ func (d *selectData) toSqlRaw() (sqlStr string, args []any, err error) {
 	}
 
 	if len(d.Offset) > 0 {
-		if d.Paginator.pType != paginatorUndefined {
+		if d.Paginator.pType != PaginatorTypeUndefined {
 			return "", nil, fmt.Errorf("offset and paginator cannot be used together")
 		}
 
 		_, _ = sql.WriteString(" OFFSET ")
 		_, _ = sql.WriteString(d.Offset)
 	}
 
-	if d.Paginator.pType == paginatorByPage {
+	if d.Paginator.pType == PaginatorTypeByPage {
 		_, _ = sql.WriteString(fmt.Sprintf(" LIMIT %d", d.Paginator.limit))
 		if d.Paginator.page > 1 {
 			_, _ = sql.WriteString(fmt.Sprintf(" OFFSET %d", d.Paginator.limit*(d.Paginator.page-1)))
 		}
-	} else if d.Paginator.pType == paginatorByID {
+	} else if d.Paginator.pType == PaginatorTypeByID {
 		_, _ = sql.WriteString(fmt.Sprintf(" LIMIT %d", d.Paginator.limit))
 	}
 

select_test.go

@@ -462,9 +462,14 @@ func TestPaginateByPage(t *testing.T) {
 }
 
 func TestPaginate(t *testing.T) {
+	pByID := PaginatorByID(10, 20)
+	assert.Equal(t, pByID.Limit(), uint64(10))
+	assert.Equal(t, pByID.LastID(), int64(20))
+	assert.Equal(t, pByID.Type(), PaginatorTypeByID)
+
 	sql, args, err := Select("id", "name").
 		From("users").
-		Paginate(PaginatorByID(10, 20)).
+		Paginate(pByID).
 		OrderBy("id ASC").
 		SetIDColumn("id").
 		ToSql()
@@ -474,14 +479,18 @@ func TestPaginate(t *testing.T) {
 
 	_, _, err = Select("id", "name").
 		From("users").
-		Paginate(PaginatorByID(10, 20)).
+		Paginate(pByID).
 		OrderBy("id ASC").
 		ToSql()
 	assert.ErrorContains(t, err, "IDColumn is required for pagination by ID")
 
+	pByPage := PaginatorByPage(10, 2)
+	assert.Equal(t, pByPage.PageSize(), uint64(10))
+	assert.Equal(t, pByPage.PageNumber(), uint64(2))
+
 	sql, args, err = Select("id", "name").
 		From("users").
-		Paginate(PaginatorByPage(10, 2)).
+		Paginate(pByPage).
 		OrderBy("id ASC").
 		ToSql()