feat: upgrade v1.15.0 (#67)

* init

* add filter doc

* add mail

* add filter

* add strings methods

* optimize worker method

* add stream

* Add Auth.Id method

* Validation supports Regex rules

* The name of Postgresql driver changes to Postgres

* Upgrade golang version

* replace sqlserver docker image

* add some new features

* add mail

* Add mail

* update

* add comment service to remaining pages

* add basic docs for http tests

* add docs for `AssertJson` and `AssertExactJson`

* add available assertions method

* add docs for fluent string

* add migration doc

* add migration docs, TODO: add 列修饰符

* add migration docs

* Sync CN and EN

* fix typo

* add docs

* feat: [#515] Input* methods of http.Request support retrieve data from query and route

* feat: [#517] different guards can configure own ttl

* add doc for scoping of JSON collection

* add doc for scoping of JSON collection

* feat: [#282]  Print the values in ctx when calling facades.Log().WithContext(ctx).Info()

* feat: [#272] The Orm module can set DSN directly

* chore: rename Stop to Shutdown

* feat: [#477] Configure camel case columns instead of snake case GORM

* chore: optimize artisan style

* optimize words

* feat: [#508] Add Restore method for Orm, to recover soft deleted dataoptimize lint

* feat: [#473] ORM has its own logger instead of using facades.Log()

* feat: Add artisan about command

* fix typo

* feat: postgres and sqlserver drivers support setting schema

* feat: Optimize testing.http

* optimize sort

* optimize

* optimize upgrade process

* add goravel/installer

* add recovery

* add abort method

* fix: typo

* add comment

* fix typo

* upgrade: v1.15.1

* upgrade packages

* upgrade cloudinay

---------

Co-authored-by: kkumar-gcc <[email protected]>

Author: hwbrzzl

Diff for: .vuepress/config/sidebar/en.ts

@@ -10,12 +10,12 @@ export function getEnSidebar(): SidebarConfigArray {
           text: "Upgrade Guide",
           children: [
             {
-              text: "Upgrading To v1.14 From v1.13",
-              link: "/upgrade/v1.14",
+              text: "Upgrading To v1.15 From v1.14",
+              link: "/upgrade/v1.15",
             },
             {
-              text: "Upgrading To v1.13 From v1.12",
-              link: "/upgrade/v1.13",
+              text: "Upgrading To v1.14 From v1.13",
+              link: "/upgrade/v1.14",
             },
             {
               text: "History Upgrade",
@@ -233,6 +233,10 @@ export function getEnSidebar(): SidebarConfigArray {
           text: "Getting Started",
           link: "/testing/getting-started",
         },
+        {
+          text: "HTTP Tests",
+          link: "/testing/htt-tests",
+        },
         {
           text: "Mock",
           link: "/testing/mock",

Diff for: .vuepress/config/sidebar/zh.ts

@@ -10,12 +10,12 @@ export function getZhSidebar(): SidebarConfigArray {
           text: "升级指南",
           children: [
             {
-              text: "从 v1.13 升级到 v1.14",
-              link: "/zh/upgrade/v1.14",
+              text: "从 v1.14 升级到 v1.15",
+              link: "/zh/upgrade/v1.15",
             },
             {
-              text: "从 v1.12 升级到 v1.13",
-              link: "/zh/upgrade/v1.13",
+              text: "从 v1.13 升级到 v1.14",
+              link: "/zh/upgrade/v1.14",
             },
             {
               text: "历史版本升级",
@@ -233,6 +233,10 @@ export function getZhSidebar(): SidebarConfigArray {
           text: "快速入门",
           link: "/zh/testing/getting-started",
         },
+        {
+          text: "HTTP Tests",
+          link: "/zh/testing/htt-tests",
+        },
         {
           text: "Mock",
           link: "/zh/testing/mock",

Diff for: digging-deeper/color.md

@@ -50,3 +50,5 @@ import "github.com/goravel/framework/support/color"
 
 color.New(color.FgRed).Println("Hello, Goravel!")
 ```
+
+<CommentService/>

Diff for: digging-deeper/helpers.md

@@ -86,7 +86,7 @@ path := path.Config("app.go")
 
 ### `path.Database()`
 
-The `path.Database()` function returns the path to your application's database directory. You may also use the `path.Database()` function to generate a path to a given file within the database directory:
+The `path.Database()` function returns the path to your application's database directory. You may also use the `path.Database()` function to generate a path to a given file within the `database` directory:
 
 ```go
 path := path.Database()
@@ -95,7 +95,7 @@ path := path.Database("factories/user_factory.go")
 
 ### `path.Storage()`
 
-The `path.Storage()` function returns the path to your application's storage directory. You may also use the `path.Storage()` function to generate a path to a given file within the storage directory:
+The `path.Storage()` function returns the path to your application's storage directory. You may also use the `path.Storage()` function to generate a path to a given file within the `storage` directory:
 
 ```go
 path := path.Storage()
@@ -104,13 +104,22 @@ path := path.Storage("app/file.txt")
 
 ### `path.Public()`
 
-The `path.Public()` function returns the path to your application's public directory. You may also use the `path.Public()` function to generate a path to a given file within the public directory:
+The `path.Public()` function returns the path to your application's public directory. You may also use the `path.Public()` function to generate a path to a given file within the `public` directory:
 
 ```go
 path := path.Public()
 path := path.Public("css/app.css")
 ```
 
+### `path.Lang()`
+
+The `path.Lang()` function returns the path to the `lang` directory. You may also use the `path.Lang()` function to generate a path to a given file within the `lang` directory:
+
+```go
+path := path.Lang()
+path := path.Lang("en.json")
+```
+
 ## Time
 
 The `carbon` module of Goravel is an expansion by [golang-module/carbon](https://github.com/golang-module/carbon), the main feature is the realization of time backtracking, please refer to the official documentation for details.

Diff for: digging-deeper/localization.md

@@ -152,3 +152,5 @@ facades.Lang(ctx).Choice("time.minutes_ago", 5, translation.Option{
   },
 })
 ```
+
+<CommentService/>

Diff for: digging-deeper/mail.md

@@ -19,7 +19,8 @@ err := facades.Mail().To([]string{"[email protected]"}).
   Cc([]string{"[email protected]"}).
   Bcc([]string{"[email protected]"}).
   Attach([]string{"file.png"}).
-  Content(mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).
+  Content(mail.Html("<h1>Hello Goravel</h1>")).
+  Subject("Subject").
   Send()
 ```
 
@@ -32,7 +33,8 @@ err := facades.Mail().To([]string{"[email protected]"}).
   Cc([]string{"[email protected]"}).
   Bcc([]string{"[email protected]"}).
   Attach([]string{"file.png"}).
-  Content(mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).
+  Content(mail.Html("<h1>Hello Goravel</h1>")).
+  Subject("Subject").
   Queue()
 ```
 
@@ -45,8 +47,9 @@ err := facades.Mail().To([]string{"[email protected]"}).
   Cc([]string{"[email protected]"}).
   Bcc([]string{"[email protected]"}).
   Attach([]string{"file.png"}).
-  Content(mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).
-  Queue(mail.Queue{Connection: "high", Queue: "mail"})
+  Content(mail.Html("<h1>Hello Goravel</h1>")).
+  Subject("Subject").
+  Queue(mail.Queue().Connection("high").Queue("mail"))
 ```
 
 ## Setting Sender
@@ -57,12 +60,66 @@ Framework uses `MAIL_FROM_ ADDRESS` and `MAIL_FROM_ NAME` in the `config/mail.go
 import "github.com/goravel/framework/contracts/mail"
 
 err := facades.Mail().To([]string{"[email protected]"}).
-  From(mail.From{Address: "[email protected]", Name: "example"}).
+  From(mail.Address(testFromAddress, testFromName)).
   Cc([]string{"[email protected]"}).
   Bcc([]string{"[email protected]"}).
   Attach([]string{"file.png"}).
-  Content(mail.Content{Subject: "Subject", Html: "<h1>Hello Goravel</h1>"}).
-  Queue(mail.Queue{Connection: "high", Queue: "mail"})
+  Content(mail.Html("<h1>Hello Goravel</h1>")).
+  Subject("Subject").
+  Queue(mail.Queue().Connection("high").Queue("mail"))
+```
+
+## Using Mailable
+
+The parameters of the email can be set in a `Mailable` struct. These structs are stored in the `app/mails` directory. You can quickly create a `Mailable` using the `make:mail` Artisan command:
+
+```bash
+go run . artisan make:mail OrderShipped
+```
+
+The generated `OrderShipped` struct is as follows:
+
+```go
+import "github.com/goravel/framework/contracts/mail"
+
+type OrderShipped struct {
+}
+
+func NewOrderShipped() *OrderShipped {
+	return &OrderShipped{}
+}
+
+func (m *OrderShipped) Attachments() []string {
+	return []string{"../logo.png"}
+}
+
+func (m *OrderShipped) Content() *mail.Content {
+	return &mail.Content{Html: "<h1>Hello Goravel</h1>"}
+}
+
+func (m *OrderShipped) Envelope() *mail.Envelope {
+	return &mail.Envelope{
+		Bcc:     []string{"[email protected]"},
+		Cc:      []string{"[email protected]"},
+		From:    mail.From{Address: "[email protected]", Name: "from"},
+		Subject: "Goravel",
+		To:      []string{"[email protected]"},
+	}
+}
+
+func (m *OrderShipped) Queue() *mail.Queue {
+  return &mail.Queue{
+    Connection: "high",
+    Queue:      "mail",
+  }
+}
+```
+
+Then you can use the `Mailalbe` in the `Send` and `Queue` methods:
+
+```go
+err := facades.Mail().Send(mails.NewOrderShipped())
+err := facades.Mail().Queue(mails.NewOrderShipped())
 ```
 
 <CommentService/>

Diff for: digging-deeper/package-development.md

@@ -122,3 +122,5 @@ The command can use the following options:
 | --tag        | -t     | Resource Group     |
 | --force      | -f     | Overwrite any existing files     |
 | --existing   | -e     | Publish and overwrite only the files that have already been published     |
+
+<CommentService/>

Diff for: digging-deeper/queues.md

@@ -91,7 +91,7 @@ func main() {
 
   // Start queue server by facades.Queue().
   go func() {
-    if err := facades.Queue().Worker(nil).Run(); err != nil {
+    if err := facades.Queue().Worker().Run(); err != nil {
       facades.Log().Errorf("Queue run error: %v", err)
     }
   }()
@@ -105,14 +105,14 @@ Different parameters can be passed in the `facades.Queue().Worker` method, you c
 ```go
 // No parameters, default listens to the configuration in the `config/queue.go`, and the number of concurrency is 1
 go func() {
-  if err := facades.Queue().Worker(nil).Run(); err != nil {
+  if err := facades.Queue().Worker().Run(); err != nil {
     facades.Log().Errorf("Queue run error: %v", err)
   }
 }()
 
 // Monitor processing queue for redis link, and the number of concurrency is 10
 go func() {
-  if err := facades.Queue().Worker(&queue.Args{
+  if err := facades.Queue().Worker(queue.Args{
     Connection: "redis",
     Queue: "processing",
     Concurrent: 10,

Diff for: digging-deeper/strings.md

@@ -126,6 +126,26 @@ import "github.com/goravel/framework/support/str"
 str.Of("Goravel").CharAt(1) // "o"
 ```
 
+### `ChopEnd`
+
+The `ChopEnd` method removes the given value(s) from the end of the string.
+
+```go
+import "github.com/goravel/framework/support/str"
+
+str.Of("https://goravel.com").ChopEnd(".dev", ".com").String() // https://goravel
+```
+
+### `ChopStart`
+
+The `ChopStart` method removes the given value(s) from the start of the string.
+
+```go
+import "github.com/goravel/framework/support/str"
+
+str.Of("https://goravel.dev").ChopStart("http://", "https://").String() // goravel.dev
+```
+
 ### `Contains`
 
 The `Contains` method determines if the given string contains the given value. The method is case-sensitive. If multiple values are provided, it will return `true` if the string contains any of the values.
@@ -1017,3 +1037,5 @@ str.Of("Hello, World!").Words(1) // "Hello..."
 
 str.Of("Hello, World!").Words(1, " (****)") // "Hello (****)"
 ```
+
+<CommentService/>

Diff for: digging-deeper/task-scheduling.md

@@ -58,6 +58,10 @@ func (kernel *Kernel) Schedule() []schedule.Event {
 }
 ```
 
+### Logging Level
+
+When `app.debug` is `true`, the console will print all logs. Otherwise, only `error` level logs will be printed.
+
 ### Schedule Frequency Options
 
 We've already seen a few examples of how you may configure a task to run at specified intervals. However, there are many more task schedule frequencies avaibable to assign to tasks:
@@ -142,4 +146,32 @@ func main() {
 }
 ```
 
-<CommentService/>
+## Stopping The Scheduler
+
+You can call the `Shutdown` method to gracefully shut down the scheduler. This method will wait for all tasks to complete before shutting down.
+
+```go
+// main.go
+bootstrap.Boot()
+
+// Create a channel to listen for OS signals
+quit := make(chan os.Signal)
+signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
+
+// Start schedule by facades.Schedule
+go facades.Schedule().Run()
+
+// Listen for the OS signal
+go func() {
+  <-quit
+  if err := facades.Schedule().Shutdown(); err != nil {
+    facades.Log().Errorf("Schedule Shutdown error: %v", err)
+  }
+
+  os.Exit(0)
+}()
+
+select {}
+```
+
+<CommentService/>

Diff for: getting-started/configuration.md

@@ -51,4 +51,12 @@ facades.Config().Add("path.with.dot.case1", "value1")
 facades.Config().Add("path.with.dot", map[string]any{"case3": "value3"})
 ```
 
+## Get Project Information
+
+You can use the `artisan about` command to view the framework version, configuration, etc.
+
+```bash
+go run . artisan about
+```
+
 <CommentService/>