Browse Source

Merge remote-tracking branch 'origin/non-static-docs' into v4

# Conflicts:
#	src/Extracting/Strategies/QueryParameters/GetFromQueryParamTag.php
#	src/Extracting/Strategies/Responses/UseApiResourceTags.php
#	src/Matching/RouteMatcher.php
#	src/Writing/PostmanCollectionWriter.php
shalvah 5 years ago
parent
commit
4eecf100ba

+ 1 - 2
src/Commands/GenerateDocumentation.php

@@ -9,8 +9,8 @@ use Illuminate\Console\Command;
 use Mpociot\ApiDoc\Tools\Flags;
 use Mpociot\ApiDoc\Tools\Utils;
 use Mpociot\Reflection\DocBlock;
-use Mpociot\ApiDoc\Writing\Writer;
 use Illuminate\Support\Collection;
+use Mpociot\ApiDoc\Writing\Writer;
 use Illuminate\Support\Facades\URL;
 use Mpociot\ApiDoc\Extracting\Generator;
 use Mpociot\ApiDoc\Matching\RouteMatcher;
@@ -154,5 +154,4 @@ class GenerateDocumentation extends Command
 
         return true;
     }
-
 }

+ 1 - 1
src/Extracting/Strategies/QueryParameters/GetFromQueryParamTag.php

@@ -10,8 +10,8 @@ use Mpociot\Reflection\DocBlock;
 use Mpociot\Reflection\DocBlock\Tag;
 use Mpociot\ApiDoc\Extracting\ParamHelpers;
 use Mpociot\ApiDoc\Extracting\RouteDocBlocker;
-use Dingo\Api\Http\FormRequest as DingoFormRequest;
 use Mpociot\ApiDoc\Extracting\Strategies\Strategy;
+use Dingo\Api\Http\FormRequest as DingoFormRequest;
 use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;
 
 class GetFromQueryParamTag extends Strategy

+ 2 - 0
src/Extracting/Strategies/Responses/UseApiResourceTags.php

@@ -14,7 +14,9 @@ use Mpociot\ApiDoc\Tools\Utils;
 use Mpociot\Reflection\DocBlock;
 use Mpociot\Reflection\DocBlock\Tag;
 use Illuminate\Database\Eloquent\Model;
+use League\Fractal\Resource\Collection;
 use Mpociot\ApiDoc\Extracting\RouteDocBlocker;
+use Illuminate\Http\Resources\Json\JsonResource;
 use Mpociot\ApiDoc\Extracting\Strategies\Strategy;
 use Illuminate\Http\Resources\Json\ResourceCollection;
 

+ 0 - 1
src/Matching/RouteMatcher.php

@@ -19,7 +19,6 @@ class RouteMatcher
      */
     protected $routeRules;
 
