Merge pull request vyuldashev#56 from vyuldashev/analysis-7a0WKZ

vyuldashev · web-flow · commit 263da6545205 · 2021-09-22T01:05:13.000+01:00
Apply fixes from StyleCI
diff --git a/examples/petstore/OpenApi/Schemas/PetSchema.php b/examples/petstore/OpenApi/Schemas/PetSchema.php
@@ -12,6 +12,7 @@ class PetSchema extends SchemaFactory implements Reusable
 {
     /**
      * @return Schema
+     *
      * @throws InvalidArgumentException
      */
     public function build(): SchemaContract
diff --git a/src/Attributes/Operation.php b/src/Attributes/Operation.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Vyuldashev\LaravelOpenApi\Attributes;
 
 use Attribute;
@@ -18,10 +19,11 @@ class Operation
     public ?string $method;
 
     /**
-     * @param string|null $id
-     * @param array $tags
-     * @param \Vyuldashev\LaravelOpenApi\Factories\SecuritySchemeFactory|string|null $security
-     * @param string|null $method
+     * @param  string|null  $id
+     * @param  array  $tags
+     * @param  \Vyuldashev\LaravelOpenApi\Factories\SecuritySchemeFactory|string|null  $security
+     * @param  string|null  $method
+     *
      * @throws InvalidArgumentException
      */
     public function __construct(string $id = null, array $tags = [], string $security = null, string $method = null)
@@ -33,6 +35,7 @@ public function __construct(string $id = null, array $tags = [], string $securit
         if ($security === '') {
             //user wants to turn off security on this operation
             $this->security = $security;
+
             return;
         }
 
diff --git a/src/Builders/Components/Builder.php b/src/Builders/Components/Builder.php
@@ -20,21 +20,21 @@ public function __construct(array $directories)
     protected function getAllClasses(string $collection): Collection
     {
         return collect($this->directories)
-            ->map(function(string $directory) {
+            ->map(function (string $directory) {
                 $map = ClassMapGenerator::createMap($directory);
 
                 return array_keys($map);
             })
             ->flatten()
-            ->filter(function(string $class) use($collection) {
+            ->filter(function (string $class) use ($collection) {
                 $reflectionClass = new ReflectionClass($class);
                 $collectionAttributes = $reflectionClass->getAttributes(CollectionAttribute::class);
 
-                if(count($collectionAttributes) === 0 && $collection === Generator::COLLECTION_DEFAULT) {
+                if (count($collectionAttributes) === 0 && $collection === Generator::COLLECTION_DEFAULT) {
                     return true;
                 }
 
-                if(count($collectionAttributes) === 0) {
+                if (count($collectionAttributes) === 0) {
                     return false;
                 }
 
diff --git a/src/Builders/ExtensionsBuilder.php b/src/Builders/ExtensionsBuilder.php
@@ -12,7 +12,7 @@ class ExtensionsBuilder
     public function build(BaseObject $object, Collection $attributes): void
     {
         $attributes
-            ->filter(static fn(object $attribute) => $attribute instanceof ExtensionAttribute)
+            ->filter(static fn (object $attribute) => $attribute instanceof ExtensionAttribute)
             ->each(static function (ExtensionAttribute $attribute) use ($object): void {
                 if ($attribute->factory) {
                     /** @var ExtensionFactory $factory */
diff --git a/src/Builders/Paths/Operation/CallbacksBuilder.php b/src/Builders/Paths/Operation/CallbacksBuilder.php
@@ -12,7 +12,7 @@ class CallbacksBuilder
     public function build(RouteInformation $route): array
     {
         return $route->actionAttributes
-            ->filter(static fn(object $attribute) => $attribute instanceof CallbackAttribute)
+            ->filter(static fn (object $attribute) => $attribute instanceof CallbackAttribute)
             ->map(static function (CallbackAttribute $attribute) {
                 $factory = app($attribute->factory);
                 $pathItem = $factory->build();
diff --git a/src/Builders/Paths/Operation/ParametersBuilder.php b/src/Builders/Paths/Operation/ParametersBuilder.php
@@ -31,7 +31,7 @@ protected function buildPath(RouteInformation $route): Collection
 
                 /** @var ReflectionParameter|null $reflectionParameter */
                 $reflectionParameter = collect($route->actionParameters)
-                    ->first(static fn(ReflectionParameter $reflectionParameter) => $reflectionParameter->name === $parameter['name']);
+                    ->first(static fn (ReflectionParameter $reflectionParameter) => $reflectionParameter->name === $parameter['name']);
 
                 if ($reflectionParameter) {
                     // The reflected param has no type, so ignore (should be defined in a ParametersFactory instead)
@@ -44,7 +44,7 @@ protected function buildPath(RouteInformation $route): Collection
 
                 /** @var Param $description */
                 $description = collect($route->actionDocBlock->getTagsByName('param'))
-                    ->first(static fn(Param $param) => Str::snake($param->getVariableName()) === Str::snake($parameter['name']));
+                    ->first(static fn (Param $param) => Str::snake($param->getVariableName()) === Str::snake($parameter['name']));
 
                 return Parameter::path()->name($parameter['name'])
                     ->required()
@@ -57,7 +57,7 @@ protected function buildPath(RouteInformation $route): Collection
     protected function buildAttribute(RouteInformation $route): Collection
     {
         /** @var Parameters|null $parameters */
-        $parameters = $route->actionAttributes->first(static fn($attribute) => $attribute instanceof Parameters, []);
+        $parameters = $route->actionAttributes->first(static fn ($attribute) => $attribute instanceof Parameters, []);
 
         if ($parameters) {
             /** @var ParametersFactory $parametersFactory */
diff --git a/src/Builders/Paths/Operation/RequestBodyBuilder.php b/src/Builders/Paths/Operation/RequestBodyBuilder.php
@@ -13,7 +13,7 @@ class RequestBodyBuilder
     public function build(RouteInformation $route): ?RequestBody
     {
         /** @var RequestBodyAttribute|null $requestBody */
-        $requestBody = $route->actionAttributes->first(static fn(object $attribute) => $attribute instanceof RequestBodyAttribute);
+        $requestBody = $route->actionAttributes->first(static fn (object $attribute) => $attribute instanceof RequestBodyAttribute);
 
         if ($requestBody) {
             /** @var RequestBodyFactory $requestBodyFactory */
diff --git a/src/Builders/Paths/Operation/ResponsesBuilder.php b/src/Builders/Paths/Operation/ResponsesBuilder.php
@@ -12,7 +12,7 @@ class ResponsesBuilder
     public function build(RouteInformation $route): array
     {
         return $route->actionAttributes
-            ->filter(static fn(object $attribute) => $attribute instanceof ResponseAttribute)
+            ->filter(static fn (object $attribute) => $attribute instanceof ResponseAttribute)
             ->map(static function (ResponseAttribute $attribute) {
                 $factory = app($attribute->factory);
                 $response = $factory->build();
diff --git a/src/Builders/Paths/Operation/SecurityBuilder.php b/src/Builders/Paths/Operation/SecurityBuilder.php
@@ -1,9 +1,10 @@
 <?php
+
 namespace Vyuldashev\LaravelOpenApi\Builders\Paths\Operation;
 
-use Vyuldashev\LaravelOpenApi\RouteInformation;
 use GoldSpecDigital\ObjectOrientedOAS\Objects\SecurityRequirement;
 use Vyuldashev\LaravelOpenApi\Attributes\Operation as OperationAttribute;
+use Vyuldashev\LaravelOpenApi\RouteInformation;
 
 class SecurityBuilder
 {
diff --git a/src/Builders/Paths/OperationsBuilder.php b/src/Builders/Paths/OperationsBuilder.php
@@ -1,18 +1,19 @@
 <?php
+
 namespace Vyuldashev\LaravelOpenApi\Builders\Paths;
 
-use Illuminate\Support\Str;
-use Illuminate\Support\Collection;
-use Vyuldashev\LaravelOpenApi\RouteInformation;
+use GoldSpecDigital\ObjectOrientedOAS\Exceptions\InvalidArgumentException;
 use GoldSpecDigital\ObjectOrientedOAS\Objects\Operation;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
+use Vyuldashev\LaravelOpenApi\Attributes\Operation as OperationAttribute;
 use Vyuldashev\LaravelOpenApi\Builders\ExtensionsBuilder;
-use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\SecurityBuilder;
 use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\CallbacksBuilder;
-use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\ResponsesBuilder;
-use Vyuldashev\LaravelOpenApi\Attributes\Operation as OperationAttribute;
 use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\ParametersBuilder;
-use GoldSpecDigital\ObjectOrientedOAS\Exceptions\InvalidArgumentException;
 use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\RequestBodyBuilder;
+use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\ResponsesBuilder;
+use Vyuldashev\LaravelOpenApi\Builders\Paths\Operation\SecurityBuilder;
+use Vyuldashev\LaravelOpenApi\RouteInformation;
 
 class OperationsBuilder
 {
@@ -40,11 +41,12 @@ public function __construct(
     }
 
     /**
-     * @param RouteInformation[]|Collection $routes
+     * @param  RouteInformation[]|Collection  $routes
      * @return array
+     *
      * @throws InvalidArgumentException
      */
-    public function build(array | Collection $routes): array
+    public function build(array|Collection $routes): array
     {
         $operations = [];
 
diff --git a/src/Builders/PathsBuilder.php b/src/Builders/PathsBuilder.php
@@ -24,8 +24,8 @@ public function __construct(
     }
 
     /**
-     * @param string $collection
-     * @param PathMiddleware[] $middlewares
+     * @param  string  $collection
+     * @param  PathMiddleware[]  $middlewares
      * @return array
      */
     public function build(
@@ -38,7 +38,7 @@ public function build(
                 $collectionAttribute = collect()
                     ->merge($routeInformation->controllerAttributes)
                     ->merge($routeInformation->actionAttributes)
-                    ->first(static fn(object $item) => $item instanceof CollectionAttribute);
+                    ->first(static fn (object $item) => $item instanceof CollectionAttribute);
 
                 return
                     (! $collectionAttribute && $collection === Generator::COLLECTION_DEFAULT) ||
@@ -51,7 +51,7 @@ public function build(
 
                 return $item;
             })
-            ->groupBy(static fn(RouteInformation $routeInformation) => $routeInformation->uri)
+            ->groupBy(static fn (RouteInformation $routeInformation) => $routeInformation->uri)
             ->map(function (Collection $routes, $uri) {
                 $pathItem = PathItem::create()->route($uri);
 
@@ -74,14 +74,14 @@ protected function routes(): Collection
     {
         /** @noinspection CollectFunctionInCollectionInspection */
         return collect(app(Router::class)->getRoutes())
-            ->filter(static fn(Route $route) => $route->getActionName() !== 'Closure')
-            ->map(static fn(Route $route) => RouteInformation::createFromRoute($route))
+            ->filter(static fn (Route $route) => $route->getActionName() !== 'Closure')
+            ->map(static fn (Route $route) => RouteInformation::createFromRoute($route))
             ->filter(static function (RouteInformation $route) {
                 $pathItem = $route->controllerAttributes
-                    ->first(static fn(object $attribute) => $attribute instanceof Attributes\PathItem);
+                    ->first(static fn (object $attribute) => $attribute instanceof Attributes\PathItem);
 
                 $operation = $route->actionAttributes
-                    ->first(static fn(object $attribute) => $attribute instanceof Attributes\Operation);
+                    ->first(static fn (object $attribute) => $attribute instanceof Attributes\Operation);
 
                 return $pathItem && $operation;
             });
diff --git a/src/Builders/ServersBuilder.php b/src/Builders/ServersBuilder.php
@@ -9,7 +9,7 @@
 class ServersBuilder
 {
     /**
-     * @param array $config
+     * @param  array  $config
      * @return Server[]
      */
     public function build(array $config): array
diff --git a/src/Builders/TagsBuilder.php b/src/Builders/TagsBuilder.php
@@ -8,7 +8,7 @@
 class TagsBuilder
 {
     /**
-     * @param array $config
+     * @param  array  $config
      * @return Tag[]
      */
     public function build(array $config): array
diff --git a/src/ClassMapGenerator.php b/src/ClassMapGenerator.php
@@ -3,18 +3,15 @@
 namespace Vyuldashev\LaravelOpenApi;
 
 use Iterator;
-
 use RecursiveDirectoryIterator;
-
 use RecursiveIteratorIterator;
 
 class ClassMapGenerator
 {
     /**
      * Iterate over all files in the given directory searching for classes.
      *
-     * @param Iterator|string $dir The directory to search in or an iterator
-     *
+     * @param  Iterator|string  $dir  The directory to search in or an iterator
      * @return array A class map array
      */
     public static function createMap(Iterator|string $dir): array
@@ -26,7 +23,7 @@ public static function createMap(Iterator|string $dir): array
         $map = [];
 
         foreach ($dir as $file) {
-            if (!$file->isFile()) {
+            if (! $file->isFile()) {
                 continue;
             }
 
@@ -54,8 +51,7 @@ public static function createMap(Iterator|string $dir): array
     /**
      * Extract the classes in the given file.
      *
-     * @param string $path The file to check
-     *
+     * @param  string  $path  The file to check
      * @return array The found classes
      */
     private static function findClasses(string $path): array
@@ -71,10 +67,10 @@ private static function findClasses(string $path): array
         $classes = [];
 
         $namespace = '';
-        for ($i = 0; isset($tokens[$i]); ++$i) {
+        for ($i = 0; isset($tokens[$i]); $i++) {
             $token = $tokens[$i];
 
-            if (!isset($token[1])) {
+            if (! isset($token[1])) {
                 continue;
             }
 
@@ -96,8 +92,8 @@ private static function findClasses(string $path): array
                 case T_TRAIT:
                     // Skip usage of ::class constant
                     $isClassConstant = false;
-                    for ($j = $i - 1; $j > 0; --$j) {
-                        if (!isset($tokens[$j][1])) {
+                    for ($j = $i - 1; $j > 0; $j--) {
+                        if (! isset($tokens[$j][1])) {
                             break;
                         }
 
@@ -106,7 +102,7 @@ private static function findClasses(string $path): array
                             break;
                         }
 
-                        if (!in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT], true)) {
+                        if (! in_array($tokens[$j][0], [T_WHITESPACE, T_DOC_COMMENT, T_COMMENT], true)) {
                             break;
                         }
                     }
diff --git a/src/RouteInformation.php b/src/RouteInformation.php
@@ -7,7 +7,6 @@
 use Attribute;
 use Illuminate\Routing\Route;
 use Illuminate\Support\Collection;
-use Illuminate\Support\HigherOrderTapProxy;
 use Illuminate\Support\Str;
 use phpDocumentor\Reflection\DocBlock;
 use phpDocumentor\Reflection\DocBlockFactory;
@@ -40,16 +39,17 @@ class RouteInformation
     public ?DocBlock $actionDocBlock;
 
     /**
-     * @param Route $route
+     * @param  Route  $route
      * @return RouteInformation
+     *
      * @throws ReflectionException
      */
     public static function createFromRoute(Route $route): RouteInformation
     {
         return tap(new static(), static function (self $instance) use ($route): void {
             $method = collect($route->methods())
-                ->map(static fn($value) => Str::lower($value))
-                ->filter(static fn($value) => ! in_array($value, ['head', 'options'], true))
+                ->map(static fn ($value) => Str::lower($value))
+                ->filter(static fn ($value) => ! in_array($value, ['head', 'options'], true))
                 ->first();
 
             $actionNameParts = explode('@', $route->getActionName());
@@ -65,7 +65,7 @@ public static function createFromRoute(Route $route): RouteInformation
             $parameters = collect($parameters[1]);
 
             if (count($parameters) > 0) {
-                $parameters = $parameters->map(static fn($parameter) => [
+                $parameters = $parameters->map(static fn ($parameter) => [
                     'name' => Str::replaceLast('?', '', $parameter),
                     'required' => ! Str::endsWith($parameter, '?'),
                 ]);
@@ -78,10 +78,10 @@ public static function createFromRoute(Route $route): RouteInformation
             $docBlock = $docComment ? DocBlockFactory::createInstance()->create($docComment) : null;
 
             $controllerAttributes = collect($reflectionClass->getAttributes())
-                ->map(fn(ReflectionAttribute $attribute) => $attribute->newInstance());
+                ->map(fn (ReflectionAttribute $attribute) => $attribute->newInstance());
 
             $actionAttributes = collect($reflectionMethod->getAttributes())
-                ->map(fn(ReflectionAttribute $attribute) => $attribute->newInstance());
+                ->map(fn (ReflectionAttribute $attribute) => $attribute->newInstance());
 
             $instance->domain = $route->domain();
             $instance->method = $method;
diff --git a/tests/Builders/InfoBuilderTest.php b/tests/Builders/InfoBuilderTest.php
@@ -11,8 +11,9 @@ class InfoBuilderTest extends TestCase
 {
     /**
      * @dataProvider providerBuildContact
-     * @param array $config
-     * @param array $expected
+     *
+     * @param  array  $config
+     * @param  array  $expected
      * @return void
      */
     public function testBuildContact(array $config, array $expected): void
@@ -105,8 +106,8 @@ public function providerBuildContact(): array
     /**
      * Assert equality as an associative array.
      *
-     * @param array $expected
-     * @param array $actual
+     * @param  array  $expected
+     * @param  array  $actual
      * @return void
      */
     protected function assertSameAssociativeArray(array $expected, array $actual): void
diff --git a/tests/Builders/SecurityBuilderTest.php b/tests/Builders/SecurityBuilderTest.php
diff --git a/tests/Builders/ServersBuilderTest.php b/tests/Builders/ServersBuilderTest.php

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ class PetSchema extends SchemaFactory implements Reusable`
`12`	`12`	`{`
`13`	`13`	`/**`
`14`	`14`	`* @return Schema`
	`15`	`+ *`
`15`	`16`	`* @throws InvalidArgumentException`
`16`	`17`	`*/`
`17`	`18`	`public function build(): SchemaContract`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ class ExtensionsBuilder`
`12`	`12`	`public function build(BaseObject $object, Collection $attributes): void`
`13`	`13`	`{`
`14`	`14`	`$attributes`
`15`		`- ->filter(static fn(object $attribute) => $attribute instanceof ExtensionAttribute)`
	`15`	`+ ->filter(static fn (object $attribute) => $attribute instanceof ExtensionAttribute)`
`16`	`16`	`->each(static function (ExtensionAttribute $attribute) use ($object): void {`
`17`	`17`	`if ($attribute->factory) {`
`18`	`18`	`/** @var ExtensionFactory $factory */`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ class CallbacksBuilder`
`12`	`12`	`public function build(RouteInformation $route): array`
`13`	`13`	`{`
`14`	`14`	`return $route->actionAttributes`
`15`		`- ->filter(static fn(object $attribute) => $attribute instanceof CallbackAttribute)`
	`15`	`+ ->filter(static fn (object $attribute) => $attribute instanceof CallbackAttribute)`
`16`	`16`	`->map(static function (CallbackAttribute $attribute) {`
`17`	`17`	`$factory = app($attribute->factory);`
`18`	`18`	`$pathItem = $factory->build();`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class RequestBodyBuilder`
`13`	`13`	`public function build(RouteInformation $route): ?RequestBody`
`14`	`14`	`{`
`15`	`15`	`/** @var RequestBodyAttribute\|null $requestBody */`
`16`		`- $requestBody = $route->actionAttributes->first(static fn(object $attribute) => $attribute instanceof RequestBodyAttribute);`
	`16`	`+ $requestBody = $route->actionAttributes->first(static fn (object $attribute) => $attribute instanceof RequestBodyAttribute);`
`17`	`17`
`18`	`18`	`if ($requestBody) {`
`19`	`19`	`/** @var RequestBodyFactory $requestBodyFactory */`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ class ResponsesBuilder`
`12`	`12`	`public function build(RouteInformation $route): array`
`13`	`13`	`{`
`14`	`14`	`return $route->actionAttributes`
`15`		`- ->filter(static fn(object $attribute) => $attribute instanceof ResponseAttribute)`
	`15`	`+ ->filter(static fn (object $attribute) => $attribute instanceof ResponseAttribute)`
`16`	`16`	`->map(static function (ResponseAttribute $attribute) {`
`17`	`17`	`$factory = app($attribute->factory);`
`18`	`18`	`$response = $factory->build();`