Merge pull request #23 from Fabricio872/feature/upgrade-packages

fixed deprecations dropped support for php older than 8.1

.github/workflows/php-composer.yml

@@ -31,4 +31,4 @@ jobs:
       run: composer install --prefer-dist --no-progress
 
     - name: Run psr-12 test
-      run: composer run-script test-psr
+      run: composer run-script cs

composer.json

@@ -11,20 +11,24 @@
         }
     ],
     "require": {
-        "php": "^7.3|^8.0",
+        "php": "^8.1",
         "doctrine/annotations": "^1.13|^2.0",
         "doctrine/orm": "^2.9",
         "symfony/config": "^4.4|^5|^6.0",
         "symfony/console": "^4.4|^5|^6.0",
         "symfony/dependency-injection": "^4.4|^5|^6.0",
+        "symfony/dotenv": "^4.4|^5|^6.0",
         "symfony/http-kernel": "^4.4|^5|^6.0",
         "symfony/security-bundle": "^4.4|^5|^6.0",
         "symfony/serializer": "^4.4|^5|^6.0",
         "symfony/validator": "^4.4|^5|^6.0"
     },
     "require-dev": {
+        "phpstan/extension-installer": "^1.2",
+        "phpstan/phpstan": "^1.9",
+        "rector/rector": "^0.15.16",
         "symfony/phpunit-bridge": "^4.4|^5|^6.0",
-        "symplify/easy-coding-standard": "^9.4"
+        "symplify/easy-coding-standard": "^11.2.8"
     },
     "config": {
         "optimize-autoloader": true,
@@ -33,7 +37,8 @@
         },
         "sort-packages": true,
         "allow-plugins": {
-            "composer/package-versions-deprecated": true
+            "composer/package-versions-deprecated": true,
+            "phpstan/extension-installer": true
         }
     },
     "autoload": {
@@ -47,7 +52,19 @@
         }
     },
     "scripts": {
-        "test-psr": "vendor/bin/ecs check src",
-        "fix-psr": "vendor/bin/ecs check src --fix"
+        "cs": [
+            "@ecs",
+            "@rector",
+            "@phpstan"
+        ],
+        "cs-fix": [
+            "@ecs-fix",
+            "@rector-fix"
+        ],
+        "ecs": "vendor/bin/ecs check",
+        "ecs-fix": "vendor/bin/ecs check --fix",
+        "rector": "vendor/bin/rector process --dry-run",
+        "rector-fix": "vendor/bin/rector process",
+        "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon"
     }
 }

ecs.php

@@ -3,23 +3,25 @@
 declare(strict_types=1);
 
 use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
-use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
-use Symplify\EasyCodingStandard\ValueObject\Option;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
-return static function (ContainerConfigurator $containerConfigurator): void {
-    $parameters = $containerConfigurator->parameters();
-    $parameters->set(Option::PATHS, [
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
         __DIR__ . '/src',
-        __DIR__ . '/tests',
+        __DIR__ . '/ecs.php',
+        __DIR__ . '/rector.php',
     ]);
 
-    $services = $containerConfigurator->services();
-    $services->set(ArraySyntaxFixer::class)
-        ->call('configure', [[
-            'syntax' => 'short',
-        ]]);
+    // B. standalone rule
+    $ecsConfig->ruleWithConfiguration(ArraySyntaxFixer::class, [
+        'syntax' => 'short',
+    ]);
 
-    $containerConfigurator->import(SetList::ARRAY);
-    $containerConfigurator->import(SetList::PSR_12);
+    $ecsConfig->sets([
+        SetList::SPACES,
+        SetList::PSR_12,
+        SetList::CLEAN_CODE,
+        SetList::STRICT,
+    ]);
 };

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+	level: 5
+	paths:
+		- src
+	excludePaths:
+	    - src/DependencyInjection/Configuration

rector.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\Set\DoctrineSetList;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Symfony\Set\SensiolabsSetList;
+use Rector\Symfony\Set\SymfonySetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/ecs.php',
+        __DIR__ . '/rector.php',
+    ]);
+
+    // register a single rule
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    // define sets of rules
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_81,
+    ]);
+
+    $rectorConfig->sets([
+        DoctrineSetList::ANNOTATIONS_TO_ATTRIBUTES,
+        SymfonySetList::ANNOTATIONS_TO_ATTRIBUTES,
+        SensiolabsSetList::FRAMEWORK_EXTRA_61,
+    ]);
+
+    $rectorConfig->importNames();
+};

src/Annotations/RegisterCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Fabricio872\RegisterCommand\Annotations;
 
 use Attribute;
@@ -22,7 +24,7 @@ class RegisterCommand
 
     /**
      * Question that has to be asked user
-     * @var string
+     * @var ?string
      */
     public $question;
 
