Merge branch 'release/v1.0.0-alpha.4'

.github/workflows/static.yml

@@ -15,7 +15,7 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 7.4
+        php-version: 7.3
         tools: composer:v2
         coverage: none
 
@@ -40,7 +40,7 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: 7.4
+        php-version: 7.3
         tools: composer:v2
         coverage: none
 

CHANGELOG.md

@@ -1,6 +1,49 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.0.0-alpha.4] - 2021-09-22
+
+### Miscellaneous Tasks
+
+- Add `pestphp/pest-plugin-global-assertions:^1.0` package
+
+### Testing
+
+- Add more tests for `mockClient`
+- Replace instance assertions by global functions
+- Replace assertions by expectations
+
+## [1.0.0-alpha.3] - 2021-09-22
+
+### Documentation
+
+- Add some description for `mockClient`
+- Add license docblock to the top of files
+
+### Features
+
+- Keep single instance for `MockClient` using `mockClient` function
+- Add new `assertRequestCount` for assert `MockClient` request count
+
+### Miscellaneous Tasks
+
+- Replace `php-cs-fixer` by `phpcs`
+
+### Refactor
+
+- Rename `client` function to `mockClient`
+- Rename `Client` trait to `ClientTrait`
+- Add missing strict type declarations
+- Replace mixed type usages by proper types
+
+### Styling
+
+- Solve whitespace issues all over codes
+
+### Testing
+
+- Add a test to check it can send multiple requests
+
 ## [1.0.0-alpha.2] - 2021-09-21
 
 ### Documentation

composer.json

@@ -37,6 +37,7 @@
     "require-dev": {
         "ergebnis/phpstan-rules": "^0.15.3",
         "nekofar/dev-tools": "^1.2",
+        "pestphp/pest-plugin-global-assertions": "^1.0",
         "phpstan/phpstan-strict-rules": "^0.12.11",
         "thecodingmachine/phpstan-strict-rules": "^0.12.1"
     },

tests/MockClient.php

@@ -3,14 +3,90 @@
 declare(strict_types=1);
 
 use GuzzleHttp\Psr7\Request;
+use Http\Client\Exception\RequestException;
+use Http\Message\RequestMatcher\RequestMatcher;
+use Psr\Http\Message\ResponseInterface;
 
 use function Nekofar\Pest\MockClient\mockClient;
 
 it('can send multiple requests', function (): void {
+    $firstRequest = new Request('GET', '/');
+    $secondRequest = new Request('POST', '/');
+
+    mockClient()->sendRequest($firstRequest);
+    mockClient()->sendRequest($secondRequest);
+
+    expect(mockClient()->getRequests())->toHaveCount(2);
+});
+
+it('can add response', function (): void {
     $request = new Request('GET', '/');
 
+    $response = $this->createMock(ResponseInterface::class);
+    mockClient()->addResponse($response);
+
+    $returnedResponse = mockClient()->sendRequest($request);
+    expect($returnedResponse)->toBe($response);
+    expect(mockClient()->getLastRequest())->toBe($request);
+});
+
+it('can set default response', function (): void {
+    $firstRequest = new Request('GET', '/');
+    $secondRequest = new Request('POST', '/');
+
+    $response = $this->createMock(ResponseInterface::class);
+    mockClient()->setDefaultResponse($response);
+
+    $firstReturnedResponse = mockClient()->sendRequest($firstRequest);
+    $secondReturnedResponse = mockClient()->sendRequest($secondRequest);
+    expect($firstReturnedResponse)->toBe($response);
+    expect($secondReturnedResponse)->toBe($response);
+});
+
+it('can throw exception', function (): void {
+    $request = new Request('GET', '/');
+
+    $exception = new Exception('Whoops!');
+    mockClient()->addException($exception);
+
     mockClient()->sendRequest($request);
-    mockClient()->sendRequest($request);
+})->throws(Exception::class, 'Whoops!'); // phpcs:ignore
 
-    expect(mockClient()->getRequests())->toHaveCount(2);
+it('can throw default exception', function (): void {
+    $firstRequest = new Request('GET', '/');
+    $secondRequest = new Request('POST', '/');
+
+    $exception = new Exception('Whoops!');
+    mockClient()->setDefaultException($exception);
+
+    $response = $this->createMock(ResponseInterface::class);
+    mockClient()->addResponse($response);
+
+    // The first request will returns the added response.
+    mockClient()->sendRequest($firstRequest);
+    // There is no more added response, the default exception will be thrown.
+    mockClient()->sendRequest($secondRequest);
+})->throws(Exception::class, 'Whoops!'); // phpcs:ignore
+
+it('can send request by request matcher', function (): void {
+    $request = new Request('GET', '/');
+
+    $requestMatcher = new RequestMatcher();
+
+    $response = $this->createMock(ResponseInterface::class);
+    mockClient()->on($requestMatcher, $response);
+
+    $returnedResponse = mockClient()->sendRequest($request);
+    expect($returnedResponse)->toBe($response);
 });
+
+it('can throw exception by request matcher', function (): void {
+    $request = new Request('GET', '/');
+
+    $requestMatcher = new RequestMatcher();
+
+    $exception = new RequestException('Whoops!', $request);
+    mockClient()->on($requestMatcher, $exception);
+
+    mockClient()->sendRequest($request);
+})->throws(RequestException::class, 'Whoops!'); // phpcs:ignore