feat: add Scout package - full-text search for Hypervel

.env.example

@@ -0,0 +1,16 @@
+# Integration Tests
+# Copy this file to .env and configure to run integration tests locally.
+# Tests are skipped by default. Set the RUN_*_INTEGRATION_TESTS vars to enable.
+
+# Meilisearch Integration Tests
+RUN_MEILISEARCH_INTEGRATION_TESTS=false
+MEILISEARCH_HOST=127.0.0.1
+MEILISEARCH_PORT=7700
+MEILISEARCH_KEY=secret
+
+# Typesense Integration Tests
+RUN_TYPESENSE_INTEGRATION_TESTS=false
+TYPESENSE_HOST=127.0.0.1
+TYPESENSE_PORT=8108
+TYPESENSE_API_KEY=secret
+TYPESENSE_PROTOCOL=http

.github/workflows/tests.yml

@@ -36,4 +36,80 @@ jobs:
       - name: Execute tests
         run: |
             PHP_CS_FIXER_IGNORE_ENV=1 vendor/bin/php-cs-fixer fix --dry-run --diff
-            vendor/bin/phpunit -c phpunit.xml.dist
+            vendor/bin/phpunit -c phpunit.xml.dist --exclude-group integration
+
+  meilisearch_integration_tests:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
+
+    name: Integration (Meilisearch)
+
+    services:
+      meilisearch:
+        image: getmeili/meilisearch:latest
+        env:
+          MEILI_MASTER_KEY: secret
+          MEILI_NO_ANALYTICS: true
+        ports:
+          - 7700:7700
+        options: >-
+          --health-cmd "curl -f http://localhost:7700/health"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    container:
+      image: phpswoole/swoole:6.0.2-php8.4
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+            COMPOSER_MEMORY_LIMIT=-1 composer install --prefer-dist -n -o
+
+      - name: Execute Meilisearch integration tests
+        env:
+          RUN_MEILISEARCH_INTEGRATION_TESTS: true
+          MEILISEARCH_HOST: meilisearch
+          MEILISEARCH_PORT: 7700
+          MEILISEARCH_KEY: secret
+        run: |
+            vendor/bin/phpunit -c phpunit.xml.dist --group meilisearch-integration
+
+  typesense_integration_tests:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]') && !contains(github.event.head_commit.message, '[ci skip]')"
+
+    name: Integration (Typesense)
+
+    services:
+      typesense:
+        image: typesense/typesense:27.1
+        env:
+          TYPESENSE_API_KEY: secret
+          TYPESENSE_DATA_DIR: /tmp
+        ports:
+          - 8108:8108
+
+    container:
+      image: phpswoole/swoole:6.0.2-php8.4
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+            COMPOSER_MEMORY_LIMIT=-1 composer install --prefer-dist -n -o
+
+      - name: Execute Typesense integration tests
+        env:
+          RUN_TYPESENSE_INTEGRATION_TESTS: true
+          TYPESENSE_HOST: typesense
+          TYPESENSE_PORT: 8108
+          TYPESENSE_API_KEY: secret
+          TYPESENSE_PROTOCOL: http
+        run: |
+            vendor/bin/phpunit -c phpunit.xml.dist --group typesense-integration

.gitignore

@@ -4,6 +4,7 @@
 composer.lock
 /phpunit.xml
 .phpunit.result.cache
+.env
 !tests/Foundation/fixtures/hyperf1/composer.lock
 tests/Http/fixtures
 .env

composer.json

@@ -58,6 +58,7 @@
             "Hypervel\\Redis\\": "src/redis/src/",
             "Hypervel\\Router\\": "src/router/src/",
             "Hypervel\\Sanctum\\": "src/sanctum/src/",
+            "Hypervel\\Scout\\": "src/scout/src/",
             "Hypervel\\Session\\": "src/session/src/",
             "Hypervel\\Socialite\\": "src/socialite/src/",
             "Hypervel\\Support\\": "src/support/src/",
@@ -174,6 +175,7 @@
         "hypervel/queue": "self.version",
         "hypervel/redis": "self.version",
         "hypervel/router": "self.version",
+        "hypervel/scout": "self.version",
         "hypervel/session": "self.version",
         "hypervel/socialite": "self.version",
         "hypervel/support": "self.version",
