Adds HaveTrait and NotHaveTrait rules #555
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit implements the feature requested in issue #424, enabling enforcement of trait usage policies across classes. Changes: - Extended ClassDescription to track traits used by classes - Added getTraits() and hasTrait() methods to ClassDescription - Updated ClassDescriptionBuilder with addTrait() method and trait tracking - Modified FileVisitor to parse trait usage statements (TraitUse nodes) - Implemented HaveTrait rule to require specific traits on classes - Implemented NotHaveTrait rule to prohibit specific traits on classes - Added comprehensive test coverage for both new rules The implementation follows existing patterns for attribute and interface checking, providing consistent API and behavior. Example usage: ```php // Require DatabaseTransactions trait on all Feature tests Rule::allClasses() ->that(new ResideInOneOfTheseNamespaces('Tests\\Feature')) ->should(new HaveTrait(DatabaseTransactions::class)) ->because('All Feature tests should run transactions'); // Prohibit RefreshDatabase trait for performance Rule::allClasses() ->that(new ResideInOneOfTheseNamespaces('Tests\\Feature')) ->should(new NotHaveTrait(RefreshDatabase::class)) ->because('Feature tests should never refresh the database'); ``` All existing tests continue to pass, ensuring backward compatibility. Fixes #424
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #555 +/- ##
============================================
- Coverage 97.74% 97.54% -0.21%
- Complexity 614 633 +19
============================================
Files 79 81 +2
Lines 1775 1831 +56
============================================
+ Hits 1735 1786 +51
- Misses 40 45 +5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #424