[feature] add static analysis tool

.editorconfig

@@ -6,4 +6,7 @@ end_of_line = lf
 insert_final_newline = true
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true
+
+[*.yml]
+indent_size = 2

.github/workflows/build-ci.yml

@@ -2,8 +2,6 @@ name: CI
 
 on:
     push:
-        branches:
-        tags:
     pull_request:
 
 jobs:
@@ -55,7 +53,7 @@ jobs:
             -   name: Show Docker version
                 run: if [[ "$DEBUG" == "true" ]]; then docker version && env; fi
                 env:
-                    DEBUG: ${{secrets.DEBUG}}
+                    DEBUG: ${{ secrets.DEBUG }}
             -   name: Download Composer cache dependencies from cache
                 id: composer-cache
                 run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
@@ -66,14 +64,8 @@ jobs:
                     key: ${{ matrix.os }}-composer-${{ hashFiles('**/composer.json') }}
                     restore-keys: ${{ matrix.os }}-composer-
             -   name: Install dependencies
-                run: |
-                    composer update --no-interaction $([[ "${{ matrix.mode }}" == low-deps ]] && echo ' --prefer-lowest --prefer-stable')
+                run: composer update --no-interaction $([[ "${{ matrix.mode }}" == low-deps ]] && echo ' --prefer-lowest --prefer-stable')
             -   name: Run tests
-                run: |
-                    ./vendor/bin/phpunit --coverage-clover coverage.xml
+                run: ./vendor/bin/phpunit --coverage-clover coverage.xml
                 env:
                     MONGODB_URI: 'mongodb://127.0.0.1/?replicaSet=rs'
-            -   uses: codecov/codecov-action@v3
-                with:
-                    token: ${{ secrets.CODECOV_TOKEN }}
-                    fail_ci_if_error: false

.github/workflows/coding-standards.yml

@@ -2,8 +2,6 @@ name: "Coding Standards"
 
 on:
   push:
-    branches:
-    tags:
   pull_request:
 
 env:
@@ -15,6 +13,11 @@ jobs:
     name: "phpcs"
     runs-on: "ubuntu-22.04"
 
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the
+      # added or changed files to the repository.
+      contents: write
+
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v4"
@@ -50,6 +53,67 @@ jobs:
         with:
           composer-options: "--no-suggest"
 
+      - name: "Format the code"
+        continue-on-error: true
+        run: |
+          mkdir .cache
+          ./vendor/bin/phpcbf
+
       # The -q option is required until phpcs v4 is released
       - name: "Run PHP_CodeSniffer"
         run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"
+
+      - name: "Commit the changes"
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "apply phpcbf formatting"
+
+  analysis:
+    runs-on: "ubuntu-22.04"
+    continue-on-error: true
+    strategy:
+      matrix:
+        php:
+          - '8.1'
+          - '8.2'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl, mbstring
+          tools: composer:v2
+          coverage: none
+
+      - name: Cache dependencies
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: ./vendor
+          key: composer-${{ hashFiles('**/composer.lock') }}
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Restore cache PHPStan results
+        id: phpstan-cache-restore
+        uses: actions/cache/restore@v3
+        with:
+          path: .cache
+          key: "phpstan-result-cache-${{ github.run_id }}"
+          restore-keys: |
+            phpstan-result-cache-
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan analyse --no-interaction --no-progress --ansi
+
+      - name: Save cache PHPStan results
+        id: phpstan-cache-save
+        if: always()
+        uses: actions/cache/save@v3
+        with:
+          path: .cache
+          key: ${{ steps.phpstan-cache-restore.outputs.cache-primary-key }}

.gitignore

@@ -3,9 +3,9 @@
 *.sublime-workspace
 .DS_Store
 .idea/
-.phpunit.cache/
-.phpcs-cache
 /vendor
 composer.lock
 composer.phar
 phpunit.xml
+phpstan.neon
+/.cache/

composer.json

@@ -35,7 +35,8 @@
         "orchestra/testbench": "^8.0",
         "mockery/mockery": "^1.4.4",
         "doctrine/coding-standard": "12.0.x-dev",
