sorting

README

Sorting

Sorting adds reordering abilities to GORM models and sorts collections.

Register GORM Callbacks

Sorting utilises GORM callbacks to log data, so you will need to register callbacks first:

import (
  "github.com/jinzhu/gorm"
  "github.com/qor/sorting"
)

func main() {
  db, err := gorm.Open("sqlite3", "demo_db")
  sorting.RegisterCallbacks(db)
}

Sort Modes

Sorting two modes which can be applied as anonymous fields in a model.

• Ascending mode:smallest first (sorting.Sorting)
• Descending mode: smallest last (sorting.SortingDESC)

They can be used as follows:

// Ascending mode
type Category struct {
  gorm.Model
  sorting.Sorting // this will register a `position` column to model Category, used to save record's order
}

db.Find(&categories)
// SELECT * FROM categories ORDER BY position;

// Descending mode
type Product struct {
  gorm.Model
  sorting.SortingDESC // this will register a `position` column to model Product, used to save record's order
}

db.Find(&products)
// SELECT * FROM products ORDER BY position DESC;

Reordering

// Move Up
sorting.MoveUp(&db, &product, 1)
// If a record is in positon 5, it will be brought to 4

// Move Down
sorting.MoveDown(&db, &product, 1)
// If a record is in positon 5, it will be brought to 6

// Move To
sorting.MoveTo(&db, &product, 1)
// If a record is in positon 5, it will be brought to 1

Sorting Collections

Sorts a slice of data:

sorter := sorting.SortableCollection{
  PrimaryKeys: []string{"5", "3", "1", "2"}
}

products := []Product{
  {Model: gorm.Model{ID: 1}, Code: "1"},
  {Model: gorm.Model{ID: 2}, Code: "2"},
  {Model: gorm.Model{ID: 3}, Code: "3"},
  {Model: gorm.Model{ID: 3}, Code: "4"},
  {Model: gorm.Model{ID: 3}, Code: "5"},
}

sorter.Sort(products)

products // => []Product{
         //      {Model: gorm.Model{ID: 3}, Code: "5"},
         //      {Model: gorm.Model{ID: 3}, Code: "3"},
         //      {Model: gorm.Model{ID: 1}, Code: "1"},
         //      {Model: gorm.Model{ID: 2}, Code: "2"},
         //      {Model: gorm.Model{ID: 3}, Code: "4"},
         //    }

Sorting GORM-backend Models

After enabling sorting modes for GORM models, QOR Admin will automatically enable the sorting feature for the resource.

Sorting Demo with QOR

Sorting Collections

If you want to make a sortable select_many, collection_edit field, You could add a sorting.SortableCollection field with name: Field's name + 'Sorter'; which is used to save above field's data order. That Field will also be identified as sortable in QOR Admin.

// For model relations
type Product struct {
  gorm.Model
  l10n.Locale
  Collections           []Collection
  CollectionsSorter     sorting.SortableCollection
  ColorVariations       []ColorVariation `l10n:"sync"`
  ColorVariationsSorter sorting.SortableCollection
}

// For virtual arguments
type selectedProductsArgument struct {
  Products       []string
  ProductsSorter sorting.SortableCollection
}

selectedProductsResource := Admin.NewResource(&selectedProductsArgument{})
selectedProductsResource.Meta(&admin.Meta{Name: "Products", Type: "select_many", Collection: func(value interface{}, context *qor.Context) [][]string {
  var collectionValues [][]string
  var products []*models.Product
  db.DB.Find(&products)
  for _, product := range products {
    collectionValues = append(collectionValues, []string{fmt.Sprint(product.ID), product.Name})
  }
  return collectionValues
}})

Widgets.RegisterWidget(&widget.Widget{
  Name:      "Products",
  Templates: []string{"products"},
  Setting:   selectedProductsResource,
}

About record with composite primary key.

It do support sorting records with composite primary key. However there is a exception, the version_name is a "reserved" primary key for the qor/publish2 support. So DO NOT use version_name as a part of the composite primary key unless you are using qor/publish2.

License

Released under the MIT License.

Documentation

Index

• func MoveDown(db *gorm.DB, value sortingInterface, pos int) error
• func MoveTo(db *gorm.DB, value sortingInterface, pos int) error
• func MoveUp(db *gorm.DB, value sortingInterface, pos int) error
• func RegisterCallbacks(db *gorm.DB)
• type SortableCollection
  • func (sortableCollection *SortableCollection) ConfigureQorMeta(metaor resource.Metaor)
  • func (sortableCollection *SortableCollection) Scan(value interface{}) error
  • func (sortableCollection SortableCollection) Sort(results interface{}) error
  • func (sortableCollection SortableCollection) Value() (driver.Value, error)
• type Sorting
  • func (s *Sorting) ConfigureQorResource(res resource.Resourcer)
  • func (s *Sorting) ConfigureQorResourceBeforeInitialize(res resource.Resourcer)
  • func (position Sorting) GetPosition() int
  • func (position *Sorting) SetPosition(pos int)
• type SortingDESC
  • func (SortingDESC) SortingDesc()

Functions

func MoveDown

func MoveDown(db *gorm.DB, value sortingInterface, pos int) error

MoveDown move position down

func MoveTo

func MoveTo(db *gorm.DB, value sortingInterface, pos int) error

MoveTo move position to

func MoveUp

func MoveUp(db *gorm.DB, value sortingInterface, pos int) error

MoveUp move position up

func RegisterCallbacks

func RegisterCallbacks(db *gorm.DB)

RegisterCallbacks register callbacks into gorm db instance

Types

type SortableCollection

type SortableCollection struct {
	PrimaryField string
	PrimaryKeys  []string
}

func (*SortableCollection) ConfigureQorMeta

func (sortableCollection *SortableCollection) ConfigureQorMeta(metaor resource.Metaor)

func (*SortableCollection) Scan

func (sortableCollection *SortableCollection) Scan(value interface{}) error

func (SortableCollection) Sort

func (sortableCollection SortableCollection) Sort(results interface{}) error

func (SortableCollection) Value

func (sortableCollection SortableCollection) Value() (driver.Value, error)

type Sorting

type Sorting struct {
	Position int `sql:"DEFAULT:NULL"`
}

Sorting ascending mode

func (*Sorting) ConfigureQorResource

func (s *Sorting) ConfigureQorResource(res resource.Resourcer)

func (*Sorting) ConfigureQorResourceBeforeInitialize

func (s *Sorting) ConfigureQorResourceBeforeInitialize(res resource.Resourcer)

ConfigureQorResource configure sorting for qor admin

func (Sorting) GetPosition

func (position Sorting) GetPosition() int

GetPosition get current position

func (*Sorting) SetPosition

func (position *Sorting) SetPosition(pos int)

SetPosition set position, only set field value, won't save

type SortingDESC

type SortingDESC struct {
	Sorting
}

SortingDESC descending mode

func (SortingDESC) SortingDesc

func (SortingDESC) SortingDesc()

SortingDesc make your model sorting desc by default