Updates to Ancestor Relation:

- added docs to README
- updated relation to use proper sort column
- added test to ensure eager loading produces proper output and query count

Author: ralphschindler

README.markdown

@@ -57,6 +57,7 @@ Node has following relationships that are fully functional and can be eagerly lo
 
 -   Node belongs to `parent`
 -   Node has many `children`
+-   Node has many `ancestors`
 -   Node has many `descendants`
 
 ### Inserting nodes
@@ -232,6 +233,18 @@ $result = $node->ancestors()->get();
 $result = Category::ancestorsOf($id);
 ```
 
+A collection of ancestors can be eagerly loaded:
+
+```php
+$categories = Category::with('ancestors')->paginate(30);
+
+// in view for breadcrumbs:
+@foreach($categories as $i => $category)
+    <small>{{ $category->ancestors->count() ? implode(' > ', $category->ancestors->pluck('name')->toArray()) : 'Top Level' }}</small><br>
+    {{ $category->name }}
+@endforeach
+```
+
 #### Descendants
 
 Descendants are all nodes in a sub tree, i.e. children of node, children of

src/AncestorsRelation.php

@@ -137,7 +137,7 @@ public function addEagerConstraints(array $models)
         $this->query->whereNested(function (Builder $inner) use ($sql) {
             $inner->whereRaw($sql);
         });
-        $this->query->orderBy('lft', 'ASC');
+        $this->query->orderBy($this->parent->getLftName(), 'ASC');
     }
 
     /**

src/NodeTrait.php

@@ -341,9 +341,9 @@ public function prevNodes()
     }
 
     /**
-     * Get query for ancestors to the node not including the node itself.
+     * Get query ancestors of the node.
      *
-     * @return  QueryBuilder
+     * @return  AncestorsRelation
      */
     public function ancestors()
     {

tests/NodeTest.php

@@ -860,6 +860,75 @@ public function testWhereIsLeaf()
 
         $this->assertFalse($category->isLeaf());
     }
+
+    public function testEagerLoadAncestors()
+    {
+        $queryLogCount = count(Capsule::connection()->getQueryLog());
+        $categories = Category::with('ancestors')->orderBy('name')->get();
+
+        $this->assertEquals($queryLogCount + 2, count(Capsule::connection()->getQueryLog()));
+
+        $expectedShape = [
+            'apple (3)}' => 'store (1) > notebooks (2)',
+            'galaxy (8)}' => 'store (1) > mobile (5) > samsung (7)',
+            'lenovo (4)}' => 'store (1) > notebooks (2)',
+            'lenovo (10)}' => 'store (1) > mobile (5)',
+            'mobile (5)}' => 'store (1)',
+            'nokia (6)}' => 'store (1) > mobile (5)',
+            'notebooks (2)}' => 'store (1)',
+            'samsung (7)}' => 'store (1) > mobile (5)',
+            'sony (9)}' => 'store (1) > mobile (5)',
+            'store (1)}' => '',
+            'store_2 (11)}' => ''
+        ];
+
+        $output = [];
+
+        foreach ($categories as $category) {
+            $output["{$category->name} ({$category->id})}"] = $category->ancestors->count()
+                ? implode(' > ', $category->ancestors->map(function ($cat) { return "{$cat->name} ({$cat->id})"; })->toArray())
+                : '';
+        }
+
+        $this->assertEquals($expectedShape, $output);
+    }
+
+    public function testLazyLoadAncestors()
+    {
+        $queryLogCount = count(Capsule::connection()->getQueryLog());
+        $categories = Category::orderBy('name')->get();
+
+        $this->assertEquals($queryLogCount + 1, count(Capsule::connection()->getQueryLog()));
+
+        $expectedShape = [
+            'apple (3)}' => 'store (1) > notebooks (2)',
+            'galaxy (8)}' => 'store (1) > mobile (5) > samsung (7)',
+            'lenovo (4)}' => 'store (1) > notebooks (2)',
+            'lenovo (10)}' => 'store (1) > mobile (5)',
+            'mobile (5)}' => 'store (1)',
+            'nokia (6)}' => 'store (1) > mobile (5)',
+            'notebooks (2)}' => 'store (1)',
+            'samsung (7)}' => 'store (1) > mobile (5)',
+            'sony (9)}' => 'store (1) > mobile (5)',
+            'store (1)}' => '',
+            'store_2 (11)}' => ''
+        ];
+
+        $output = [];
+
+        foreach ($categories as $category) {
+            $output["{$category->name} ({$category->id})}"] = $category->ancestors->count()
+                ? implode(' > ', $category->ancestors->map(function ($cat) { return "{$cat->name} ({$cat->id})"; })->toArray())
+                : '';
+        }
+
+        // assert that there is number of original query + 1 + number of rows to fulfill the relation
+        $this->assertEquals($queryLogCount + 12, count(Capsule::connection()->getQueryLog()));
+
+        $this->assertEquals($expectedShape, $output);
+    }
+
+
 }
 
 function all($items)