-        "spatie/laravel-query-builder": "^5.6"
+        "spatie/laravel-query-builder": "^5.6",
+        "phpstan/phpstan": "^1.10"
     },
     "replace": {
         "jenssegers/mongodb": "self.version"

phpcs.xml.dist

@@ -3,7 +3,7 @@
     <arg name="basepath" value="." />
     <arg name="extensions" value="php" />
     <arg name="parallel" value="80" />
-    <arg name="cache" value=".phpcs-cache" />
+    <arg name="cache" value=".cache/phpcs" />
     <arg name="colors" />
 
     <!-- Ignore warnings (n), show progress of the run (p), and show sniff names (s) -->

phpstan-baseline.neon

@@ -0,0 +1,31 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Variable \\$value on left side of \\?\\? always exists and is always null\\.$#"
+			count: 1
+			path: src/Eloquent/Model.php
+
+		-
+			message: "#^Variable \\$value on left side of \\?\\? always exists and is not nullable\\.$#"
+			count: 1
+			path: src/Eloquent/Model.php
+
+		-
+			message: "#^Cannot call method modelKeys\\(\\) on array\\|Illuminate\\\\Support\\\\Collection\\.$#"
+			count: 1
+			path: src/Relations/BelongsToMany.php
+
+		-
+			message: "#^Method Illuminate\\\\Database\\\\Eloquent\\\\Model\\:\\:push\\(\\) invoked with 3 parameters, 0 required\\.$#"
+			count: 3
+			path: src/Relations/BelongsToMany.php
+
+		-
+			message: "#^Method Illuminate\\\\Database\\\\Eloquent\\\\Model\\:\\:push\\(\\) invoked with 3 parameters, 0 required\\.$#"
+			count: 6
+			path: src/Relations/MorphToMany.php
+
+		-
+			message: "#^Method Illuminate\\\\Database\\\\Schema\\\\Blueprint\\:\\:create\\(\\) invoked with 1 parameter, 0 required\\.$#"
+			count: 1
+			path: src/Schema/Builder.php

phpstan.neon.dist

@@ -0,0 +1,16 @@
+includes:
+    - ./phpstan-baseline.neon
+
+parameters:
+    tmpDir: .cache/phpstan
+
+    paths:
+        - src
+
+    level: 2
+
+    editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
+
+    ignoreErrors:
+        - '#Unsafe usage of new static#'
+        - '#Call to an undefined method [a-zA-Z0-9\\_\<\>]+::[a-zA-Z]+\(\)#'

phpunit.xml.dist

@@ -1,15 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.4/phpunit.xsd"
-         backupGlobals="false"
          bootstrap="vendor/autoload.php"
-         colors="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         cacheDirectory=".phpunit.cache"
-         backupStaticProperties="false"
->
-    <coverage/>
+         cacheDirectory=".cache/phpunit"
+         executionOrder="depends,defects"
+         beStrictAboutCoverageMetadata="true"
+         beStrictAboutOutputDuringTests="true"
+         failOnRisky="true"
+         failOnWarning="true">
     <testsuites>
         <testsuite name="Test Suite">
             <directory>tests/</directory>
@@ -20,10 +18,15 @@
         <env name="MONGODB_DATABASE" value="unittest"/>
         <env name="SQLITE_DATABASE" value=":memory:"/>
         <env name="QUEUE_CONNECTION" value="database"/>
+
+        <ini name="memory_limit" value="-1"/>
     </php>
-    <source>
+
+    <source restrictDeprecations="true"
+        restrictNotices="true"
+        restrictWarnings="true">
         <include>
-            <directory suffix=".php">./src</directory>
+            <directory>./src</directory>
         </include>
     </source>
 </phpunit>

src/Eloquent/Builder.php

@@ -16,6 +16,7 @@
 use function is_array;
 use function iterator_to_array;
 
+/** @method \MongoDB\Laravel\Query\Builder toBase() */
 class Builder extends EloquentBuilder
 {
     use QueriesRelationships;
@@ -219,16 +220,15 @@ protected function ensureOrderForCursorPagination($shouldReverse = false)
         }
 
         if ($shouldReverse) {
-            $this->query->orders = collect($this->query->orders)->map(function ($direction) {
-                return $direction === 1 ? -1 : 1;
-            })->toArray();
+            $this->query->orders = collect($this->query->orders)
+                ->map(static fn (int $direction) => $direction === 1 ? -1 : 1)
+                ->toArray();
         }
 
-        return collect($this->query->orders)->map(function ($direction, $column) {
-            return [
+        return collect($this->query->orders)
+            ->map(static fn ($direction, $column) => [
                 'column' => $column,
                 'direction' => $direction === 1 ? 'asc' : 'desc',
-            ];
-        })->values();
+            ])->values();
     }
 }

src/Relations/BelongsToMany.php

@@ -15,8 +15,8 @@
 use function array_map;
 use function array_merge;
 use function array_values;
+use function assert;
 use function count;
-use function is_array;
 use function is_numeric;
 
 class BelongsToMany extends EloquentBelongsToMany
@@ -82,11 +82,11 @@ protected function setWhere()
     }
 
     /** @inheritdoc */
-    public function save(Model $model, array $joining = [], $touch = true)
+    public function save(Model $model, array $pivotAttributes = [], $touch = true)
     {
         $model->save(['touch' => false]);
 
-        $this->attach($model, $joining, $touch);
+        $this->attach($model, $pivotAttributes, $touch);
 
         return $model;
     }
@@ -131,7 +131,7 @@ public function sync($ids, $detaching = true)
             $current = $ids->modelKeys();
         }
 
-        $records = $this->formatSyncList($ids);
+        $records = $this->formatRecordsList($ids);
 
         $current = Arr::wrap($current);
 
@@ -171,6 +171,7 @@ public function sync($ids, $detaching = true)
     public function updateExistingPivot($id, array $attributes, $touch = true)
     {
         // Do nothing, we have no pivot table.
+        return $this;
     }
 
     /** @inheritdoc */
@@ -229,6 +230,8 @@ public function detach($ids = [], $touch = true)
         }
 
         // Remove the relation to the parent.
+        assert($this->parent instanceof \MongoDB\Laravel\Eloquent\Model);
+        assert($query instanceof \MongoDB\Laravel\Eloquent\Builder);
         $query->pull($this->foreignPivotKey, $this->parent->getKey());
 
         if ($touch) {
@@ -266,7 +269,7 @@ public function newPivotQuery()
     /**
      * Create a new query builder for the related model.
      *
-     * @return \Illuminate\Database\Query\Builder
+     * @return Builder|Model
      */
     public function newRelatedQuery()
     {
@@ -295,28 +298,6 @@ public function getQualifiedRelatedPivotKeyName()
         return $this->relatedPivotKey;
     }
 
-    /**
-     * Format the sync list so that it is keyed by ID. (Legacy Support)
-     * The original function has been renamed to formatRecordsList since Laravel 5.3.
-     *
-     * @deprecated
-     *
-     * @return array
-     */
-    protected function formatSyncList(array $records)
-    {
-        $results = [];
-        foreach ($records as $id => $attributes) {
-            if (! is_array($attributes)) {
-                [$id, $attributes] = [$attributes, []];
-            }
-
-            $results[$id] = $attributes;
-        }
-
-        return $results;
-    }
-
     /**
      * Get the name of the "where in" method for eager loading.
      *