Changeset 3520

Timestamp:

02/19/07 18:14:05 (2 years ago)

Author:

tristan

Message:

sfPropelActAsNestedSetBehaviorPlugin :

• Implemented more methods (+ unit tests) :
  
  • insertAsParentOf
    
  • retrieveSiblings
    
  • isEqualTo
    
  • isChildOf
    

• Enhanced internal API
  
• Releasing 0.8.0
  

Files:

• plugins/sfPropelActAsNestedSetBehaviorPlugin/README (modified) (4 diffs)
• plugins/sfPropelActAsNestedSetBehaviorPlugin/config/config.php (modified) (3 diffs)
• plugins/sfPropelActAsNestedSetBehaviorPlugin/lib/sfPropelActAsNestedSetBehavior.class.php (modified) (8 diffs)
• plugins/sfPropelActAsNestedSetBehaviorPlugin/package.xml (modified) (2 diffs)
• plugins/sfPropelActAsNestedSetBehaviorPlugin/test/unit/PropelActAsNestedSetBehaviorTest.php (modified) (5 diffs)

plugins/sfPropelActAsNestedSetBehaviorPlugin/README

@@ -168 +168 @@
- * `void insertAsNextSiblingOf(BaseObject $dest_node)` : Inserts node as next sibling of given node.
- * `void insertAsPrevSiblingOf(BaseObject $dest_node)` : Inserts node as previous sibling of given node.
-'''NOT IMPLEMENTED YET'''
+Inserts node as parent of given node
-
-=== Informational methods ===
@@ -178 +178 @@
- * `bool hasPrevSibling()` : Returns true if given node has a previous sibling.
- * `bool isLeaf()` : Returns true if given node does not have children.
-
-
+
- * `integer getNumberOfChildren()` : Returns given node number of direct children.
- * `integer getNumberOfDescendants()` : Returns given node number of descendants (n level).
@@ -193 +192 @@
- * `BaseObject retrieveLastChild()` : Returns given node last child.
- * `BaseObject retrieveParent()` : Returns given node parent.
-'''NOT IMPLEMENTED YET'''
+Returns node siblings.
- * `array getPath()` : Returns path to a specific node as an array, useful to create breadcrumbs.
-
@@ -209 +208 @@
- * `void makeRoot()` : Sets node properties to make it a root node.
- * `BaseObject reload()` : Returns an up to date version of node
+ * `bool isEqualTo(BaseObject $node)` : Returns true if given node is equivalent to node.
-
-== Changelog ==
+
+=== 2007-02-19 | 0.8.0 ===
+
+Implemented more methods (+ unit tests) :
+
+ * `insertAsParentOf`
+ * `retrieveSiblings`
+ * `isEqualTo`
+ * `isChildOf`
-
-=== 2007-02-19 | 0.7.0 ===

plugins/sfPropelActAsNestedSetBehaviorPlugin/config/config.php

@@ -69 +69 @@
-  array (
-    'sfPropelActAsNestedSetBehavior',
+    'insertAsParentOf'
+  ),
+  array (
+    'sfPropelActAsNestedSetBehavior',
-    'hasChildren'
-  ),
@@ -106 +110 @@
-    'sfPropelActAsNestedSetBehavior',
-    'isLeaf'
+  ),
+  array (
+    'sfPropelActAsNestedSetBehavior',
+    'isEqualTo'
+  ),
+  array (
+    'sfPropelActAsNestedSetBehavior',
+    'isChildOf'
-  ),
-  array (
@@ -153 +165 @@
-  array (
-    'sfPropelActAsNestedSetBehavior',
+    'retrieveSiblings'
+  ),
+  array (
+    'sfPropelActAsNestedSetBehavior',
-    'getLevel'
-  ),

plugins/sfPropelActAsNestedSetBehaviorPlugin/lib/sfPropelActAsNestedSetBehavior.class.php

@@ -332 +332 @@
-  }
-
+  /**
+   * Inserts node as parent of given node.
+   * 
+   * @param      BaseObject     $node
+   * @param      BaseObject     $dest_node
+   * @throws     Exception      When trying to insert node as parent of a root node
+   */
+  public function insertAsParentOf(BaseObject $node, BaseObject $dest_node)
+  {
+    if ($dest_node->isRoot())
+    {
+      $msg = 'Impossible to insert a node as parent of a root node';
+      throw new Exception($msg);
+    }
+
+    $peer_name = get_class($node->getPeer());
+
+    $this->addPreSaveStackEntries(self::shiftRLValues($peer_name, $dest_node->getLeftValue(), 1, $dest_node->getScopeIdValue()));
+    $this->addPreSaveStackEntries(self::shiftRLValues($peer_name, $dest_node->getRightValue() + 2, -1, $dest_node->getScopeIdValue()));
+    
+    $node->setLeftValue($dest_node->getLeftValue());
+    $node->setRightValue($dest_node->getRightValue() + 2);
+
+    $previous_parent = $dest_node->getParentIdValue();
+    $node->setParentIdValue($previous_parent);
+    $dest_node->setParentIdValue($node->getPrimaryKey());
+
+    $this->addPreSaveStackEntries(array($dest_node));
+    
+  }
+
-# ---- INFORMATIONAL METHODS
-
@@ -398 +429 @@
-  {
-    return $node->getRightValue() - $node->getLeftValue() == 1;
+  }
+
+  /**
+   * Returns true if given node is identical to node.
+   * 
+   * @param      BaseObject      $node
+   * @param      BaseObject      $compared_node
+   * @return     bool
+   */
+  public function isEqualTo(BaseObject $node, BaseObject $compared_node)
+  {
+    return ($node->getLeftValue()        === $compared_node->getLeftValue()
+            && $node->getRightValue()    === $compared_node->getRightValue()
+            && $node->getScopeIdValue()  === $compared_node->getScopeIdValue()
+            && $node->getParentIdValue() === $compared_node->getParentIdValue());
+  }
+
+  /**
+   * Returns true if given node is parent of node.
+   * 
+   * @param      BaseObject      $node
+   * @param      BaseObject      $parent_node
+   */
+  public function isChildOf(BaseObject $node, BaseObject $parent_node)
+  {
+    return ($node->getParentIdValue() === $parent_node->getPrimaryKey()
+            && $node->getScopeIdValue() === $parent_node->getScopeIdValue());
-  }
-
@@ -598 +656 @@
-  }
-
+  /**
+   * Returns node siblings.
+   * 
+   * @param      BaseObject     $node
+   * @param      string         $peer_method    (optional) defaults to "doSelect"
+   * @return     array
+   */
+  public function retrieveSiblings(BaseObject $node, $peer_method = 'doSelect')
+  {
+    $c = new Criteria();
+    $c->add(self::getColumnConstant(get_class($node), 'parent'), $node->getParentIdValue());
+    $c->add(self::getColumnConstant(get_class($node), 'scope'), $node->getScopeIdValue());
+    
+    $results = call_user_func(array($node->getPeer(), $peer_method), $c);
+    $final_results = array();
+    if (is_array($results))
+    {
+      foreach ($results as $r)
+      {
+        if ($node->isEqualTo($r))
+        {
+          continue;
+        }
+        $final_results[] = $r;
+      }
+    }
+    
+    return $final_results;
+  }
-
-  /**
@@ -631 +718 @@
-    $node->setParentIdValue($dest_node->getPrimaryKey());
-    $node->setScopeIdValue($dest_node->getScopeIdValue());
-$this->
+self::
-  }
-
@@ -644 +731 @@
-    $node->setParentIdValue($dest_node->getPrimaryKey());
-    $node->setScopeIdValue($dest_node->getScopeIdValue());
-$this->
+self::
-  }
-
@@ -657 +744 @@
-    $node->setParentIdValue($dest_node->getParentIdValue());
-    $node->setScopeIdValue($dest_node->getScopeIdValue());
-$this->
+self::
-  }
-
@@ -670 +757 @@
-    $node->setParentIdValue($dest_node->getParentIdValue());
-    $node->setScopeIdValue($dest_node->getScopeIdValue());
-$this->
+self::
-  }
-
@@ -914 +1001 @@
-   * @return array
-   */
-
+static 
-  {
-    $statements = array();

plugins/sfPropelActAsNestedSetBehaviorPlugin/package.xml

@@ -13 +13 @@
- <date>2007-02-19</date>
- <version>
-7
-7
+8
+8
- </version>
- <stability>
@@ -53 +53 @@
-
- <changelog>
+
+  <release>
+   <version>
+    <release>0.8.0</release>
+    <api>0.8.0</api>
+   </version>
+   <stability>
+    <release>beta</release>
+    <api>beta</api>
+   </stability>
+   <date>2007-02-19</date>
+   <license uri="http://www.symfony-project.com/license">MIT license</license>
+   <notes>
+Implemented more methods (+ unit tests) :
+ 
+ * `insertAsParentOf`
+ * `retrieveSiblings`
+ * `isEqualTo`
+ * `isChildOf`
+   </notes>
+  </release>
-
-  <release>

plugins/sfPropelActAsNestedSetBehaviorPlugin/test/unit/PropelActAsNestedSetBehaviorTest.php

@@ -82 +82 @@
-
-// insertAsFirstChildOf
-24
+6
-$t->diag('insertAsFirstChildOf');
-$t->diag('insert N1 as first child of ROOT');
@@ -98 +98 @@
-$t->is($n1->getParentIdValue(), $root->getId(), 'N1 parent id equals ROOT id');
-$t->is($n1->getScopeIdValue(), $root->getScopeIdValue(), 'N1 scope id equals ROOT id');
+
+// isEqualTo
+$t = new lime_test(2, new lime_output_color());
+$t->is($n1->isEqualTo($n1), true, 'isEqualTo() returns true when nodes are equivalent');
+$t->is($root->isEqualTo($n1), false, 'isEqualTo() returns false when nodes are different');
-
-$t->diag('insert N2 as first child of ROOT');
@@ -611 +616 @@
-$t->is($n6->getParentIdValue(), $n8->getPrimaryKey(), 'N6 parent id equals N8 id');
-$t->is($n6->getScopeIdValue(), $n8->getScopeIdValue(), 'N6 scope id equals N8 scope id');
+
+// retrieveSiblings
+$t = new lime_test(15, new lime_output_color());
+$t->diag('retrieveSiblings');
+$t->diag('Retrieve siblings of N7');
+$expected = array($n3->getId(), $n4->getId());
+$got = array();
+foreach ($n7->retrieveSiblings() as $node)
+{
+  $got[] = $node->getId();
+}
+
+$t->is($got, $expected, 'retrieveSiblings() returns the right siblings');
-
-// delete
@@ -837 +855 @@
-
-// deleteDescendants
-22
+14
-$t->diag('deleteDescendants');
-$t->diag('Delete N8 descendants');
@@ -879 +897 @@
-$t->is($n8->getScopeIdValue(), $root->getScopeIdValue(), 'N8 scope id equals ROOT scope id');
-
+// insertAsParentOf
+$t = new lime_test(15, new lime_output_color());
+$t->diag('insertAsParentOf');
+$t->diag('Insert N8 as parent of N4');
+$t->diag('root');
+$t->diag(' |-N8');
+$t->diag('   |-N4');
+$t->diag(' |-N7');
+
+$n8->insertAsParentOf($n4);
+$n8->save();
+
+// -- reload nodes
+$n4 = $n4->reload();
+$n7 = $n7->reload();
+$n8 = $n8->reload();
+$root = $root->reload();
+
+$t->is($root->getLeftValue(), 1, 'root "left" is "1"');
+$t->is($root->getRightValue(), 8, 'root "right" is "8"');
+$t->is($n4->getLeftValue(), 3, 'N4 "left" is "3"');
+$t->is($n4->getRightValue(), 4, 'N4 "right" is "4"');
+$t->is($n4->getParentIdValue(), $n8->getPrimaryKey(), 'N4 parent is N8');
+$t->is($n4->getScopeIdValue(), $n8->getScopeIdValue(), 'N4 scope id equals N8 scope id');
+$t->is($n7->getLeftValue(), 6, 'N7 "left" is "6"');
+$t->is($n7->getRightValue(), 7, 'N7 "right" is "7"');
+$t->is($n7->getParentIdValue(), $root->getPrimaryKey(), 'N7 parent is ROOT');
+$t->is($n7->getScopeIdValue(), $root->getScopeIdValue(), 'N7 scope id equals ROOT scope id');
+$t->is($n8->getLeftValue(), 2, 'N8 "left" is "2"');
+$t->is($n8->getRightValue(), 5, 'N8 "right" is "5"');
+$t->is($n8->getParentIdValue(), $root->getPrimaryKey(), 'N8 parent is ROOT');
+$t->is($n8->getScopeIdValue(), $root->getScopeIdValue(), 'N8 scope id equals ROOT scope id');
+
+try
+{
+  $n8->insertAsParentOf($root);
+  $t->fail('insertAsParentOf() throws an exception when asked to insert a node as parent of a root node');
+}
+catch (Exception $e)
+{
+  $t->pass('insertAsParentOf() throws an exception when asked to insert a node as parent of a root node');
+}
+
+// isChildOf
+$t = new lime_test(2, new lime_output_color());
+$t->diag('isChildOf');
+$t->is($n4->isChildOf($n8), true, 'isChildOf() returns true when given node is node parent');
+$t->is($n4->isChildOf($root), false, 'isChildOf() returns false when given node is not node parent');
+
-// Helper functions
-