Fix eager loading issue ancestors/descendants relationships (fixes lazychaser#339, lazychaser#351, lazychaser#329, lazychaser#334, lazychaser#271)

The way eager loading is handled in Laravel has changed since the
original implementation of the NestedSet library. It was not possible
anymore to apply the scope to eagerly loaded ancestors/descendants
relationships.

Also removed defaultOrder() from the relations so custom orders can be
applied. Sorting should never be a part of a relation anyway, or it
would be hard to customize.

Author: Ciaro

phpunit.xml

@@ -7,7 +7,6 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="true"
 >
     <testsuites>
         <testsuite name="Package Test Suite">

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

@@ -154,6 +154,11 @@ public function getResults()
      */
     public function addEagerConstraints(array $models)
     {
+        // The first model in the array is always the parent, so add the scope constraints based on that model.
+        // @link https://github.com/laravel/framework/pull/25240
+        // @link https://github.com/lazychaser/laravel-nestedset/issues/351
+        optional($models[0])->applyNestedSetScope($this->query);
+
         $this->query->whereNested(function (Builder $inner) use ($models) {
             // We will use this query in order to apply constraints to the
             // base query builder

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();
     }
 
     /**

src/NodeTrait.php

@@ -248,7 +248,7 @@ public function children()
      */
     public function descendants()
     {
-        return new DescendantsRelation($this->newScopedQuery(), $this);
+        return new DescendantsRelation($this->newQuery(), $this);
     }
 
     /**
@@ -337,7 +337,7 @@ public function prevNodes()
      */
     public function ancestors()
     {
-        return new AncestorsRelation($this->newScopedQuery(), $this);
+        return new AncestorsRelation($this->newQuery(), $this);
     }
 
     /**

tests/NodeTest.php

@@ -870,7 +870,9 @@ public function testFlatTree()
         $this->assertEquals('galaxy', $tree[3]->name);
     }
 
-    public function testSeveralNodesModelWork()
+    // Commented, cause there is no assertion here and otherwise the test is marked as risky in PHPUnit 7.
+    // What's the purpose of this method? @todo: remove/update?
+    /*public function testSeveralNodesModelWork()
     {
         $category = new Category;
 
@@ -883,7 +885,7 @@ public function testSeveralNodesModelWork()
         $duplicate->name = 'test';
 
         $duplicate->saveAsRoot();
-    }
+    }*/
 
     public function testWhereIsLeaf()
     {

tests/ScopedNodeTest.php

@@ -193,11 +193,13 @@ protected function assertOtherScopeNotAffected()
         $this->assertEquals(1, $node->getLft());
     }
 
-    public function testRebuildsTree()
+    // Commented, cause there is no assertion here and otherwise the test is marked as risky in PHPUnit 7.
+    // What's the purpose of this method? @todo: remove/update?
+    /*public function testRebuildsTree()
     {
         $data = [];
         MenuItem::scoped([ 'menu_id' => 2 ])->rebuildTree($data);
-    }
+    }*/
 
     /**
      * @expectedException LogicException