Skip to content

refactor: Centralize query condition building in QueryConditionBuilder. #48

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 6 commits into from
Jul 2, 2025

Conversation

terabytesoftw
Copy link
Member

@terabytesoftw terabytesoftw commented Jul 2, 2025

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

Summary by CodeRabbit

  • New Features

    • Added a utility for building standardized query conditions for nested set tree operations, improving consistency and reusability.
  • Improvements

    • Enhanced performance by caching node attributes for left, right, and depth values.
    • Improved exception messages for clarity.
    • Strengthened validation when inserting after a node.
  • Refactor

    • Centralized and streamlined query condition construction for tree-related operations.
    • Removed redundant internal methods related to tree attribute condition application.
  • Tests

    • Removed tests related to previously used internal methods and exception handling for deprecated behaviors.

@terabytesoftw terabytesoftw added the bug Something isn't working label Jul 2, 2025
Copy link

coderabbitai bot commented Jul 2, 2025

Warning

Rate limit exceeded

@terabytesoftw has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5dbcb34 and 0854586.

📒 Files selected for processing (2)
  • src/NestedSetsBehavior.php (28 hunks)
  • src/QueryConditionBuilder.php (1 hunks)

Walkthrough

The changes introduce a new QueryConditionBuilder utility class for standardized construction of nested sets query conditions. The NestedSetsBehavior class is refactored to use this builder, adds caching for node attributes, improves exception messaging, and updates validation logic. Related test methods and stubs for the removed applyTreeAttributeCondition method are deleted.

Changes

File(s) Change Summary
src/NestedSetsBehavior.php Refactored to use QueryConditionBuilder for query conditions; added attribute value caching; improved exception handling and validation; removed applyTreeAttributeCondition.
src/QueryConditionBuilder.php Introduced new utility class with static methods for building nested sets query conditions.
tests/NestedSetsBehaviorTest.php Removed tests for applyTreeAttributeCondition and exception when inserting after a new record.
tests/support/stub/ExtendableNestedSetsBehavior.php Removed method exposing applyTreeAttributeCondition for testing.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NestedSetsBehavior
    participant QueryConditionBuilder

    User->>NestedSetsBehavior: Perform tree operation (e.g., find children, move node)
    NestedSetsBehavior->>QueryConditionBuilder: Build query condition via static method
    QueryConditionBuilder-->>NestedSetsBehavior: Return condition array
    NestedSetsBehavior->>NestedSetsBehavior: Use cached attribute values
    NestedSetsBehavior-->>User: Complete operation
Loading

Possibly related PRs

Poem

In tangled roots and branches deep,
Condition builders now we keep.
Caching left and right and depth,
Brings swift returns with every step.
Old helpers gone, new flows begin—
The nested sets now dance within!
🐇🌳✨

✨ 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

codecov bot commented Jul 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (60786a4) to head (0854586).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##                main       #48   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity       102       131   +29     
===========================================
  Files              3         4    +1     
  Lines            504       528   +24     
===========================================
+ Hits             504       528   +24     

☔ 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 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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 60786a4 and 1e97d67.

📒 Files selected for processing (4)
  • src/NestedSetsBehavior.php (29 hunks)
  • src/QueryConditionBuilder.php (1 hunks)
  • tests/NestedSetsBehaviorTest.php (0 hunks)
  • tests/support/stub/ExtendableNestedSetsBehavior.php (0 hunks)
💤 Files with no reviewable changes (2)
  • tests/support/stub/ExtendableNestedSetsBehavior.php
  • tests/NestedSetsBehaviorTest.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.889Z
Learning: The user terabytesoftw prefers to keep PRs focused and small, implementing enhancements in separate dedicated PRs rather than bundling multiple changes together.
🪛 GitHub Actions: ecs
src/NestedSetsBehavior.php

[warning] 502-502: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.


[warning] 929-929: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.


[warning] 1146-1146: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.


[warning] 1165-1165: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.


[warning] 1186-1186: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.


[warning] 1438-1438: PhpCsFixer: Missing trailing comma in multiline array or argument list. Run 'vendor/bin/ecs check --fix' to apply the fix.

🪛 GitHub Check: phpstan / PHP 8.4-ubuntu-latest
src/QueryConditionBuilder.php

[failure] 428-428:
Method yii2\extensions\nestedsets\QueryConditionBuilder::createSubtreeMoveCondition() return type has no value type specified in iterable type array.

🪛 GitHub Check: mutation / PHP 8.4-ubuntu-latest
src/QueryConditionBuilder.php

[failure] 428-428:
Method yii2\extensions\nestedsets\QueryConditionBuilder::createSubtreeMoveCondition() return type has no value type specified in iterable type array.

⏰ Context from checks skipped due to timeout of 90000ms (13)
  • GitHub Check: phpunit-compatibility / PHP 8.4-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.1-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.3-ubuntu-latest
  • GitHub Check: phpunit-compatibility / PHP 8.2-windows-latest
  • 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: mutation / PHP 8.4-ubuntu-latest
  • GitHub Check: phpunit / PHP 8.4-ubuntu-latest
  • GitHub Check: phpunit / PHP 8.3-windows-latest
  • GitHub Check: phpunit-compatibility / PHP 8.4-ubuntu-latest
  • GitHub Check: phpstan / PHP 8.4-ubuntu-latest
🔇 Additional comments (5)
src/NestedSetsBehavior.php (4)

133-147: Good addition of caching for performance optimization

The introduction of cached values for frequently accessed attributes (depth, left, right) is a solid performance improvement that reduces repeated database attribute lookups.


225-225: Good modernization of exception messages

Using ::class syntax instead of get_class() is cleaner and more idiomatic in modern PHP.

Also applies to: 351-351, 406-406


622-625: Good validation addition

Adding the check to prevent inserting after a new record is a good defensive programming practice that prevents potential runtime errors.


1336-1343: Well-implemented caching getters

The getter methods follow a consistent lazy-loading pattern that ensures values are fetched only once and cached for subsequent access. This is a clean implementation that improves performance.

Also applies to: 1345-1352, 1378-1385

src/QueryConditionBuilder.php (1)

1-31: Well-structured utility class for query condition building

The QueryConditionBuilder class is well-designed with clear documentation and appropriate use of the final keyword for a utility class. The static methods are suitable for this type of functionality.

@terabytesoftw terabytesoftw requested a review from Copilot July 2, 2025 23:28
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

Centralizes query condition construction by introducing a QueryConditionBuilder utility and refactors NestedSetsBehavior to leverage it, removing redundant methods and stubs.
Key changes:

  • Added QueryConditionBuilder with static methods for all nested-set query conditions.
  • Refactored NestedSetsBehavior to replace inline condition arrays with builder calls and added caching for boundary attributes.
  • Removed the deprecated applyTreeAttributeCondition stub and related tests.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
tests/support/stub/ExtendableNestedSetsBehavior.php Removed deprecated exposedApplyTreeAttributeCondition stub
tests/NestedSetsBehaviorTest.php Removed tests for deprecated behavior and legacy exception path
src/QueryConditionBuilder.php New utility class for standardized nested-set query condition building
src/NestedSetsBehavior.php Refactored to use QueryConditionBuilder, removed inline conditions, added attribute caching
Comments suppressed due to low confidence (1)

src/QueryConditionBuilder.php:1

  • Consider adding dedicated unit tests for each QueryConditionBuilder method to ensure comprehensive coverage of all new condition-building utilities.
<?php

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.

2 participants
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