Merge pull request #216 from dereuromark/tree-and-typemap

Add tree parent info and add TypeMap behavior.

.travis.yml

@@ -47,8 +47,9 @@ before_script:
 
 script:
   - if [[ $DEFAULT == 1 ]]; then vendor/bin/phpunit; fi
-  - if [[ $CHECKS == 1 ]]; then vendor/bin/phpcs -p --extensions=php --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --ignore=/tests/test_files/ src tests config ; fi
+
   - if [[ $CHECKS == 1 ]]; then composer phpstan-setup && composer phpstan ; fi
+  - if [[ $CHECKS == 1 ]]; then composer cs-check ; fi
 
   - if [[ $CODECOVERAGE == 1 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml || true; fi
   - if [[ $CODECOVERAGE == 1 ]]; then wget -O codecov.sh https://codecov.io/bash; fi

composer.json

@@ -50,8 +50,8 @@
 		"test": "php phpunit.phar",
 		"test-setup": "[ ! -f phpunit.phar ] && wget https://phar.phpunit.de/phpunit-5.7.20.phar && mv phpunit-5.7.20.phar phpunit.phar || true",
 		"test-coverage": "php phpunit.phar --log-junit webroot/coverage/unitreport.xml --coverage-html webroot/coverage --coverage-clover webroot/coverage/coverage.xml",
-		"cs-check": "phpcs -p --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --ignore=/cakephp-tools/vendor/,/tmp/,/logs/,/tests/test_files/ --extensions=php ./",
-		"cs-fix": "phpcbf -v --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --ignore=/cakephp-tools/vendor/,/tmp/,/logs/,/tests/test_files --extensions=php ./"
+		"cs-check": "phpcs -p --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --extensions=php --ignore=/tests/test_files/ src/ tests/ config/",
+		"cs-fix": "phpcbf -v --standard=vendor/fig-r/psr2r-sniffer/PSR2R/ruleset.xml --extensions=php --ignore=/tests/test_files/ src/ tests/ config/"
 	},
 	"config": {
 		"process-timeout": 600

docs/Helper/Tree.md

@@ -0,0 +1,119 @@
+# Tree Helper
+
+A CakePHP helper to handle tree structures.
+
+By default, it uses the core TreeBehavior and MPTT (Modified Preorder Tree Traversal).
+But it sure can work with any tree like input as nested object or array structure.
+
+It can work with both arrays and Entity objects. The latter should be preferred as you can
+then use all properties and getters on that object.
+
+## Usage
+
+### Basic usage
+Include helper in your AppView class as
+```php
+$this->addHelper('Tools.Tree', [
+	...
+]);
+```
+
+Then you can use it in your templates as
+```php
+echo $this->Tree->generate($articles);
+```
+
+### Templated usage
+By default, just outputting the display name is usually not enough.
+You want to create some `Template/Element/tree_element.ctp` element instead:
+
+```php
+echo $this->Tree->generate($articles, ['element' => 'tree_element']);
+```
+
+That template can then contain all normal template additions, including full helper access:
+
+```php
+<?php
+/**
+ * @var \App\View\AppView $this
+ * @var \App\Model\Entity\Article|\Cake\Collection\CollectionInterface $data
+ * @var bool $activePathElement
+ */
+
+if (!$data->visible) { // You can do anything here depending on the record content
+	return;
+}
+$label = $data->title;
+if ($activePathElement) {
+	$label .= ' (active)';
+}
+?>
+<li>
+<?php echo $this->Html->link($label, ['action' => 'view', $data->id]); ?>
+</li>
+```
+
+So the current entity object is available as `$data` variable inside this snippet.
+
+#### Available element data
+
+- $data : object|object[]|array
+- $parent : object|array|null
+- $depth : int
+- $hasChildren : int
+- $numberOfDirectChildren : int
+- $numberOfTotalChildren : int
+- $firstChild : bool
+- $lastChild : bool
+- $hasVisibleChildren : bool
+- $activePathElement : string
+- $isSibling : bool
+
+plus all config values. 
+
+### Callback usage
+
+Here the same keys are available on the first argument (`$data` array). So the above `$data` would actually be
+`$data['data']` and usually be the entity. 
+If you are passing entities, it helps to inline annotate in this case:
+```php
+	$closure = function(array $data) {
+		/** @var \Cake\ORM\Entity $entity */
+		$entity = $data['data'];
+
+		return h($entity->name) . ($data['activePathElement'] ? ' (active)' : '');
+	};
+```
+
+### Active path
+When using the TreeHelper for navigation structures, you would usually want to set the active path as class elements ("active") 
+on the `<li>` elements.
+You can do that by passing in the current path.
+```php
+// Your controller fetches the navigation tree
+$tree = $this->Table->find('threaded')->toArray();
+
+// The current active element in the tree (/view/6)
+$id = 6;
+		
+// We need to get the current path for this element
+$nodes = $this->Table->find('path', ['for' => $id]);
+$path = $nodes->extract('id')->toArray();
+
+// In your view
+$options = [
+	'autoPath' => [$current->lft, $current->rght], 
+	'treePath' => $path, 
+	'element' => 'tree', // src/Template/Element/tree.ctp
+];
+echo $this->Tree->generate($tree, $options);
+```
+The `autoPath` setting passed using `[lft, rght]` of your current element will auto-add "active" into your elements.
+You can also just pass the current entity (`'autoPath' => $current`) and it will extract lft and rght properties based on the config.
+
+The `treePath` is optional and needed for additional things like hiding unrelated siblings etc.
+
+## Outview
+
+You can read some more tutorial like details in [my blog post](http://www.dereuromark.de/2013/02/17/cakephp-and-tree-structures/).

docs/README.md

@@ -47,6 +47,7 @@ Helpers:
 * [Form](Helper/Form.md)
 * [Common](Helper/Common.md)
 * [Format](Helper/Format.md)
+* [Tree](Helper/Tree.md)
 * [Typography](Helper/Typography.md)
 
 Widgets:

src/Model/Behavior/TypeMapBehavior.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Tools\Model\Behavior;
+
+use Cake\ORM\Behavior;
+use RuntimeException;
+
+/**
+ * A behavior that will allow changing a table's field types on the fly.
+ *
+ * Usage: See docs
+ *
+ * @author Mark Scherer
+ * @license MIT
+ */
+class TypeMapBehavior extends Behavior {
+
+	/**
+	 * @var array
+	 */
+	protected $_defaultConfig = [
+		'fields' => [], // Fields to change column type for
+	];
+
+	/**
+	 * @param array $config
+	 * @throws \RuntimeException
+	 * @return void
+	 */
+	public function initialize(array $config = []) {
+		if (empty($this->_config['fields'])) {
+			throw new RuntimeException('Fields are required');
+		}
+		if (!is_array($this->_config['fields'])) {
+			$this->_config['fields'] = (array)$this->_config['fields'];
+		}
+
+		foreach ($this->_config['fields'] as $field => $type) {
+			if (is_array($type)) {
+				$type = $field['type'];
+			}
+			if (!is_string($type)) {
+				throw new RuntimeException('Invalid field type setup.');
+			}
+
+			$this->_table->getSchema()->setColumnType($field, $type);
+		}
+	}
+
+}

src/View/Helper/TreeHelper.php

@@ -17,7 +17,6 @@ use Exception;
 /**
  * Helper to generate tree representations of MPTT or recursively nested data.
  *
- * @deprecated Use https://github.com/ADmad/cakephp-tree instead.
  * @author Andy Dawson
  * @author Mark Scherer
  * @link http://www.dereuromark.de/2013/02/17/cakephp-and-tree-structures/
@@ -39,6 +38,7 @@ class TreeHelper extends Helper {
 		'element' => false,
 		'callback' => false,
 		'autoPath' => false,
+		'autoPathClass' => 'active',
 		'hideUnrelated' => false,
 		'treePath' => [],
 		'left' => 'lft',
@@ -47,6 +47,7 @@ class TreeHelper extends Helper {
 		'maxDepth' => 999,
 		'firstChild' => true,
 		'indent' => null,
+		'indentWith' => "\t",
 		'splitDepth' => false,
 		'splitCount' => null,
 		'totalNodes' => null,
@@ -100,12 +101,13 @@ class TreeHelper extends Helper {
 	 *    'element' => path to an element to render to get node contents.
 	 *    'callback' => callback to use to get node contents. e.g. array(&$anObject, 'methodName') or 'floatingMethod'
 	 *    'autoPath' => array($left, $right [$classToAdd = 'active']) if set any item in the path will have the class $classToAdd added. MPTT only.
-	 *  'hideUnrelated' => if unrelated (not children, not siblings) should be hidden, needs 'treePath', true/false or array/string for callback
-	 *  'treePath' => treePath to insert into callback/element
+	 *      You can also just pass the current entity and it will extract lft and rght properties based on the config.
+	 *    'hideUnrelated' => if unrelated (not children, not siblings) should be hidden, needs 'treePath', true/false or array/string for callback
+	 *    'treePath' => treePath to insert into callback/element
 	 *    'left' => name of the 'lft' field if not lft. only applies to MPTT data
 	 *    'right' => name of the 'rght' field if not rght. only applies to MPTT data
 	 *    'depth' => used internally when running recursively, can be used to override the depth in either mode.
-	 *  'maxDepth' => used to control the depth upto which to generate tree
+	 *    'maxDepth' => used to control the depth upto which to generate tree
 	 *    'firstChild' => used internally when running recursively.
 	 *    'splitDepth' => if multiple "parallel" types are required, instead of one big type, nominate the depth to do so here
 	 *        example: useful if you have 30 items to display, and you'd prefer they appeared in the source as 3 lists of 10 to be able to
@@ -113,22 +115,42 @@ class TreeHelper extends Helper {
 	 *    'splitCount' => the number of "parallel" types. defaults to null (disabled) set the splitCount,
 	 *        and optionally set the splitDepth to get parallel lists
 	 *
-	 * @param array|\Cake\Orm\Query $data Data to loop over
+	 * @param array|\Cake\Datasource\QueryInterface|\Cake\ORM\ResultSet $data Data to loop over
 	 * @param array $config Config
 	 * @return string HTML representation of the passed data
 	 * @throws \Exception
 	 */
 	public function generate($data, array $config = []) {
-		if (is_object($data)) {
-			$data = $data->toArray();
+		return $this->_generate($data, $config);
+	}
+
+	/**
+	 * @param array|\Cake\Datasource\QueryInterface|\Cake\ORM\ResultSet $data
+	 * @param array $config
+	 * @param array|\Cake\Datasource\QueryInterface|\Cake\ORM\ResultSet|null $parent
+	 *
+	 * @throws \Exception
+	 * @return string
+	 */
+	protected function _generate($data, array $config, $parent = null) {
+		$dataArray = $data;
+		if (is_object($dataArray)) {
+			$dataArray = $data->toArray();
 		}
-		if (!$data) {
+		if (!$dataArray) {
 			return '';
 		}
 
 		$this->_config = $config + $this->_defaultConfig;
+		if ($this->_config['autoPath'] && is_object($this->_config['autoPath'])) {
+			$autoPathEntity = $this->_config['autoPath'];
+			$propertyLeft = $this->_config['left'];
+			$propertyRight = $this->_config['right'];
+			$this->_config['autoPath'] = [$autoPathEntity->$propertyLeft, $autoPathEntity->$propertyRight];
+		}
+
 		if ($this->_config['autoPath'] && !isset($this->_config['autoPath'][2])) {
-			$this->_config['autoPath'][2] = 'active';
+			$this->_config['autoPath'][2] = $this->_config['autoPathClass'];
 		}
 		extract($this->_config);
 		if ($indent === null && Configure::read('debug')) {
@@ -147,8 +169,8 @@ class TreeHelper extends Helper {
 		}
 		$return = '';
 		$addType = true;
-		$this->_config['totalNodes'] = count($data);
-		$keys = array_keys($data);
+		$this->_config['totalNodes'] = count($dataArray);
+		$keys = array_keys($dataArray);
 
 		if ($hideUnrelated === true || is_numeric($hideUnrelated)) {
 			$this->_markUnrelatedAsHidden($data, $treePath);
@@ -156,25 +178,17 @@ class TreeHelper extends Helper {
 			call_user_func($hideUnrelated, $data, $treePath);
 		}
 
-		foreach ($data as $i => &$result) {
-			/* Allow 2d data arrays */
-			if (is_object($result)) {
-				$result = $result->toArray();
-			}
-			if ($model && isset($result->$model)) {
-				$row = &$result->$model;
-			} else {
-				$row = &$result;
-			}
+		foreach ($data as $i => $result) {
+			$row = $result;
 
 			/* Close open items as appropriate */
 			// @codingStandardsIgnoreStart
-			while ($stack && ($stack[count($stack)-1] < $row[$right])) {
+			while ($stack && ($stack[count($stack) - 1] < $row[$right])) {
 				// @codingStandardsIgnoreEnd
 				array_pop($stack);
 				if ($indent) {
-					$whiteSpace = str_repeat("\t", count($stack));
-					$return .= "\r\n" . $whiteSpace . "\t";
+					$whiteSpace = str_repeat($indentWith, count($stack));
+					$return .= "\r\n" . $whiteSpace . $indentWith;
 				}
 				if ($type) {
 					$return .= '</' . $type . '>';
@@ -234,6 +248,7 @@ class TreeHelper extends Helper {
 
 			$elementData = [
 				'data' => $result,
+				'parent' => $parent,
 				'depth' => $depth,
 				'hasChildren' => $hasChildren,
 				'numberOfDirectChildren' => $numberOfDirectChildren,
@@ -266,9 +281,9 @@ class TreeHelper extends Helper {
 			if (!$content) {
 				continue;
 			}
-			$whiteSpace = str_repeat("\t", $depth);
+			$whiteSpace = str_repeat($indentWith, $depth);
 			if ($indent && strpos($content, "\r\n", 1)) {
-				$content = str_replace("\r\n", "\n" . $whiteSpace . "\t", $content);
+				$content = str_replace("\r\n", "\n" . $whiteSpace . $indentWith, $content);
 			}
 			/* Prefix */
 			if ($addType) {
@@ -281,7 +296,7 @@ class TreeHelper extends Helper {
 				}
 			}
 			if ($indent) {
-				$return .= "\r\n" . $whiteSpace . "\t";
+				$return .= "\r\n" . $whiteSpace . $indentWith;
 			}
 			if ($itemType) {
 				$itemAttributes = $this->_attributes($itemType, $elementData);
@@ -293,11 +308,14 @@ class TreeHelper extends Helper {
 			if ($hasVisibleChildren) {
 				if ($numberOfDirectChildren) {
 					$config['depth'] = $depth + 1;
+					$children = $result['children'];
+					//unset($result['children']);
+
 					$return .= $this->_suffix();
-					$return .= $this->generate($result['children'], $config);
+					$return .= $this->_generate($children, $config, $result);
 					if ($itemType) {
 						if ($indent) {
-							$return .= $whiteSpace . "\t";
+							$return .= $whiteSpace . $indentWith;
 						}
 						$return .= '</' . $itemType . '>';
 					}
@@ -316,8 +334,8 @@ class TreeHelper extends Helper {
 		while ($stack) {
 			array_pop($stack);
 			if ($indent) {
-				$whiteSpace = str_repeat("\t", count($stack));
-				$return .= "\r\n" . $whiteSpace . "\t";
+				$whiteSpace = str_repeat($indentWith, count($stack));
+				$return .= "\r\n" . $whiteSpace . $indentWith;
 			}
 			if ($type) {
 				$return .= '</' . $type . '>';
@@ -339,6 +357,7 @@ class TreeHelper extends Helper {
 				$return .= "\r\n";
 			}
 		}
+
 		return $return;
 	}
 
@@ -348,9 +367,9 @@ class TreeHelper extends Helper {
 	 * Called to modify the attributes of the next <item> to be processed
 	 * Note that the content of a 'node' is processed before generating its wrapping <item> tag
 	 *
-	 * @param string $id
-	 * @param string $key
-	 * @param mixed $value
+	 * @param string $id Id
+	 * @param string $key Key
+	 * @param mixed $value Value
 	 * @return void
 	 */
 	public function addItemAttribute($id = '', $key = '', $value = null) {
@@ -383,10 +402,10 @@ class TreeHelper extends Helper {
 	 * // give top level type (1) a class
 	 * $tree->addTypeAttribute('class', 'hasHiddenGrandChildren', null, 'previous');
 	 *
-	 * @param string $id
-	 * @param string $key
-	 * @param mixed|null $value
-	 * @param string $previousOrNext
+	 * @param string $id ID
+	 * @param string $key Key
+	 * @param mixed|null $value Value
+	 * @param string $previousOrNext Previous or next
 	 * @return void
 	 */
 	public function addTypeAttribute($id = '', $key = '', $value = null, $previousOrNext = 'next') {
@@ -407,7 +426,7 @@ class TreeHelper extends Helper {
 	 *
 	 * Used to close and reopen a ul/ol to allow easier listings
 	 *
-	 * @param bool $reset
+	 * @param bool $reset Reset
 	 * @return string
 	 */
 	protected function _suffix($reset = false) {
@@ -441,6 +460,7 @@ class TreeHelper extends Helper {
 				$_splitCounter++;
 				if ($type && ($_splitCounter % $_splitCount) === 0 && !$lastChild) {
 					unset($this->_config['callback']);
+
 					return '</' . $type . '><' . $type . '>';
 				}
 			}
@@ -452,9 +472,9 @@ class TreeHelper extends Helper {
 	 *
 	 * Logic to apply styles to tags.
 	 *
-	 * @param string $rType
-	 * @param array $elementData
-	 * @param bool $clear
+	 * @param string $rType rType
+	 * @param array $elementData Element data
+	 * @param bool $clear Clear
 	 * @return string
 	 */
 	protected function _attributes($rType, array $elementData = [], $clear = true) {
@@ -497,6 +517,7 @@ class TreeHelper extends Helper {
 			}
 			$attributes[$type] = $type . '="' . implode(' ', $attributes[$type]) . '"';
 		}
+
 		return ' ' . implode(' ', $attributes);
 	}
 
@@ -506,7 +527,7 @@ class TreeHelper extends Helper {
 	 *
 	 * @param array $tree Tree
 	 * @param array $path Tree path
-	 * @param int $level
+	 * @param int $level Level
 	 * @return void
 	 * @throws \Exception
 	 */
@@ -521,7 +542,7 @@ class TreeHelper extends Helper {
 				throw new Exception('Only works with threaded (nested children) results');
 			}
 
-			if (!empty($path[$level]) && $subTree['id'] == $path[$level]['id']) {
+			if (!empty($path[$level]) && $subTree['id'] == $path[$level]) {
 				$subTree['show'] = 1;
 				$siblingIsActive = true;
 			}

tests/Fixture/DataFixture.php

@@ -0,0 +1,37 @@
+<?php
+namespace Tools\Test\Fixture;
+
+use Cake\TestSuite\Fixture\TestFixture;
+
+class DataFixture extends TestFixture {
+
+	/**
+	 * Fields
+	 *
+	 * @var array
+	 */
+	public $fields = [
+		'id' => ['type' => 'integer', 'length' => 11, 'unsigned' => false, 'null' => false, 'default' => null, 'comment' => '', 'autoIncrement' => true, 'precision' => null],
+		'name' => ['type' => 'string', 'length' => 50, 'null' => false, 'default' => null, 'comment' => '', 'precision' => null, 'fixed' => null],
+		'data_json' => ['type' => 'text', 'length' => 16777215, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'data_array' => ['type' => 'text', 'length' => 16777215, 'null' => true, 'default' => null, 'comment' => '', 'precision' => null],
+		'_constraints' => [
+			'primary' => ['type' => 'primary', 'columns' => ['id'], 'length' => []],
+		],
+	];
+
+	/**
+	 * Records
+	 *
+	 * @var array
+	 */
+	public $records = [
+			[
+				'id' => 1,
+				'name' => 'Lorem ipsum dolor sit amet',
+				'data_json' => null,
+				'data_array' => null,
+			],
+		];
+
+}

tests/TestCase/Model/Behavior/TypeMapBehaviorTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Tools\Test\TestCase\Model\Behavior;
+
+use Cake\ORM\TableRegistry;
+use Tools\TestSuite\TestCase;
+
+class TypeMapBehaviorTest extends TestCase {
+
+	/**
+	 * @var \Tools\Model\Behavior\TypeMapBehavior
+	 */
+	public $TypeMapBehavior;
+
+	/**
+	 * @var \Tools\Model\Table\Table
+	 */
+	protected $Table;
+
+	/**
+	 * @var array
+	 */
+	public $fixtures = ['plugin.Tools.Data'];
+
+	/**
+	 * @return void
+	 */
+	public function setUp() {
+		parent::setUp();
+	}
+
+	/**
+	 * Tests that we can disable array conversion for edit forms if we need to modify the JSON directly.
+	 *
+	 * @return void
+	 */
+	public function testFields() {
+		$this->Table = TableRegistry::get('Data');
+		$this->Table->addBehavior('Tools.Jsonable', ['fields' => ['data_array']]);
+
+		$entity = $this->Table->newEntity();
+
+		$data = [
+			'name' => 'FooBar',
+			'data_json' => ['x' => 'y'],
+			'data_array' => ['x' => 'y'],
+		];
+		$entity = $this->Table->patchEntity($entity, $data);
+		$this->assertEmpty($entity->getErrors());
+
+		$this->Table->saveOrFail($entity);
+		$this->assertSame($data['data_json'], $entity->data_json);
+		$this->assertSame('{"x":"y"}', $entity->data_array);
+
+		$savedEntity = $this->Table->get($entity->id);
+
+		$this->assertSame($data['data_json'], $savedEntity->data_json);
+		$this->assertSame($data['data_array'], $savedEntity->data_array);
+
+		// Now let's disable the array conversion per type
+		$this->Table->removeBehavior('Jsonable');
+		$this->Table->addBehavior('Tools.TypeMap', ['fields' => ['data_json' => 'text']]);
+		$entity = $this->Table->get($entity->id);
+
+		$this->assertSame('{"x":"y"}', $entity->data_json);
+		$this->assertSame('{"x":"y"}', $entity->data_array);
+
+		$data = [
+			'data_json' => '{"x":"z"}',
+			'data_array' => '{"x":"z"}',
+		];
+		$entity = $this->Table->patchEntity($entity, $data);
+		$this->Table->saveOrFail($entity);
+
+		$savedEntity = $this->Table->get($entity->id);
+		$this->assertSame($data['data_json'], $savedEntity->data_json);
+		$this->assertSame($data['data_array'], $savedEntity->data_array);
+	}
+
+}

tests/TestCase/View/Helper/TreeHelperTest.php

@@ -4,7 +4,6 @@ namespace Tools\Test\TestCase\View\Helper;
 
 use Cake\Datasource\ConnectionManager;
 use Cake\ORM\Entity;
-use Cake\ORM\Table;
 use Cake\ORM\TableRegistry;
 use Cake\View\View;
 use Tools\TestSuite\TestCase;
@@ -22,7 +21,12 @@ class TreeHelperTest extends TestCase {
 	/**
 	 * @var \Cake\ORM\Table
 	 */
-	public $Table;
+	protected $Table;
+
+	/**
+	 * @var \Tools\View\Helper\TreeHelper
+	 */
+	protected $Tree;
 
 	/**
 	 * Initial Tree
@@ -46,13 +50,11 @@ class TreeHelperTest extends TestCase {
 		$this->Table = TableRegistry::get('AfterTrees');
 		$this->Table->addBehavior('Tree');
 
-		//$this->Table->truncate();
 		$connection = ConnectionManager::get('test');
 		$sql = $this->Table->getSchema()->truncateSql($connection);
 		foreach ($sql as $snippet) {
 			$connection->execute($snippet);
 		}
-		//$this->Table->deleteAll(array());
 
 		$data = [
 			['name' => 'One'],
@@ -87,15 +89,6 @@ class TreeHelperTest extends TestCase {
 	/**
 	 * @return void
 	 */
-	public function testObject() {
-		$this->assertInstanceOf('Tools\View\Helper\TreeHelper', $this->Tree);
-	}
-
-	/**
-	 * TreeHelperTest::testGenerate()
-	 *
-	 * @return void
-	 */
 	public function testGenerate() {
 		$tree = $this->Table->find('threaded')->toArray();
 
@@ -137,15 +130,12 @@ TEXT;
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateWithFindAll()
-	 *
 	 * @return void
 	 */
 	public function testGenerateWithFindAll() {
 		$tree = $this->Table->find('all', ['order' => ['lft' => 'ASC']])->toArray();
 
 		$output = $this->Tree->generate($tree);
-		//debug($output); return;
 		$expected = <<<TEXT
 
 <ul>
@@ -182,8 +172,6 @@ TEXT;
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateWithDepth()
-	 *
 	 * @return void
 	 */
 	public function testGenerateWithDepth() {
@@ -224,8 +212,6 @@ TEXT;
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateWithSettings()
-	 *
 	 * @return void
 	 */
 	public function testGenerateWithSettings() {
@@ -266,8 +252,6 @@ TEXT;
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateWithMaxDepth()
-	 *
 	 * @return void
 	 */
 	public function testGenerateWithMaxDepth() {
@@ -304,16 +288,12 @@ TEXT;
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateWithAutoPath()
-	 *
 	 * @return void
 	 */
 	public function testGenerateWithAutoPath() {
 		$tree = $this->Table->find('threaded')->toArray();
-		//debug($tree);
 
 		$output = $this->Tree->generate($tree, ['autoPath' => [7, 10]]); // Two-SubA-1
-		//debug($output);
 		$expected = <<<TEXT
 
 <ul>
@@ -347,7 +327,6 @@ TEXT;
 		$this->assertTextEquals($expected, $output);
 
 		$output = $this->Tree->generate($tree, ['autoPath' => [8, 9]]); // Two-SubA-1-1
-		//debug($output);
 		$expected = <<<TEXT
 
 <ul>
@@ -382,6 +361,49 @@ TEXT;
 	}
 
 	/**
+	 * @return void
+	 */
+	public function testGenerateWithAutoPathAsEntity() {
+		$tree = $this->Table->find('threaded')->toArray();
+		$entity = new Entity();
+		$entity->lft = 7;
+		$entity->rght = 10;
+
+		$output = $this->Tree->generate($tree, ['autoPath' => $entity]);
+		$expected = <<<TEXT
+
+<ul>
+	<li>One
+	<ul>
+		<li>One-SubA</li>
+	</ul>
+	</li>
+	<li class="active">Two
+	<ul>
+		<li class="active">Two-SubA
+		<ul>
+			<li class="active">Two-SubA-1
+			<ul>
+				<li>Two-SubA-1-1</li>
+			</ul>
+			</li>
+		</ul>
+		</li>
+	</ul>
+	</li>
+	<li>Three</li>
+	<li>Four
+	<ul>
+		<li>Four-SubA</li>
+	</ul>
+	</li>
+</ul>
+
+TEXT;
+		$this->assertTextEquals($expected, $output);
+	}
+
+	/**
 	 * - One
 	 * -- One-SubA
 	 * - Two
@@ -397,8 +419,6 @@ TEXT;
 	 * @return void
 	 */
 	public function testGenerateWithAutoPathAndHideUnrelated() {
-		$this->skipIf(true, 'FIXME');
-
 		$data = [
 			['name' => 'Two-SubB', 'parent_id' => 2],
 			['name' => 'Two-SubC', 'parent_id' => 2],
@@ -414,7 +434,6 @@ TEXT;
 		$path = $nodes->extract('id')->toArray();
 
 		$output = $this->Tree->generate($tree, ['autoPath' => [6, 11], 'hideUnrelated' => true, 'treePath' => $path, 'callback' => [$this, '_myCallback']]); // Two-SubA
-		//debug($output);
 
 		$expected = <<<TEXT
 
@@ -457,8 +476,6 @@ TEXT;
 	 * @return void
 	 */
 	public function testGenerateWithAutoPathAndHideUnrelatedAndSiblings() {
-		$this->skipIf(true, 'FIXME');
-
 		$data = [
 			['name' => 'Two-SubB', 'parent_id' => 2],
 			['name' => 'Two-SubC', 'parent_id' => 2],
@@ -469,14 +486,14 @@ TEXT;
 		}
 
 		$tree = $this->Table->find('threaded')->toArray();
-		$id = 6;
+
+		$id = 6; // Two-SubA
 		$nodes = $this->Table->find('path', ['for' => $id]);
 		$path = $nodes->extract('id')->toArray();
 
 		$output = $this->Tree->generate($tree, [
 			'autoPath' => [6, 11], 'hideUnrelated' => true, 'treePath' => $path,
-			'callback' => [$this, '_myCallbackSiblings']]); // Two-SubA
-		//debug($output);
+			'callback' => [$this, '_myCallbackSiblings']]);
 
 		$expected = <<<TEXT
 
@@ -486,7 +503,7 @@ TEXT;
 	<ul>
 		<li class="active">Two-SubA (active)
 		<ul>
-			<li>Two-SubA-1</li>
+			<li>Two-SubA-1</li>	
 		</ul>
 		</li>
 		<li>Two-SubB</li>
@@ -507,8 +524,10 @@ TEXT;
 	 * @param array $data
 	 * @return string|null
 	 */
-	public function _myCallback($data) {
-		if (!empty($data['data']['hide'])) {
+	public function _myCallback(array $data) {
+		/** @var \Cake\ORM\Entity $entity */
+		$entity = $data['data'];
+		if (!empty($entity['hide'])) {
 			return null;
 		}
 		return $data['data']['name'] . ($data['activePathElement'] ? ' (active)' : '');
@@ -518,19 +537,20 @@ TEXT;
 	 * @param array $data
 	 * @return string|null
 	 */
-	public function _myCallbackSiblings($data) {
-		if (!empty($data['data']['hide'])) {
+	public function _myCallbackSiblings(array $data) {
+		/** @var \Cake\ORM\Entity $entity */
+		$entity = $data['data'];
+
+		if (!empty($entity['hide'])) {
 			return null;
 		}
 		if ($data['depth'] == 0 && $data['isSibling']) {
-			return $data['data']['name'] . ' (sibling)';
+			return $entity['name'] . ' (sibling)';
 		}
-		return $data['data']['name'] . ($data['activePathElement'] ? ' (active)' : '');
+		return $entity['name'] . ($data['activePathElement'] ? ' (active)' : '');
 	}
 
 	/**
-	 * TreeHelperTest::testGenerateProductive()
-	 *
 	 * @return void
 	 */
 	public function testGenerateProductive() {
@@ -542,4 +562,75 @@ TEXT;
 		$this->assertTextEquals($expected, $output);
 	}
 
+	/**
+	 * @return void
+	 */
+	public function testGenerateWithEntityUsage() {
+		$data = [
+			['name' => 'Two-SubB', 'parent_id' => 2],
+			['name' => 'Two-SubC', 'parent_id' => 2],
+		];
+		foreach ($data as $row) {
+			$row = new Entity($row);
+			$this->Table->save($row);
+		}
+
+		$tree = $this->Table->find('threaded')->toArray();
+
+		$id = 6;
+		$nodes = $this->Table->find('path', ['for' => $id]);
+		$path = $nodes->extract('id')->toArray();
+
+		$output = $this->Tree->generate($tree, [
+			'autoPath' => [6, 11], 'treePath' => $path,
+			'callback' => [$this, '_myCallbackEntity']]); // Two-SubA
+
+		$expected = <<<TEXT
+
+<ul>
+	<li>One
+	<ul>
+		<li>One-SubA</li>
+	</ul>
+	</li>
+	<li class="active">Two (active)
+	<ul>
+		<li class="active">Two-SubA (active)
+		<ul>
+			<li>Two-SubA-1
+			<ul>
+				<li>Two-SubA-1-1</li>
+			</ul>
+			</li>
+		</ul>
+		</li>
+		<li>Two-SubB</li>
+		<li>Two-SubC</li>
+	</ul>
+	</li>
+	<li>Three</li>
+	<li>Four
+	<ul>
+		<li>Four-SubA</li>
+	</ul>	
+	</li>
+</ul>
+
+TEXT;
+		$output = str_replace(["\t", "\r", "\n"], '', $output);
+		$expected = str_replace(["\t", "\r", "\n"], '', $expected);
+		$this->assertTextEquals($expected, $output);
+	}
+
+	/**
+	 * @param array $data
+	 * @return string|null
+	 */
+	public function _myCallbackEntity(array $data) {
+		/** @var \Cake\ORM\Entity $entity */
+		$entity = $data['data'];
+
+		return h($entity->name) . ($data['activePathElement'] ? ' (active)' : '');
+	}
+
 }

tests/test_app/Model/Table/DataTable.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Model\Table;
+
+use Cake\Database\Schema\TableSchema;
+use Tools\Model\Table\Table;
+
+class DataTable extends Table {
+
+	/**
+	 * @param \Cake\Database\Schema\TableSchema $schema
+	 *
+	 * @return \Cake\Database\Schema\TableSchema
+	 */
+	protected function _initializeSchema(TableSchema $schema) {
+		$schema->setColumnType('data_json', 'json');
+		$schema->setColumnType('data_array', 'array');
+
+		return $schema;
+	}
+
+}