@@ -78,14 +80,14 @@ class RegisterCommand
     public function __construct(
         ?string $field = null,
         ?string $question = null,
-        ?array  $options = null,
-        bool   $userIdentifier = false,
-        ?bool   $valueBoolean = null,
+        ?array $options = null,
+        bool $userIdentifier = false,
+        ?bool $valueBoolean = null,
         ?string $valueString = null,
         ?string $valuePassword = null,
-        ?array  $valueArray = null,
-        ?int    $valueInt = null,
-        ?float  $valueFloat = null,
+        ?array $valueArray = null,
+        ?int $valueInt = null,
+        ?float $valueFloat = null,
         ?string $valueDateTime = null
     ) {
         $this->field = $field;

src/Command/AbstractList.php

@@ -1,10 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Fabricio872\RegisterCommand\Command;
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\ORM\EntityManagerInterface;
+use Exception;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -19,30 +22,37 @@ abstract class AbstractList extends Command
 {
     /** @var string */
     protected $userClassName;
-    /** @var int */
-    private $tableLimit;
-    /** @var int */
-    private $maxColWidth;
+
     /** @var InputInterface */
     protected $input;
+
     /** @var OutputInterface */
     protected $output;
+
     /** @var SymfonyStyle */
     protected $io;
+
     /** @var EntityManagerInterface */
     protected $em;
+
     /** @var int */
     protected $colWidth;
+
     /** @var int */
     protected $totalUsers;
+
     /** @var int */
     protected $limitUsers;
+
     /** @var int */
     protected $currentPage = 0;
+
     /** @var UserPasswordHasherInterface */
     protected $passwordEncoder;
+
     /** @var Reader */
     protected $reader;
+
     /** @var ValidatorInterface */
     protected $validator;
 
@@ -54,15 +64,13 @@ abstract class AbstractList extends Command
      */
     public function __construct(
         string $userClassName,
-        int $tableLimit,
-        int $maxColWidth,
+        private readonly int $tableLimit,
+        private readonly int $maxColWidth,
         EntityManagerInterface $em,
         UserPasswordHasherInterface $passwordEncoder,
         ValidatorInterface $validator
     ) {
         $this->userClassName = $userClassName;
-        $this->tableLimit = $tableLimit;
-        $this->maxColWidth = $maxColWidth;
         $this->em = $em;
         $this->passwordEncoder = $passwordEncoder;
         $this->reader = new AnnotationReader();
@@ -82,14 +90,13 @@ protected function configure()
      * @param InputInterface $input
      * @param OutputInterface $output
      * @return int
-     * @throws \Exception
+     * @throws Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->input = $input;
         $this->output = $output;
         $this->io = new SymfonyStyle($this->input, $this->output);
-        /** @var int $colWidth */
         $this->colWidth = $this->input->getOption('col-width');
 
         $this->totalUsers = $this->em
@@ -98,38 +105,31 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $this->limitUsers = $this->input->getOption('limit');
 
-        if ($this->totalUsers == 0) {
+        if ($this->totalUsers === 0) {
             $this->io->warning("User Table is empty");
             return 0;
         }
 
         $userClass = new $this->userClassName();
-        if (!$userClass instanceof UserInterface) {
-            throw new \Exception("Provided user must implement " . UserInterface::class);
+        if (! $userClass instanceof UserInterface) {
+            throw new Exception("Provided user must implement " . UserInterface::class);
         }
 
         return $this->draw(null);
     }
 
-    /**
-     * @return string
-     */
     protected function askPage(): string
     {
         return $this->io->ask('page', ($this->currentPage < $this->getTotalPages()) ? $this->currentPage + 1 : 'q');
     }
 
-    /**
-     * @return false|float
-     */
-    protected function getTotalPages()
+    protected function getTotalPages(): false|float
     {
         return ceil($this->totalUsers / $this->limitUsers);
     }
 
     /**
      * @param int $page
-     * @return int
      */
     abstract protected function draw(?int $page): int;
 }

src/Command/UserListCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Fabricio872\RegisterCommand\Command;
 
 use Fabricio872\RegisterCommand\Services\ArrayToTable;
@@ -11,9 +13,11 @@
 class UserListCommand extends AbstractList
 {
     protected static $defaultName = 'user:list';
+
     protected static $defaultDescription = 'List all existing users';
+
     /** @var array|object[] */
-    private $userList;
+    private ?array $userList = null;
 
     protected function configure()
     {
@@ -67,15 +71,14 @@ protected function draw(?int $page): int
 
     /**
      * @param $page
-     * @return int|null
      */
     protected function getPage($page): ?int
     {
-        if (strtolower($page) == 'q') {
+        if (strtolower((string) $page) === 'q') {
             $this->io->writeln('Bye (=◉ᆽ◉=)');
             return null;
         }
-        if (strtolower($page) == 'e') {
+        if (strtolower((string) $page) === 'e') {
             /** @var UserEditorInterface $userEditor */
             $userEditor = new UserEditor(
                 $this->input,
@@ -88,7 +91,7 @@ protected function getPage($page): ?int
             $userEditor->drawEdiTable();
             return $this->getPage($this->askPage());
         }
-        if (!is_numeric($page)) {
+        if (! is_numeric($page)) {
             $this->io->writeln('Bad input');
             return $this->getPage($this->askPage());
         }