Merge pull request #88 from RonasIT/fix-handling-no-boung-contracts

Fix handling no boung contracts

Author: DenTray

readme.md

@@ -57,22 +57,7 @@ passing PHPUnit tests.
 
 ### Basic usage
 
-1. Create test for API endpoint:
-
-    ```php
-    public function testUpdate()
-    {
-        $response = $this->json('put', '/users/1', [
-            'name': 'Updated User',
-            'is_active': true,
-            'age': 22
-        ]);
-
-        $response->assertStatus(Response::HTTP_NO_CONTENT);
-    }
-    ```
-
-2. Create request class:
+1. Create request class:
 
     ```php
     <?php
@@ -119,7 +104,6 @@ passing PHPUnit tests.
     }
 
     ```
-
     > ***Note***
     > 
     > For correct working of plugin you'll have to dispose all the validation rules 
@@ -128,9 +112,49 @@ passing PHPUnit tests.
     > Plugin will take validation rules from the request class and generate fields description
     > of input parameter.
 
-3. Run tests
-4. Go to route defined in the `auto-doc.route` config
-5. Profit!
+2. Create a controller and a method for your route:
+
+    ```php
+    <?php
+
+    namespace App\Http\Controllers;
+
+    use App\Http\Requests\Users\UpdateUserDataRequest;
+
+    class UserController extends Controller
+    {
+        public function update(UpdateUserDataRequest $request, UserService $service, $id)
+        {
+            // do something here...
+
+            return response('', Response::HTTP_NO_CONTENT);
+        }
+    }
+    ```
+
+    > ***Note***
+    > 
+    > Dependency injection of request class is optional but if it not presents,
+    > the "Parameters" block in the API documentation will be empty.
+
+3. Create test for API endpoint:
+
+    ```php
+    public function testUpdate()
+    {
+        $response = $this->json('put', '/users/1', [
+            'name': 'Updated User',
+            'is_active': true,
+            'age': 22
+        ]);
+
+        $response->assertStatus(Response::HTTP_NO_CONTENT);
+    }
+    ```
+
+4. Run tests
+5. Go to route defined in the `auto-doc.route` config
+6. Profit!
 
     ![img.png](resources/assets/images/img.png)
 

src/Traits/GetDependenciesTrait.php

@@ -46,6 +46,10 @@ protected function getClassByInterface($interfaceName)
 
         $implementation = Arr::get($bindings, "{$interfaceName}.concrete");
 
+        if (empty($implementation)) {
+            return null;
+        }
+
         $classFields = (new ReflectionFunction($implementation))->getStaticVariables();
 
         return $classFields['concrete'];

tests/SwaggerServiceTest.php

@@ -329,4 +329,21 @@ public function testLimitResponseData()
 
         $service->addData($request, $response);
     }
+
+    public function testAddDataWithoutBoundContract()
+    {
+        config(['auto-doc.response_example_limit_count' => 1]);
+
+        $this->mockDriverGetEmptyAndSaveTpmData($this->getJsonFixture('tmp_data_search_users_empty_request'));
+
+        $service = app(SwaggerService::class);
+
+        $request = $this->generateRequest('get', '/api/users', [], [], [], 'testRequestWithContract');
+
+        $response = $this->generateResponse('example_success_users_response.json', 200, [
+            'Content-type' => 'application/json'
+        ]);
+
+        $service->addData($request, $response);
+    }
 }

tests/fixtures/SwaggerServiceTest/tmp_data_search_users_empty_request.json

@@ -0,0 +1,94 @@
+{
+  "swagger": "2.0",
+  "host": "localhost",
+  "basePath": "\/",
+  "schemes": [],
+  "paths":
+  {
+    "\/api\/users":
+    {
+      "get":
+      {
+        "tags": ["api"],
+        "produces": ["application\/json"],
+        "parameters": [],
+        "responses":
+        {
+          "200":
+          {
+            "description": "OK",
+            "schema":
+            {
+              "example":
+              {
+                "current_page": 1,
+                "data": [
+                  {
+                    "id": 1,
+                    "first_name": "Billy",
+                    "last_name": "Coleman",
+                    "email": "billy.coleman@example.com",
+                    "created_at": null,
+                    "updated_at": null,
+                    "role_id": 1,
+                    "date_of_birth": "1986-05-20",
+                    "phone": "+79535482530",
+                    "position": "admin",
+                    "starts_on": "2022-04-16 00:00:00",
+                    "hr_id": null,
+                    "manager_id": null,
+                    "lead_id": null,
+                    "avatar_id": null,
+                    "deleted_at": null,
+                    "company_id": 1
+                  }
+                ],
+                "first_page_url": "http:\/\/localhost\/api\/users?page=1",
+                "from": 1,
+                "last_page": 1,
+                "last_page_url": "http:\/\/localhost\/api\/users?page=1",
+                "links": [
+                  {
+                    "url": null,
+                    "label": "« Previous",
+                    "active": false
+                  },
+                  {
+                    "url": "http:\/\/localhost\/api\/users?page=1",
+                    "label": "1",
+                    "active": true
+                  },
+                  {
+                    "url": null,
+                    "label": "Next »",
+                    "active": false
+                  }],
+                "next_page_url": null,
+                "path": "http:\/\/localhost\/api\/users",
+                "per_page": 20,
+                "prev_page_url": null,
+                "to": 1,
+                "total": 1
+              }
+            }
+          }
+        },
+        "security": [],
+        "description": "",
+        "consumes": []
+      }
+    }
+  },
+  "definitions": [],
+  "info":
+  {
+    "description": "This is automatically collected documentation",
+    "version": "0.0.0",
+    "title": "Name of Your Application",
+    "termsOfService": "",
+    "contact":
+    {
+      "email": "your@email.com"
+    }
+  }
+}

tests/support/Mock/TestContract.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace RonasIT\Support\Tests\Support\Mock;
+
+interface TestContract
+{
+    public function find(string $resourceType, string $resourceId): ?object;
+}

tests/support/Mock/TestController.php

@@ -15,4 +15,8 @@ public function testRequestWithoutRuleType(TestRequestWithoutRuleType $request)
     public function testRequestWithAnnotations(TestRequestWithAnnotations $request)
     {
     }
+
+    public function testRequestWithContract(TestContract $contract)
+    {
+    }
 }