#11 code review changes

- added cs-fixer rule for strict types
qossmic · Apr 4, 2024 · 4351e75 · 4351e75
1 parent 5c1aa72
commit 4351e75
Show file tree

Hide file tree

Showing 24 changed files with 54 additions and 12 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -10,6 +10,7 @@
     ->setRules([
     '@Symfony' => true,
     '@Symfony:risky' => true,
+    '@PHP80Migration:risky' => true,
     'array_syntax' => ['syntax' => 'short'],
     'yoda_style' => false,
 ])

diff --git a/config/documentation.php b/config/documentation.php
@@ -15,25 +15,30 @@
 use Qossmic\TwigDocBundle\Service\ComponentService;
 use Qossmic\TwigDocBundle\Twig\TwigDocExtension;
 
-return static function (ContainerConfigurator $container) {
-    $container->services()->set('twig_doc.controller.documentation', TwigDocController::class)
+return static function (ContainerConfigurator $container): void {
+    $container->services()
+        ->set('twig_doc.controller.documentation', TwigDocController::class)
         ->public()
         ->arg('$twig', service('twig'))
         ->arg('$componentService', service('twig_doc.service.component'))
         ->arg('$profiler', service('profiler')->nullOnInvalid())
+
         ->set('twig_doc.service.category', CategoryService::class)
         ->alias(CategoryService::class, 'twig_doc.service.category')
+
         ->set('twig_doc.service.component_factory', ComponentItemFactory::class)
         ->public()
         ->arg('$validator', service('validator'))
         ->arg('$categoryService', service('twig_doc.service.category'))
         ->arg('$faker', service('twig_doc.service.faker'))
         ->alias(ComponentItemFactory::class, 'twig_doc.service.component_factory')
+
         ->set('twig_doc.service.component', ComponentService::class)
         ->public()
         ->arg('$itemFactory', service('twig_doc.service.component_factory'))
         ->arg('$cache', service('cache.app'))
         ->alias(ComponentService::class, 'twig_doc.service.component')
+
         ->set('twig_doc.twig.extension', TwigDocExtension::class)
         ->public()
         ->arg('$componentRenderer', service('ux.twig_component.component_renderer')->nullOnInvalid())
@@ -42,6 +47,7 @@
         ->arg('$twig', service('twig'))
         ->tag('twig.extension')
         ->alias(TwigDocExtension::class, 'twig_doc.twig.extension')
+
         ->set('twig_doc.cache_warmer', ComponentsWarmer::class)
         ->arg('$container', service('service_container'))
         ->tag('kernel.cache_warmer')
@@ -54,6 +60,7 @@
         ->set('twig_doc.data_generator.scalar', ScalarGenerator::class)
         ->public()
         ->tag('twig_doc.data_generator', ['priority' => -5])
+
         ->set('twig_doc.data_generator.fixture', FixtureGenerator::class)
         ->public()
         ->tag('twig_doc.data_generator', ['priority' => -10])

diff --git a/src/Component/ComponentItemList.php b/src/Component/ComponentItemList.php
@@ -83,9 +83,7 @@ static function (ComponentItem $item) use ($query) {
                 break;
             case 'tags':
                 $tags = array_map('trim', explode(',', strtolower($query)));
-                $components = array_filter($this->getArrayCopy(), static function (ComponentItem $item) use ($tags) {
-                    return array_intersect($tags, array_map('strtolower', $item->getTags())) !== [];
-                });
+                $components = array_filter($this->getArrayCopy(), static fn (ComponentItem $item) => array_intersect($tags, array_map('strtolower', $item->getTags())) !== []);
 
                 break;
             case 'name':

diff --git a/src/Component/Data/Faker.php b/src/Component/Data/Faker.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data;
 
 /**

diff --git a/src/Component/Data/FixtureData.php b/src/Component/Data/FixtureData.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data;
 
 use Symfony\Component\PropertyInfo\Type;

diff --git a/src/Component/Data/Generator/FixtureGenerator.php b/src/Component/Data/Generator/FixtureGenerator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data\Generator;
 
 use Nelmio\Alice\Loader\NativeLoader;

diff --git a/src/Component/Data/Generator/NullGenerator.php b/src/Component/Data/Generator/NullGenerator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data\Generator;
 
 use Qossmic\TwigDocBundle\Component\Data\GeneratorInterface;

diff --git a/src/Component/Data/Generator/ScalarGenerator.php b/src/Component/Data/Generator/ScalarGenerator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data\Generator;
 
 use Faker\Factory;
@@ -48,7 +50,7 @@ public function createParamValue(string $type): bool|int|float|string|null
                 return $this->generator->numberBetween(0, 100000);
             case 'bool':
             case 'boolean':
-                return [true, false][rand(0, 1)];
+                return [true, false][random_int(0, 1)];
             case 'float':
             case 'double':
                 return $this->generator->randomFloat();

diff --git a/src/Component/Data/GeneratorInterface.php b/src/Component/Data/GeneratorInterface.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Component\Data;
 
 interface GeneratorInterface

diff --git a/src/Service/ComponentService.php b/src/Service/ComponentService.php
@@ -56,9 +56,7 @@ public function filter(string $filterQuery, string $filterType): ComponentItemLi
     {
         $hash = sprintf('twig_doc_bundle.search.%s.%s', md5($filterQuery.$filterType), $this->configReadTime);
 
-        return $this->cache->get($hash, function () use ($filterQuery, $filterType) {
-            return $this->getComponents()->filter($filterQuery, $filterType);
-        });
+        return $this->cache->get($hash, fn () => $this->getComponents()->filter($filterQuery, $filterType));
     }
 
     /**

diff --git a/tests/TestApp/Component/Data/Generator/CustomGenerator.php b/tests/TestApp/Component/Data/Generator/CustomGenerator.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\TestApp\Component\Data\Generator;
 
 use Qossmic\TwigDocBundle\Component\Data\GeneratorInterface;

diff --git a/tests/TestApp/Entity/Car.php b/tests/TestApp/Entity/Car.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\TestApp\Entity;
 
 class Car

diff --git a/tests/TestApp/Entity/Manufacturer.php b/tests/TestApp/Entity/Manufacturer.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\TestApp\Entity;
 
 class Manufacturer

diff --git a/tests/TestApp/Entity/Special.php b/tests/TestApp/Entity/Special.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\TestApp\Entity;
 
 class Special

diff --git a/tests/TestApp/config/packages/framework.php b/tests/TestApp/config/packages/framework.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 $configuration = [
     'secret' => 'F00',
     'session' => [

diff --git a/tests/TestApp/config/packages/twig.php b/tests/TestApp/config/packages/twig.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 $container->loadFromExtension('twig', [
     'default_path' => '%kernel.project_dir%/tests/TestApp/templates',
 ]);
diff --git a/tests/TestApp/config/packages/twig_doc.php b/tests/TestApp/config/packages/twig_doc.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 $config = [
     'directories' => [
         '%twig.default_path%/snippets',

diff --git a/tests/TestApp/config/services.php b/tests/TestApp/config/services.php
@@ -1,9 +1,11 @@
 <?php
 
+declare(strict_types=1);
+
 use Psr\Log\NullLogger;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 
-return static function (ContainerConfigurator $container) {
+return static function (ContainerConfigurator $container): void {
     $container->services()
         ->defaults()
             ->autowire()

diff --git a/tests/Unit/Component/ComponentItemFactoryTest.php b/tests/Unit/Component/ComponentItemFactoryTest.php
@@ -47,7 +47,7 @@ public function testValidComponent(array $componentData): void
         static::assertInstanceOf(ComponentCategory::class, $item->getCategory());
     }
 
-    public function testInvalidCategory()
+    public function testInvalidCategory(): void
     {
         $this->expectException(InvalidComponentConfigurationException::class);
 

diff --git a/tests/Unit/Component/Data/FakerTest.php b/tests/Unit/Component/Data/FakerTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\Unit\Component\Data;
 
 use PHPUnit\Framework\Attributes\CoversClass;

diff --git a/tests/Unit/Component/Data/Generator/FixtureGeneratorTest.php b/tests/Unit/Component/Data/Generator/FixtureGeneratorTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\Unit\Component\Data\Generator;
 
 use PHPUnit\Framework\Attributes\CoversClass;

diff --git a/tests/Unit/Component/Data/Generator/NullGeneratorTest.php b/tests/Unit/Component/Data/Generator/NullGeneratorTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\Unit\Component\Data\Generator;
 
 use PHPUnit\Framework\Attributes\CoversClass;

diff --git a/tests/Unit/Component/Data/Generator/ScalarGeneratorTest.php b/tests/Unit/Component/Data/Generator/ScalarGeneratorTest.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Qossmic\TwigDocBundle\Tests\Unit\Component\Data\Generator;
 
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -13,7 +15,7 @@
 class ScalarGeneratorTest extends TestCase
 {
     #[DataProvider('getSupportsTestCases')]
-    public function testSupports(string $type, mixed $context, bool $expected)
+    public function testSupports(string $type, mixed $context, bool $expected): void
     {
         $generator = new ScalarGenerator();
 

diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Qossmic\TwigDocBundle\Tests\TestApp\Kernel;
 use Symfony\Component\Filesystem\Filesystem;