refactor: use PHPUnit native PHP attributes instead of docblock annotations

maartenpaauw · maartenpaauw · commit 8a0d350dd8ec · 2024-07-15T19:09:20.000+02:00
diff --git a/tests/Api/IllustrationRequestTest.php b/tests/Api/IllustrationRequestTest.php
@@ -10,11 +10,12 @@
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\Attributes\Test;
 use Psr\Http\Message\ResponseInterface;
 
 final class IllustrationRequestTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_should_return_an_illustration_response_correctly(): void
     {
         // Arrange
diff --git a/tests/Api/IllustrationResponseTest.php b/tests/Api/IllustrationResponseTest.php
@@ -7,10 +7,11 @@
 use BladeComponents\Undraw\Api\IllustrationResponse;
 use BladeComponents\Undraw\Tests\TestCase;
 use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\Attributes\Test;
 
 final class IllustrationResponseTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_should_receive_the_response_content_correctly(): void
     {
         // Arrange
diff --git a/tests/Api/IllustrationTest.php b/tests/Api/IllustrationTest.php
@@ -6,16 +6,13 @@
 
 use BladeComponents\Undraw\Api\Illustration;
 use BladeComponents\Undraw\Tests\TestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
 
 final class IllustrationTest extends TestCase
 {
-    /**
-     * @test
-     * @dataProvider slugDataProvider
-     *
-     * @param string $title
-     * @param string $expectedSlug
-     */
+    #[Test]
+    #[DataProvider('slugDataProvider')]
     public function it_should_covert_the_title_to_a_slug_correctly(string $title, string $expectedSlug): void
     {
         // Arrange
@@ -37,13 +34,8 @@ public static function slugDataProvider(): array
         ];
     }
 
-    /**
-     * @test
-     * @dataProvider snakeDataProvider
-     *
-     * @param string $title
-     * @param string $expectedSnake
-     */
+    #[Test]
+    #[DataProvider('snakeDataProvider')]
     public function it_should_covert_the_title_to_a_snake_correctly(string $title, string $expectedSnake): void
     {
         // Arrange
@@ -65,13 +57,8 @@ public static function snakeDataProvider(): array
         ];
     }
 
-    /**
-     * @test
-     * @dataProvider studlyDataProvider
-     *
-     * @param string $title
-     * @param string $expectedStudly
-     */
+    #[Test]
+    #[DataProvider('studlyDataProvider')]
     public function it_should_covert_the_title_to_a_studly_correctly(string $title, string $expectedStudly): void
     {
         // Arrange
diff --git a/tests/Api/IllustrationsRequestTest.php b/tests/Api/IllustrationsRequestTest.php
@@ -11,11 +11,12 @@
 use GuzzleHttp\Handler\MockHandler;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\Attributes\Test;
 use Psr\Http\Message\ResponseInterface;
 
 final class IllustrationsRequestTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_should_return_a_page_correctly(): void
     {
         // Arrange
diff --git a/tests/Api/IllustrationsResponseTest.php b/tests/Api/IllustrationsResponseTest.php
@@ -8,10 +8,11 @@
 use BladeComponents\Undraw\Api\IllustrationsResponse;
 use BladeComponents\Undraw\Tests\TestCase;
 use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\Attributes\Test;
 
 final class IllustrationsResponseTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_should_return_the_next_page_correctly(): void
     {
         // Arrange
@@ -26,7 +27,7 @@ public function it_should_return_the_next_page_correctly(): void
         $this->assertSame($expectedNextPage, $nextPage);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_return_zero_for_next_page_when_the_status_code_is_not_200(): void
     {
         // Arrange
@@ -46,7 +47,7 @@ public function it_should_return_zero_for_next_page_when_the_status_code_is_not_
         $this->assertSame($expectedNextPage, $nextPage);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_return_true_when_there_are_more_pages(): void
     {
         // Arrange
@@ -60,7 +61,7 @@ public function it_should_return_true_when_there_are_more_pages(): void
         $this->assertTrue($hasMore);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_return_false_for_has_more_when_the_status_code_is_not_200(): void
     {
         // Arrange
@@ -79,7 +80,7 @@ public function it_should_return_false_for_has_more_when_the_status_code_is_not_
         $this->assertFalse($hasMore);
     }
 
-    /** @test */
+    #[Test]
     public function it_returns_an_empty_array_when_the_status_code_is_not_200(): void
     {
         // Arrange
@@ -98,7 +99,7 @@ public function it_returns_an_empty_array_when_the_status_code_is_not_200(): voi
         $this->assertEmpty($illustrations);
     }
 
-    /** @test */
+    #[Test]
     public function it_returns_an_empty_array_when_there_are_no_illustrations(): void
     {
         // Arrange
@@ -112,7 +113,7 @@ public function it_returns_an_empty_array_when_there_are_no_illustrations(): voi
         $this->assertEmpty($illustrations);
     }
 
-    /** @test */
+    #[Test]
     public function it_returns_a_list_of_illustrations(): void
     {
         // Arrange
diff --git a/tests/Api/UndrawClientTest.php b/tests/Api/UndrawClientTest.php
@@ -7,10 +7,11 @@
 use BladeComponents\Undraw\Api\UndrawClient;
 use BladeComponents\Undraw\Tests\TestCase;
 use GuzzleHttp\Psr7\Uri;
+use PHPUnit\Framework\Attributes\Test;
 
 final class UndrawClientTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_should_set_the_base_uri_correctly(): void
     {
         // Arrange
diff --git a/tests/Components/BaseComponentTest.php b/tests/Components/BaseComponentTest.php
@@ -6,10 +6,11 @@
 
 use BladeComponents\Undraw\Components\UndrawComponent;
 use BladeComponents\Undraw\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 final class BaseComponentTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_has_a_color_by_default(): void
     {
         // Arrange
@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_change_the_color(): void
     {
         // Arrange
@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_view_name_correctly(): void
     {
         // Arrange
@@ -53,7 +54,7 @@ public function it_should_generate_the_view_name_correctly(): void
         $this->assertSame($expectedViewName, $name);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_view_name_correctly_when_using_different_separators(): void
     {
         // Arrange
@@ -65,7 +66,7 @@ public function it_should_generate_the_view_name_correctly_when_using_different_
         $this->assertSame($expectedViewName, (new UndrawComponent('3d modeling'))->render()->name());
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_illustration_name_based_on_the_class_name(): void
     {
         // Arrange
diff --git a/tests/Components/Illustrations/Undraw3dModelingComponentTest.php b/tests/Components/Illustrations/Undraw3dModelingComponentTest.php
@@ -6,10 +6,11 @@
 
 use BladeComponents\Undraw\Components\Illustrations\Undraw3dModelingComponent;
 use BladeComponents\Undraw\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 final class Undraw3dModelingComponentTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_has_a_color_by_default(): void
     {
         // Arrange
@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_change_the_color(): void
     {
         // Arrange
@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_view_name_correctly(): void
     {
         // Arrange
diff --git a/tests/Components/Illustrations/UndrawAbstractComponentTest.php b/tests/Components/Illustrations/UndrawAbstractComponentTest.php
@@ -6,10 +6,11 @@
 
 use BladeComponents\Undraw\Components\Illustrations\UndrawAbstractComponent;
 use BladeComponents\Undraw\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 final class UndrawAbstractComponentTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_has_a_color_by_default(): void
     {
         // Arrange
@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_change_the_color(): void
     {
         // Arrange
@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_view_name_correctly(): void
     {
         // Arrange
diff --git a/tests/Components/Illustrations/UndrawBuildYourHomeComponentTest.php b/tests/Components/Illustrations/UndrawBuildYourHomeComponentTest.php
@@ -6,10 +6,11 @@
 
 use BladeComponents\Undraw\Components\Illustrations\UndrawBuildYourHomeComponent;
 use BladeComponents\Undraw\Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
 
 final class UndrawBuildYourHomeComponentTest extends TestCase
 {
-    /** @test */
+    #[Test]
     public function it_has_a_color_by_default(): void
     {
         // Arrange
@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_can_change_the_color(): void
     {
         // Arrange
@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void
         $this->assertSame($expectedColor, $color);
     }
 
-    /** @test */
+    #[Test]
     public function it_should_generate_the_view_name_correctly(): void
     {
         // Arrange

Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,12 @@`
`10`	`10`	`use GuzzleHttp\Handler\MockHandler;`
`11`	`11`	`use GuzzleHttp\HandlerStack;`
`12`	`12`	`use GuzzleHttp\Psr7\Response;`
	`13`	`+use PHPUnit\Framework\Attributes\Test;`
`13`	`14`	`use Psr\Http\Message\ResponseInterface;`
`14`	`15`
`15`	`16`	`final class IllustrationRequestTest extends TestCase`
`16`	`17`	`{`
`17`		`- /** @test */`
	`18`	`+ #[Test]`
`18`	`19`	`public function it_should_return_an_illustration_response_correctly(): void`
`19`	`20`	`{`
`20`	`21`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,11 @@`
`7`	`7`	`use BladeComponents\Undraw\Api\IllustrationResponse;`
`8`	`8`	`use BladeComponents\Undraw\Tests\TestCase;`
`9`	`9`	`use GuzzleHttp\Psr7\Response;`
	`10`	`+use PHPUnit\Framework\Attributes\Test;`
`10`	`11`
`11`	`12`	`final class IllustrationResponseTest extends TestCase`
`12`	`13`	`{`
`13`		`- /** @test */`
	`14`	`+ #[Test]`
`14`	`15`	`public function it_should_receive_the_response_content_correctly(): void`
`15`	`16`	`{`
`16`	`17`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -11,11 +11,12 @@`
`11`	`11`	`use GuzzleHttp\Handler\MockHandler;`
`12`	`12`	`use GuzzleHttp\HandlerStack;`
`13`	`13`	`use GuzzleHttp\Psr7\Response;`
	`14`	`+use PHPUnit\Framework\Attributes\Test;`
`14`	`15`	`use Psr\Http\Message\ResponseInterface;`
`15`	`16`
`16`	`17`	`final class IllustrationsRequestTest extends TestCase`
`17`	`18`	`{`
`18`		`- /** @test */`
	`19`	`+ #[Test]`
`19`	`20`	`public function it_should_return_a_page_correctly(): void`
`20`	`21`	`{`
`21`	`22`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,11 @@`
`8`	`8`	`use BladeComponents\Undraw\Api\IllustrationsResponse;`
`9`	`9`	`use BladeComponents\Undraw\Tests\TestCase;`
`10`	`10`	`use GuzzleHttp\Psr7\Response;`
	`11`	`+use PHPUnit\Framework\Attributes\Test;`
`11`	`12`
`12`	`13`	`final class IllustrationsResponseTest extends TestCase`
`13`	`14`	`{`
`14`		`- /** @test */`
	`15`	`+ #[Test]`
`15`	`16`	`public function it_should_return_the_next_page_correctly(): void`
`16`	`17`	`{`
`17`	`18`	`// Arrange`
`@@ -26,7 +27,7 @@ public function it_should_return_the_next_page_correctly(): void`
`26`	`27`	`$this->assertSame($expectedNextPage, $nextPage);`
`27`	`28`	`}`
`28`	`29`
`29`		`- /** @test */`
	`30`	`+ #[Test]`
`30`	`31`	`public function it_should_return_zero_for_next_page_when_the_status_code_is_not_200(): void`
`31`	`32`	`{`
`32`	`33`	`// Arrange`
`@@ -46,7 +47,7 @@ public function it_should_return_zero_for_next_page_when_the_status_code_is_not_`
`46`	`47`	`$this->assertSame($expectedNextPage, $nextPage);`
`47`	`48`	`}`
`48`	`49`
`49`		`- /** @test */`
	`50`	`+ #[Test]`
`50`	`51`	`public function it_should_return_true_when_there_are_more_pages(): void`
`51`	`52`	`{`
`52`	`53`	`// Arrange`
`@@ -60,7 +61,7 @@ public function it_should_return_true_when_there_are_more_pages(): void`
`60`	`61`	`$this->assertTrue($hasMore);`
`61`	`62`	`}`
`62`	`63`
`63`		`- /** @test */`
	`64`	`+ #[Test]`
`64`	`65`	`public function it_should_return_false_for_has_more_when_the_status_code_is_not_200(): void`
`65`	`66`	`{`
`66`	`67`	`// Arrange`
`@@ -79,7 +80,7 @@ public function it_should_return_false_for_has_more_when_the_status_code_is_not_`
`79`	`80`	`$this->assertFalse($hasMore);`
`80`	`81`	`}`
`81`	`82`
`82`		`- /** @test */`
	`83`	`+ #[Test]`
`83`	`84`	`public function it_returns_an_empty_array_when_the_status_code_is_not_200(): void`
`84`	`85`	`{`
`85`	`86`	`// Arrange`
`@@ -98,7 +99,7 @@ public function it_returns_an_empty_array_when_the_status_code_is_not_200(): voi`
`98`	`99`	`$this->assertEmpty($illustrations);`
`99`	`100`	`}`
`100`	`101`
`101`		`- /** @test */`
	`102`	`+ #[Test]`
`102`	`103`	`public function it_returns_an_empty_array_when_there_are_no_illustrations(): void`
`103`	`104`	`{`
`104`	`105`	`// Arrange`
`@@ -112,7 +113,7 @@ public function it_returns_an_empty_array_when_there_are_no_illustrations(): voi`
`112`	`113`	`$this->assertEmpty($illustrations);`
`113`	`114`	`}`
`114`	`115`
`115`		`- /** @test */`
	`116`	`+ #[Test]`
`116`	`117`	`public function it_returns_a_list_of_illustrations(): void`
`117`	`118`	`{`
`118`	`119`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -7,10 +7,11 @@`
`7`	`7`	`use BladeComponents\Undraw\Api\UndrawClient;`
`8`	`8`	`use BladeComponents\Undraw\Tests\TestCase;`
`9`	`9`	`use GuzzleHttp\Psr7\Uri;`
	`10`	`+use PHPUnit\Framework\Attributes\Test;`
`10`	`11`
`11`	`12`	`final class UndrawClientTest extends TestCase`
`12`	`13`	`{`
`13`		`- /** @test */`
	`14`	`+ #[Test]`
`14`	`15`	`public function it_should_set_the_base_uri_correctly(): void`
`15`	`16`	`{`
`16`	`17`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,11 @@`
`6`	`6`
`7`	`7`	`use BladeComponents\Undraw\Components\UndrawComponent;`
`8`	`8`	`use BladeComponents\Undraw\Tests\TestCase;`
	`9`	`+use PHPUnit\Framework\Attributes\Test;`
`9`	`10`
`10`	`11`	`final class BaseComponentTest extends TestCase`
`11`	`12`	`{`
`12`		`- /** @test */`
	`13`	`+ #[Test]`
`13`	`14`	`public function it_has_a_color_by_default(): void`
`14`	`15`	`{`
`15`	`16`	`// Arrange`
`@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void`
`24`	`25`	`$this->assertSame($expectedColor, $color);`
`25`	`26`	`}`
`26`	`27`
`27`		`- /** @test */`
	`28`	`+ #[Test]`
`28`	`29`	`public function it_can_change_the_color(): void`
`29`	`30`	`{`
`30`	`31`	`// Arrange`
`@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void`
`39`	`40`	`$this->assertSame($expectedColor, $color);`
`40`	`41`	`}`
`41`	`42`
`42`		`- /** @test */`
	`43`	`+ #[Test]`
`43`	`44`	`public function it_should_generate_the_view_name_correctly(): void`
`44`	`45`	`{`
`45`	`46`	`// Arrange`
`@@ -53,7 +54,7 @@ public function it_should_generate_the_view_name_correctly(): void`
`53`	`54`	`$this->assertSame($expectedViewName, $name);`
`54`	`55`	`}`
`55`	`56`
`56`		`- /** @test */`
	`57`	`+ #[Test]`
`57`	`58`	`public function it_should_generate_the_view_name_correctly_when_using_different_separators(): void`
`58`	`59`	`{`
`59`	`60`	`// Arrange`
`@@ -65,7 +66,7 @@ public function it_should_generate_the_view_name_correctly_when_using_different_`
`65`	`66`	`$this->assertSame($expectedViewName, (new UndrawComponent('3d modeling'))->render()->name());`
`66`	`67`	`}`
`67`	`68`
`68`		`- /** @test */`
	`69`	`+ #[Test]`
`69`	`70`	`public function it_should_generate_the_illustration_name_based_on_the_class_name(): void`
`70`	`71`	`{`
`71`	`72`	`// Arrange`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,11 @@`
`6`	`6`
`7`	`7`	`use BladeComponents\Undraw\Components\Illustrations\Undraw3dModelingComponent;`
`8`	`8`	`use BladeComponents\Undraw\Tests\TestCase;`
	`9`	`+use PHPUnit\Framework\Attributes\Test;`
`9`	`10`
`10`	`11`	`final class Undraw3dModelingComponentTest extends TestCase`
`11`	`12`	`{`
`12`		`- /** @test */`
	`13`	`+ #[Test]`
`13`	`14`	`public function it_has_a_color_by_default(): void`
`14`	`15`	`{`
`15`	`16`	`// Arrange`
`@@ -24,7 +25,7 @@ public function it_has_a_color_by_default(): void`
`24`	`25`	`$this->assertSame($expectedColor, $color);`
`25`	`26`	`}`
`26`	`27`
`27`		`- /** @test */`
	`28`	`+ #[Test]`
`28`	`29`	`public function it_can_change_the_color(): void`
`29`	`30`	`{`
`30`	`31`	`// Arrange`
`@@ -39,7 +40,7 @@ public function it_can_change_the_color(): void`
`39`	`40`	`$this->assertSame($expectedColor, $color);`
`40`	`41`	`}`
`41`	`42`
`42`		`- /** @test */`
	`43`	`+ #[Test]`
`43`	`44`	`public function it_should_generate_the_view_name_correctly(): void`
`44`	`45`	`{`
`45`	`46`	`// Arrange`