Merge 718c862 into 298c893

adrenalinkin · Feb 6, 2023 · 3ab829f · 3ab829f
2 parents 298c893 + 718c862
commit 3ab829f
Show file tree

Hide file tree

Showing 39 changed files with 207 additions and 88 deletions.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml
@@ -0,0 +1,23 @@
+name: Static analysis
+
+on: [push, pull_request]
+
+jobs:
+    static-analysis:
+        runs-on: ubuntu-latest
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v2
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 8.1
+                    coverage: none
+                    tools: php-cs-fixer:3.x, composer-normalize:2.x
+
+            -   name: Run PHP-CS-Fixer
+                run: php-cs-fixer fix --dry-run
+
+            -   name: Run composer normalize
+                run: composer-normalize --dry-run
diff --git a/.github/workflows/unit-tests.yaml → .github/workflows/tests.yaml b/.github/workflows/unit-tests.yaml → .github/workflows/tests.yaml
@@ -1,4 +1,4 @@
-name: UnitTests
+name: Tests
 
 on: [push, pull_request]
 

diff --git a/.gitignore b/.gitignore
@@ -5,5 +5,3 @@
 composer.lock
 composer.phar
 phpunit.xml
-.php_cs
-.php_cs.cache
diff --git a/.php_cs.dist → .php-cs-fixer.dist.php b/.php_cs.dist → .php-cs-fixer.dist.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 $fileHeaderComment = <<<COMMENT
 This file is part of the SwaggerResolverBundle package.
 
@@ -13,7 +15,7 @@
     ->in(__DIR__)
     ->exclude('Resources/config')
     ->exclude('var')
