Merge pull request mpociot#669 from andrey-helldar/patch-2020-01-13-10-27

Added support for the latest packages

Author: shalvah

.travis.yml

@@ -1,21 +1,37 @@
+dist: bionic
 language: php
 
-php:
-  - 7.3
-  - 7.2
-
 env:
-  - PREFER_LOWEST=""
-  - PREFER_LOWEST="--prefer-lowest"
+  global:
+    - SETUP=stable
 
-jobs:
+matrix:
+  fast_finish: true
   include:
-    - script: composer lint
+    - php: 7.2
+    - php: 7.2
+      env: SETUP=lowest
+    - php: 7.3
+    - php: 7.3
+      env: SETUP=lowest
+    - php: 7.4
+    - php: 7.4
+      env: SETUP=lowest
+    - php: 7.4
+      env: SETUP=lint
       name: "Lint code"
-      php: 7.3
-      env: PREFER_LOWEST=""
 
-script: composer test-ci
-before_script:
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+before_install:
   - travis_retry composer self-update
-  - travis_retry composer update --no-interaction --prefer-dist $PREFER_LOWEST
+
+install:
+  - if [[ $SETUP = 'stable' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable --no-suggest; fi
+  - if [[ $SETUP = 'lowest' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-lowest --prefer-stable --no-suggest; fi
+  - if [[ $SETUP = 'lint' ]]; then travis_retry composer update --prefer-dist --no-interaction --prefer-stable --no-suggest; travis_retry composer lint; fi
+
+script:
+  - vendor/bin/phpunit

composer.json

@@ -16,24 +16,26 @@
     ],
     "require": {
         "php": ">=7.2.0",
+        "ext-json": "*",
         "fzaninotto/faker": "^1.8",
-        "illuminate/routing": "^5.7|^6.0",
-        "illuminate/support": "^5.7|^6.0",
-        "illuminate/console": "^5.7|^6.0",
+        "illuminate/console": "^5.7|^6.0|^7.0",
+        "illuminate/routing": "^5.7|^6.0|^7.0",
+        "illuminate/support": "^5.7|^6.0|^7.0",
+        "league/flysystem": "^1.0",
         "mpociot/documentarian": "^0.3.0",
         "mpociot/reflection-docblock": "^1.0.1",
+        "nunomaduro/collision": "^3.0",
         "ramsey/uuid": "^3.8",
-        "symfony/var-exporter": "^4.0",
-        "league/flysystem": "^1.0",
-        "nunomaduro/collision": "^3.0"
+        "symfony/var-exporter": "^4.0|^5.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^3.7.0 || ^4.0",
-        "phpunit/phpunit": "^7.5.0",
         "dingo/api": "^2.3.0",
-        "mockery/mockery": "^1.2.0",
+        "dms/phpunit-arraysubset-asserts": "^0.1.0",
         "league/fractal": "^0.17.0",
-        "phpstan/phpstan": "^0.11.15"
+        "mockery/mockery": "^1.2.0",
+        "orchestra/testbench": "^3.7|^4.0",
+        "phpstan/phpstan": "^0.11.15",
+        "phpunit/phpunit": "^8.0"
     },
     "suggest": {
         "league/fractal": "Required for transformers support"
@@ -62,5 +64,9 @@
         "branch-alias": {
             "dev-v4": "4.x-dev"
         }
+    },
+    "config": {
+        "preferred-install": "dist",
+        "sort-packages": true
     }
 }

phpstan.neon

@@ -1,7 +1,7 @@
 parameters:
     level: 5
     reportUnmatchedIgnoredErrors: false
-    inferPrivatePropertyTypeFromConstructor:: true
+    inferPrivatePropertyTypeFromConstructor: true
     ignoreErrors:
         - '#Call to an undefined static method Illuminate\\Support\\Facades\\Route::getRoutes().#'
         - '#Call to an undefined static method Illuminate\\Support\\Facades\\URL::forceRootUrl()#'

src/Commands/GenerateDocumentation.php

@@ -86,6 +86,8 @@ public function handle(RouteMatcherInterface $routeMatcher)
      * @param \Mpociot\ApiDoc\Extracting\Generator $generator
      * @param Match[] $routes
      *
+     * @throws \ReflectionException
+     *
      * @return array
      */
     private function processRoutes(Generator $generator, array $routes)

src/Extracting/Generator.php

@@ -47,11 +47,13 @@ public function getMethods(Route $route)
      * @param \Illuminate\Routing\Route $route
      * @param array $routeRules Rules to apply when generating documentation for this route
      *
+     * @throws \ReflectionException
+     *
      * @return array
      */
     public function processRoute(Route $route, array $routeRules = [])
     {
-        list($controllerName, $methodName) = Utils::getRouteClassAndMethodNames($route->getAction());
+        [$controllerName, $methodName] = Utils::getRouteClassAndMethodNames($route->getAction());
         $controller = new ReflectionClass($controllerName);
         $method = $controller->getMethod($methodName);
 

src/Extracting/ParamHelpers.php

@@ -3,6 +3,7 @@
 namespace Mpociot\ApiDoc\Extracting;
 
 use Faker\Factory;
+use stdClass;
 
 trait ParamHelpers
 {
@@ -32,7 +33,7 @@ protected function generateDummyValue(string $type)
                 return [];
             },
             'object' => function () {
-                return new \stdClass;
+                return new stdClass;
             },
         ];
 

src/Extracting/RouteDocBlocker.php

@@ -20,6 +20,7 @@ class RouteDocBlocker
      * @param Route $route
      *
      * @throws \ReflectionException
+     * @throws \Exception
      *
      * @return array<string, DocBlock> Method and class docblocks
      */

src/Extracting/Strategies/Responses/UseTransformerTags.php

@@ -4,6 +4,7 @@
 
 use Exception;
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Model as IlluminateModel;
 use Illuminate\Routing\Route;
 use Illuminate\Support\Arr;
 use League\Fractal\Manager;
@@ -34,7 +35,7 @@ class UseTransformerTags extends Strategy
      *
      * @return array|null
      */
-    public function __invoke(Route $route, \ReflectionClass $controller, \ReflectionMethod $method, array $rulesToApply, array $context = [])
+    public function __invoke(Route $route, ReflectionClass $controller, ReflectionMethod $method, array $rulesToApply, array $context = [])
     {
         $docBlocks = RouteDocBlocker::getDocBlocksFromRoute($route);
         /** @var DocBlock $methodDocBlock */
@@ -47,6 +48,7 @@ public function __invoke(Route $route, \ReflectionClass $controller, \Reflection
      * Get a response from the transformer tags.
      *
      * @param array $tags
+     * @param Route $route
      *
      * @return array|null
      */
@@ -57,7 +59,7 @@ protected function getTransformerResponse(array $tags, Route $route)
                 return null;
             }
 
-            list($statusCode, $transformer) = $this->getStatusCodeAndTransformerClass($transformerTag);
+            [$statusCode, $transformer] = $this->getStatusCodeAndTransformerClass($transformerTag);
             $model = $this->getClassToBeTransformed($tags, (new ReflectionClass($transformer))->getMethod('transform'));
             $modelInstance = $this->instantiateTransformerModel($model);
 
@@ -81,7 +83,7 @@ protected function getTransformerResponse(array $tags, Route $route)
                     'content' => $response->getContent(),
                 ],
             ];
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             echo 'Exception thrown when fetching transformer response for ['.implode(',', $route->methods)."] {$route->uri}.\n";
             if (Flags::$shouldBeVerbose) {
                 Utils::dumpException($e);
@@ -112,6 +114,8 @@ private function getStatusCodeAndTransformerClass($tag): array
      * @param array $tags
      * @param ReflectionMethod $transformerMethod
      *
+     * @throws Exception
+     *
      * @return string
      */
     private function getClassToBeTransformed(array $tags, ReflectionMethod $transformerMethod): string
@@ -125,9 +129,9 @@ private function getClassToBeTransformed(array $tags, ReflectionMethod $transfor
             $type = $modelTag->getContent();
         } else {
             $parameter = Arr::first($transformerMethod->getParameters());
-            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists((string) $parameter->getType())) {
+            if ($parameter->hasType() && ! $parameter->getType()->isBuiltin() && class_exists($parameter->getType()->getName())) {
                 // Ladies and gentlemen, we have a type!
-                $type = (string) $parameter->getType();
+                $type = $parameter->getType()->getName();
             }
         }
 
@@ -153,20 +157,20 @@ protected function instantiateTransformerModel(string $type)
             $type = ltrim($type, '\\');
 
             return factory($type)->make();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             if (Flags::$shouldBeVerbose) {
                 echo "Eloquent model factory failed to instantiate {$type}; trying to fetch from database.\n";
             }
 
             $instance = new $type;
-            if ($instance instanceof \Illuminate\Database\Eloquent\Model) {
+            if ($instance instanceof IlluminateModel) {
                 try {
                     // we can't use a factory but can try to get one from the database
                     $firstInstance = $type::first();
                     if ($firstInstance) {
                         return $firstInstance;
                     }
-                } catch (\Exception $e) {
+                } catch (Exception $e) {
                     // okay, we'll stick with `new`
                     if (Flags::$shouldBeVerbose) {
                         echo "Failed to fetch first {$type} from database; using `new` to instantiate.\n";

src/Tools/Utils.php

@@ -94,6 +94,14 @@ public static function deleteDirectoryAndContents($dir)
         $fs->deleteDir($dir);
     }
 
+    /**
+     * @param mixed $value
+     * @param int $indentationLevel
+     *
+     * @throws \Symfony\Component\VarExporter\Exception\ExceptionInterface
+     *
+     * @return string
+     */
     public static function printPhpValue($value, $indentationLevel = 0)
     {
         $output = VarExporter::export($value);

tests/GenerateDocumentationTest.php

@@ -65,8 +65,8 @@ public function console_command_does_not_work_with_closure()
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
         $output = $this->artisan('apidoc:generate');
 
-        $this->assertContains('Skipping route: [GET] api/closure', $output);
-        $this->assertContains('Processed route: [GET] api/test', $output);
+        $this->assertStringContainsString('Skipping route: [GET] api/closure', $output);
+        $this->assertStringContainsString('Processed route: [GET] api/test', $output);
     }
 
     /** @test */
@@ -85,8 +85,8 @@ public function console_command_does_not_work_with_closure_using_dingo()
         config(['apidoc.routes.0.match.versions' => ['v1']]);
         $output = $this->artisan('apidoc:generate');
 
-        $this->assertContains('Skipping route: [GET] closure', $output);
-        $this->assertContains('Processed route: [GET] test', $output);
+        $this->assertStringContainsString('Skipping route: [GET] closure', $output);
+        $this->assertStringContainsString('Processed route: [GET] test', $output);
     }
 
     /** @test */
@@ -97,8 +97,8 @@ public function console_command_work_with_routes_callable_tuple()
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
         $output = $this->artisan('apidoc:generate');
 
-        $this->assertNotContains('Skipping route: [GET] api/array/test', $output);
-        $this->assertContains('Processed route: [GET] api/array/test', $output);
+        $this->assertStringNotContainsString('Skipping route: [GET] api/array/test', $output);
+        $this->assertStringContainsString('Processed route: [GET] api/array/test', $output);
     }
 
     /** @test */
@@ -110,8 +110,8 @@ public function can_skip_single_routes()
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
         $output = $this->artisan('apidoc:generate');
 
-        $this->assertContains('Skipping route: [GET] api/skip', $output);
-        $this->assertContains('Processed route: [GET] api/test', $output);
+        $this->assertStringContainsString('Skipping route: [GET] api/skip', $output);
+        $this->assertStringContainsString('Processed route: [GET] api/test', $output);
     }
 
     /** @test */
@@ -122,8 +122,8 @@ public function can_skip_non_existent_response_files()
         config(['apidoc.routes.0.match.prefixes' => ['api/*']]);
         $output = $this->artisan('apidoc:generate');
 
-        $this->assertContains('Skipping route: [GET] api/non-existent', $output);
-        $this->assertContains('@responseFile i-do-not-exist.json does not exist', $output);
+        $this->assertStringContainsString('Skipping route: [GET] api/non-existent', $output);
+        $this->assertStringContainsString('@responseFile i-do-not-exist.json does not exist', $output);
     }
 
     /** @test */
@@ -392,7 +392,7 @@ public function can_parse_utf8_response()
         $this->artisan('apidoc:generate');
 
         $generatedMarkdown = file_get_contents(__DIR__.'/../resources/docs/source/index.md');
-        $this->assertContains('Лорем ипсум долор сит амет', $generatedMarkdown);
+        $this->assertStringContainsString('Лорем ипсум долор сит амет', $generatedMarkdown);
     }
 
     /** @test */
@@ -437,7 +437,7 @@ public function supports_partial_resource_controller()
 
         $this->assertNull($thrownException);
         $generatedMarkdown = file_get_contents(__DIR__.'/../resources/docs/source/index.md');
-        $this->assertContains('Group A', $generatedMarkdown);
-        $this->assertContains('Group B', $generatedMarkdown);
+        $this->assertStringContainsString('Group A', $generatedMarkdown);
+        $this->assertStringContainsString('Group B', $generatedMarkdown);
     }
 }