Skip to content

test: Verify protected methods remain accessible to subclasses in NestedSetsBehavior. #31

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 1 commit into from
Jun 30, 2025

Conversation

terabytesoftw
Copy link
Member

@terabytesoftw terabytesoftw commented Jun 30, 2025

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

Summary by CodeRabbit

  • New Features

    • Added a new model supporting nested set trees with extended behavior for testing purposes.
    • Introduced a custom query class with enhanced nested set query capabilities.
    • Provided a stub behavior to track and expose internal method calls for advanced testing scenarios.
  • Tests

    • Added a new test to verify subclass access to protected methods in nested set behavior.
  • Chores

    • Updated static analysis configuration to recognize the new model and its behaviors.

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

coderabbitai bot commented Jun 30, 2025

Walkthrough

This change introduces new test coverage and supporting test infrastructure to verify that the protected method applyTreeAttributeCondition in the NestedSetsBehavior class remains accessible to subclasses. New stub and model classes are added to facilitate this test, and static analysis configuration is updated accordingly. No existing functionality is modified.

Changes

File(s) Change Summary
tests/NestedSetsBehaviorTest.php Added a test method to verify subclass accessibility of a protected method.
tests/phpstan-config.php Included ExtendableMultipleTree in PHPStan configuration for models with behaviors.
tests/support/model/ExtendableMultipleTree.php Introduced a new ActiveRecord model for testing subclass behavior and tree attribute handling.
tests/support/model/ExtendableMultipleTreeQuery.php Added a custom query class for the new model, integrating nested sets query behavior.
tests/support/stub/ExtendableNestedSetsBehavior.php Added a subclass of NestedSetsBehavior with public wrappers to expose and track protected methods.

Sequence Diagram(s)

sequenceDiagram
    participant Test as NestedSetsBehaviorTest
    participant Model as ExtendableMultipleTree
    participant Behavior as ExtendableNestedSetsBehavior

    Test->>Model: Create instance
    Model->>Behavior: Attach behavior
    Test->>Behavior: Call exposedApplyTreeAttributeCondition(&condition)
    Behavior->>Behavior: Set calledMethods['applyTreeAttributeCondition']
    Behavior->>Behavior: Call parent::applyTreeAttributeCondition(&condition)
    Test->>Behavior: Check wasMethodCalled('applyTreeAttributeCondition')
    Test->>Behavior: Assert condition modified
Loading

Possibly related PRs

Poem

In the warren of code, a new test appears,
Checking subclasses can reach through their peers.
With wrappers and models, the methods are tracked,
Ensuring inheritance stays right on track.
🐇 A hop and a check, the tree stands tall—
Behaviors extend, accessible to all!

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)
tests/NestedSetsBehaviorTest.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

tests/phpstan-config.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

tests/support/model/ExtendableMultipleTreeQuery.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

  • 2 others

📜 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 5a42388 and 16b43d9.

