Skip to content

refactor: Streamline node movement logic in NestedSetsBehavior class in afterUpdate() method. #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 29, 2025

Conversation

terabytesoftw
Copy link
Member

@terabytesoftw terabytesoftw commented Jun 29, 2025

Q A
Is bugfix? ✔️
New feature?
Breaks BC?

Summary by CodeRabbit

  • Refactor
    • Improved internal handling of node updates for nested sets, resulting in more explicit and reliable node movement operations. No changes to user-facing features or functionality.

@terabytesoftw terabytesoftw added the bug Something isn't working label Jun 29, 2025
Copy link

codecov bot commented Jun 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (517d7e9) to head (71d09c7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##                main       #15   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity        82        86    +4     
===========================================
  Files              2         2           
  Lines            457       460    +3     
===========================================
+ Hits             457       460    +3     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link

coderabbitai bot commented Jun 29, 2025

"""

Walkthrough

The moveNode() method in NestedSetsBehavior was refactored to require an explicit ActiveRecord $node parameter instead of relying on an internal property. The afterUpdate() method was updated to use a match(true) expression for control flow and to pass the node instance directly to moveNode().

Changes

File(s) Change Summary
src/NestedSetsBehavior.php Refactored afterUpdate() to use match(true) and pass node instance to moveNode(). Updated moveNode() signature to accept ActiveRecord $node and refactored internal logic to use the passed node.

Possibly related PRs

Poem

🐇
Refactored code, a tidy feat,
Passing nodes, no more discrete.
Matches guide the update way,
Explicit nodes now here to stay.
Hopping forward, clear and neat—
Nested sets can’t be beat!

"""

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 phpcs (3.7.2)
src/NestedSetsBehavior.php

Warning: PHP Startup: Invalid date.timezone value 'UTC', using 'UTC' instead in Unknown on line 0

Fatal error: Uncaught Error: Class "Phar" not found in /usr/local/bin/phpcs:3
Stack trace:
#0 {main}
thrown in /usr/local/bin/phpcs on line 3


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 062e01d and 71d09c7.

📒 Files selected for processing (1)
  • src/NestedSetsBehavior.php (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/NestedSetsBehavior.php
⏰ Context from checks skipped due to timeout of 90000ms (17)
  • GitHub Check: phpunit-compatibility / PHP 8.2-ubuntu-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-ubuntu-latest
  • GitHub Check: phpunit-compatibility / PHP 8.1-ubuntu-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-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.4-ubuntu-latest
  • GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
  • GitHub Check: phpunit / PHP 8.2-windows-latest
  • GitHub Check: phpunit / PHP 8.3-ubuntu-latest
  • 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.3-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
  • GitHub Check: phpunit / PHP 8.1-windows-latest
✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/NestedSetsBehavior.php (1)

250-265: Consider using match expression for cleaner control flow.

The refactoring to pass $this->node explicitly to moveNode() is excellent, but the change from match to switch(true) makes the code more verbose without clear benefits. Consider using a match expression with the explicit parameter passing:

-        switch (true) {
-            case $this->operation === self::OPERATION_APPEND_TO && $this->node !== null:
-                $this->moveNode($this->node, $this->node->getAttribute($this->rightAttribute), 1);
-                break;
-            case $this->operation === self::OPERATION_INSERT_AFTER && $this->node !== null:
-                $this->moveNode($this->node, $this->node->getAttribute($this->rightAttribute) + 1, 0);
-                break;
-            case $this->operation === self::OPERATION_INSERT_BEFORE && $this->node !== null:
-                $this->moveNode($this->node, $this->node->getAttribute($this->leftAttribute), 0);
-                break;
-            case $this->operation === self::OPERATION_MAKE_ROOT:
-                $this->moveNodeAsRoot();
-                break;
-            case $this->operation === self::OPERATION_PREPEND_TO && $this->node !== null:
-                $this->moveNode($this->node, $this->node->getAttribute($this->leftAttribute) + 1, 1);
-        }
+        match ($this->operation) {
+            self::OPERATION_APPEND_TO when $this->node !== null => 
+                $this->moveNode($this->node, $this->node->getAttribute($this->rightAttribute), 1),
+            self::OPERATION_INSERT_AFTER when $this->node !== null => 
+                $this->moveNode($this->node, $this->node->getAttribute($this->rightAttribute) + 1, 0),
+            self::OPERATION_INSERT_BEFORE when $this->node !== null => 
+                $this->moveNode($this->node, $this->node->getAttribute($this->leftAttribute), 0),
+            self::OPERATION_MAKE_ROOT => 
+                $this->moveNodeAsRoot(),
+            self::OPERATION_PREPEND_TO when $this->node !== null => 
+                $this->moveNode($this->node, $this->node->getAttribute($this->leftAttribute) + 1, 1),
+            default => null,
+        };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 517d7e9 and d8fcdf4.

📒 Files selected for processing (1)
  • src/NestedSetsBehavior.php (3 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 (1)
src/NestedSetsBehavior.php (1)
tests/TestCase.php (1)
  • getDb (40-43)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: phpunit / PHP 8.4-windows-latest
  • GitHub Check: phpunit / PHP 8.1-windows-latest
  • GitHub Check: phpunit / PHP 8.3-windows-latest
  • GitHub Check: phpunit / PHP 8.2-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.2-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
🔇 Additional comments (1)
src/NestedSetsBehavior.php (1)

1169-1169: Excellent refactoring to use explicit parameter.

The replacement of $this->node references with the passed $node parameter improves the method's encapsulation and makes it independent of internal behavior state. This change enhances testability and makes the code more explicit about which node is being operated on.

Also applies to: 1175-1175, 1236-1236

@terabytesoftw terabytesoftw requested a review from Copilot June 29, 2025 11:59
Copilot

This comment was marked as outdated.

@terabytesoftw terabytesoftw requested a review from Copilot June 29, 2025 12:06
Copilot

This comment was marked as outdated.

@terabytesoftw terabytesoftw requested a review from Copilot June 29, 2025 12:09
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR refactors the afterUpdate() method in NestedSetsBehavior to use a boolean match for operation dispatch and updates the moveNode method to accept an explicit ActiveRecord $node parameter.

  • Streamlined operation handling in afterUpdate() using match(true)
  • Changed moveNode signature to include the node instance and updated internal references
  • Added a docblock parameter for $node
Comments suppressed due to low confidence (3)

src/NestedSetsBehavior.php:1155

  • The docblock now includes a new $node parameter but the existing @param tags for $value and $depth are unchanged; please update and reorder the docblock to document all parameters consistently.
     * @param ActiveRecord $node Node to be moved within the nested set tree.

src/NestedSetsBehavior.php:248

  • The updated afterUpdate() logic now dispatches different operations with explicit node handling; consider adding or updating unit tests to cover each operation path (append, prepend, insert before/after, make root).
    public function afterUpdate(): void

src/NestedSetsBehavior.php:1159

  • Changing the protected moveNode signature is a backward-incompatible change for any subclasses that override this method; consider deprecating the old signature or increasing the major version to reflect the API change.
    protected function moveNode(ActiveRecord $node, int $value, int $depth): void

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy