full refactoring (#146)

Author: markus621

.github/dependabot.yml

@@ -1,3 +1,4 @@
+
 version: 2
 updates:
   - package-ecosystem: "gomod" # See documentation for possible values

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+
 name: CI
 
 on:
@@ -11,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: [ '1.23.11' ]
+        go: [ '1.25' ]
     steps:
       - uses: actions/checkout@v3
 
@@ -23,4 +24,4 @@ jobs:
       - name: Run CI
         env:
           COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
-        run: make pre-commit
+        run: make ci

.gitignore

@@ -1,28 +1,23 @@
-*.bin
+
+.tools/
+bin/
+vendor/
+build/
+.idea/
+.vscode/
+coverage.txt
+coverage.out
 *.exe
 *.exe~
 *.dll
 *.so
 *.dylib
-*.test
-*.out
 *.db
-*.db-shm
-*.db-wal
 *.db-journal
-*.dev.yaml
-*.mmdb
-
-.idea/
-.vscode/
-.tools/
-
-coverage.txt
-coverage.out
-
-bin/
-vendor/
-build/
-
 *.mmdb
+*.test
+*.out
 .env
+*.db-shm
+*.db-wal
+*.bin

.golangci.yml

@@ -1,7 +1,7 @@
 version: "2"
 
 run:
-  go: "1.23"
+  go: "1.25"
   timeout: 5m
   tests: false
   issues-exit-code: 1

Makefile

@@ -27,6 +27,9 @@ tests:
 .PHONY: pre-commit
 pre-commit: install setup license lint build tests
 
+.PHONY: ci
+ci: pre-commit
+
 .PHONY: tidy
 tidy:
 	go mod tidy -v

_example/basic/Makefile

@@ -4,5 +4,6 @@ run:
 	go run main.go --config=config.yaml
 
 check:
-	time ab -n 1230 -c 5 http://127.0.0.1:10000/users
-	curl -v http://127.0.0.1:12000/metrics
+	curl -v http://127.0.0.1:10000/users && echo "" && echo "" && echo ""
+	time ab -n 1230 -c 5 http://127.0.0.1:10000/users && echo "" && echo "" && echo ""
+	curl -v http://127.0.0.1:12000/metrics && echo "" && echo "" && echo ""

_example/basic/main.go

@@ -6,10 +6,10 @@
 package main
 
 import (
+	"encoding/json"
 	"fmt"
 	"os"
 
-	"go.osspkg.com/console"
 	"go.osspkg.com/logx"
 
 	"go.osspkg.com/goppy/v2"
@@ -19,16 +19,22 @@ import (
 )
 
 func main() {
+	// Specify the path to the config via the argument: `--config`.
+	// Specify the path to the pidfile via the argument: `--pid`.
 	app := goppy.New("app_name", "v1.0.0", "app description")
 	app.Plugins(
 		metrics.WithServer(),
 		web.WithServer(),
 	)
 	app.Plugins(
-		plugins.Plugin{
+		plugins.Kind{
 			Inject: NewController,
-			Resolve: func(routes web.RouterPool, c *Controller) {
-				router := routes.Main()
+			Resolve: func(routes web.ServerPool, c *Controller) {
+				router, ok := routes.Main()
+				if !ok {
+					return
+				}
+
 				router.Use(web.ThrottlingMiddleware(100))
 				router.Get("/users", c.Users)
 
@@ -37,7 +43,7 @@ func main() {
 			},
 		},
 	)
-	app.Command("env", func(s console.CommandSetter) {
+	app.Command("env", func() {
 		fmt.Println(os.Environ())
 	})
 	app.Run()
@@ -49,14 +55,24 @@ func NewController() *Controller {
 	return &Controller{}
 }
 
-func (v *Controller) Users(ctx web.Context) {
+func (v *Controller) Users(ctx web.Ctx) {
 	metrics.Gauge("users_request").Inc()
-	data := []int64{1, 2, 3, 4}
+	data := Model{
+		data: []int64{1, 2, 3, 4},
+	}
 	ctx.JSON(200, data)
 }
 
-func (v *Controller) User(ctx web.Context) {
+func (v *Controller) User(ctx web.Ctx) {
 	id, _ := ctx.Param("id").Int() // nolint: errcheck
 	ctx.String(200, "user id: %d", id)
 	logx.Info("user - %d", id)
 }
+
+type Model struct {
+	data []int64
+}
+
+func (m Model) MarshalJSON() ([]byte, error) {
+	return json.Marshal(m.data)
+}

_example/database/Makefile

@@ -4,5 +4,6 @@ run:
 	go run main.go --config=config.yaml
 
 check:
-	curl -v http://127.0.0.1:10000/users && echo ""
-	curl -v http://127.0.0.1:10000/api/v1/user/1 && echo ""
+	curl -v http://127.0.0.1:10000/users && echo "" && echo "" && echo ""
+	curl -v http://127.0.0.1:10000/api/v1/user/1 && echo "" && echo "" && echo ""
+	time ab -n 1230 -c 5 http://127.0.0.1:10000/api/v1/user/1 && echo "" && echo "" && echo ""

_example/database/config.yaml

@@ -9,22 +9,6 @@ http:
   - tag: main
     addr: 0.0.0.0:10000
 
-mysql:
-  - tags: mysql_master,mysql_slave
-    host: 127.0.0.1
-    port: 3306
-    schema: test_database
-    user: test
-    password: test
-
-pgsql:
-  - tags: pgsql_master,pgsql_slave
-    host: 127.0.0.1
-    port: 5432
-    schema: postgres
-    user: postgres
-    password: postgres
-
 sqlite:
   - tags: sqlite_master
     file: ./sqlite.db

_example/database/main.go

@@ -6,10 +6,13 @@
 package main
 
 import (
+	"encoding/json"
 	"fmt"
 
 	"go.osspkg.com/logx"
 
+	"go.osspkg.com/goppy/v2/orm/clients/sqlite"
+
 	"go.osspkg.com/goppy/v2"
 	"go.osspkg.com/goppy/v2/orm"
 	"go.osspkg.com/goppy/v2/plugins"
@@ -21,24 +24,30 @@ func main() {
 	app := goppy.New("goppy_database", "v1.0.0", "")
 	app.Plugins(
 		web.WithServer(),
-		orm.WithMysqlClient(),
-		orm.WithSqliteClient(),
-		orm.WithPgsqlClient(),
-		orm.WithORM(),
+		orm.WithORM(sqlite.Name),
 		orm.WithMigration(orm.Migration{
-			Tags:    []string{"mysql_master"},
+			Tags:    []string{"sqlite_master"},
 			Dialect: "mysql",
 			Data: map[string]string{
-				"0001_data.sql": "CREATE TABLE IF NOT EXISTS `demo` (\n  `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY\n);",
+				"0002_data.sql": `
+					CREATE TABLE IF NOT EXISTS "demo2"
+					(
+						"id" integer NOT NULL PRIMARY KEY AUTOINCREMENT
+					);
+`,
 			},
 		}),
 		orm.WithMigration(),
 	)
 	app.Plugins(
-		plugins.Plugin{
+		plugins.Kind{
 			Inject: NewController,
-			Resolve: func(routes web.RouterPool, c *Controller) {
-				router := routes.Main()
+			Resolve: func(routes web.ServerPool, c *Controller) {
+				router, ok := routes.Main()
+				if !ok {
+					return
+				}
+
 				router.Use(web.ThrottlingMiddleware(100))
 				router.Get("/users", c.Users)
 
@@ -61,27 +70,29 @@ func NewController(orm orm.ORM) *Controller {
 	}
 }
 
-func (v *Controller) Users(ctx web.Context) {
-	data := []int64{1, 2, 3, 4}
+func (v *Controller) Users(ctx web.Ctx) {
+	data := Model{data: []int64{1, 2, 3, 4}}
 	ctx.JSON(200, data)
 }
 
-func (v *Controller) User(ctx web.Context) {
+func (v *Controller) User(ctx web.Ctx) {
 	id, _ := ctx.Param("id").Int() // nolint: errcheck
 
-	err := v.orm.Tag("mysql_master").PingContext(ctx.Context())
-	if err != nil {
-		ctx.ErrorJSON(500, err, web.ErrCtx{"id": id})
-		return
-	}
-
-	err = v.orm.Tag("sqlite_master").PingContext(ctx.Context())
+	err := v.orm.Tag("sqlite_master").PingContext(ctx.Context())
 	if err != nil {
-		ctx.ErrorJSON(500, err, web.ErrCtx{"id": id})
+		ctx.ErrorJSON(500, err, "id", id)
 		return
 	}
 
-	ctx.ErrorJSON(400, fmt.Errorf("user not found"), web.ErrCtx{"id": id})
+	ctx.ErrorJSON(200, fmt.Errorf("user not found"), "id", id)
 
 	logx.Info("user", "id", id)
 }
+
+type Model struct {
+	data []int64
+}
+
+func (m Model) MarshalJSON() ([]byte, error) {
+	return json.Marshal(m.data)
+}