Rename rule attribute to TestRule

carlosas · Nov 24, 2023 · 03a1c70 · 03a1c70
2 parents 93a73e6 + 2a8559f
commit 03a1c70
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 11 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## 0.10.11
+* Add `#[TestRule]` attribute to mark test's methods as rules
+* Add `shouldApplyAttribute()` assertion
+* Deprecate `hasAttribute()` selector in favor of `appliesAttribute()`
+* Allow extending test files
+
 ## 0.10.10
 * Add `shouldOnlyHaveOnePublicMethod()` assertion.
 * Fix return type of target excludes builder step.

diff --git a/docs/documentation/rules.md b/docs/documentation/rules.md
@@ -1,16 +1,18 @@
 # Rules
 
-A rule is a statement, consisting in Selector and Assertions, that must be true for the test to pass. Each test class can contain one or more rules.
+A rule is a statement, consisting in Selectors and Assertions, that must be true for the test to pass.
+
+Each test class can contain one or more rules.
 
 ![image-layered](../assets/rules.png)
 
-Your rules must be public methods that start with `test_` or apply the `Test` attribute. You can build rules using the `\PHPat\Test\PHPat::rule()` method:
+Your rules must be public methods that start with `test_` or apply the `#[TestRule]` attribute. You can build rules using the `\PHPat\Test\PHPat::rule()` method:
 
 ```php
 namespace App\Tests\Architecture;
 
 use PHPat\Selector\Selector;
-use PHPat\Test\Attributes\Test;
+use PHPat\Test\Attributes\TestRule;
 use PHPat\Test\Builder\Rule;
 use PHPat\Test\PHPat;
 
@@ -25,7 +27,7 @@ final class ConfigurationTest
         ;
     }
 
-    #[Test]
+    #[TestRule]
     public function entities_are_final(): Rule
     {
         return PHPat::rule()
@@ -83,4 +85,4 @@ final class UserDomainTest extends AbstractDomainTest
 }
 ```
 
-Note that you only would need to register the `UserDomainTest` class in the PHPStan config file.
+Note that you would only need to register the `UserDomainTest` class as a PHPat test in the PHPStan config file.
diff --git a/src/Test/Attributes/Test.php → src/Test/Attributes/TestRule.php b/src/Test/Attributes/Test.php → src/Test/Attributes/TestRule.php
@@ -3,4 +3,4 @@
 namespace PHPat\Test\Attributes;
 
 #[\Attribute(\Attribute::TARGET_METHOD)]
-final class Test {}
+final class TestRule {}
diff --git a/src/Test/TestParser.php b/src/Test/TestParser.php
@@ -2,7 +2,7 @@
 
 namespace PHPat\Test;
 
-use PHPat\Test\Attributes\Test;
+use PHPat\Test\Attributes\TestRule;
 use PHPat\Test\Builder\Rule as RuleBuilder;
 
 class TestParser
@@ -45,7 +45,7 @@ private function parse(): array
             $object = $reflected->newInstanceWithoutConstructor();
             foreach ($reflected->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) {
                 if (
-                    !empty($method->getAttributes(Test::class))
+                    !empty($method->getAttributes(TestRule::class))
                     || preg_match('/^(test)[A-Za-z0-9_\x80-\xff]*/', $method->getName())
                 ) {
                     $ruleBuilder = $object->{$method->getName()}();

diff --git a/tests/architecture/ConfigurationTest.php b/tests/architecture/ConfigurationTest.php
@@ -4,13 +4,13 @@
 
 use PHPat\Configuration;
 use PHPat\Selector\Selector;
-use PHPat\Test\Attributes\Test;
+use PHPat\Test\Attributes\TestRule;
 use PHPat\Test\Builder\Rule;
 use PHPat\Test\PHPat;
 
 final class ConfigurationTest
 {
-    #[Test]
+    #[TestRule]
     public function configuration_does_not_have_dependencies(): Rule
     {
         return PHPat::rule()
@@ -20,7 +20,7 @@ public function configuration_does_not_have_dependencies(): Rule
         ;
     }
 
-    #[Test]
+    #[TestRule]
     public function configuration_is_final(): Rule
     {
         return PHPat::rule()