Assert same scope

lazychaser · lazychaser · commit 0ded8b27315d · 2017-05-13T10:03:18.000+03:00
diff --git a/src/NodeTrait.php b/src/NodeTrait.php
@@ -189,7 +189,7 @@ protected function actionAppendOrPrepend(self $parent, $prepend = false)
     protected function setParent($value)
     {
         $this->setParentId($value ? $value->getKey() : null)
-             ->setRelation('parent', $value);
+            ->setRelation('parent', $value);
 
         return $this;
     }
@@ -230,7 +230,7 @@ public function refreshNode()
     public function parent()
     {
         return $this->belongsTo(get_class($this), $this->getParentIdName())
-                    ->setModel($this);
+            ->setModel($this);
     }
 
     /**
@@ -241,7 +241,7 @@ public function parent()
     public function children()
     {
         return $this->hasMany(get_class($this), $this->getParentIdName())
-                    ->setModel($this);
+            ->setModel($this);
     }
 
     /**
@@ -262,25 +262,25 @@ public function descendants()
     public function siblings()
     {
         return $this->newScopedQuery()
-                    ->where($this->getKeyName(), '<>', $this->getKey())
-                    ->where($this->getParentIdName(), '=', $this->getParentId());
+            ->where($this->getKeyName(), '<>', $this->getKey())
+            ->where($this->getParentIdName(), '=', $this->getParentId());
     }
 
-   /**
+    /**
      * Get the node siblings and the node itself.
      *
      * @return \Kalnoy\Nestedset\QueryBuilder
      */
     public function siblingsAndSelf()
     {
         return $this->newScopedQuery()
-                    ->where($this->getParentIdName(), '=', $this->getParentId());
+            ->where($this->getParentIdName(), '=', $this->getParentId());
     }
 
     /**
      * Get query for the node siblings and the node itself.
      *
-     * @param  array  $columns
+     * @param  array $columns
      *
      * @return \Illuminate\Database\Eloquent\Collection
      */
