Laravel Nested Sets v7 - Laravel 11, PHP 8.3, PHPUnit 10.* and drop EOL PHP support

.github/workflows/run-tests.yml

@@ -0,0 +1,43 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - "*"
+  schedule:
+  - cron: '0 0 * * *'
+
+jobs:
+  php-tests:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    env:
+      COMPOSER_NO_INTERACTION: 1
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [8.3, 8.2]
+
+    name: P${{ matrix.php }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php }}
+        coverage: none
+        tools: composer:v2
+
+    - name: Install dependencies
+      run: |
+        composer install -o --quiet
+
+    - name: Execute Unit Tests
+      run: composer test

.gitignore

@@ -3,3 +3,4 @@
 composer.phar
 composer.lock
 .DS_Store
+.phpunit.result.cache

CHANGELOG.markdown

@@ -1,4 +1,14 @@
-### 4.2.8
+### 4.3.4
+*   Support Laravel 5.8
+
+### 4.3.3
+*   Support Laravel 5.7
+
+### 4.3.2
+*   Support Laravel 5.6
+*   Added `nestedSet` and `dropNestedSet` blueprint macros
+
+### 4.3.0
 *   Support Laravel 5.5
 *   Added `fixSubtree` and `rebuildSubtree` methods
 *   Increased performance of tree rebuilding
@@ -104,4 +114,4 @@
 ### 1.1.0
 
 *   `Collection::toDictionary` is now obsolete. Use `Collection::groupBy`.
-*   Laravel 4.2 is required
+*   Laravel 4.2 is required

README.markdown

