yokai-php · yann-eugone · Jun 5, 2023 · Jun 4, 2023 · Jun 4, 2023 · Jun 4, 2023
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -57,8 +57,8 @@ jobs:
         with:
           php-version: '8.2'
           symfony-version: '6.2.*'
-      - name: "Run checkstyle with squizlabs/php_codesniffer"
-        run: vendor/bin/phpcs
+      - name: "Run checkstyle with symplify/easy-coding-standard"
+        run: vendor/bin/ecs
 
   conventions:
     name: "Conventions"

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 /.idea/
-/.phpcs-cache
 /.phpunit.result.cache
 /tests/.artifacts/
 /tests/symfony/var/

diff --git a/composer.json b/composer.json
@@ -37,10 +37,10 @@
     "phpspec/prophecy-phpunit": "^2.0",
     "phpstan/phpstan": "^1.4",
     "phpunit/phpunit": "^9.5",
-    "squizlabs/php_codesniffer": "^3.6",
     "symfony/filesystem": "^5.0|^6.0",
     "symfony/finder": "^5.0|^6.0",
-    "symfony/process": "^5.0|^6.0"
+    "symfony/process": "^5.0|^6.0",
+    "symplify/easy-coding-standard": "^11.3"
   },
   "replace": {
     "yokai/batch": "self.version",

diff --git a/ecs.php b/ecs.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
+use PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer;
+use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayListItemNewlineFixer;
+use Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer;
+use Symplify\CodingStandard\Fixer\ArrayNotation\StandaloneLineInMultilineArrayFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests/convention',
+        __DIR__ . '/tests/integration',
+        __DIR__ . '/tests/symfony/src',
+        __DIR__ . '/tests/symfony/tests',
+    ]);
+
+    $ecsConfig->sets([
+        SetList::ARRAY,
+        SetList::DOCBLOCK,
+        SetList::NAMESPACES,
+        SetList::COMMENTS,
+        SetList::STRICT,
+        SetList::PSR_12,
+    ]);
+
+    $ecsConfig->skip([
+        /* Do not force array on multiple lines : ['foo' => $foo, 'bar' => $bar] */
+        ArrayOpenerAndCloserNewlineFixer::class,
+        ArrayListItemNewlineFixer::class,
+        StandaloneLineInMultilineArrayFixer::class,
+    ]);
+
+    $ecsConfig->ruleWithConfiguration(ForbiddenFunctionsSniff::class, [
+        'forbiddenFunctions' => ['dump' => null, 'dd' => null, 'var_dump' => null, 'die' => null],
+    ]);
+    $ecsConfig->ruleWithConfiguration(FunctionDeclarationFixer::class, [
+        'closure_fn_spacing' => 'none',
+    ]);
+};
diff --git a/phpcs.xml b/phpcs.xml
diff --git a/scripts/tests b/scripts/tests
@@ -16,7 +16,7 @@ install () {
 }
 
 install "php82" "6.2.*"
-led in -s php82 -- vendor/bin/phpcs
+led in -s php82 -- vendor/bin/ecs
 led in -s php82 -- vendor/bin/phpstan analyze
 led in -s php82 -- vendor/bin/phpunit --testsuite=Convention
 

diff --git a/src/batch-box-spout/src/Reader/FlatFileReader.php b/src/batch-box-spout/src/Reader/FlatFileReader.php
@@ -36,9 +36,6 @@ public function __construct(
         $this->headerStrategy = $headerStrategy ?? HeaderStrategy::skip();
     }
 
