Merge pull request #2 from FishGoddess/develop

v0.6.1-alpha

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.6.1-alpha
+
+> 此版本发布于 2024-08-10
+
+* 增加常用错误快捷方式
+
 ### v0.6.0-alpha
 
 > 此版本发布于 2024-08-09

README.en.md

@@ -41,6 +41,14 @@ func main() {
 	// Also, we provide some useful information carrier for you.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+
+	// What's more, we provide some shortcuts for you.
+	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	berr := errors.BadRequest("id is wrong")
+	ferr := errors.Forbidden("user isn't allowed")
+	nerr := errors.NotFound("book not found")
+	rerr := errors.RequireLogin("user requires login")
+	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
 }
 
 ```

README.md

@@ -41,6 +41,14 @@ func main() {
 	// Also, we provide some useful information carrier for you.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+
+	// What's more, we provide some shortcuts for you.
+	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	berr := errors.BadRequest("id is wrong")
+	ferr := errors.Forbidden("user isn't allowed")
+	nerr := errors.NotFound("book not found")
+	rerr := errors.RequireLogin("user requires login")
+	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
 }
 
 ```

_examples/basic.go

@@ -27,4 +27,12 @@ func main() {
 	// Also, we provide some useful information carrier for you.
 	err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller()
 	fmt.Println(err)
+
+	// What's more, we provide some shortcuts for you.
+	// All these ways are returning a *Error and you are free to use all methods on *Error.
+	berr := errors.BadRequest("id is wrong")
+	ferr := errors.Forbidden("user isn't allowed")
+	nerr := errors.NotFound("book not found")
+	rerr := errors.RequireLogin("user requires login")
+	fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
 }

_icons/coverage.svg

@@ -0,0 +1,28 @@
+// Copyright 2024 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package errors
+
+const (
+	CodeBadRequest   = 400
+	CodeForbidden    = 403
+	CodeNotFound     = 404
+	CodeRequireLogin = 1000
+)
+
+func BadRequest(message string) *Error {
+	return Wrap(CodeBadRequest, message)
+}
+
+func Forbidden(message string) *Error {
+	return Wrap(CodeForbidden, message)
+}
+
+func NotFound(message string) *Error {
+	return Wrap(CodeNotFound, message)
+}
+
+func RequireLogin(message string) *Error {
+	return Wrap(CodeRequireLogin, message)
+}

types.go

@@ -0,0 +1,87 @@
+// Copyright 2024 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package errors
+
+import "testing"
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestBadRequest$
+func TestBadRequest(t *testing.T) {
+	testCases := []struct {
+		message string
+		code    int32
+	}{
+		{
+			message: "id is nil",
+			code:    CodeBadRequest,
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := BadRequest(testCase.message)
+		if err.Code() != testCase.code {
+			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestForbidden$
+func TestForbidden(t *testing.T) {
+	testCases := []struct {
+		message string
+		code    int32
+	}{
+		{
+			message: "id is nil",
+			code:    CodeForbidden,
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := Forbidden(testCase.message)
+		if err.Code() != testCase.code {
+			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestNotFound$
+func TestNotFound(t *testing.T) {
+	testCases := []struct {
+		message string
+		code    int32
+	}{
+		{
+			message: "id is nil",
+			code:    CodeNotFound,
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := NotFound(testCase.message)
+		if err.Code() != testCase.code {
+			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
+		}
+	}
+}
+
+// go test -v -cover -count=1 -test.cpu=1 -run=^TestRequireLogin$
+func TestRequireLogin(t *testing.T) {
+	testCases := []struct {
+		message string
+		code    int32
+	}{
+		{
+			message: "id is nil",
+			code:    CodeRequireLogin,
+		},
+	}
+
+	for _, testCase := range testCases {
+		err := RequireLogin(testCase.message)
+		if err.Code() != testCase.code {
+			t.Errorf("err.Code() %d != testCase.code %d", err.Code(), testCase.code)
+		}
+	}
+}