[Tree] Add pre-order and level-order traversals #2498

Jean-Beru · 2022-07-26T16:44:37Z

In order to get the next node when traversing a tree, this PRs add new methods NestedTreeRepository::getNextNode and NestedTreeRepository::getNextNodes. They take some arguments :

$root is the top node and is used to limit result to this (sub-)tree
$node is the current node (or null for the first call)
$limit (only for getNextNodes) can limit nodes count to return
$traversalStrategy accepts self::TRAVERSAL_PRE_ORDER (default) or self::TRAVERSAL_LEVEL_ORDER and is used to determine which algorithm use (see https://www.geeksforgeeks.org/tree-traversals-inorder-preorder-and-postorder).

These methods can be used, for example, to read a book page after page:

The History of Middle-earth
- The Book of Lost Tales 1
  - Chapter 1
    - Page 1
    - Page 2
    - Page 3
    - ...
  - Chapter 2
    - Page 1
    - Page 2
    - Page 3
    - ...
- The Book of Lost Tales 2
- ...

codecov-commenter · 2022-07-27T08:24:09Z

Codecov Report

Attention: Patch coverage is 95.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 79.30%. Comparing base (f21d888) to head (0037f83).
Report is 135 commits behind head on main.

Files	Patch %	Lines
...rc/Tree/Entity/Repository/NestedTreeRepository.php	95.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2498      +/-   ##
==========================================
+ Coverage   79.22%   79.30%   +0.07%     
==========================================
  Files         161      161              
  Lines        8415     8455      +40     
==========================================
+ Hits         6667     6705      +38     
- Misses       1748     1750       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

morban · 2023-04-25T13:30:58Z

It will be nice if this PR was successful and merge. Thank you.

src/Tree/Entity/Repository/NestedTreeRepository.php

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

src/Tree/Entity/Repository/NestedTreeRepository.php

tests/Gedmo/Tree/NestedTreeTraversalTest.php

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

tests/Gedmo/Tree/NestedTreeTraversalTest.php

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

franmomu

I guess we can add object type to parameters

franmomu · 2023-08-06T13:06:41Z

CHANGELOG.md

@@ -58,6 +58,7 @@ a release.

 ### Added
 - Tree: Add `Nested::ALLOWED_NODE_POSITIONS` constant in order to expose the available node positions
+- Tree: Add pre-order and level-order traversals (#2498). Add `getNextNode()` and `getNextNodes()` methods to traverse the tree


This should be moved to the ## [Unreleased] section

franmomu · 2023-08-06T13:14:37Z

src/Tree/Entity/Repository/NestedTreeRepository.php

+     *
+     * @throws InvalidArgumentException if input is invalid
+     */
+    public function getNextNodesQueryBuilder($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): QueryBuilder


Suggested change

public function getNextNodesQueryBuilder($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): QueryBuilder

public function getNextNodesQueryBuilder(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): QueryBuilder

Should we make this method private?

franmomu · 2023-08-06T13:17:03Z

src/Tree/Entity/Repository/NestedTreeRepository.php

+     * @param int|null          $limit             Maximum nodes to return. If null, all nodes will be returned
+     * @param self::TRAVERSAL_* $traversalStrategy Strategy to use to traverse tree
+     */
+    public function getNextNodesQuery($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): Query


Suggested change

public function getNextNodesQuery($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): Query

public function getNextNodesQuery(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): Query

franmomu · 2023-08-06T13:17:43Z

src/Tree/Entity/Repository/NestedTreeRepository.php

+     * @param object|null       $node              Current node. If null, first node will be returned
+     * @param self::TRAVERSAL_* $traversalStrategy Strategy to use to traverse tree
+     */
+    public function getNextNode($root, $node = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): ?object


Suggested change

public function getNextNode($root, $node = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): ?object

public function getNextNode(object $root, ?object $node = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): ?object

franmomu · 2023-08-06T13:17:57Z

src/Tree/Entity/Repository/NestedTreeRepository.php

+     *
+     * @return array<object>
+     */
+    public function getNextNodes($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): array


Suggested change

public function getNextNodes($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): array

public function getNextNodes(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): array

Jean-Beru · 2023-08-07T08:55:16Z

@franmomu I agree to add the object type to arguments and make some functions private. Since this logic could be applied to other NestedTreeRepository functions (get*QueryBuilder and get*Query), should we:

keep as it is to have the same approach
make only new typehinted and private
make all typehinted and private => will cause a BC break
?

IMO, the second one it the best answer since we improve code without any BC break. Before doing any commit, is it OK for you @phansys ?

phansys · 2023-08-12T19:31:52Z

src/Tree/Entity/Repository/NestedTreeRepository.php

+            }
+        } elseif (self::TRAVERSAL_LEVEL_ORDER === $traversalStrategy) {
+            if (!isset($config['level'])) {
+                throw new \InvalidArgumentException('TreeLevel must be set to use level order traversal.');


Why \InvalidArgumentException? $config['level'] isn't provided as an argument in this method.

phansys · 2023-08-12T19:36:17Z

IMO, the second one it the best answer since we improve code without any BC break. Before doing any commit, is it OK for you @phansys ?

LGTM.

github-actions · 2024-02-14T09:04:04Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Jean-Beru · 2024-05-24T13:08:48Z

github-actions, you can keep this PR opened. I'll fix conflicts soon.

Jean-Beru force-pushed the feat/get-next-node branch from 2fad25b to 442d99b Compare July 27, 2022 08:22

Jean-Beru force-pushed the feat/get-next-node branch 2 times, most recently from 3e19794 to c47fa1b Compare July 27, 2022 08:26

phansys added Tree Needs Changelog note New Feature labels Jul 28, 2022

phansys removed the Needs Changelog note label Jun 4, 2023

phansys requested changes Jun 4, 2023

View reviewed changes

Jean-Beru and others added 10 commits July 28, 2023 10:32

[Tree] Add pre-order and level-order traversals

a8ced41

update CHANGELOG.md

490fff3

Update src/Tree/Entity/Repository/NestedTreeRepository.php

3f5ad50

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

90431f3

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

7f0889b

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

e1f3b78

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

5e0bded

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

f599f4a

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

1087769

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

cs

079cec2

Jean-Beru force-pushed the feat/get-next-node branch from 42c0094 to 079cec2 Compare July 28, 2023 08:35

Jean-Beru requested a review from phansys July 28, 2023 08:43

phansys requested changes Jul 30, 2023

View reviewed changes

src/Tree/Entity/Repository/NestedTreeRepository.php Outdated Show resolved Hide resolved

src/Tree/Entity/Repository/NestedTreeRepository.php Outdated Show resolved Hide resolved

tests/Gedmo/Tree/NestedTreeTraversalTest.php Outdated Show resolved Hide resolved

Jean-Beru and others added 4 commits July 31, 2023 16:32

Update src/Tree/Entity/Repository/NestedTreeRepository.php

93f0f2c

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

Update src/Tree/Entity/Repository/NestedTreeRepository.php

fac750d

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

fix: review

d46164c

cs

db2c5ea

phansys reviewed Aug 1, 2023

View reviewed changes

tests/Gedmo/Tree/NestedTreeTraversalTest.php Outdated Show resolved Hide resolved

phansys requested a review from franmomu August 1, 2023 09:34

Update tests/Gedmo/Tree/NestedTreeTraversalTest.php

0037f83

Co-authored-by: Javier Spagnoletti <phansys@gmail.com>

phansys approved these changes Aug 5, 2023

View reviewed changes

franmomu reviewed Aug 6, 2023

View reviewed changes

phansys reviewed Aug 12, 2023

View reviewed changes

phansys self-requested a review August 18, 2023 00:58

github-actions bot added Stale and removed Stale labels Feb 14, 2024

franmomu added the Still Relevant Mark PRs that might've been auto-closed that are still relevant. label Jun 9, 2024

phansys added the Needs Rebase label Aug 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tree] Add pre-order and level-order traversals #2498

[Tree] Add pre-order and level-order traversals #2498

Jean-Beru commented Jul 26, 2022

codecov-commenter commented Jul 27, 2022 •

edited by codecov bot

Loading

morban commented Apr 25, 2023

franmomu left a comment

franmomu Aug 6, 2023

franmomu Aug 6, 2023

franmomu Aug 6, 2023

franmomu Aug 6, 2023

franmomu Aug 6, 2023

Jean-Beru commented Aug 7, 2023

phansys Aug 12, 2023

phansys commented Aug 12, 2023

github-actions bot commented Feb 14, 2024

Jean-Beru commented May 24, 2024

	public function getNextNodesQueryBuilder($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): QueryBuilder
	public function getNextNodesQueryBuilder(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): QueryBuilder

	public function getNextNodesQuery($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): Query
	public function getNextNodesQuery(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): Query

	public function getNextNode($root, $node = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): ?object
	public function getNextNode(object $root, ?object $node = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): ?object

	public function getNextNodes($root, $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): array
	public function getNextNodes(object $root, ?object $node = null, ?int $limit = null, string $traversalStrategy = self::TRAVERSAL_PRE_ORDER): array

[Tree] Add pre-order and level-order traversals #2498

Are you sure you want to change the base?

[Tree] Add pre-order and level-order traversals #2498

Conversation

Jean-Beru commented Jul 26, 2022

codecov-commenter commented Jul 27, 2022 • edited by codecov bot Loading

Codecov Report

morban commented Apr 25, 2023

franmomu left a comment

Choose a reason for hiding this comment

franmomu Aug 6, 2023

Choose a reason for hiding this comment

franmomu Aug 6, 2023

Choose a reason for hiding this comment

franmomu Aug 6, 2023

Choose a reason for hiding this comment

franmomu Aug 6, 2023

Choose a reason for hiding this comment

franmomu Aug 6, 2023

Choose a reason for hiding this comment

Jean-Beru commented Aug 7, 2023

phansys Aug 12, 2023

Choose a reason for hiding this comment

phansys commented Aug 12, 2023

github-actions bot commented Feb 14, 2024

Jean-Beru commented May 24, 2024

codecov-commenter commented Jul 27, 2022 •

edited by codecov bot

Loading