refactor(core): updated syntax for php8 and phpunit

oniice · oniice · commit f65f3a13da7c · 2024-09-14T19:20:49.000+01:00
Signed-off-by: Fred Myerscough &lt;oniice@gmail.com&gt;
diff --git a/src/Body.php b/src/Body.php
@@ -32,10 +32,8 @@ class Body implements Arrayable, Jsonable
 
     /**
      * Status code of the response
-     *
-     * @var int $status
      */
-    private $status;
+    private int $status;
 
     public function __construct($data = [], $meta = [], $messages = [], int $status = 200)
     {
@@ -45,39 +43,25 @@ public function __construct($data = [], $meta = [], $messages = [], int $status
         $this->setStatus($status);
     }
 
-    /**
-     * @return mixed
-     */
     public function getData(): array
     {
         return $this->data;
     }
 
-    /**
-     * @param mixed $data
-     *
-     * @return Body
-     */
-    public function setData($data): Body
+    
+    public function setData(mixed $data): Body
     {
         $this->data = $data;
 
         return $this;
     }
 
-    /**
-     * @return mixed
-     */
     public function getMessages(): array
     {
         return $this->messages;
     }
 
-    /**
-     * @param mixed $messages
-     *
-     * @return Body
-     */
+    
     public function setMessages(array $messages): Body
     {
         $this->messages = $messages;
@@ -87,8 +71,6 @@ public function setMessages(array $messages): Body
 
     /**
      * @param string $message
-     *
-     * @return Body
      */
     public function addMessage($message): Body
     {
@@ -97,39 +79,25 @@ public function addMessage($message): Body
         return $this;
     }
 
-    /**
-     * @return mixed
-     */
     public function getMeta(): array
     {
         return $this->meta;
     }
 
-    /**
-     * @param mixed $meta
-     *
-     * @return Body
-     */
-    public function setMeta($meta): Body
+    
+    public function setMeta(mixed $meta): Body
     {
         $this->meta = $meta;
 
         return $this;
     }
 
-    /**
-     * @return int
-     */
     public function getStatus(): int
     {
         return $this->status;
     }
 
-    /**
-     * @param int $status
-     *
-     * @return Body
-     */
+    
     public function setStatus(int $status): Body
     {
         $this->status = $status;
@@ -141,7 +109,6 @@ public function setStatus(int $status): Body
      * Convert the object to its JSON representation.
      *
      * @param  int $options
-     * @return string
      */
     public function toJson($options = 0): string
     {
@@ -156,8 +123,6 @@ public function toJson($options = 0): string
 
     /**
      * Get the instance as an array.
-     *
-     * @return array
      */
     public function toArray(): array
     {
diff --git a/src/Builder.php b/src/Builder.php
@@ -23,8 +23,6 @@ public function __construct()
 
     /**
      * Reset response body, headers and options
-     *
-     * @return Builder
      */
     public function fresh(): Builder
     {
@@ -46,9 +44,6 @@ public function body()
 
     /**
      * Set the api data response
-     *
-     * @param array $data
-     * @return Builder
      */
     public function data(array $data): Builder
     {
@@ -59,9 +54,6 @@ public function data(array $data): Builder
 
     /**
      * Set meta data of current api response
-     *
-     * @param array $meta
-     * @return Builder
      */
     public function meta(array $meta): Builder
     {
@@ -72,9 +64,6 @@ public function meta(array $meta): Builder
 
     /**
      * Add a response message
-     *
-     * @param string $messages
-     * @return Builder
      */
     public function message(string $messages): Builder
     {
@@ -85,9 +74,6 @@ public function message(string $messages): Builder
 
     /**
      * Set collection of response messages
-     *
-     * @param array $messages
-     * @return Builder
      */
     public function messages(array $messages): Builder
     {
@@ -98,9 +84,6 @@ public function messages(array $messages): Builder
 
     /**
      * Set HTTP status of response
-     *
-     * @param int $status
-     * @return Builder
      */
     public function status(int $status): Builder
     {
@@ -112,11 +95,9 @@ public function status(int $status): Builder
     /**
      * Set a HTTP header value to be returned with the response
      *
-     * @param string $key
-     * @param string $value
      * @return $this
      */
-    public function header(string $key, string $value)
+    public function header(string $key, string $value): static
     {
         $this->headers[$key] = $value;
 
@@ -126,10 +107,9 @@ public function header(string $key, string $value)
     /**
      * Set headers that should be returned with the response
      *
-     * @param array $headers
      * @return $this
      */
-    public function headers(array $headers)
+    public function headers(array $headers): static
     {
         $this->headers = array_filter($headers);
 
diff --git a/src/helpers.php b/src/helpers.php
@@ -1,14 +1,13 @@
 <?php
 
+use Myerscode\Laravel\ApiResponse\Builder;
 if (!function_exists('api')) {
 
     /**
      * Start creating a idempotent api response
-     *
-     * @return \Myerscode\Laravel\ApiResponse\Builder
      */
-    function api()
+    function api(): Builder
     {
-        return new \Myerscode\Laravel\ApiResponse\Builder();
+        return new Builder();
     }
 }
diff --git a/tests/BodyTest.php b/tests/BodyTest.php
@@ -2,23 +2,31 @@
 
 namespace Tests;
 
+use Mockery;
 use Illuminate\Database\Eloquent\JsonEncodingException;
 use Myerscode\Laravel\ApiResponse\Body;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class BodyTest extends TestCase
 {
 
-    public function provider()
+    public static function provider(): array
     {
         return [
             [200, [], [], []],
         ];
     }
 
     /**
-     * @dataProvider provider
+     * @param $status
+     * @param $data
+     * @param $messages
+     * @param $meta
+     *
+     * @return void
      */
-    public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
+    #[DataProvider('provider')]
+    public function testResponsePropertiesAreSet($status, $data, $messages, $meta): void
     {
         $body = new Body();
         $body->setStatus(($status))->setData($data)->setMessages($messages)->setMeta($meta);
@@ -29,34 +37,32 @@ public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
         $this->assertEquals($meta, $body->getMeta());
     }
 
-    public function testAddMessageToBody()
+    public function testAddMessageToBody(): void
     {
         $body = new Body();
         $body->addMessage(('Hello World'));
 
         $this->assertEquals(['Hello World'], $body->getMessages());
     }
 
-    /**
-     * @dataProvider provider
-     */
-    public function testBodyConvertedToJson($status, $data, $messages, $meta)
+    #[DataProvider('provider')]
+    public function testBodyConvertedToJson($status, $data, $messages, $meta): void
     {
         $body = new Body();
         $body->setStatus(($status))->setData($data)->setMessages($messages)->setMeta($meta);
 
         $this->assertJson($body->toJson());
     }
 
-    public function testInvalidJsonThrowsError()
+    public function testInvalidJsonThrowsError(): void
     {
         $this->expectException(JsonEncodingException::class);
 
-        $body = \Mockery::mock(Body::class)->makePartial();
+        $body = Mockery::mock(Body::class)->makePartial();
 
         $body->shouldReceive('toArray')
             ->andReturn([NAN]);
 
         $body->toJson();
     }
-}
+}
diff --git a/tests/BuilderTest.php b/tests/BuilderTest.php
@@ -3,22 +3,21 @@
 namespace Tests;
 
 use Illuminate\Testing\TestResponse;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class BuilderTest extends TestCase
 {
 
-    public function provider()
+    public static function provider(): array
     {
         return [
             [200, [], [], []],
         ];
     }
 
 
-    /**
-     * @dataProvider provider
-     */
-    public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
+    #[DataProvider('provider')]
+    public function testResponsePropertiesAreSet($status, $data, $messages, $meta): void
     {
         $builder = api()->status($status)->data($data)->messages($messages)->meta($meta);
 
@@ -28,26 +27,26 @@ public function testResponsePropertiesAreSet($status, $data, $messages, $meta)
         $this->assertEquals($meta, $builder->body()->getMeta());
     }
 
-    public function testAddMessageToResponse()
+    public function testAddMessageToResponse(): void
     {
         $builder = api()->message('Hello World');
 
         $this->assertEquals(['Hello World'], $builder->body()->getMessages());
     }
 
-    public function testAddingHeaderToResponse()
+    public function testAddingHeaderToResponse(): void
     {
-        $response = new TestResponse(api()->header('foo', 'bar')->respond());
+        $testResponse = new TestResponse(api()->header('foo', 'bar')->respond());
 
-        $response->assertHeader('foo');
+        $testResponse->assertHeader('foo');
     }
 
-    public function testAddingMultipleHeaderToResponse()
+    public function testAddingMultipleHeaderToResponse(): void
     {
-        $response = new TestResponse(api()->headers(['foo' => 'bar', 'hello' => 'world', 'invalid header'])->respond());
+        $testResponse = new TestResponse(api()->headers(['foo' => 'bar', 'hello' => 'world', 'invalid header'])->respond());
 
-        $response->assertHeader('foo');
-        $response->assertHeader('hello');
-        $response->assertHeaderMissing('invalid header');
+        $testResponse->assertHeader('foo');
+        $testResponse->assertHeader('hello');
+        $testResponse->assertHeaderMissing('invalid header');
     }
 }
diff --git a/tests/RespondTest.php b/tests/RespondTest.php
@@ -9,12 +9,12 @@
 class RespondTest extends TestCase
 {
 
-    public function testHelperMakesBuilder()
+    public function testHelperMakesBuilder(): void
     {
         $this->assertInstanceOf(Builder::class, api());
     }
 
-    public function testRespondCreatesJsonResponse()
+    public function testRespondCreatesJsonResponse(): void
     {
         $this->assertInstanceOf(JsonResponse::class, api()->respond());
         $this->assertInstanceOf(JsonResponse::class,  api()->toResponse( new Request()));

Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,8 @@ class Body implements Arrayable, Jsonable`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* Status code of the response`
`35`		`- *`
`36`		`- * @var int $status`
`37`	`35`	`*/`
`38`		`- private $status;`
	`36`	`+ private int $status;`
`39`	`37`
`40`	`38`	`public function __construct($data = [], $meta = [], $messages = [], int $status = 200)`
`41`	`39`	`{`
`@@ -45,39 +43,25 @@ public function __construct($data = [], $meta = [], $messages = [], int $status`
`45`	`43`	`$this->setStatus($status);`
`46`	`44`	`}`
`47`	`45`
`48`		`- /**`
`49`		`- * @return mixed`
`50`		`- */`
`51`	`46`	`public function getData(): array`
`52`	`47`	`{`
`53`	`48`	`return $this->data;`
`54`	`49`	`}`
`55`	`50`
`56`		`- /**`
`57`		`- * @param mixed $data`
`58`		`- *`
`59`		`- * @return Body`
`60`		`- */`
`61`		`- public function setData($data): Body`
	`51`	`+`
	`52`	`+ public function setData(mixed $data): Body`
`62`	`53`	`{`
`63`	`54`	`$this->data = $data;`
`64`	`55`
`65`	`56`	`return $this;`
`66`	`57`	`}`
`67`	`58`
`68`		`- /**`
`69`		`- * @return mixed`
`70`		`- */`
`71`	`59`	`public function getMessages(): array`
`72`	`60`	`{`
`73`	`61`	`return $this->messages;`
`74`	`62`	`}`
`75`	`63`
`76`		`- /**`
`77`		`- * @param mixed $messages`
`78`		`- *`
`79`		`- * @return Body`
`80`		`- */`
	`64`	`+`
`81`	`65`	`public function setMessages(array $messages): Body`
`82`	`66`	`{`
`83`	`67`	`$this->messages = $messages;`
`@@ -87,8 +71,6 @@ public function setMessages(array $messages): Body`
`87`	`71`
`88`	`72`	`/**`
`89`	`73`	`* @param string $message`
`90`		`- *`
`91`		`- * @return Body`
`92`	`74`	`*/`
`93`	`75`	`public function addMessage($message): Body`
`94`	`76`	`{`
`@@ -97,39 +79,25 @@ public function addMessage($message): Body`
`97`	`79`	`return $this;`
`98`	`80`	`}`
`99`	`81`
`100`		`- /**`
`101`		`- * @return mixed`
`102`		`- */`
`103`	`82`	`public function getMeta(): array`
`104`	`83`	`{`
`105`	`84`	`return $this->meta;`
`106`	`85`	`}`
`107`	`86`
`108`		`- /**`
`109`		`- * @param mixed $meta`
`110`		`- *`
`111`		`- * @return Body`
`112`		`- */`
`113`		`- public function setMeta($meta): Body`
	`87`	`+`
	`88`	`+ public function setMeta(mixed $meta): Body`
`114`	`89`	`{`
`115`	`90`	`$this->meta = $meta;`
`116`	`91`
`117`	`92`	`return $this;`
`118`	`93`	`}`
`119`	`94`
`120`		`- /**`
`121`		`- * @return int`
`122`		`- */`
`123`	`95`	`public function getStatus(): int`
`124`	`96`	`{`
`125`	`97`	`return $this->status;`
`126`	`98`	`}`
`127`	`99`
`128`		`- /**`
`129`		`- * @param int $status`
`130`		`- *`
`131`		`- * @return Body`
`132`		`- */`
	`100`	`+`
`133`	`101`	`public function setStatus(int $status): Body`
`134`	`102`	`{`
`135`	`103`	`$this->status = $status;`
`@@ -141,7 +109,6 @@ public function setStatus(int $status): Body`
`141`	`109`	`* Convert the object to its JSON representation.`
`142`	`110`	`*`
`143`	`111`	`* @param int $options`
`144`		`- * @return string`
`145`	`112`	`*/`
`146`	`113`	`public function toJson($options = 0): string`
`147`	`114`	`{`
`@@ -156,8 +123,6 @@ public function toJson($options = 0): string`
`156`	`123`
`157`	`124`	`/**`
`158`	`125`	`* Get the instance as an array.`
`159`		`- *`
`160`		`- * @return array`
`161`	`126`	`*/`
`162`	`127`	`public function toArray(): array`
`163`	`128`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,13 @@`
`1`	`1`	`<?php`
`2`	`2`
	`3`	`+use Myerscode\Laravel\ApiResponse\Builder;`
`3`	`4`	`if (!function_exists('api')) {`
`4`	`5`
`5`	`6`	`/**`
`6`	`7`	`* Start creating a idempotent api response`
`7`		`- *`
`8`		`- * @return \Myerscode\Laravel\ApiResponse\Builder`
`9`	`8`	`*/`
`10`		`- function api()`
	`9`	`+ function api(): Builder`
`11`	`10`	`{`
`12`		`- return new \Myerscode\Laravel\ApiResponse\Builder();`
	`11`	`+ return new Builder();`
`13`	`12`	`}`
`14`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,22 +3,21 @@`
`3`	`3`	`namespace Tests;`
`4`	`4`
`5`	`5`	`use Illuminate\Testing\TestResponse;`
	`6`	`+use PHPUnit\Framework\Attributes\DataProvider;`
`6`	`7`
`7`	`8`	`class BuilderTest extends TestCase`
`8`	`9`	`{`
`9`	`10`
`10`		`- public function provider()`
	`11`	`+ public static function provider(): array`
`11`	`12`	`{`
`12`	`13`	`return [`
`13`	`14`	`[200, [], [], []],`
`14`	`15`	`];`
`15`	`16`	`}`
`16`	`17`
`17`	`18`
`18`		`- /**`
`19`		`- * @dataProvider provider`
`20`		`- */`
`21`		`- public function testResponsePropertiesAreSet($status, $data, $messages, $meta)`
	`19`	`+ #[DataProvider('provider')]`
	`20`	`+ public function testResponsePropertiesAreSet($status, $data, $messages, $meta): void`
`22`	`21`	`{`
`23`	`22`	`$builder = api()->status($status)->data($data)->messages($messages)->meta($meta);`
`24`	`23`
`@@ -28,26 +27,26 @@ public function testResponsePropertiesAreSet($status, $data, $messages, $meta)`
`28`	`27`	`$this->assertEquals($meta, $builder->body()->getMeta());`
`29`	`28`	`}`
`30`	`29`
`31`		`- public function testAddMessageToResponse()`
	`30`	`+ public function testAddMessageToResponse(): void`
`32`	`31`	`{`
`33`	`32`	`$builder = api()->message('Hello World');`
`34`	`33`
`35`	`34`	`$this->assertEquals(['Hello World'], $builder->body()->getMessages());`
`36`	`35`	`}`
`37`	`36`
`38`		`- public function testAddingHeaderToResponse()`
	`37`	`+ public function testAddingHeaderToResponse(): void`
`39`	`38`	`{`
`40`		`- $response = new TestResponse(api()->header('foo', 'bar')->respond());`
	`39`	`+ $testResponse = new TestResponse(api()->header('foo', 'bar')->respond());`
`41`	`40`
`42`		`- $response->assertHeader('foo');`
	`41`	`+ $testResponse->assertHeader('foo');`
`43`	`42`	`}`
`44`	`43`
`45`		`- public function testAddingMultipleHeaderToResponse()`
	`44`	`+ public function testAddingMultipleHeaderToResponse(): void`
`46`	`45`	`{`
`47`		`- $response = new TestResponse(api()->headers(['foo' => 'bar', 'hello' => 'world', 'invalid header'])->respond());`
	`46`	`+ $testResponse = new TestResponse(api()->headers(['foo' => 'bar', 'hello' => 'world', 'invalid header'])->respond());`
`48`	`47`
`49`		`- $response->assertHeader('foo');`
`50`		`- $response->assertHeader('hello');`
`51`		`- $response->assertHeaderMissing('invalid header');`
	`48`	`+ $testResponse->assertHeader('foo');`
	`49`	`+ $testResponse->assertHeader('hello');`
	`50`	`+ $testResponse->assertHeaderMissing('invalid header');`
`52`	`51`	`}`
`53`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,12 +9,12 @@`
`9`	`9`	`class RespondTest extends TestCase`
`10`	`10`	`{`
`11`	`11`
`12`		`- public function testHelperMakesBuilder()`
	`12`	`+ public function testHelperMakesBuilder(): void`
`13`	`13`	`{`
`14`	`14`	`$this->assertInstanceOf(Builder::class, api());`
`15`	`15`	`}`
`16`	`16`
`17`		`- public function testRespondCreatesJsonResponse()`
	`17`	`+ public function testRespondCreatesJsonResponse(): void`
`18`	`18`	`{`
`19`	`19`	`$this->assertInstanceOf(JsonResponse::class, api()->respond());`
`20`	`20`	`$this->assertInstanceOf(JsonResponse::class, api()->toResponse( new Request()));`