@@ -194,7 +196,9 @@
         "symfony/mailgun-mailer": "Required to enable support for the Mailgun mail transport (^6.2).",
         "symfony/postmark-mailer": "Required to enable support for the Postmark mail transport (^6.2).",
         "ably/ably-php": "Required to use the Ably broadcast driver (^1.0).",
-        "pusher/pusher-php-server": "Required to use the Pusher broadcast driver (^6.0|^7.0)."
+        "pusher/pusher-php-server": "Required to use the Pusher broadcast driver (^6.0|^7.0).",
+        "meilisearch/meilisearch-php": "Required to use the Meilisearch Scout driver (^1.16).",
+        "typesense/typesense-php": "Required to use the Typesense Scout driver (^5.2)."
     },
     "require-dev": {
         "ably/ably-php": "^1.0",
@@ -211,14 +215,16 @@
         "league/flysystem-google-cloud-storage": "^3.0",
         "league/flysystem-path-prefixing": "^3.3",
         "league/flysystem-read-only": "^3.3",
+        "meilisearch/meilisearch-php": "^1.16",
         "mockery/mockery": "1.6.x-dev",
         "nunomaduro/collision": "^8.5",
         "pda/pheanstalk": "v5.0.9",
         "phpstan/phpstan": "^2.0",
         "phpunit/phpunit": "10.5.45",
         "pusher/pusher-php-server": "^7.2",
         "swoole/ide-helper": "~5.1.0",
-        "symfony/yaml": "^7.3"
+        "symfony/yaml": "^7.3",
+        "typesense/typesense-php": "^5.2"
     },
     "config": {
         "sort-packages": true
@@ -260,6 +266,7 @@
         "hypervel": {
             "providers": [
                 "Hypervel\\Notifications\\NotificationServiceProvider",
+                "Hypervel\\Scout\\ScoutServiceProvider",
                 "Hypervel\\Telescope\\TelescopeServiceProvider",
                 "Hypervel\\Sentry\\SentryServiceProvider"
             ]

phpstan.neon.dist

@@ -43,6 +43,7 @@ parameters:
     - '#Call to an undefined method Hyperf\\Database\\Query\\Builder::firstOrFail\(\)#'
     - '#Access to an undefined property Hyperf\\Collection\\HigherOrderCollectionProxy#'
     - '#Call to an undefined method Hyperf\\Tappable\\HigherOrderTapProxy#'
+    - '#Trait Hypervel\\Scout\\Searchable is used zero times and is not analysed#'
     - message: '#.*#'
       paths:
         - src/core/src/Database/Eloquent/Builder.php

phpunit.xml.dist

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit backupGlobals="false"
+         bootstrap="tests/bootstrap.php"
          beStrictAboutTestsThatDoNotTestAnything="false"
          colors="true"
          processIsolation="false"

src/scout/LICENSE.md

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) Taylor Otwell
+
+Copyright (c) Hypervel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/scout/README.md

@@ -0,0 +1,4 @@
+Scout for Hypervel
+===
+
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/hypervel/scout)

src/scout/composer.json

@@ -0,0 +1,58 @@
+{
+    "name": "hypervel/scout",
+    "type": "library",
+    "description": "Full-text search for Eloquent models.",
+    "license": "MIT",
+    "keywords": [
+        "php",
+        "hypervel",
+        "scout",
+        "search",
+        "full-text-search",
+        "meilisearch",
+        "typesense",
+        "database"
+    ],
+    "authors": [
+        {
+            "name": "Albert Chen",
+            "email": "albert@hypervel.org"
+        }
+    ],
+    "support": {
+        "issues": "https://github.com/hypervel/components/issues",
+        "source": "https://github.com/hypervel/components"
+    },
+    "autoload": {
+        "psr-4": {
+            "Hypervel\\Scout\\": "src/"
+        }
+    },
+    "require": {
+        "php": "^8.2",
+        "hypervel/config": "^0.3",
+        "hypervel/console": "^0.3",
+        "hypervel/core": "^0.3",
+        "hypervel/coroutine": "^0.3",
+        "hypervel/event": "^0.3",
+        "hypervel/queue": "^0.3",
+        "hypervel/support": "^0.3"
+    },
+    "suggest": {
+        "meilisearch/meilisearch-php": "Required for Meilisearch driver (^1.0)",
+        "typesense/typesense-php": "Required for Typesense driver (^5.2)"
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "0.3-dev"
+        },
+        "hypervel": {
+            "providers": [
+                "Hypervel\\Scout\\ScoutServiceProvider"
+            ]
+        }
+    }
+}