-
     public function __construct(array $routeRules = [], string $router = 'laravel')
     {
         $this->router = $router;

+ 3 - 3
src/Writing/PostmanCollectionWriter.php

@@ -40,7 +40,7 @@ class PostmanCollectionWriter
         $collection = [
             'variables' => [],
             'info' => [
-                'name' => config('apidoc.postman.name') ?: config('app.name'). ' API',
+                'name' => config('apidoc.postman.name') ?: config('app.name').' API',
                 '_postman_id' => Uuid::uuid4()->toString(),
                 'description' => config('apidoc.postman.description') ?: '',
                 'schema' => 'https://schema.getpostman.com/json/collection/v2.0.0/collection.json',
@@ -57,8 +57,8 @@ class PostmanCollectionWriter
                             'request' => [
                                 'url' => url($route['uri']).(collect($route['queryParameters'])->isEmpty()
                                         ? ''
-                                        : ('?' . implode('&', collect($route['queryParameters'])->map(function ($parameter, $key) {
-                                                return urlencode($key).'=' . urlencode($parameter['value'] ?? '');
+                                        : ('?'.implode('&', collect($route['queryParameters'])->map(function ($parameter, $key) {
+                                            return urlencode($key).'='.urlencode($parameter['value'] ?? '');
                                         })->all()))),
                                 'method' => $route['methods'][0],
                                 'header' => collect($route['headers'])

+ 3 - 3
src/Writing/Writer.php

@@ -140,7 +140,7 @@ class Writer
 
         $this->output->info('Writing index.md and source files to: '.$sourceOutputPath);
 
-        if (!is_dir($sourceOutputPath)) {
+        if (! is_dir($sourceOutputPath)) {
             $documentarian = new Documentarian();
             $documentarian->create($sourceOutputPath);
         }
@@ -229,7 +229,7 @@ class Writer
             ? file_get_contents($prependFile)."\n" : '';
 
         return $prependFileContents;
-}
+    }
 
     /**
      * @param string $sourceOutputPath
@@ -243,7 +243,7 @@ class Writer
             ? "\n".file_get_contents($appendFile) : '';
 
         return $appendFileContents;
-}
+    }
 
     protected function copyAssetsFromSourceFolderToPublicFolder(string $sourceOutputPath, bool $isStatic = true): void
     {

+ 2 - 2
tests/GenerateDocumentationTest.php

@@ -136,7 +136,7 @@ class GenerateDocumentationTest extends TestCase
     /** @test */
     public function can_parse_partial_resource_routes()
     {
-            RouteFacade::resource('/api/users', TestResourceController::class)
+        RouteFacade::resource('/api/users', TestResourceController::class)
                 ->only(['index', 'create']);
 
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
@@ -152,7 +152,7 @@ class GenerateDocumentationTest extends TestCase
         $generatedMarkdown = __DIR__.'/../resources/docs/source/index.md';
         $this->assertFilesHaveSameContent($fixtureMarkdown, $generatedMarkdown);
 
-            RouteFacade::apiResource('/api/users', TestResourceController::class)
+        RouteFacade::apiResource('/api/users', TestResourceController::class)
                 ->only(['index', 'create']);
 
         $this->artisan('apidoc:generate');

+ 1 - 1
tests/Unit/GeneratorPluginSystemTestCase.php

@@ -6,10 +6,10 @@ use ReflectionClass;
 use ReflectionMethod;
 use Illuminate\Routing\Route;
 use Mpociot\ApiDoc\Extracting\Generator;
-use Mpociot\ApiDoc\Extracting\Strategies\Strategy;
 use Mpociot\ApiDoc\Tools\DocumentationConfig;
 use Mpociot\ApiDoc\Tests\Fixtures\TestController;
 use Mpociot\ApiDoc\ApiDocGeneratorServiceProvider;
+use Mpociot\ApiDoc\Extracting\Strategies\Strategy;
 
 class GeneratorPluginSystemTestCase extends LaravelGeneratorTest
 {

+ 15 - 15
tests/Unit/RouteMatcherTest.php

@@ -56,17 +56,17 @@ class RouteMatcherTest extends TestCase
         $routeRules[0]['match']['prefixes'] = ['*'];
 
         $routeRules[0]['match']['domains'] = ['*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(12, $routes);
 
         $routeRules[0]['match']['domains'] = ['domain1.*', 'domain2.*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(12, $routes);
 
         $routeRules[0]['match']['domains'] = ['domain1.*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(6, $routes);
         foreach ($routes as $route) {
@@ -74,7 +74,7 @@ class RouteMatcherTest extends TestCase
         }
 
         $routeRules[0]['match']['domains'] = ['domain2.*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(6, $routes);
         foreach ($routes as $route) {
@@ -121,17 +121,17 @@ class RouteMatcherTest extends TestCase
         $routeRules[0]['match']['domains'] = ['*'];
 
         $routeRules[0]['match']['prefixes'] = ['*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(12, $routes);
 
         $routeRules[0]['match']['prefixes'] = ['prefix1/*', 'prefix2/*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(8, $routes);
 
         $routeRules[0]['match']['prefixes'] = ['prefix1/*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(4, $routes);
         foreach ($routes as $route) {
@@ -139,7 +139,7 @@ class RouteMatcherTest extends TestCase
         }
 
         $routeRules[0]['match']['prefixes'] = ['prefix2/*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(4, $routes);
         foreach ($routes as $route) {
@@ -154,7 +154,7 @@ class RouteMatcherTest extends TestCase
         $routeRules[0]['match']['versions'] = ['v2'];
         $routeRules[0]['match']['domains'] = ['*'];
         $routeRules[0]['match']['prefixes'] = ['*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(6, $routes);
         foreach ($routes as $route) {
@@ -164,7 +164,7 @@ class RouteMatcherTest extends TestCase
         $routeRules[0]['match']['versions'] = ['v1', 'v2'];
         $routeRules[0]['match']['domains'] = ['*'];
         $routeRules[0]['match']['prefixes'] = ['*'];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(18, $routes);
     }
@@ -200,7 +200,7 @@ class RouteMatcherTest extends TestCase
                 'include' => [$mustInclude],
             ],
         ];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $oddRuleOut = collect($routes)->filter(function ($route) use ($mustInclude) {
             return $route['route']->getName() === $mustInclude;
@@ -241,7 +241,7 @@ class RouteMatcherTest extends TestCase
                 'include' => [$includePattern],
             ],
         ];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $oddRuleOut = collect($routes)->filter(function ($route) use ($mustInclude) {
             return in_array($route['route']->getName(), $mustInclude);
@@ -280,7 +280,7 @@ class RouteMatcherTest extends TestCase
                 'exclude' => [$mustNotInclude],
             ],
         ];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $oddRuleOut = collect($routes)->filter(function ($route) use ($mustNotInclude) {
             return $route['route']->getName() === $mustNotInclude;
@@ -321,7 +321,7 @@ class RouteMatcherTest extends TestCase
                 'exclude' => [$excludePattern],
             ],
         ];
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $oddRuleOut = collect($routes)->filter(function ($route) use ($mustNotInclude) {
             return in_array($route['route']->getName(), $mustNotInclude);
@@ -386,7 +386,7 @@ class RouteMatcherTest extends TestCase
             ],
         ];
 
-        $matcher = new RouteMatcher($routeRules, "dingo");
+        $matcher = new RouteMatcher($routeRules, 'dingo');
         $routes = $matcher->getRoutes();
         $this->assertCount(18, $routes);