feat: Introduce NodeContext class for improved node movement handling and refactor beforeInsert, and moveNode method to use context.
#46
Conversation
…ions and improve node movement logic.
|
""" WalkthroughThe changes refactor node movement operations in the nested set behavior by introducing a typed Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant NestedSetsBehavior
participant Database
User->>NestedSetsBehavior: afterUpdate()
NestedSetsBehavior->>NestedSetsBehavior: createMoveContext(targetNode, operation)
NestedSetsBehavior->>NestedSetsBehavior: moveNode(NodeContext)
alt Move as root
NestedSetsBehavior->>NestedSetsBehavior: moveNodeAsRoot(treeValue)
NestedSetsBehavior->>NestedSetsBehavior: moveSubtreeToTargetTree(...)
NestedSetsBehavior->>Database: Bulk update subtree attributes
else Move within tree
NestedSetsBehavior->>NestedSetsBehavior: moveSubtreeToTargetTree(...)
NestedSetsBehavior->>Database: Bulk update subtree attributes
end
Possibly related PRs
Suggested labels
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🧰 Additional context used🧠 Learnings (1)📓 Common learnings⏰ Context from checks skipped due to timeout of 90000ms (13)
🔇 Additional comments (13)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #46 +/- ##
===========================================
Coverage 100.00% 100.00%
- Complexity 91 102 +11
===========================================
Files 2 3 +1
Lines 474 504 +30
===========================================
+ Hits 474 504 +30 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/NestedSetsBehavior.php (1)
1423-1461: Verify parameter naming for clarity.The new
moveSubtreeToTargetTree()method efficiently centralizes the subtree movement logic. However, the parameter naming might be confusing:
$nodeRootValue: Appears to be the new tree identifier (assigned to tree attribute)$treeValue: Appears to be the current tree identifier (used in WHERE condition)Consider renaming these parameters for better clarity, e.g.,
$newTreeValueand$currentTreeValue.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/NestedSetsBehavior.php(9 hunks)tests/support/stub/ExtendableNestedSetsBehavior.php(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#13
File: src/NestedSetsBehavior.php:145-145
Timestamp: 2025-06-29T11:22:41.839Z
Learning: The user terabytesoftw prefers to keep PRs focused and small, implementing enhancements in separate dedicated PRs rather than bundling multiple changes together.
🧬 Code Graph Analysis (2)
tests/support/stub/ExtendableNestedSetsBehavior.php (1)
src/NestedSetsBehavior.php (2)
moveNode(1190-1292)moveNodeAsRoot(1314-1330)
src/NestedSetsBehavior.php (2)
src/NestedSetsQueryBehavior.php (1)
getOwner(136-143)tests/TestCase.php (1)
getDb(40-43)
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: phpunit / PHP 8.4-windows-latest
- GitHub Check: phpunit / PHP 8.2-windows-latest
- GitHub Check: phpunit / PHP 8.1-windows-latest
- GitHub Check: phpunit / PHP 8.3-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.2-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
- GitHub Check: mutation / PHP 8.4-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.4-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.2-ubuntu-latest
- GitHub Check: phpunit / PHP 8.2-ubuntu-latest
- GitHub Check: mutation / PHP 8.4-ubuntu-latest
🔇 Additional comments (6)
src/NestedSetsBehavior.php (5)
9-11: LGTM! Good infrastructure improvements.The addition of the
Connectionimport and the private property for caching the database connection is a good optimization. Thesprintfimport properly supports the existing string formatting in database expressions.Also applies to: 124-125
254-267: LGTM! Consistent implementation of multi-tree support.The tree attribute value is correctly retrieved and passed to all movement methods. The conditional check ensures backward compatibility when
treeAttributeisfalse.
1186-1292: LGTM! Well-structured refactoring for multi-tree support.The method signature change and implementation improvements enhance clarity and maintainability:
- The explicit
$treeValueparameter makes the multi-tree handling more transparent- Centralizing the subtree movement logic in
moveSubtreeToTargetTree()reduces code duplication- The conditional logic correctly handles both same-tree and cross-tree movements
1312-1330: LGTM! Consistent refactoring pattern.The changes to
moveNodeAsRoot()follow the same pattern asmoveNode(), maintaining consistency across the codebase. The delegation tomoveSubtreeToTargetTree()simplifies the implementation.
1364-1379: LGTM! Smart performance optimization.The database connection caching using the null coalescing assignment operator (
??=) is an elegant solution that prevents redundant lookups. This will improve performance when multiple database operations are performed in succession.tests/support/stub/ExtendableNestedSetsBehavior.php (1)
57-57: LGTM! Test stub correctly updated.The method calls are properly updated to match the new signatures in the parent class, passing
nullas the tree value parameter. This maintains the test compatibility while allowing the stub to exercise the updated methods.Also applies to: 64-64
…larity and consistency.
There was a problem hiding this comment.
Pull Request Overview
Enhances the NestedSetsBehavior to fully support multi-tree operations by introducing a treeValue parameter in movement methods, refactors subtree moves into a single bulk operation, and adds connection caching for performance.
- Added a
treeValueargument tomoveNodeandmoveNodeAsRootto handle explicit tree assignment. - Extracted subtree update logic into
moveSubtreeToTargetTreefor cleaner bulk updates. - Introduced a cached
getDb()method and updated test stubs to match new signatures.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/support/stub/ExtendableNestedSetsBehavior.php | Updated exposedMoveNode and exposedMoveNodeAsRoot to pass a null treeValue. |
| src/NestedSetsBehavior.php | Refactored node movement methods to accept and propagate treeValue, added getDb() caching, and extracted subtree logic into a new helper. |
… and refactor moveNode method to use context.
…rect method call in `ExtendableNestedSetsBehavior`.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
src/NestedSetsBehavior.php (1)
1190-1190: Consider using a more descriptive variable name.The variable
depthOffsetwould be clearer than reusing the parameter name pattern.-$depthOffset = $targetNodeDepthValue - $ownerDepthValue + $context->depthLevelDelta; +$depthOffset = $targetNodeDepthValue - $ownerDepthValue + $context->depthLevelDelta;
🧹 Nitpick comments (2)
src/NodeContext.php (2)
85-96: Maintain consistency in PHPDoc annotations.Use
@phpstan-varinstead of@varto maintain consistency with other factory methods in this class.public static function forInsertBefore(ActiveRecord $targetNode, string $leftAttribute): self { - /** @var int $leftValue */ + /** @phpstan-var int $leftValue */ $leftValue = $targetNode->getAttribute($leftAttribute);
106-117: Maintain consistency in PHPDoc annotations.Use
@phpstan-varinstead of@varto maintain consistency with other factory methods in this class.public static function forPrependTo(ActiveRecord $targetNode, string $leftAttribute): self { - /** @var int $leftValue */ + /** @phpstan-var int $leftValue */ $leftValue = $targetNode->getAttribute($leftAttribute);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/NestedSetsBehavior.php(8 hunks)src/NodeContext.php(1 hunks)tests/support/stub/ExtendableNestedSetsBehavior.php(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- tests/support/stub/ExtendableNestedSetsBehavior.php
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#13
File: src/NestedSetsBehavior.php:145-145
Timestamp: 2025-06-29T11:22:41.839Z
Learning: The user terabytesoftw prefers to keep PRs focused and small, implementing enhancements in separate dedicated PRs rather than bundling multiple changes together.
🧬 Code Graph Analysis (1)
src/NodeContext.php (1)
src/NestedSetsBehavior.php (1)
NestedSetsBehavior(47-1504)
🪛 GitHub Check: mutation / PHP 8.4-ubuntu-latest
src/NodeContext.php
[failure] 129-129:
Variable $depth in PHPDoc tag @var does not exist.
[failure] 129-129:
Method yii2\extensions\nestedsets\NodeContext::getTargetDepth() should return int but returns mixed.
🪛 GitHub Check: phpstan / PHP 8.4-ubuntu-latest
src/NodeContext.php
[failure] 129-129:
Variable $depth in PHPDoc tag @var does not exist.
[failure] 129-129:
Method yii2\extensions\nestedsets\NodeContext::getTargetDepth() should return int but returns mixed.
🪛 GitHub Actions: ecs
src/NodeContext.php
[error] 29-29: PhpCsFixer: SingleLineEmptyBodyFixer - Empty body should be written as {} instead of separate braces.
🔇 Additional comments (4)
src/NestedSetsBehavior.php (4)
259-278: Well-structured refactoring using NodeContext.The refactored
afterUpdate()method effectively uses the newNodeContextpattern, improving code clarity and maintainability. The early returns and centralized state reset enhance readability.
1363-1372: Excellent use of match expression and typed context creation.The
createMoveContext()method provides a clean, type-safe way to create operation-specific contexts with proper error handling for unsupported operations.
1385-1388: Smart database connection caching.The
getDb()method efficiently caches the database connection using the null coalescing assignment operator, avoiding redundant lookups.
1454-1492: Efficient bulk update implementation for multi-tree operations.The
moveSubtreeToTargetTree()method effectively handles complex subtree movements with a single update query, properly updating all necessary attributes (left, right, depth, and tree).
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
src/NodeContext.php (2)
27-33: Fix constructor body formatting.The empty constructor body should be formatted as
{}on the same line to comply with code style requirements.public function __construct( public readonly ActiveRecord $targetNode, public readonly string $operation, public readonly int $targetPositionValue, public readonly int $depthLevelDelta, -) { -} +) {}
126-129: Fix type safety issue in getTargetDepth method.The static analysis correctly identifies that casting
mixedtointis unsafe. The method should validate the type before casting to ensure type safety.public function getTargetDepth(string $depthAttribute): int { - return (int) $this->targetNode->getAttribute($depthAttribute); + $depthValue = $this->targetNode->getAttribute($depthAttribute); + + if (!is_numeric($depthValue)) { + throw new \InvalidArgumentException("Depth attribute must be numeric, got: " . gettype($depthValue)); + } + + return (int) $depthValue; }
🧹 Nitpick comments (1)
src/NodeContext.php (1)
35-117: Consider standardizing PHPDoc annotations across factory methods.The factory methods use inconsistent PHPDoc annotations - some use
@phpstan-varwhile others use@var. Consider standardizing to@phpstan-varfor better static analysis support.For consistency, update the remaining factory methods:
public static function forInsertBefore(ActiveRecord $targetNode, string $leftAttribute): self { - /** @var int $leftValue */ + /** @phpstan-var int $leftValue */ $leftValue = $targetNode->getAttribute($leftAttribute);public static function forPrependTo(ActiveRecord $targetNode, string $leftAttribute): self { - /** @var int $leftValue */ + /** @phpstan-var int $leftValue */ $leftValue = $targetNode->getAttribute($leftAttribute);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/NodeContext.php(1 hunks)tests/support/stub/ExtendableNestedSetsBehavior.php(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- tests/support/stub/ExtendableNestedSetsBehavior.php
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#13
File: src/NestedSetsBehavior.php:145-145
Timestamp: 2025-06-29T11:22:41.839Z
Learning: The user terabytesoftw prefers to keep PRs focused and small, implementing enhancements in separate dedicated PRs rather than bundling multiple changes together.
🧬 Code Graph Analysis (1)
src/NodeContext.php (1)
src/NestedSetsBehavior.php (1)
NestedSetsBehavior(47-1504)
🪛 GitHub Check: mutation / PHP 8.4-ubuntu-latest
src/NodeContext.php
[failure] 128-128:
Cannot cast mixed to int.
🪛 GitHub Check: phpstan / PHP 8.4-ubuntu-latest
src/NodeContext.php
[failure] 128-128:
Cannot cast mixed to int.
🪛 GitHub Actions: ecs
src/NodeContext.php
[warning] 29-29: PhpCsFixer SingleLineEmptyBodyFixer: Method body should be empty on a single line. Run 'vendor/bin/ecs check --fix' to apply the fix.
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: phpunit-compatibility / PHP 8.2-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.2-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.4-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.1-ubuntu-latest
- GitHub Check: phpunit / PHP 8.3-windows-latest
- GitHub Check: phpunit / PHP 8.2-windows-latest
- GitHub Check: phpunit / PHP 8.1-windows-latest
- GitHub Check: phpunit / PHP 8.3-ubuntu-latest
- GitHub Check: phpunit / PHP 8.1-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
🔇 Additional comments (1)
src/NodeContext.php (1)
1-144: Excellent design for encapsulating node movement context.The
NodeContextclass provides a clean, immutable value object that effectively encapsulates all necessary data for node movement operations. The static factory methods for each operation type (forAppendTo,forInsertAfter, etc.) provide clear, type-safe ways to create instances with appropriate positioning calculations.Key strengths:
- Immutable design with readonly properties
- Operation-specific factory methods with clear naming
- Proper calculation of
targetPositionValueanddepthLevelDeltafor each operation- Type-safe accessor methods for target node properties
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
NestedSetsBehavior class to support multi-tree operations and improve node movement logic.moveNode method to use context.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
…InsertNode method calls.
moveNode method to use context.beforeInsert, and moveNode method to use context.
…Context in NestedSetsBehavior.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/NestedSetsBehavior.php (1)
381-393: Fix trailing comma formatting issue.The pipeline failure indicates missing trailing commas in the multiline match expression. Add trailing commas to improve consistency and maintainability.
Apply this formatting fix:
match (true) { $this->operation === self::OPERATION_APPEND_TO && $this->node !== null => $this->beforeInsertNodeWithContext( - NodeContext::forAppendTo($this->node, $this->rightAttribute) + NodeContext::forAppendTo($this->node, $this->rightAttribute), ), $this->operation === self::OPERATION_INSERT_AFTER && $this->node !== null => $this->beforeInsertNodeWithContext( - NodeContext::forInsertAfter($this->node, $this->rightAttribute) + NodeContext::forInsertAfter($this->node, $this->rightAttribute), ), $this->operation === self::OPERATION_INSERT_BEFORE && $this->node !== null => $this->beforeInsertNodeWithContext( - NodeContext::forInsertBefore($this->node, $this->leftAttribute) + NodeContext::forInsertBefore($this->node, $this->leftAttribute), ), $this->operation === self::OPERATION_MAKE_ROOT => $this->beforeInsertRootNode(), $this->operation === self::OPERATION_PREPEND_TO && $this->node !== null => $this->beforeInsertNodeWithContext( - NodeContext::forPrependTo($this->node, $this->leftAttribute) + NodeContext::forPrependTo($this->node, $this->leftAttribute), ), default => throw new NotSupportedException( 'Method "' . get_class($this->getOwner()) . '::insert" is not supported for inserting new nodes.', ), };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/NestedSetsBehavior.php(12 hunks)src/NodeContext.php(1 hunks)tests/NestedSetsBehaviorTest.php(1 hunks)tests/support/stub/ExtendableNestedSetsBehavior.php(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- tests/support/stub/ExtendableNestedSetsBehavior.php
- src/NodeContext.php
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: terabytesoftw
PR: yii2-extensions/nested-sets-behavior#13
File: src/NestedSetsBehavior.php:145-145
Timestamp: 2025-06-29T11:22:41.839Z
Learning: The user terabytesoftw prefers to keep PRs focused and small, implementing enhancements in separate dedicated PRs rather than bundling multiple changes together.
🧬 Code Graph Analysis (1)
src/NestedSetsBehavior.php (3)
src/NestedSetsQueryBehavior.php (1)
getOwner(136-143)src/NodeContext.php (9)
NodeContext(25-157)forAppendTo(43-50)forInsertAfter(62-71)forInsertBefore(83-92)forPrependTo(104-113)getTargetPositionValue(139-142)getDepthLevelDelta(115-118)getTargetTreeValue(151-156)getTargetDepth(129-132)tests/TestCase.php (1)
getDb(40-43)
🪛 GitHub Actions: ecs
src/NestedSetsBehavior.php
[error] 379-395: PhpCsFixer: TrailingCommaInMultilineFixer detected missing trailing commas in multiline match expression. Run 'vendor/bin/ecs check --fix' to apply fixes.
⏰ Context from checks skipped due to timeout of 90000ms (15)
- GitHub Check: phpunit / PHP 8.1-ubuntu-latest
- GitHub Check: phpunit / PHP 8.4-windows-latest
- GitHub Check: phpunit / PHP 8.1-windows-latest
- GitHub Check: phpunit / PHP 8.2-windows-latest
- GitHub Check: phpunit / PHP 8.2-ubuntu-latest
- GitHub Check: phpunit / PHP 8.3-windows-latest
- GitHub Check: phpunit / PHP 8.3-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-ubuntu-latest
- GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.4-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.2-windows-latest
- GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
- GitHub Check: mutation / PHP 8.4-ubuntu-latest
- GitHub Check: phpunit / PHP 8.2-windows-latest
- GitHub Check: mutation / PHP 8.4-ubuntu-latest
🔇 Additional comments (10)
tests/NestedSetsBehaviorTest.php (1)
1604-1604: LGTM! Method signature properly updated to align with NodeContext refactoring.The change from
int|null $valuetoint $valuecorrectly reflects the removal of nullable position parameters in the core behavior, which is part of the NodeContext class introduction. This enforces better type safety and aligns with the centralized movement logic improvements.src/NestedSetsBehavior.php (9)
8-12: LGTM: Improved imports for new functionality.The addition of
RuntimeException,Connection, and explicitsprintfimport appropriately supports the refactored node movement operations and improved database connection handling.
125-131: LGTM: Performance optimization with cached database connection.Adding a cached
Connectionproperty with proper encapsulation improves performance by avoiding redundant database connection lookups throughout the behavior's operations.
261-274: LGTM: Improved type safety and clarity with NodeContext.The refactoring to use explicit conditionals and
NodeContextinstances enhances type safety and makes the movement logic more maintainable. The early return pattern for root movement improves readability.
1094-1110: LGTM: Clean abstraction with NodeContext delegation.The new method provides a clean interface for NodeContext-based insertion while maintaining the existing logic through delegation. This approach reduces code duplication and improves type safety.
1372-1381: LGTM: Well-structured factory method for movement contexts.The
createMoveContext()method provides a clean factory pattern for creating typedNodeContextinstances based on operation type. The use ofRuntimeExceptionfor unsupported operations is appropriate.
1394-1397: LGTM: Efficient database connection caching.The cached
getDb()method using null coalescing assignment optimizes performance by avoiding redundant connection lookups while maintaining clean encapsulation.
1437-1442: LGTM: Centralized tree value extraction.The
getTreeValue()method provides a consistent way to extract tree attribute values with proper null handling, improving maintainability across the behavior.
1463-1501: LGTM: Centralized subtree movement logic.The
moveSubtreeToTargetTree()method effectively centralizes the complex logic for moving subtrees between trees, performing all necessary attribute updates in a single bulk operation for optimal performance.
1070-1070: Position value is always non-null in NodeContextNodeContext’s factory methods may pass a nullable value into its constructor, but getTargetPositionValue() always returns an int—defaulting to 0 when the stored value is null. Since beforeInsertNodeWithContext() always calls beforeInsertNode($context->getTargetPositionValue(), …), the signature change safely assumes a non-nullable int.
No further changes needed.
…ant `getter` methods.
…lity and update documentation.
Summary by CodeRabbit
New Features
Refactor
Chores