Refactor NestedSet

Author: lazychaser

CHANGELOG.markdown

@@ -6,7 +6,7 @@
     data (lft and rgt values).
 *   The root node is not required now. You can use `saveAsRoot` or `makeRoot` method.
     New model is saved as root by default.
-*   You can now create as many nodes and in any order as possible within single 
+*   You can now create as many nodes and in any order as you want within single 
     request.
 *   Laravel 2 is supported but not required.
 *   `ancestorsOf` now doesn't include target node into results.
@@ -15,6 +15,8 @@
 *   Default order is not applied by default.
 *   New method `descendantsOf` that allows to get descendants by id of the node.
 *   Added `countErrors` and `isBroken` methods to check whether the tree is broken.
+*   `NestedSet::createRoot` has been removed.
+*   `NestedSet::column` doesn't create a foreign key anymore.
 
 ### 1.1.0
 

UPGRADE.markdown

@@ -1,8 +1,13 @@
-### Upgrading to 1.2
+### Upgrading to 2.0
 
 Calling `$parent->append($node)` and `$parent->prepend($node)` now automatically
 saves `$node`. Those functions returns whether the node was saved.
 
-`ancestorsOf` now return ancestors only not including target node.
+`ancestorsOf` now return ancestors only, not including target node.
 
-Default order is not applied automatically.
+Default order is not applied automatically, so if you need nodes to be in tree-order
+you should call `defaultOrder` on the query.
+
+Since root node is not required now, `NestedSet::createRoot` method has been removed.
+
+`NestedSet::columns` now doesn't create a foreign key for a `parent_id` column.

src/Kalnoy/Nestedset/NestedSet.php

@@ -1,75 +1,48 @@
-<?php namespace Kalnoy\Nestedset;
+<?php
 
-use \Illuminate\Database\Connection;
-use \Illuminate\Database\Schema\Blueprint;
+namespace Kalnoy\Nestedset;
+
+use Illuminate\Database\Connection;
+use Illuminate\Database\Schema\Blueprint;
 
 class NestedSet {
 
     /**
-     * Add NestedSet columns to the table. Also create index and foreign key.
-     *
-     * @param   Blueprint  $table
+     * Add default nested set columns to the table. Also create an index.
      *
-     * @return  void
+     * @param \Illuminate\Database\Schema\Blueprint $table
+     * @param string $primaryKey
      */
-    static public function columns(Blueprint $table, $primaryKey = 'id')
+    public static function columns(Blueprint $table, $primaryKey = 'id')
     {
         $table->integer(Node::LFT);
         $table->integer(Node::RGT);
         $table->unsignedInteger(Node::PARENT_ID)->nullable();
 
-        $table->index(array(Node::LFT, Node::RGT, Node::PARENT_ID), 'nested_set_index');
-
-        $table
-            ->foreign(Node::PARENT_ID, self::getForeignKeyName($table->getTable()))
-            ->references($primaryKey)
-            ->on($table->getTable())
-            ->onDelete('cascade');
-    }
-
-    /**
-     * Get foreign key name for the table.
-     *
-     * @param   string  $table
-     *
-     * @return  string
-     */
-    protected static function getForeignKeyName($table)
-    {
-        return $table.'_nested_set_foreign';
+        $table->index(self::getDefaultColumns());
     }
 
     /**
      * Drop NestedSet columns.
      *
-     * @param   Blueprint  $table
-     *
-     * @return  void
+     * @param \Illuminate\Database\Schema\Blueprint $table
      */
-    static public function dropColumns(Blueprint $table)
+    public static function dropColumns(Blueprint $table)
     {
-        $table->dropForeign('nested_set_foreign');
-        $table->dropIndex('nested_set_index');
-        $table->dropColumn(Node::LFT, Node::RGT, Node::PARENT_ID);
+        $columns = self::getDefaultColumns();
+
+        $table->dropIndex($columns);
+        $table->dropColumn($columns);
     }
 
     /**
-     * Create root node.
-     *
-     * @param   string  $table
-     * @param   array   $extra
-     * @param   string  $connection
-     *
-     * @return  boolean
+     * Get a list of default columns.
+     * 
+     * @return array
      */
-    static function createRoot($table, array $extra = array(), $connection = null)
+    public static function getDefaultColumns()
     {
-        $extra = array_merge($extra, array(
-            Node::LFT => 1,
-            Node::RGT => 2,
-            Node::PARENT_ID => NULL,    
-        ));
-
-        return \DB::connection($connection)->table($table)->insert($extra);
+        return [ Node::LFT, Node::RGT, Node::PARENT_ID ];
     }
+
 }