@@ -4,17 +4,18 @@
 [![Latest Unstable Version](https://poser.pugx.org/kalnoy/nestedset/v/unstable.svg)](https://packagist.org/packages/kalnoy/nestedset)
 [![License](https://poser.pugx.org/kalnoy/nestedset/license.svg)](https://packagist.org/packages/kalnoy/nestedset)
 
-This is a Laravel 4-5 package for working with trees in relational databases.
-
-*   **Laravel 5.2, 5.3, 5.4, 5.5** is supported since v4
+This is a Laravel 4-11 package for working with trees in relational databases.
+
+*   **Laravel 11.0** is supported since v7
+*   **Laravel 10.0** is supported since v6.0.2
+*   **Laravel 9.0** is supported since v6.0.1
+*   **Laravel 8.0** is supported since v6.0.0
+*   **Laravel 5.7, 5.8, 6.0, 7.0** is supported since v5
+*   **Laravel 5.5, 5.6** is supported since v4.3
+*   **Laravel 5.2, 5.3, 5.4** is supported since v4
 *   **Laravel 5.1** is supported in v3
 *   **Laravel 4** is supported in v2
 
-Although this project is completely free for use, I appreciate any support!
-
--   __[Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5TJUM7FYU5VR2)__
--   My Visa: 4276 0700 1073 4244
-
 __Contents:__
 
 - [Theory](#what-are-nested-sets)
@@ -384,6 +385,9 @@ position.
 Various constraints that can be applied to the query builder:
 
 -   __whereIsRoot()__ to get only root nodes;
+-   __hasParent()__ to get non-root nodes;
+-   __whereIsLeaf()__ to get only leaves;
+-   __hasChildren()__ to get non-leave nodes;
 -   __whereIsAfter($id)__ to get every node (not just siblings) that are after a node
     with specified id;
 -   __whereIsBefore($id)__ to get every node that is before a node with specified id.
@@ -571,17 +575,17 @@ protected function getScopeAttributes()
 }
 ```
 
-But now in order to execute some custom query, you need to provide attributes
+But now, in order to execute some custom query, you need to provide attributes
 that are used for scoping:
 
 ```php
 MenuItem::scoped([ 'menu_id' => 5 ])->withDepth()->get(); // OK
 MenuItem::descendantsOf($id)->get(); // WRONG: returns nodes from other scope
-MenuItem::scoped([ 'menu_id' => 5 ])->fixTree();
+MenuItem::scoped([ 'menu_id' => 5 ])->fixTree(); // OK
 ```
 
 When requesting nodes using model instance, scopes applied automatically based
-on the attributes of that model. See examples:
+on the attributes of that model:
 
 ```php
 $node = MenuItem::findOrFail($id);
@@ -595,12 +599,13 @@ To get scoped query builder using instance:
 $node->newScopedQuery();
 ```
 
-Note, that scoping is not required when retrieving model by primary key
-(since the key is unique):
+#### Scoping and eager loading
+
+Always use scoped query when eager loading:
 
 ```php
-$node = MenuItem::findOrFail($id); // OK
-$node = MenuItem::scoped([ 'menu_id' => 5 ])->findOrFail(); // OK, but redundant
+MenuItem::scoped([ 'menu_id' => 5])->with('descendants')->findOrFail($id); // OK
+MenuItem::with('descendants')->findOrFail($id); // WRONG
 ```
 
 Requirements
@@ -625,7 +630,21 @@ composer require kalnoy/nestedset
 
 #### The schema
 
-You can use a method to add needed columns with default names:
+For Laravel 5.5 and above users:
+
+```php
+Schema::create('table', function (Blueprint $table) {
+    ...
+    $table->nestedSet();
+});
+
+// To drop columns
+Schema::table('table', function (Blueprint $table) {
+    $table->dropNestedSet();
+});
+```
+
+For prior Laravel versions:
 
 ```php
 ...

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "kalnoy/nestedset",
-    "description": "Nested Set Model for Laravel 4-5",
+    "description": "Nested Set Model for Laravel 5.7 and up",
     "keywords": ["laravel", "nested sets", "nsm", "database", "hierarchy"],
     "license": "MIT",
 
@@ -12,10 +12,10 @@
     ],
 
     "require": {
-        "php": ">=5.5.9",
-        "illuminate/support": "5.2 - 5.5",
-        "illuminate/database": "5.2 - 5.5",
-        "illuminate/events": "5.2 - 5.5"
+        "php": "^8.2",
+        "illuminate/support": "^11.0",
+        "illuminate/database": "^11.0",
+        "illuminate/events": "^11.0"
     },
 
     "autoload": {
@@ -24,15 +24,33 @@
         }
     },
 
+    "autoload-dev": {
+        "psr-4": {
+            "Kalnoy\\Nestedset\\Tests\\": "tests/"
+        }
+    },
+
     "require-dev": {
-        "phpunit/phpunit": "4.8.*"
+        "phpunit/phpunit": "10.*"
     },
 
     "minimum-stability": "dev",
+    "prefer-stable": true,
 
     "extra": {
         "branch-alias": {
-            "dev-master": "v4.2.x-dev"
+            "dev-master": "v5.0.x-dev"
+        },
+
+        "laravel": {
+            "providers": [
+                "Kalnoy\\Nestedset\\NestedSetServiceProvider"
+            ]
         }
+    },
+    "scripts": {
+        "test": [
+            "@php ./vendor/bin/phpunit"
+        ]
     }
 }

phpunit.php

@@ -8,4 +8,5 @@
 $capsule->bootEloquent();
 $capsule->setAsGlobal();
 
-include __DIR__.'/tests/models/Category.php';
+include __DIR__.'/tests/models/Category.php';
+include __DIR__.'/tests/models/MenuItem.php';

phpunit.xml

@@ -1,24 +1,21 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="phpunit.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="true"
-         syntaxCheck="false"
->
-    <testsuites>
-        <testsuite name="Package Test Suite">
-            <directory suffix=".php">./tests/</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./src</directory>
-        </whitelist>
-    </filter>
-</phpunit>
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  backupGlobals="false"
+  bootstrap="phpunit.php"
+  colors="true"
+  processIsolation="false"
+  xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+  cacheDirectory=".phpunit.cache"
+  backupStaticProperties="false"
+>
+  <testsuites>
+    <testsuite name="Package Test Suite">
+      <directory suffix=".php">./tests/</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
+</phpunit>

src/AncestorsRelation.php

@@ -15,7 +15,8 @@ public function addConstraints()
     {
         if ( ! static::$constraints) return;
 
-        $this->query->whereAncestorOf($this->parent)->defaultOrder();
+        $this->query->whereAncestorOf($this->parent)
+            ->applyNestedSetScope();
     }
 
     /**

src/BaseRelation.php

@@ -111,28 +111,15 @@ public function initRelation(array $models, $relation)
         return $models;
     }
 
-    /**
-     * @param EloquentBuilder $query
-     * @param EloquentBuilder $parent
-     * @param array $columns
-     *
-     * @return mixed
-     */
-    public function getRelationQuery(
-        EloquentBuilder $query, EloquentBuilder $parent,
-        $columns = [ '*' ]
-    ) {
-        return $this->getRelationExistenceQuery($query, $parent, $columns);
-    }
-
     /**
      * Get a relationship join table hash.
      *
+     * @param  bool $incrementJoinCount
      * @return string
      */
-    public function getRelationCountHash()
+    public function getRelationCountHash($incrementJoinCount = true)
     {
-        return 'nested_set_'.self::$selfJoinCount++;
+        return 'nested_set_'.($incrementJoinCount ? static::$selfJoinCount++ : static::$selfJoinCount);
     }
 
     /**
@@ -154,10 +141,6 @@ public function getResults()
      */
     public function addEagerConstraints(array $models)
     {
-        $model = reset($models);
-
-        $this->query = $model->newScopedQuery();
-
         $this->query->whereNested(function (Builder $inner) use ($models) {
             // We will use this query in order to apply constraints to the
             // base query builder
@@ -207,4 +190,16 @@ protected function matchForModel(Model $model, EloquentCollection $results)
 
         return $result;
     }
-}
+
+    /**
+     * Get the plain foreign key.
+     *
+     * @return mixed
+     */
+    public function getForeignKeyName()
+    {
+        // Return a stub value for relation
+        // resolvers which need this function.
+        return NestedSet::PARENT_ID;
+    }
+}

src/DescendantsRelation.php

@@ -17,7 +17,8 @@ public function addConstraints()
     {
         if ( ! static::$constraints) return;
 
-        $this->query->whereDescendantOf($this->parent);
+        $this->query->whereDescendantOf($this->parent)
+        ->applyNestedSetScope();
     }
 
     /**