Merge branch 'development' into add-oidc-middleware

Author: meher745

.github/workflows/go.yml

@@ -275,45 +275,45 @@ jobs:
           name: submodule-coverage-reports
           path: coverage_reports/*.cov
 
-  # Job for uploading coverage to external services (CodeClimate)
-#  upload_coverage:
-#    name: Upload Coverage📊
-#    runs-on: ubuntu-latest
-#    # This job only needs example and pkg test results, not submodules
-#    needs: [Example-Unit-Testing, PKG-Unit-Testing]
-#    # Only run this job on pushes to the development branch
-#    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
-#    steps:
-#      - name: Check out code into the Go module directory
-#        uses: actions/checkout@v5
-#
-#      # Download coverage artifacts
-#      - name: Download Coverage Report
-#        uses: actions/download-artifact@v5
-#        with:
-#          path: artifacts
-#
-#      # Merge coverage from example and pkg tests only
-#      - name: Merge Coverage Files
-#        working-directory: artifacts
-#        run: |
-#          echo "mode: set" > merged_profile.cov
-#          tail -n +2 ./Example-Test-Report/profile.cov >> merged_profile.cov
-#          tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
-#
-#          # Generate and print total coverage percentage
-#          echo "Total Coverage:"
-#          go tool cover -func=merged_profile.cov | tail -n 1
-#        shell: bash
-#
-#      # Upload merged coverage to CodeClimate for analysis
-#      - name: Upload
-#        uses: paambaati/[email protected]
-#        env:
-#          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-#        with:
-#          coverageLocations: artifacts/merged_profile.cov:gocov
-#          prefix: gofr.dev
+  # Job for uploading coverage to external services (qlty.sh)
+  upload_coverage:
+    name: Upload Coverage📊
+    runs-on: ubuntu-latest
+    # This job only needs example and pkg test results, not submodules
+    needs: [Example-Unit-Testing, PKG-Unit-Testing]
+    # Only run this job on pushes to the development branch
+    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/development'}}
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v5
+
+      - name: Install qlty CLI
+        run: curl -s https://qlty.sh/install | bash
+
+      # Download coverage artifacts
+      - name: Download Coverage Report
+        uses: actions/download-artifact@v5
+        with:
+          path: artifacts
+
+      # Merge coverage from example and pkg tests only
+      - name: Merge Coverage Files
+        working-directory: artifacts
+        run: |
+          echo "mode: set" > merged_profile.cov
+          tail -n +2 ./Example-Test-Report/profile.cov >> merged_profile.cov
+          tail -n +2 ./PKG-Coverage-Report/profile.cov >> merged_profile.cov
+
+          # Generate and print total coverage percentage
+          echo "Total Coverage:"
+          go tool cover -func=merged_profile.cov | tail -n 1
+        shell: bash
+
+      # Upload merged coverage to CodeClimate for analysis
+      - name: Upload
+        run: qlty coverage publish --input merged_profile.cov
+        env:
+          QLTY_TOKEN: ${{ secrets.QLTY_TOKEN }}
 
   # Job for code quality checks
   code_quality:

.github/workflows/typos.yml

@@ -11,4 +11,4 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v5
       - name: typos-action
-        uses: crate-ci/[email protected].3
+        uses: crate-ci/[email protected].5

.qlty/.gitignore

@@ -0,0 +1,7 @@
+*
+!configs
+!configs/**
+!hooks
+!hooks/**
+!qlty.toml
+!.gitignore

.qlty/configs/.hadolint.yaml

@@ -0,0 +1,2 @@
+ignored:
+  - DL3008

.qlty/configs/.yamllint.yaml

@@ -0,0 +1,8 @@
+rules:
+  document-start: disable
+  quoted-strings:
+    required: only-when-needed
+    extra-allowed: ["{|}"]
+  key-duplicates: {}
+  octal-values:
+    forbid-implicit-octal: true

.qlty/qlty.toml

@@ -0,0 +1,88 @@
+# This file was automatically generated by `qlty init`.
+# You can modify it to suit your needs.
+# We recommend you to commit this file to your repository.
+#
+# This configuration is used by both Qlty CLI and Qlty Cloud.
+#
+#     Qlty CLI -- Code quality toolkit for developers
+#     Qlty Cloud -- Fully automated Code Health Platform
+#
+# Try Qlty Cloud: https://qlty.sh
+#
+# For a guide to configuration, visit https://qlty.sh/d/config
+# Or for a full reference, visit https://qlty.sh/d/qlty-toml
+config_version = "0"
+
+exclude_patterns = [
+  "*_min.*",
+  "*-min.*",
+  "*.min.*",
+  "**/.yarn/**",
+  "**/*.d.ts",
+  "**/assets/**",
+  "**/bower_components/**",
+  "**/build/**",
+  "**/cache/**",
+  "**/config/**",
+  "**/db/**",
+  "**/deps/**",
+  "**/dist/**",
+  "**/extern/**",
+  "**/external/**",
+  "**/generated/**",
+  "**/Godeps/**",
+  "**/gradlew/**",
+  "**/mvnw/**",
+  "**/node_modules/**",
+  "**/protos/**",
+  "**/seed/**",
+  "**/target/**",
+  "**/templates/**",
+  "**/testdata/**",
+  "**/vendor/**", "**/mock_*", "**/*_test.go",
+]
+
+test_patterns = [
+  "**/test/**",
+  "**/spec/**",
+  "**/*.test.*",
+  "**/*.spec.*",
+  "**/*_test.*",
+  "**/*_spec.*",
+  "**/test_*.*",
+  "**/spec_*.*",
+]
+
+[smells]
+mode = "comment"
+
+[smells.boolean_logic]
+threshold = 10
+enabled = true
+
+[smells.file_complexity]
+threshold = 66
+enabled = true
+
+[smells.return_statements]
+threshold = 8
+enabled = true
+
+[smells.nested_control_flow]
+threshold = 4
+enabled = true
+
+[smells.function_parameters]
+threshold = 6
+enabled = true
+
+[smells.function_complexity]
+threshold = 13
+enabled = true
+
+[smells.duplication]
+enabled = false
+
+[[source]]
+name = "default"
+default = true

