Files
probo/pkg/page/cursor.go
Sacha Al Himdani 4c57d201a4 Make license declarations consistently MIT
The source headers, LICENSE files, and license metadata had drifted
apart. Align the entire project to MIT:

- Convert every source-file header to the MIT text across all comment
  styles (Go, TS, TSX, JS, MJS, SQL, CSS, GraphQL, shell), including
  SPDX-License-Identifier tags
- Set the root and cookie-banner LICENSE files to the MIT text with a
  "MIT License" title line
- Switch the package.json license fields, Docker image label, and
  cookie-banner README to MIT
- Update docs and the genmodels header generator accordingly
- Normalize copyright lines to a single format
  (Copyright (c) <year(s)> Probo Inc <hello@probo.com>.): unify the
  hello@getprobo.com and hello@probo.inc emails to hello@probo.com and
  the comma-separated years to a hyphenated range

Genuine third-party references are intentionally left untouched: the
Lucide icon attributions (Lucide is ISC) and the trivy dependency
license allowlist.

Signed-off-by: Sacha Al Himdani <sacha@probo.com>
2026-07-13 16:21:14 +02:00

113 lines
3.1 KiB
Go

// Copyright (c) 2025-2026 Probo Inc <hello@probo.com>.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package page
import (
"github.com/jackc/pgx/v5"
)
type (
Cursor[T OrderField] struct {
Size int
Position Position
Key *CursorKey
OrderBy OrderBy[T]
}
Position string
OrderBy[T OrderField] struct {
Field T
Direction OrderDirection
}
)
const (
DefaultCursorSize = 25
MaxCursorSize = 500
Tail Position = "TAIL"
Head Position = "HEAD"
)
func NewCursor[T OrderField](size int, from *CursorKey, pos Position, orderBy OrderBy[T]) *Cursor[T] {
if size <= 0 {
size = DefaultCursorSize
} else if size > MaxCursorSize {
size = MaxCursorSize
}
return &Cursor[T]{
Size: size,
Key: from,
Position: pos,
OrderBy: orderBy,
}
}
func (c *Cursor[T]) SQLFragment() string {
fieldName := c.OrderBy.Field.Column()
var orderDirection string
switch {
case c.OrderBy.Direction == OrderDirectionAsc && c.Position == Head:
orderDirection = "ASC"
case c.OrderBy.Direction == OrderDirectionDesc && c.Position == Head:
orderDirection = "DESC"
case c.OrderBy.Direction == OrderDirectionAsc && c.Position == Tail:
orderDirection = "DESC"
case c.OrderBy.Direction == OrderDirectionDesc && c.Position == Tail:
orderDirection = "ASC"
}
whereClause := "TRUE"
if c.Key != nil && orderDirection == "DESC" {
whereClause = "(" + fieldName + " <= @cursor_field_value) AND NOT (" + fieldName + " = @cursor_field_value AND id > @cursor_id)"
} else if c.Key != nil && orderDirection == "ASC" {
whereClause = "(" + fieldName + " >= @cursor_field_value) AND NOT (" + fieldName + " = @cursor_field_value AND id < @cursor_id)"
}
orderByClause := fieldName + " " + orderDirection + ", id " + orderDirection
return whereClause + " ORDER BY " + orderByClause + " LIMIT @cursor_limit"
}
func (c *Cursor[T]) SQLArguments() pgx.NamedArgs {
var size = c.Size
if c.Key == nil {
size += 1
} else {
size += 2
}
arguments := pgx.NamedArgs{
"cursor_limit": size,
}
if c.Key != nil {
arguments["cursor_id"] = c.Key.ID
arguments["cursor_field_value"] = c.Key.Value
}
return arguments
}