From 56fa213a6edf0c9ae0421ebf59683cbe6c41c8ca Mon Sep 17 00:00:00 2001
From: Anker Jam <jianzhiyao020@qq.com>
Date: Sun, 25 Oct 2020 23:49:21 +0800
Subject: [PATCH] support OrderClauses for QuerySeter

---
 client/orm/orm_queryset.go               |  9 +++++++
 client/orm/structs/clauses/order.go      | 34 ++++++++++++++++++++++++
 client/orm/structs/clauses/order_test.go | 29 ++++++++++++++++++++
 client/orm/types.go                      | 19 +++++++++++++
 4 files changed, 91 insertions(+)
 create mode 100644 client/orm/structs/clauses/order_test.go

diff --git a/client/orm/orm_queryset.go b/client/orm/orm_queryset.go
index 5ca10421..e6493d8f 100644
--- a/client/orm/orm_queryset.go
+++ b/client/orm/orm_queryset.go
@@ -147,6 +147,15 @@ func (o querySet) OrderBy(expressions ...string) QuerySeter {
 	return &o
 }
 
+// add ORDER expression.
+func (o querySet) OrderClauses(orders ...*clauses.Order) QuerySeter {
+	if len(orders) <= 0 {
+		return &o
+	}
+	o.orders = orders
+	return &o
+}
+
 // add DISTINCT to SELECT
 func (o querySet) Distinct() QuerySeter {
 	o.distinct = true
diff --git a/client/orm/structs/clauses/order.go b/client/orm/structs/clauses/order.go
index 66e8fe73..64e4ebbd 100644
--- a/client/orm/structs/clauses/order.go
+++ b/client/orm/structs/clauses/order.go
@@ -8,9 +8,21 @@ const (
 	SortDescending Sort = 2
 )
 
+type OrderOption func(order *Order)
+
 type Order struct {
 	column string
 	sort   Sort
+	isRaw  bool
+}
+
+func OrderClause(options ...OrderOption) *Order {
+	o := &Order{}
+	for _, option := range options {
+		option(o)
+	}
+
+	return o
 }
 
 func (o *Order) GetColumn() string {
@@ -21,6 +33,10 @@ func (o *Order) GetSort() Sort {
 	return o.sort
 }
 
+func (o *Order) IsRaw() bool {
+	return o.isRaw
+}
+
 func ParseOrder(expressions ...string) []*Order {
 	var orders []*Order
 	for _, expression := range expressions {
@@ -39,3 +55,21 @@ func ParseOrder(expressions ...string) []*Order {
 
 	return orders
 }
+
+func OrderColumn(column string) OrderOption {
+	return func(order *Order) {
+		order.column = column
+	}
+}
+
+func OrderSort(sort Sort) OrderOption {
+	return func(order *Order) {
+		order.sort = sort
+	}
+}
+
+func OrderRaw(isRaw bool) OrderOption {
+	return func(order *Order) {
+		order.isRaw = isRaw
+	}
+}
diff --git a/client/orm/structs/clauses/order_test.go b/client/orm/structs/clauses/order_test.go
new file mode 100644
index 00000000..2f44975d
--- /dev/null
+++ b/client/orm/structs/clauses/order_test.go
@@ -0,0 +1,29 @@
+package clauses
+
+import "testing"
+
+func TestOrderClause(t *testing.T) {
+	var (
+		column = `a`
+		sort   = SortDescending
+		raw    = true
+	)
+
+	o := OrderClause(
+		OrderColumn(column),
+		OrderSort(sort),
+		OrderRaw(raw),
+	)
+
+	if o.GetColumn() != column {
+		t.Error()
+	}
+
+	if o.GetSort() != sort {
+		t.Error()
+	}
+
+	if o.IsRaw() != raw {
+		t.Error()
+	}
+}
diff --git a/client/orm/types.go b/client/orm/types.go
index 34c61d51..f1d6def7 100644
--- a/client/orm/types.go
+++ b/client/orm/types.go
@@ -17,6 +17,7 @@ package orm
 import (
 	"context"
 	"database/sql"
+	"github.com/astaxie/beego/client/orm/structs/clauses"
 	"reflect"
 	"time"
 
@@ -289,6 +290,24 @@ type QuerySeter interface {
 	// for example:
 	//	qs.OrderBy("-status")
 	OrderBy(exprs ...string) QuerySeter
+	// add ORDER expression by order clauses
+	// for example:
+	// OrderClauses(clauses.OrderClause(
+	//		clauses.OrderColumn(`status`),
+	//		clauses.OrderSort(clauses.SortAscending),
+	//		clauses.OrderRaw(false),
+	//	))
+	// OrderClauses(clauses.OrderClause(
+	//		clauses.OrderColumn(`user__status`),
+	//		clauses.OrderSort(clauses.SortAscending),
+	//		clauses.OrderRaw(false),
+	//	))
+	// OrderClauses(clauses.OrderClause(
+	//		clauses.OrderColumn(`random()`),
+	//		clauses.OrderSort(clauses.SortNone),
+	//		clauses.OrderRaw(true),
+	//	))
+	OrderClauses(orders ...*clauses.Order) QuerySeter
 	// add FORCE INDEX expression.
 	// for example:
 	//	qs.ForceIndex(`idx_name1`,`idx_name2`)