CONTRIBUTING.md

@@ -96,6 +96,13 @@ docker run -d --name arangodb \
   -e ARANGO_ROOT_PASSWORD=rootpassword \
   --pull always \
   arangodb:latest
+<<<<<<< HEAD
+docker run -d --name db -p 8091-8096:8091-8096 -p 11210-11211:11210-11211 couchbase
+=======
+docker login container-registry.oracle.com
+docker pull container-registry.oracle.com/database/free:latest
+docker run -d --name oracle-free -p 1521:1521 -e ORACLE_PWD=YourPasswordHere container-registry.oracle.com/database/free:latest
+>>>>>>> origin
 ```
 
 > [!NOTE]

docs/datasources/couchbase/page.md

@@ -0,0 +1,112 @@
+## Couchbase
+
+GoFr supports injecting `Couchbase` that implements the following interface. Any driver that implements the interface can be
+added using the `app.AddCouchbase()` method, and users can use Couchbase across the application with `gofr.Context`.
+
+```go
+type Couchbase interface {
+    Get(ctx context.Context, key string, result any) error
+
+    Insert(ctx context.Context, key string, document, result any) error
+
+    Upsert(ctx context.Context, key string, document any, result any) error
+
+    Remove(ctx context.Context, key string) error
+
+    Query(ctx context.Context, statement string, params map[string]any, result any) error
+
+    AnalyticsQuery(ctx context.Context, statement string, params map[string]any, result any) error
+}
+```
+
+Users can easily inject a driver that supports this interface, providing usability without compromising the extensibility to use multiple databases.
+Don't forget to serup the Couchbase cluster in Couchbase Web Console first. [Follow for more details](https://docs.couchbase.com/server/current/install/getting-started-docker.html#section_jvt_zvj_42b).
+To begin using Couchbase in your GoFr application, you need to import the Couchbase datasource package:
+
+```shell
+go get gofr.dev/pkg/gofr/datasource/couchbase@latest
+```
+
+### Example
+
+Here is an example of how to use the Couchbase datasource in a GoFr application:
+
+```go
+package main
+
+import (
+    "context"
+    "fmt"
+    "log"
+
+    "gofr.dev/pkg/gofr"
+    "gofr.dev/pkg/gofr/datasource/couchbase"
+)
+
+type User struct {
+    ID   string `json:"id"`
+    Name string `json:"name"`
+    Age  int    `json:"age"`
+}
+
+func main() {
+    // Create a new GoFr application
+    a := gofr.New()
+
+    // Add the Couchbase datasource to the application
+    a.AddCouchbase(couchbase.New(&couchbase.Config{
+        Host:     "localhost",
+        User:     "Administrator",
+        Password: "password",
+        Bucket:   "test-bucket",
+    }))
+
+    // Add the routes
+    a.GET("/users/{id}", getUser)
+    a.POST("/users", createUser)
+	a.DELETE("/users/{id}", deleteUser)
+
+    // Run the application
+    a.Run()
+}
+
+func getUser(c *gofr.Context) (any, error) {
+    // Get the user ID from the URL path
+    id := c.PathParam("id")
+
+    // Get the user from Couchbase
+    var user User
+    if err := c.Couchbase.Get(c, id, &user); err != nil {
+        return nil, err
+    }
+
+    return user, nil
+}
+
+func createUser(c *gofr.Context) (any, error) {
+    // Get the user from the request body
+    var user User
+    if err := c.Bind(&user); err != nil {
+        return nil, err
+    }
+
+    // Insert the user into Couchbase
+    if err := c.Couchbase.Insert(c, user.ID, user, nil); err != nil {
+        return nil, err
+    }
+
+    return "user created successfully", nil
+}
+
+func deleteUser(c *gofr.Context) (any, error) {
+	// Get the user ID from the URL path
+	id := c.PathParam("id")
+
+	// Remove the user from Couchbase
+	if err := c.Couchbase.Remove(c, id); err != nil {
+		return nil, err
+	}
+
+	return "user deleted successfully", nil
+}
+```

docs/datasources/mongodb/page.md

@@ -66,7 +66,7 @@ func main() {
 	app.AddMongo(db)
 
 	app.POST("/mongo", Insert)
-	app.GET("/mongo", Get)
+	app.GET("/mongo/{name}", Get)
 
 	app.Run()
 }
@@ -89,7 +89,7 @@ func Insert(ctx *gofr.Context) (any, error) {
 func Get(ctx *gofr.Context) (any, error) {
 	var result Person
 
-	p := ctx.Param("name")
+	p := ctx.PathParam("name")
 
 	err := ctx.Mongo.FindOne(ctx, "collection", bson.D{{"name", p}} /* valid filter */, &result)
 	if err != nil {