📒 Files selected for processing (5)
  • tests/NestedSetsBehaviorTest.php (2 hunks)
  • tests/phpstan-config.php (2 hunks)
  • tests/support/model/ExtendableMultipleTree.php (1 hunks)
  • tests/support/model/ExtendableMultipleTreeQuery.php (1 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 (3)
tests/phpstan-config.php (2)
tests/support/model/ExtendableMultipleTree.php (1)
  • ExtendableMultipleTree (18-59)
src/NestedSetsBehavior.php (1)
  • NestedSetsBehavior (44-1404)
tests/support/model/ExtendableMultipleTree.php (2)
tests/support/stub/ExtendableNestedSetsBehavior.php (1)
  • ExtendableNestedSetsBehavior (15-91)
tests/support/model/ExtendableMultipleTreeQuery.php (2)
  • behaviors (26-31)
  • ExtendableMultipleTreeQuery (15-32)
tests/support/model/ExtendableMultipleTreeQuery.php (2)
src/NestedSetsQueryBehavior.php (1)
  • NestedSetsQueryBehavior (36-142)
tests/support/model/ExtendableMultipleTree.php (1)
  • behaviors (25-33)
🔇 Additional comments (6)
tests/phpstan-config.php (1)

8-8: LGTM! PHPStan configuration properly updated.

The addition of ExtendableMultipleTree to both the import list and behaviors configuration follows the established pattern for other model classes in this file.

Also applies to: 24-26

tests/support/model/ExtendableMultipleTreeQuery.php (1)

1-32: LGTM! Query class implementation follows established patterns.

The class correctly:

  • Uses generic template constrained to ExtendableMultipleTree
  • Extends ActiveQuery with proper constructor delegation
  • Attaches NestedSetsQueryBehavior for nested set query functionality
  • Uses final modifier appropriately for test infrastructure
tests/NestedSetsBehaviorTest.php (2)

13-19: LGTM! Import additions are correctly structured.

The imports properly include the new test model and stub behavior classes needed for the new test method.


2055-2087: Excellent test implementation for verifying protected method accessibility.

The test method effectively validates the PR objective by:

  • Creating an instance with the extendable behavior
  • Verifying the behavior is the expected subclass type
  • Testing protected method accessibility via the exposed wrapper
  • Asserting both method call tracking and functional correctness

The test clearly demonstrates that applyTreeAttributeCondition remains accessible to subclasses and functions correctly.

tests/support/model/ExtendableMultipleTree.php (1)

1-59: LGTM! ActiveRecord model implementation is well-structured.

The model correctly implements all necessary components:

  • Proper property documentation with type annotations
  • Correct table name mapping to {{%multiple_tree}}
  • Appropriate behavior configuration with ExtendableNestedSetsBehavior and treeAttribute
  • Standard validation rules and transaction settings
  • Custom find() method returning the specialized query class

The implementation follows established patterns from other test models in the codebase.

tests/support/stub/ExtendableNestedSetsBehavior.php (1)

1-91: Excellent stub implementation for testing protected method accessibility.

The stub behavior effectively serves the testing purpose by:

  • Extending the original behavior while preserving functionality
  • Exposing protected methods via public wrapper methods with exposed prefix
  • Implementing comprehensive call tracking with the calledMethods array
  • Providing utility methods for managing and querying call state
  • Using proper PHPStan generic annotations for type safety

The implementation allows thorough testing of protected method accessibility without compromising the encapsulation of the original behavior class.

✨ 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 Jun 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5a42388) to head (16b43d9).
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##                main       #31   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity        90        90           
===========================================
  Files              2         2           
  Lines            469       469           
===========================================
  Hits             469       469           

☔ 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.

@terabytesoftw terabytesoftw requested a review from Copilot June 30, 2025 12:08
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 adds support for testing subclass access to protected methods in the nested sets behavior by introducing stub and extendable classes, updating PHPStan config, and adding a new test.

  • Introduced ExtendableNestedSetsBehavior stub that exposes protected methods for tracking calls.
  • Added ExtendableMultipleTree model and ExtendableMultipleTreeQuery to wire in the stub behavior.
  • Updated phpstan-config.php to recognize the new model and behavior, and added a test verifying subclass access to applyTreeAttributeCondition.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/support/stub/ExtendableNestedSetsBehavior.php Stub behavior exposing protected methods for test instrumentation
tests/support/model/ExtendableMultipleTreeQuery.php Custom ActiveQuery class attaching NestedSetsQueryBehavior
tests/support/model/ExtendableMultipleTree.php ActiveRecord model using the stub behavior with treeAttribute
tests/phpstan-config.php Registered ExtendableMultipleTree with NestedSetsBehavior
tests/NestedSetsBehaviorTest.php Added test to verify protected method access in subclass
Comments suppressed due to low confidence (1)

tests/NestedSetsBehaviorTest.php:2055

  • [nitpick] Consider adding tests for the other exposed protected methods (e.g., beforeInsertNode, deleteWithChildrenInternal, moveNode, etc.) to ensure full coverage that all protected methods remain accessible to subclasses.
    public function testProtectedApplyTreeAttributeConditionRemainAccessibleToSubclasses(): 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