-    ->notPath('Tests/Functional/src/swagger.php'); // PHPCS-Fixer does not recognising the DocBlock inside swagger.php.
+    ->notPath('Tests/Functional/src/swagger.php'); // PHPCS-Fixer does not recognise the DocBlock inside swagger.php.
 
 return (new PhpCsFixer\Config())
     ->setRules([

diff --git a/Collection/SchemaDefinitionCollection.php b/Collection/SchemaDefinitionCollection.php
@@ -13,16 +13,14 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Collection;
 
-use ArrayIterator;
 use EXSyst\Component\Swagger\Schema;
-use IteratorAggregate;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\DefinitionNotFoundException;
 use Symfony\Component\Config\Resource\FileResource;
 
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
-class SchemaDefinitionCollection implements IteratorAggregate
+class SchemaDefinitionCollection implements \IteratorAggregate
 {
     /**
      * @var Schema[]
@@ -37,9 +35,9 @@ class SchemaDefinitionCollection implements IteratorAggregate
     /**
      * {@inheritdoc}
      */
-    public function getIterator(): ArrayIterator
+    public function getIterator(): \ArrayIterator
     {
-        return new ArrayIterator($this->schemaCollection);
+        return new \ArrayIterator($this->schemaCollection);
     }
 
     public function addSchema(string $definitionName, Schema $schema): self

diff --git a/Collection/SchemaOperationCollection.php b/Collection/SchemaOperationCollection.php
@@ -13,16 +13,14 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Collection;
 
-use ArrayIterator;
 use EXSyst\Component\Swagger\Schema;
-use IteratorAggregate;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\OperationNotFoundException;
 use Symfony\Component\Config\Resource\FileResource;
 
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
-class SchemaOperationCollection implements IteratorAggregate
+class SchemaOperationCollection implements \IteratorAggregate
 {
     /**
      * @var Schema[][]
@@ -37,9 +35,9 @@ class SchemaOperationCollection implements IteratorAggregate
     /**
      * {@inheritdoc}
      */
-    public function getIterator(): ArrayIterator
+    public function getIterator(): \ArrayIterator
     {
-        return new ArrayIterator($this->schemaCollection);
+        return new \ArrayIterator($this->schemaCollection);
     }
 
     public function addSchema(string $routeName, string $method, Schema $schema): self

diff --git a/DependencyInjection/Compiler/SwaggerNormalizerCompilerPass.php b/DependencyInjection/Compiler/SwaggerNormalizerCompilerPass.php
@@ -14,7 +14,6 @@
 namespace Linkin\Bundle\SwaggerResolverBundle\DependencyInjection\Compiler;
 
 use Linkin\Bundle\SwaggerResolverBundle\Builder\SwaggerResolverBuilder;
-use SplPriorityQueue;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -35,7 +34,7 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $normalizerQueue = new SplPriorityQueue();
+        $normalizerQueue = new \SplPriorityQueue();
 
         foreach ($container->findTaggedServiceIds(self::TAG) as $id => $attributes) {
             $normalizerQueue->insert(new Reference($id), $attributes[0]['priority'] ?? 0);

diff --git a/DependencyInjection/Compiler/SwaggerValidatorCompilerPass.php b/DependencyInjection/Compiler/SwaggerValidatorCompilerPass.php
@@ -14,7 +14,6 @@
 namespace Linkin\Bundle\SwaggerResolverBundle\DependencyInjection\Compiler;
 
 use Linkin\Bundle\SwaggerResolverBundle\Builder\SwaggerResolverBuilder;
-use SplPriorityQueue;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Reference;
@@ -35,7 +34,7 @@ public function process(ContainerBuilder $container): void
             return;
         }
 
-        $validatorQueue = new SplPriorityQueue();
+        $validatorQueue = new \SplPriorityQueue();
 
         foreach ($container->findTaggedServiceIds(self::TAG) as $id => $attributes) {
             $validatorQueue->insert(new Reference($id), $attributes[0]['priority'] ?? 0);

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -13,7 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\DependencyInjection;
 
-use Closure;
 use Linkin\Bundle\SwaggerResolverBundle\Enum\ParameterLocationEnum;
 use Linkin\Bundle\SwaggerResolverBundle\Loader\SwaggerConfigurationLoaderInterface;
 use Linkin\Bundle\SwaggerResolverBundle\Merger\MergeStrategyInterface;
@@ -84,7 +83,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    private function validationForConfigurationLoader(): Closure
+    private function validationForConfigurationLoader(): \Closure
     {
         return static function ($className) {
             if (!is_subclass_of($className, SwaggerConfigurationLoaderInterface::class)) {
@@ -95,7 +94,7 @@ private function validationForConfigurationLoader(): Closure
         };
     }
 
-    private function validationForPathMergeStrategy(): Closure
+    private function validationForPathMergeStrategy(): \Closure
     {
         return static function ($className) {
             if (!is_subclass_of($className, MergeStrategyInterface::class)) {

diff --git a/Enum/ParameterCollectionFormatEnum.php b/Enum/ParameterCollectionFormatEnum.php
@@ -13,8 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Enum;
 
-use RuntimeException;
-
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
@@ -45,7 +43,7 @@ public static function getDelimiter(string $collectionFormat): string
             case self::MULTI:
                 return '&';
             default:
-                throw new RuntimeException(sprintf('Unexpected collection format: %s', $collectionFormat));
+                throw new \RuntimeException(sprintf('Unexpected collection format: %s', $collectionFormat));
         }
     }
 }
diff --git a/Exception/DefinitionNotFoundException.php b/Exception/DefinitionNotFoundException.php
@@ -13,12 +13,10 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Exception;
 
-use RuntimeException;
-
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
-class DefinitionNotFoundException extends RuntimeException
+class DefinitionNotFoundException extends \RuntimeException
 {
     public function __construct(string $className)
     {

diff --git a/Exception/OperationNotFoundException.php b/Exception/OperationNotFoundException.php
@@ -13,12 +13,10 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Exception;
 
-use RuntimeException;
-
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
-class OperationNotFoundException extends RuntimeException
+class OperationNotFoundException extends \RuntimeException
 {
     public function __construct(string $path, string $method)
     {

diff --git a/Exception/UndefinedPropertyTypeException.php b/Exception/UndefinedPropertyTypeException.php
@@ -13,12 +13,10 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Exception;
 
-use RuntimeException;
-
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
-class UndefinedPropertyTypeException extends RuntimeException
+class UndefinedPropertyTypeException extends \RuntimeException
 {
     public function __construct(string $definitionName, string $propertyName, string $type)
     {

diff --git a/Loader/AbstractSwaggerConfigurationLoader.php b/Loader/AbstractSwaggerConfigurationLoader.php
@@ -21,7 +21,6 @@
 use Linkin\Bundle\SwaggerResolverBundle\Collection\SchemaOperationCollection;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\OperationNotFoundException;
 use Linkin\Bundle\SwaggerResolverBundle\Merger\OperationParameterMerger;
-use ReflectionClass;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Routing\RouterInterface;
 
@@ -178,7 +177,7 @@ private function initRouteMaps(): void
                 $defaults = $route->getDefaults();
                 $exploded = explode('::', $defaults['_controller']);
                 $controllerName = reset($exploded);
-                $fullClassName = (new ReflectionClass($controllerName))->getFileName();
+                $fullClassName = (new \ReflectionClass($controllerName))->getFileName();
 
                 $this->mapPathToRouteName[$route->getPath()][$this->normalizeMethod($method)] = $routeName;
                 $this->mapRouteNameToSourceFile[$routeName] = new FileResource($fullClassName);

diff --git a/Merger/Strategy/StrictMergeStrategy.php b/Merger/Strategy/StrictMergeStrategy.php
@@ -13,8 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Merger\Strategy;
 
-use RuntimeException;
-
 /**
  * @author Viktor Linkin <adrenalinkin@gmail.com>
  */
@@ -26,7 +24,7 @@ class StrictMergeStrategy extends AbstractMergeStrategy
     public function addParameter(string $parameterSource, string $name, array $data, bool $isRequired): void
     {
         if (isset($this->parameters[$name])) {
-            throw new RuntimeException(sprintf('Parameter "%s" has duplicate. Rename parameter or use another merger strategy', $name));
+            throw new \RuntimeException(sprintf('Parameter "%s" has duplicate. Rename parameter or use another merger strategy', $name));
         }
 
         if ($isRequired) {

diff --git a/Normalizer/BooleanNormalizer.php b/Normalizer/BooleanNormalizer.php
@@ -13,7 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Normalizer;
 
-use Closure;
 use EXSyst\Component\Swagger\Schema;
 use Linkin\Bundle\SwaggerResolverBundle\Enum\ParameterTypeEnum;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\NormalizationFailedException;
@@ -35,7 +34,7 @@ public function supports(Schema $propertySchema, string $propertyName, bool $isR
     /**
      * {@inheritdoc}
      */
-    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): Closure
+    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): \Closure
     {
         return static function (Options $options, $value) use ($isRequired, $propertyName) {
             if ('true' === $value || '1' === $value || 1 === $value || true === $value) {

diff --git a/Normalizer/IntegerNormalizer.php b/Normalizer/IntegerNormalizer.php
@@ -13,7 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Normalizer;
 
-use Closure;
 use EXSyst\Component\Swagger\Schema;
 use Linkin\Bundle\SwaggerResolverBundle\Enum\ParameterTypeEnum;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\NormalizationFailedException;
@@ -35,7 +34,7 @@ public function supports(Schema $propertySchema, string $propertyName, bool $isR
     /**
      * {@inheritdoc}
      */
-    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): Closure
+    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): \Closure
     {
         return static function (Options $options, $value) use ($isRequired, $propertyName) {
             if (is_numeric($value)) {

diff --git a/Normalizer/NumberNormalizer.php b/Normalizer/NumberNormalizer.php
@@ -13,7 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Normalizer;
 
-use Closure;
 use EXSyst\Component\Swagger\Schema;
 use Linkin\Bundle\SwaggerResolverBundle\Enum\ParameterTypeEnum;
 use Linkin\Bundle\SwaggerResolverBundle\Exception\NormalizationFailedException;
@@ -35,7 +34,7 @@ public function supports(Schema $propertySchema, string $propertyName, bool $isR
     /**
      * {@inheritdoc}
      */
-    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): Closure
+    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): \Closure
     {
         return static function (Options $options, $value) use ($isRequired, $propertyName) {
             if (is_numeric($value)) {

diff --git a/Normalizer/SwaggerNormalizerInterface.php b/Normalizer/SwaggerNormalizerInterface.php
@@ -13,7 +13,6 @@
 
 namespace Linkin\Bundle\SwaggerResolverBundle\Normalizer;
 
-use Closure;
 use EXSyst\Component\Swagger\Schema;
 
 /**
@@ -32,5 +31,5 @@ public function supports(Schema $propertySchema, string $propertyName, bool $isR
      *
      * Returns closure for normalizing property
      */
-    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): Closure;
+    public function getNormalizer(Schema $propertySchema, string $propertyName, bool $isRequired): \Closure;
 }
diff --git a/README.RU.md b/README.RU.md
@@ -215,6 +215,36 @@ $data = $swaggerResolver->resolve(json_decode($request->getContent(), true));
 класс, реализующий интерфейс [SwaggerNormalizerInterface](./Normalizer/SwaggerNormalizerInterface.php) и
 зарегистрировать его с тегом `linkin_swagger_resolver.normalizer`.
 
+### Запуск тестов и инструментов статического анализа
+Скачать проект:
+```bash
+git clone git@github.com:adrenalinkin/swagger-resolver-bundle.git
+cd swagger-resolver-bundle
+```
+
+Пройти [по инструкции](https://gist.github.com/adrenalinkin/35176a7b52b996666c4a36384fd536ad#file-an-instruction-md)
+для настройки простого docker контейнера.
+
+Установить Composer зависимости:
+```bash
+composer update
+```
+
+Для запуска тестов выполнить:
+```bash
+bin/simple-phpunit
+```
+
+Для запуска [PHP-CS-Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) выполнить:
+```bash
+php-cs-fixer fix --diff
+```
+
+Для запуска [composer-normalize](https://github.com/ergebnis/composer-normalize) выполнить:
+```bash
+composer-normalize --dry-run
+```
+
 Лицензия
 --------