Merge pull request #32 from rizalgowandy/arwego/feat/sortx

Add Sortx Package

Author: rizalgowandy

.github/configs/release-drafter.yml

@@ -30,7 +30,7 @@ version-resolver:
   patch:
     labels:
       - 'patch'
-  default: patch
+  default: minor
 template: |
   ## Changes
 

.github/workflows/go.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Set up Go 1.x
       uses: actions/setup-go@v2
       with:
-        go-version: ^1.13
+        go-version: 1.15
 
     - name: Check out code into the Go module directory
       uses: actions/checkout@v2

.github/workflows/test-coverage.yml

@@ -7,80 +7,19 @@ on:
   workflow_dispatch:
 
 jobs:
-
   test:
-    name: Test
     runs-on: ubuntu-latest
     steps:
-    - name: Set up Go 1.x
-      uses: actions/setup-go@v2
-      with:
-        go-version: ^1.13
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
-
-    - name: Get dependencies
-      run: go mod vendor -v
-
-    - name: Test
-      run: |
-        go test ./... -cover -count=1 -race -coverprofile ../main.out
-
-    - name: Set main branch code coverage
-      id: codecov-main-branch
-      uses: actions/github-script@v3
-      with:
-        github-token: ${{secrets.GITHUB_TOKEN}}
-        result-encoding: string
-        script: |
-          const goTool = require(`${process.env.GITHUB_WORKSPACE}/.github/scripts/gotool.js`)
-          return await goTool({file: "../main.out"})
-
-    - name: Checkout PR branch
-      uses: actions/checkout@v2
-
-    - name: Test PR branch
-      run: |
-        go test ./... -cover -count=1 -race -coverprofile ../pr.out
-
-    - name: Set PR branch code coverage
-      id: codecov-pr-branch
-      uses: actions/github-script@v3
-      with:
-        github-token: ${{secrets.GITHUB_TOKEN}}
-        result-encoding: string
-        script: |
-          const goTool = require(`${process.env.GITHUB_WORKSPACE}/.github/scripts/gotool.js`)
-          return await goTool({file: "../pr.out"})
-
-    - name: Create comment
-      if: github.event_name == 'pull_request'
-      uses: actions/github-script@v3
-      env:
-        main_code_cov: ${{steps.codecov-main-branch.outputs.result}}
-        pr_code_cov: ${{steps.codecov-pr-branch.outputs.result}}
-      with:
-        github-token: ${{secrets.GITHUB_TOKEN}}
-        script: |
-          const runID = ${{github.run_id}}
-          mainCodeCov =  process.env.main_code_cov.replace(/[\n\t\r]/g,"")
-          prCodeCov =  process.env.pr_code_cov.replace(/[\n\t\r]/g,"")
-
-          const body = `
-          ### Test Coverage Result
-          Success! :confetti_ball::confetti_ball::confetti_ball:
+      - name: Checkout
+        uses: actions/checkout@v2
 
-          **Code Coverage**
-          Main: ${mainCodeCov}
-          PR  : ${prCodeCov}
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.15
 
-          Check Detail: [Here](https://github.com/${context.issue.owner}/${context.issue.repo}/actions/runs/${runID})
-          `
+      - name: Run tests with coverage report output
+        run: go test ./... -coverprofile=docs/coverage.out
 
-          github.issues.createComment({
-            issue_number: context.issue.number,
-            owner: context.repo.owner,
-            repo: context.repo.repo,
-            body: body
-          })
+      - name: Comment
+        uses: k1LoW/octocov-action@v0

.octocov.yml

@@ -0,0 +1,31 @@
+coverage:
+  # acceptable: current >= 60% && diff >= 0.5%
+  badge:
+    path: docs/coverage.svg
+  paths:
+    - docs/coverage.out
+codeToTestRatio:
+  badge:
+    path: docs/ratio.svg
+  code:
+    - '**/*.go'
+    - '!**/*_test.go'
+  test:
+    - '**/*_test.go'
+testExecutionTime:
+  # acceptable: 1min30sec
+  badge:
+    path: docs/time.svg
+diff:
+  datastores:
+    - artifact://rizalgowandy/gdk
+push:
+  if: is_default_branch
+comment:
+  if: is_pull_request
+  deletePrevious: true
+  hideFooterLink: true
+report:
+  if: is_default_branch
+  datastores:
+    - artifact://rizalgowandy/gdk

loader.go

@@ -22,6 +22,7 @@ import (
 	_ "github.com/rizalgowandy/gdk/pkg/queue/nsqx"
 	_ "github.com/rizalgowandy/gdk/pkg/queue/nsqx/interceptor"
 	_ "github.com/rizalgowandy/gdk/pkg/regex"
+	_ "github.com/rizalgowandy/gdk/pkg/sortx"
 	_ "github.com/rizalgowandy/gdk/pkg/stack"
 	_ "github.com/rizalgowandy/gdk/pkg/storage/cache"
 	_ "github.com/rizalgowandy/gdk/pkg/storage/database"

pkg/sortx/sortx.go

@@ -0,0 +1,48 @@
+package sortx
+
+import "strings"
+
+type (
+	Key   string
+	Order int64
+)
+
+const (
+	SortOrderAscending Order = iota + 1
+	SortOrderDescending
+)
+
+type Sort struct {
+	Key   Key
+	Order Order
+}
+
+// NewSorts create sorting based on
+// Format:
+//	sort=key1:asc,key2:desc,key3:asc
+func NewSorts(qs string) []Sort {
+	sorts := strings.Split(qs, ",")
+
+	var res []Sort
+	for _, v := range sorts {
+		kv := strings.Split(v, ":")
+
+		s := Sort{
+			Key:   Key(kv[0]),
+			Order: SortOrderAscending,
+		}
+		if len(kv) == 2 {
+			switch kv[1] {
+			case "asc":
+				s.Order = SortOrderAscending
+			case "desc":
+				s.Order = SortOrderDescending
+			default:
+				s.Order = SortOrderAscending
+			}
+		}
+		res = append(res, s)
+	}
+
+	return res
+}

pkg/sortx/sortx_test.go

@@ -0,0 +1,45 @@
+package sortx
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestNewSorts(t *testing.T) {
+	type args struct {
+		qs string
+	}
+	tests := []struct {
+		name string
+		args args
+		want []Sort
+	}{
+		{
+			name: "Success",
+			args: args{
+				qs: "id:desc,status:asc,created_at",
+			},
+			want: []Sort{
+				{
+					Key:   "id",
+					Order: SortOrderDescending,
+				},
+				{
+					Key:   "status",
+					Order: SortOrderAscending,
+				},
+				{
+					Key:   "created_at",
+					Order: SortOrderAscending,
+				},
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := NewSorts(tt.args.qs); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("NewSorts() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}