@@ -297,7 +297,7 @@ public function getSiblingsAndSelf(array $columns = [ '*' ])
     public function nextSiblings()
     {
         return $this->nextNodes()
-                    ->where($this->getParentIdName(), '=', $this->getParentId());
+            ->where($this->getParentIdName(), '=', $this->getParentId());
     }
 
     /**
@@ -308,7 +308,7 @@ public function nextSiblings()
     public function prevSiblings()
     {
         return $this->prevNodes()
-                    ->where($this->getParentIdName(), '=', $this->getParentId());
+            ->where($this->getParentIdName(), '=', $this->getParentId());
     }
 
     /**
@@ -319,7 +319,7 @@ public function prevSiblings()
     public function nextNodes()
     {
         return $this->newScopedQuery()
-                    ->where($this->getLftName(), '>', $this->getLft());
+            ->where($this->getLftName(), '>', $this->getLft());
     }
 
     /**
@@ -330,7 +330,7 @@ public function nextNodes()
     public function prevNodes()
     {
         return $this->newScopedQuery()
-                    ->where($this->getLftName(), '<', $this->getLft());
+            ->where($this->getLftName(), '<', $this->getLft());
     }
 
     /**
@@ -426,7 +426,8 @@ public function prependToNode(self $parent)
     public function appendOrPrependTo(self $parent, $prepend = false)
     {
         $this->assertNodeExists($parent)
-             ->assertNotDescendant($parent);
+            ->assertNotDescendant($parent)
+            ->assertSameScope($parent);
 
         $this->setParent($parent)->dirtyBounds();
 
@@ -465,7 +466,9 @@ public function beforeNode(self $node)
      */
     public function beforeOrAfterNode(self $node, $after = false)
     {
-        $this->assertNodeExists($node)->assertNotDescendant($node);
+        $this->assertNodeExists($node)
+            ->assertNotDescendant($node)
+            ->assertSameScope($node);
 
         if ( ! $this->isSiblingOf($node)) {
             $this->setParent($node->getRelationValue('parent'));
@@ -529,9 +532,9 @@ public function rawNode($lft, $rgt, $parentId)
     public function up($amount = 1)
     {
         $sibling = $this->prevSiblings()
-                        ->defaultOrder('desc')
-                        ->skip($amount - 1)
-                        ->first();
+            ->defaultOrder('desc')
+            ->skip($amount - 1)
+            ->first();
 
         if ( ! $sibling) return false;
 
@@ -548,9 +551,9 @@ public function up($amount = 1)
     public function down($amount = 1)
     {
         $sibling = $this->nextSiblings()
-                        ->defaultOrder()
-                        ->skip($amount - 1)
-                        ->first();
+            ->defaultOrder()
+            ->skip($amount - 1)
+            ->first();
 
         if ( ! $sibling) return false;
 
@@ -587,7 +590,7 @@ protected function insertAt($position)
     protected function moveNode($position)
     {
         $updated = $this->newNestedSetQuery()
-                        ->moveNode($this->getKey(), $position) > 0;
+                ->moveNode($this->getKey(), $position) > 0;
 
         if ($updated) $this->refreshNode();
 
@@ -649,8 +652,8 @@ protected function deleteDescendants()
     protected function restoreDescendants($deletedAt)
     {
         $this->descendants()
-             ->where($this->getDeletedAtColumn(), '>=', $deletedAt)
-             ->restore();
+            ->where($this->getDeletedAtColumn(), '>=', $deletedAt)
+            ->restore();
     }
 
     /**
@@ -932,8 +935,8 @@ public function getPrevNode(array $columns = [ '*' ])
     public function getAncestors(array $columns = [ '*' ])
     {
         return $this->newScopedQuery()
-                    ->defaultOrder()
-                    ->ancestorsOf($this, $columns);
+            ->defaultOrder()
+            ->ancestorsOf($this, $columns);
     }
 
     /**
@@ -1006,7 +1009,7 @@ public function getPrevSibling(array $columns = [ '*' ])
     public function isDescendantOf(self $other)
     {
         return $this->getLft() > $other->getLft() &&
-               $this->getLft() < $other->getRgt();
+            $this->getLft() < $other->getRgt();
     }
 
     /**
@@ -1019,7 +1022,7 @@ public function isDescendantOf(self $other)
     public function isSelfOrDescendantOf(self $other)
     {
         return $this->getLft() >= $other->getLft() &&
-               $this->getLft() < $other->getRgt();
+            $this->getLft() < $other->getRgt();
     }
 
     /**
@@ -1186,4 +1189,19 @@ protected function assertNodeExists(self $node)
         return $this;
     }
 
+    /**
+     * @param self $node
+     */
+    protected function assertSameScope(self $node)
+    {
+        if ( ! $scoped = $this->getScopeAttributes()) {
+            return;
+        }
+
+        foreach ($scoped as $attr) {
+            if ($this->getAttribute($attr) != $node->getAttribute($attr)) {
+                throw new LogicException('Nodes must be in the same scope');
+            }
+        }
+    }
 }
diff --git a/tests/NodeTest.php b/tests/NodeTest.php
@@ -11,6 +11,8 @@ public static function setUpBeforeClass()
 
         $schema->dropIfExists('categories');
 
+        Capsule::disableQueryLog();
+
         $schema->create('categories', function (\Illuminate\Database\Schema\Blueprint $table) {
             $table->increments('id');
             $table->string('name');
@@ -27,6 +29,8 @@ public function setUp()
 
         Capsule::table('categories')->insert($data);
 
+        Capsule::flushQueryLog();
+
         Category::resetActionsPerformed();
 
         date_default_timezone_set('America/Denver');
diff --git a/tests/ScopedNodeTest.php b/tests/ScopedNodeTest.php
@@ -130,6 +130,7 @@ public function testSaveAsRoot()
         $node->saveAsRoot();
 
         $this->assertEquals(5, $node->getLft());
+        $this->assertEquals(null, $node->parent_id);
 
         $this->assertOtherScopeNotAffected();
     }
@@ -138,11 +139,14 @@ public function testInsertion()
     {
         $node = MenuItem::create([ 'menu_id' => 1, 'parent_id' => 5 ]);
 
+        $this->assertEquals(5, $node->parent_id);
+        $this->assertEquals(5, $node->getLft());
+
         $this->assertOtherScopeNotAffected();
     }
 
-    /*
-     * @expectedException
+    /**
+     * @expectedException \Illuminate\Database\Eloquent\ModelNotFoundException
      */
     public function testInsertionToParentFromOtherScope()
     {
@@ -180,4 +184,26 @@ public function testRebuildsTree()
         $data = [];
         MenuItem::scoped([ 'menu_id' => 2 ])->rebuildTree($data);
     }
+
+    /**
+     * @expectedException LogicException
+     */
+    public function testAppendingToAnotherScopeFails()
+    {
+        $a = MenuItem::find(1);
+        $b = MenuItem::find(3);
+
+        $a->appendToNode($b)->save();
+    }
+
+    /**
+     * @expectedException LogicException
+     */
+    public function testInsertingBeforeAnotherScopeFails()
+    {
+        $a = MenuItem::find(1);
+        $b = MenuItem::find(3);
+
+        $a->insertAfterNode($b);
+    }
 }
diff --git a/tests/models/MenuItem.php b/tests/models/MenuItem.php
@@ -7,7 +7,7 @@ class MenuItem extends \Illuminate\Database\Eloquent\Model
 
     public $timestamps = false;
 
-    protected $fillable = ['menu_id'];
+    protected $fillable = ['menu_id','parent_id'];
 
     public static function resetActionsPerformed()
     {

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ protected function actionAppendOrPrepend(self $parent, $prepend = false)`
`189`	`189`	`protected function setParent($value)`
`190`	`190`	`{`
`191`	`191`	`$this->setParentId($value ? $value->getKey() : null)`
`192`		`- ->setRelation('parent', $value);`
	`192`	`+ ->setRelation('parent', $value);`
`193`	`193`
`194`	`194`	`return $this;`
`195`	`195`	`}`
`@@ -230,7 +230,7 @@ public function refreshNode()`
`230`	`230`	`public function parent()`
`231`	`231`	`{`
`232`	`232`	`return $this->belongsTo(get_class($this), $this->getParentIdName())`
`233`		`- ->setModel($this);`
	`233`	`+ ->setModel($this);`
`234`	`234`	`}`
`235`	`235`
`236`	`236`	`/**`
`@@ -241,7 +241,7 @@ public function parent()`
`241`	`241`	`public function children()`
`242`	`242`	`{`
`243`	`243`	`return $this->hasMany(get_class($this), $this->getParentIdName())`
`244`		`- ->setModel($this);`
	`244`	`+ ->setModel($this);`
`245`	`245`	`}`
`246`	`246`
`247`	`247`	`/**`
`@@ -262,25 +262,25 @@ public function descendants()`
`262`	`262`	`public function siblings()`
`263`	`263`	`{`
`264`	`264`	`return $this->newScopedQuery()`
`265`		`- ->where($this->getKeyName(), '<>', $this->getKey())`
`266`		`- ->where($this->getParentIdName(), '=', $this->getParentId());`
	`265`	`+ ->where($this->getKeyName(), '<>', $this->getKey())`
	`266`	`+ ->where($this->getParentIdName(), '=', $this->getParentId());`
`267`	`267`	`}`
`268`	`268`
`269`		`- /**`
	`269`	`+ /**`
`270`	`270`	`* Get the node siblings and the node itself.`
`271`	`271`	`*`
`272`	`272`	`* @return \Kalnoy\Nestedset\QueryBuilder`
`273`	`273`	`*/`
`274`	`274`	`public function siblingsAndSelf()`
`275`	`275`	`{`
`276`	`276`	`return $this->newScopedQuery()`
`277`		`- ->where($this->getParentIdName(), '=', $this->getParentId());`
	`277`	`+ ->where($this->getParentIdName(), '=', $this->getParentId());`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`/**`
`281`	`281`	`* Get query for the node siblings and the node itself.`
`282`	`282`	`*`
`283`		`- * @param array $columns`
	`283`	`+ * @param array $columns`
`284`	`284`	`*`
`285`	`285`	`* @return \Illuminate\Database\Eloquent\Collection`
`286`	`286`	`*/`
`@@ -297,7 +297,7 @@ public function getSiblingsAndSelf(array $columns = [ '*' ])`
`297`	`297`	`public function nextSiblings()`
`298`	`298`	`{`
`299`	`299`	`return $this->nextNodes()`
`300`		`- ->where($this->getParentIdName(), '=', $this->getParentId());`
	`300`	`+ ->where($this->getParentIdName(), '=', $this->getParentId());`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`/**`
`@@ -308,7 +308,7 @@ public function nextSiblings()`
`308`	`308`	`public function prevSiblings()`
`309`	`309`	`{`
`310`	`310`	`return $this->prevNodes()`
`311`		`- ->where($this->getParentIdName(), '=', $this->getParentId());`
	`311`	`+ ->where($this->getParentIdName(), '=', $this->getParentId());`
`312`	`312`	`}`
`313`	`313`
`314`	`314`	`/**`
`@@ -319,7 +319,7 @@ public function prevSiblings()`
`319`	`319`	`public function nextNodes()`
`320`	`320`	`{`
`321`	`321`	`return $this->newScopedQuery()`
`322`		`- ->where($this->getLftName(), '>', $this->getLft());`
	`322`	`+ ->where($this->getLftName(), '>', $this->getLft());`
`323`	`323`	`}`
`324`	`324`
`325`	`325`	`/**`
`@@ -330,7 +330,7 @@ public function nextNodes()`
`330`	`330`	`public function prevNodes()`
`331`	`331`	`{`
`332`	`332`	`return $this->newScopedQuery()`
`333`		`- ->where($this->getLftName(), '<', $this->getLft());`
	`333`	`+ ->where($this->getLftName(), '<', $this->getLft());`
`334`	`334`	`}`
`335`	`335`
`336`	`336`	`/**`
`@@ -426,7 +426,8 @@ public function prependToNode(self $parent)`
`426`	`426`	`public function appendOrPrependTo(self $parent, $prepend = false)`
`427`	`427`	`{`
`428`	`428`	`$this->assertNodeExists($parent)`
`429`		`- ->assertNotDescendant($parent);`
	`429`	`+ ->assertNotDescendant($parent)`
	`430`	`+ ->assertSameScope($parent);`
`430`	`431`
`431`	`432`	`$this->setParent($parent)->dirtyBounds();`
`432`	`433`
`@@ -465,7 +466,9 @@ public function beforeNode(self $node)`
`465`	`466`	`*/`
`466`	`467`	`public function beforeOrAfterNode(self $node, $after = false)`
`467`	`468`	`{`
`468`		`- $this->assertNodeExists($node)->assertNotDescendant($node);`
	`469`	`+ $this->assertNodeExists($node)`
	`470`	`+ ->assertNotDescendant($node)`
	`471`	`+ ->assertSameScope($node);`
`469`	`472`
`470`	`473`	`if ( ! $this->isSiblingOf($node)) {`
`471`	`474`	`$this->setParent($node->getRelationValue('parent'));`
`@@ -529,9 +532,9 @@ public function rawNode($lft, $rgt, $parentId)`
`529`	`532`	`public function up($amount = 1)`
`530`	`533`	`{`
`531`	`534`	`$sibling = $this->prevSiblings()`
`532`		`- ->defaultOrder('desc')`
`533`		`- ->skip($amount - 1)`
`534`		`- ->first();`
	`535`	`+ ->defaultOrder('desc')`
	`536`	`+ ->skip($amount - 1)`
	`537`	`+ ->first();`
`535`	`538`
`536`	`539`	`if ( ! $sibling) return false;`
`537`	`540`
`@@ -548,9 +551,9 @@ public function up($amount = 1)`
`548`	`551`	`public function down($amount = 1)`
`549`	`552`	`{`
`550`	`553`	`$sibling = $this->nextSiblings()`
`551`		`- ->defaultOrder()`
`552`		`- ->skip($amount - 1)`
`553`		`- ->first();`
	`554`	`+ ->defaultOrder()`
	`555`	`+ ->skip($amount - 1)`
	`556`	`+ ->first();`
`554`	`557`
`555`	`558`	`if ( ! $sibling) return false;`
`556`	`559`
`@@ -587,7 +590,7 @@ protected function insertAt($position)`
`587`	`590`	`protected function moveNode($position)`
`588`	`591`	`{`
`589`	`592`	`$updated = $this->newNestedSetQuery()`
`590`		`- ->moveNode($this->getKey(), $position) > 0;`
	`593`	`+ ->moveNode($this->getKey(), $position) > 0;`
`591`	`594`
`592`	`595`	`if ($updated) $this->refreshNode();`
`593`	`596`
`@@ -649,8 +652,8 @@ protected function deleteDescendants()`
`649`	`652`	`protected function restoreDescendants($deletedAt)`
`650`	`653`	`{`
`651`	`654`	`$this->descendants()`
`652`		`- ->where($this->getDeletedAtColumn(), '>=', $deletedAt)`
`653`		`- ->restore();`
	`655`	`+ ->where($this->getDeletedAtColumn(), '>=', $deletedAt)`
	`656`	`+ ->restore();`
`654`	`657`	`}`
`655`	`658`
`656`	`659`	`/**`
`@@ -932,8 +935,8 @@ public function getPrevNode(array $columns = [ '*' ])`
`932`	`935`	`public function getAncestors(array $columns = [ '*' ])`
`933`	`936`	`{`
`934`	`937`	`return $this->newScopedQuery()`
`935`		`- ->defaultOrder()`
`936`		`- ->ancestorsOf($this, $columns);`
	`938`	`+ ->defaultOrder()`
	`939`	`+ ->ancestorsOf($this, $columns);`
`937`	`940`	`}`
`938`	`941`
`939`	`942`	`/**`
`@@ -1006,7 +1009,7 @@ public function getPrevSibling(array $columns = [ '*' ])`
`1006`	`1009`	`public function isDescendantOf(self $other)`
`1007`	`1010`	`{`
`1008`	`1011`	`return $this->getLft() > $other->getLft() &&`
`1009`		`- $this->getLft() < $other->getRgt();`
	`1012`	`+ $this->getLft() < $other->getRgt();`
`1010`	`1013`	`}`
`1011`	`1014`
`1012`	`1015`	`/**`
`@@ -1019,7 +1022,7 @@ public function isDescendantOf(self $other)`
`1019`	`1022`	`public function isSelfOrDescendantOf(self $other)`
`1020`	`1023`	`{`
`1021`	`1024`	`return $this->getLft() >= $other->getLft() &&`
`1022`		`- $this->getLft() < $other->getRgt();`
	`1025`	`+ $this->getLft() < $other->getRgt();`
`1023`	`1026`	`}`
`1024`	`1027`
`1025`	`1028`	`/**`
`@@ -1186,4 +1189,19 @@ protected function assertNodeExists(self $node)`
`1186`	`1189`	`return $this;`
`1187`	`1190`	`}`
`1188`	`1191`
	`1192`	`+ /**`
	`1193`	`+ * @param self $node`
	`1194`	`+ */`
	`1195`	`+ protected function assertSameScope(self $node)`
	`1196`	`+ {`
	`1197`	`+ if ( ! $scoped = $this->getScopeAttributes()) {`
	`1198`	`+ return;`
	`1199`	`+ }`
	`1200`	`+`
	`1201`	`+ foreach ($scoped as $attr) {`
	`1202`	`+ if ($this->getAttribute($attr) != $node->getAttribute($attr)) {`
	`1203`	`+ throw new LogicException('Nodes must be in the same scope');`
	`1204`	`+ }`
	`1205`	`+ }`
	`1206`	`+ }`
`1189`	`1207`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ class MenuItem extends \Illuminate\Database\Eloquent\Model`
`7`	`7`
`8`	`8`	`public $timestamps = false;`
`9`	`9`
`10`		`- protected $fillable = ['menu_id'];`
	`10`	`+ protected $fillable = ['menu_id','parent_id'];`
`11`	`11`
`12`	`12`	`public static function resetActionsPerformed()`
`13`	`13`	`{`