-    /**
-     * @inheritDoc
-     */
     public function read(): iterable
     {
         /** @var string $path */

diff --git a/src/batch-box-spout/src/Reader/Options/CSVOptions.php b/src/batch-box-spout/src/Reader/Options/CSVOptions.php
@@ -22,9 +22,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritdoc
-     */
     public function configure(ReaderInterface $reader): void
     {
         if (!$reader instanceof CSVReader) {
@@ -38,9 +35,6 @@ public function configure(ReaderInterface $reader): void
         $reader->setShouldPreserveEmptyRows($this->preserveEmptyRows);
     }
 
-    /**
-     * @inheritdoc
-     */
     public function getSheets(ReaderInterface $reader): iterable
     {
         return $reader->getSheetIterator();

diff --git a/src/batch-box-spout/src/Reader/Options/ODSOptions.php b/src/batch-box-spout/src/Reader/Options/ODSOptions.php
@@ -23,9 +23,6 @@ public function __construct(
         $this->sheetFilter = $sheetFilter ?? SheetFilter::all();
     }
 
-    /**
-     * @inheritDoc
-     */
     public function configure(ReaderInterface $reader): void
     {
         if (!$reader instanceof ODSReader) {
@@ -36,9 +33,6 @@ public function configure(ReaderInterface $reader): void
         $reader->setShouldPreserveEmptyRows($this->preserveEmptyRows);
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getSheets(ReaderInterface $reader): iterable
     {
         yield from $this->sheetFilter->getSheets($reader);

diff --git a/src/batch-box-spout/src/Reader/Options/XLSXOptions.php b/src/batch-box-spout/src/Reader/Options/XLSXOptions.php
@@ -23,9 +23,6 @@ public function __construct(
         $this->sheetFilter = $sheetFilter ?? SheetFilter::all();
     }
 
-    /**
-     * @inheritDoc
-     */
     public function configure(ReaderInterface $reader): void
     {
         if (!$reader instanceof XLSXReader) {
@@ -36,9 +33,6 @@ public function configure(ReaderInterface $reader): void
         $reader->setShouldPreserveEmptyRows($this->preserveEmptyRows);
     }
 
-    /**
-     * @inheritDoc
-     */
     public function getSheets(ReaderInterface $reader): iterable
     {
         yield from $this->sheetFilter->getSheets($reader);

diff --git a/src/batch-box-spout/src/Writer/FlatFileWriter.php b/src/batch-box-spout/src/Writer/FlatFileWriter.php
@@ -46,9 +46,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function initialize(): void
     {
         /** @var string $path */
@@ -67,9 +64,6 @@ public function initialize(): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function write(iterable $items): void
     {
         $writer = $this->writer;
@@ -102,9 +96,6 @@ public function write(iterable $items): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function flush(): void
     {
         if ($this->writer === null) {

diff --git a/src/batch-box-spout/src/Writer/Options/CSVOptions.php b/src/batch-box-spout/src/Writer/Options/CSVOptions.php
@@ -20,9 +20,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritdoc
-     */
     public function configure(WriterInterface $writer): void
     {
         if (!$writer instanceof CSVWriter) {

diff --git a/src/batch-box-spout/src/Writer/Options/ODSOptions.php b/src/batch-box-spout/src/Writer/Options/ODSOptions.php
@@ -20,9 +20,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function configure(WriterInterface $writer): void
     {
         if (!$writer instanceof ODSWriter) {

diff --git a/src/batch-box-spout/src/Writer/Options/XLSXOptions.php b/src/batch-box-spout/src/Writer/Options/XLSXOptions.php
@@ -20,9 +20,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function configure(WriterInterface $writer): void
     {
         if (!$writer instanceof XLSXWriter) {

diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALInsertWriter.php b/src/batch-doctrine-dbal/src/DoctrineDBALInsertWriter.php
@@ -29,9 +29,6 @@ public function __construct(
         $this->connection = $connection;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function write(iterable $items): void
     {
         foreach ($items as $item) {

diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php b/src/batch-doctrine-dbal/src/DoctrineDBALJobExecutionStorage.php
@@ -69,9 +69,6 @@ public function createSchema(): void
         $this->connection->getConfiguration()->setSchemaAssetsFilter($assetFilter);
     }
 
-    /**
-     * @inheritDoc
-     */
     public function store(JobExecution $execution): void
     {
         try {
@@ -94,9 +91,6 @@ public function store(JobExecution $execution): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function remove(JobExecution $execution): void
     {
         try {
@@ -106,9 +100,6 @@ public function remove(JobExecution $execution): void
         }
     }
 
-    /**
-     * @inheritDoc
-     */
     public function retrieve(string $jobName, string $executionId): JobExecution
     {
         try {
@@ -120,9 +111,6 @@ public function retrieve(string $jobName, string $executionId): JobExecution
         return $this->fromRow($row);
     }
 
-    /**
-     * @inheritDoc
-     */
     public function list(string $jobName): iterable
     {
         $qb = $this->connection->createQueryBuilder();
@@ -133,9 +121,6 @@ public function list(string $jobName): iterable
         yield from $this->queryList($qb->getSQL(), ['jobName' => $jobName], ['jobName' => Types::STRING]);
     }
 
-    /**
-     * @inheritDoc
-     */
     public function query(Query $query): iterable
     {
         $queryParameters = [];

diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALQueryCursorReader.php b/src/batch-doctrine-dbal/src/DoctrineDBALQueryCursorReader.php
@@ -55,7 +55,6 @@ public function __construct(
     }
 
     /**
-     * @inheritdoc
      * @phpstan-return Generator<array<string, string>>
      */
     public function read(): Generator

diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALQueryOffsetReader.php b/src/batch-doctrine-dbal/src/DoctrineDBALQueryOffsetReader.php
@@ -43,7 +43,6 @@ public function __construct(ConnectionRegistry $doctrine, string $sql, string $c
     }
 
     /**
-     * @inheritdoc
      * @phpstan-return Generator<array<string, string>>
      */
     public function read(): Generator

diff --git a/src/batch-doctrine-dbal/src/DoctrineDBALUpsertWriter.php b/src/batch-doctrine-dbal/src/DoctrineDBALUpsertWriter.php
@@ -33,9 +33,6 @@ public function __construct(ConnectionRegistry $doctrine, string $connection = n
         $this->connection = $connection;
     }
 
-    /**
-     * @inheritdoc
-     */
     public function write(iterable $items): void
     {
         foreach ($items as $item) {

diff --git a/src/batch-doctrine-dbal/tests/DoctrineDBALInsertWriterTest.php b/src/batch-doctrine-dbal/tests/DoctrineDBALInsertWriterTest.php
@@ -5,7 +5,6 @@
 namespace Yokai\Batch\Tests\Bridge\Doctrine\DBAL;
 
 use Doctrine\DBAL\Types\Types;
-use Generator;
 use Yokai\Batch\Bridge\Doctrine\DBAL\DoctrineDBALInsertWriter;
 use Yokai\Batch\Exception\UnexpectedValueException;
 

diff --git a/src/batch-doctrine-dbal/tests/DoctrineDBALJobExecutionStorageTest.php b/src/batch-doctrine-dbal/tests/DoctrineDBALJobExecutionStorageTest.php
@@ -5,7 +5,6 @@
 namespace Yokai\Batch\Tests\Bridge\Doctrine\DBAL;
 
 use DateTimeImmutable;
-use Exception;
 use Generator;
 use RuntimeException;
 use Throwable;
@@ -227,23 +226,23 @@ public function retrieveInvalid(): \Generator
     {
         yield '"parameters" column value is expected to be array' => [
             ['parameters' => '"string"'],
-            UnexpectedValueException::type('array', 'string')
+            UnexpectedValueException::type('array', 'string'),
         ];
         yield '"summary" column value is expected to be array' => [
             ['summary' => '"string"'],
-            UnexpectedValueException::type('array', 'string')
+            UnexpectedValueException::type('array', 'string'),
         ];
         yield '"failures" column value is expected to be array' => [
             ['failures' => '"string"'],
-            UnexpectedValueException::type('array', 'string')
+            UnexpectedValueException::type('array', 'string'),
         ];
         yield '"warnings" column value is expected to be array' => [
             ['warnings' => '"string"'],
-            UnexpectedValueException::type('array', 'string')
+            UnexpectedValueException::type('array', 'string'),
         ];
         yield '"child_executions" column value is expected to be array' => [
             ['child_executions' => '"string"'],
-            UnexpectedValueException::type('array', 'string')
+            UnexpectedValueException::type('array', 'string'),
         ];
     }
 

diff --git a/src/batch-doctrine-orm/src/EntityReader.php b/src/batch-doctrine-orm/src/EntityReader.php
@@ -23,9 +23,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function read(): iterable
     {
         $manager = $this->doctrine->getManagerForClass($this->class);

diff --git a/src/batch-doctrine-persistence/src/ObjectWriter.php b/src/batch-doctrine-persistence/src/ObjectWriter.php
@@ -30,9 +30,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @inheritDoc
-     */
     public function write(iterable $items): void
     {
         foreach ($items as $item) {

diff --git a/src/batch-league-flysystem/src/Job/CopyFilesJob.php b/src/batch-league-flysystem/src/Job/CopyFilesJob.php
@@ -39,7 +39,7 @@ final public function execute(JobExecution $jobExecution): void
             throw UnexpectedValueException::type('string|string[]', $config);
         }
 
-        $transformLocation = $this->transformLocation ?? fn ($sourceLocation) => $sourceLocation;
+        $transformLocation = $this->transformLocation ?? fn($sourceLocation) => $sourceLocation;
         foreach ($locations as $sourceLocation) {
             $destinationLocation = $transformLocation($sourceLocation);
             if (!\is_string($destinationLocation)) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,9 +20,6 @@ public function __construct( @@
         ) {
         }
-        /**
-         * @inheritdoc
-         */
         public function configure(WriterInterface $writer): void
         {
             if (!$writer instanceof CSVWriter) {
@@ Expand Down @@