Merge 2.x into 3.x

sonata-project · Dec 28, 2021 · 5c1657b · 5c1657b
2 parents a4d6e6f + 756e9c8
commit 5c1657b
Show file tree

Hide file tree

Showing 51 changed files with 228 additions and 99 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -3,3 +3,6 @@ parameters:
         - # Disallow VariableMethodCallRule and VariablePropertyFetchRule
             message: '#^Variable (method call|property access)#'
             path: .
+        - # https://github.com/phpstan/phpstan-strict-rules/issues/130
+            message: '#^Call to static method PHPUnit\\Framework\\Assert::.* will always evaluate to true\.$#'
+            path: tests/
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2,7 +2,7 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: 2
+    level: 5
     paths:
         - src
         - tests

diff --git a/psalm.xml b/psalm.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" errorLevel="8" findUnusedPsalmSuppress="true" resolveFromConfigFile="true" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd">
+<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" errorLevel="5" findUnusedPsalmSuppress="true" resolveFromConfigFile="true" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd">
     <projectFiles>
         <directory name="src"/>
         <directory name="tests"/>

diff --git a/src/Bridge/Symfony/Bundle/SonataExporterBundle.php b/src/Bridge/Symfony/Bundle/SonataExporterBundle.php
@@ -22,6 +22,7 @@
     ForwardCompatibleSonataExporterBundle::class
 ), \E_USER_DEPRECATED);
 
+// @phpstan-ignore-next-line
 if (false) {
     /**
      * NEXT_MAJOR: remove this class.

diff --git a/src/Source/AbstractPropertySourceIterator.php b/src/Source/AbstractPropertySourceIterator.php
@@ -63,7 +63,7 @@ public function __construct(array $fields, string $dateTimeFormat = 'r')
     }
 
     /**
-     * @return mixed
+     * @return array<string, mixed>
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -134,17 +134,15 @@ public function getDuration(\DateInterval $interval): string
 
     /**
      * @param object|mixed[] $current
+     *
+     * @return array<string, mixed>
      */
     protected function getCurrentData($current): array
     {
         $data = [];
         foreach ($this->fields as $key => $field) {
-            if (\is_string($field)) {
-                $name = \is_string($key) ? $key : $field;
-                $propertyPath = $field;
-            } else {
-                throw new \TypeError('Unsupported field type. Field should be a string.');
-            }
+            $name = \is_string($key) ? $key : $field;
+            $propertyPath = $field;
 
             try {
                 $propertyValue = $this->propertyAccessor->getValue($current, new PropertyPath($propertyPath));

diff --git a/src/Source/AbstractXmlSourceIterator.php b/src/Source/AbstractXmlSourceIterator.php
@@ -27,6 +27,8 @@ abstract class AbstractXmlSourceIterator implements SourceIteratorInterface
 
     /**
      * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     protected $file;
 
@@ -41,7 +43,7 @@ abstract class AbstractXmlSourceIterator implements SourceIteratorInterface
     protected $columns = [];
 
     /**
-     * @var resource|null
+     * @var \XMLParser|null
      */
     protected $parser;
 
@@ -178,7 +180,9 @@ final protected function parseRow(): void
         }
 
         $this->currentRowEnded = false;
+
         // read file until row is ended
+        // @phpstan-ignore-next-line: The currentRowEnded value is updated when parsing the data
         while (!$this->currentRowEnded && !feof($this->file)) {
             $data = fread($this->file, 1024);
             xml_parse($this->parser, $data);

diff --git a/src/Source/CsvSourceIterator.php b/src/Source/CsvSourceIterator.php
@@ -27,6 +27,8 @@ final class CsvSourceIterator implements SourceIteratorInterface
 
     /**
      * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 
@@ -50,11 +52,6 @@ final class CsvSourceIterator implements SourceIteratorInterface
      */
     private $hasHeaders;
 
-    /**
-     * @var array
-     */
-    private $lines = [];
-
     /**
      * @var array
      */
@@ -66,7 +63,7 @@ final class CsvSourceIterator implements SourceIteratorInterface
     private $position = 0;
 
     /**
-     * @var array
+     * @var array|false
      */
     private $currentLine = [];
 
@@ -85,7 +82,7 @@ public function __construct(
     }
 
     /**
-     * @return mixed
+     * @return array|false
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -94,7 +91,7 @@ public function current()
     }
 
     /**
-     * @return mixed
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function key()

diff --git a/src/Source/DoctrineDBALConnectionSourceIterator.php b/src/Source/DoctrineDBALConnectionSourceIterator.php
@@ -29,12 +29,12 @@ final class DoctrineDBALConnectionSourceIterator implements SourceIteratorInterf
     private $query;
 
     /**
-     * @var array
+     * @var mixed[]
      */
     private $parameters;
 
     /**
-     * @var mixed
+     * @var array<string, mixed>|false
      */
     private $current;
 
@@ -48,13 +48,20 @@ final class DoctrineDBALConnectionSourceIterator implements SourceIteratorInterf
      */
     private $result;
 
+    /**
+     * @param mixed[] $parameters
+     */
     public function __construct(Connection $connection, string $query, array $parameters = [])
     {
         $this->connection = $connection;
         $this->query = $query;
         $this->parameters = $parameters;
     }
 
+    /**
+     * @return array<string, mixed>|false
+     */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         return $this->current;
@@ -66,6 +73,10 @@ public function next(): void
         ++$this->position;
     }
 
+    /**
+     * @return int
+     */
+    #[\ReturnTypeWillChange]
     public function key()
     {
         return $this->position;
@@ -76,16 +87,21 @@ public function valid(): bool
         return \is_array($this->current);
     }
 
+    /**
+     * @psalm-suppress InvalidPropertyAssignmentValue
+     */
     public function rewind(): void
     {
         $statement = $this->connection->prepare($this->query);
 
-        // TODO: Keep only the if part when dropping support for Doctrine DBAL < 3.1
-        if (method_exists($statement, 'executeQuery')) {
-            $this->result = $statement->executeQuery($this->parameters);
-        } else {
-            $statement->execute($this->parameters);
+        $result = $statement->execute($this->parameters);
 
+        // TODO: Keep only the if part when dropping support for Doctrine DBAL < 3.1
+        // @phpstan-ignore-next-line
+        if ($result instanceof Result) {
+            $this->result = $result;
+        } else { // @phpstan-ignore-line
+            // @phpstan-ignore-next-line
             $this->result = $statement;
         }
 

diff --git a/src/Source/DoctrineODMQuerySourceIterator.php b/src/Source/DoctrineODMQuerySourceIterator.php
@@ -40,7 +40,7 @@ public function __construct(Query $query, array $fields, string $dateTimeFormat
     }
 
     /**
-     * @return mixed
+     * @return array<string, mixed>
      */
     public function current()
     {

diff --git a/src/Source/DoctrineORMQuerySourceIterator.php b/src/Source/DoctrineORMQuerySourceIterator.php
@@ -47,7 +47,7 @@ public function __construct(Query $query, array $fields, string $dateTimeFormat
     }
 
     /**
-     * @return mixed
+     * @return array<string, mixed>
      */
     public function current()
     {

diff --git a/src/Source/PDOStatementSourceIterator.php b/src/Source/PDOStatementSourceIterator.php
@@ -58,7 +58,7 @@ public function next(): void
     }
 
     /**
-     * @return mixed
+     * @return int
      */
     #[\ReturnTypeWillChange]
     public function key()

diff --git a/src/Source/SourceIteratorInterface.php b/src/Source/SourceIteratorInterface.php
@@ -16,9 +16,9 @@
 /**
  * NEXT_MAJOR: Remove this interface.
  *
- * @deprecated since 2.9 use \Iterator instead.
+ * @deprecated since sonata-project/exporter 2.9 use \Iterator instead.
  *
- * @phpstan-extends \Iterator<array<mixed>>
+ * @phpstan-extends \Iterator<mixed>
  */
 interface SourceIteratorInterface extends \Iterator
 {

diff --git a/src/Source/SymfonySitemapSourceIterator.php b/src/Source/SymfonySitemapSourceIterator.php
@@ -50,6 +50,9 @@ public function __construct(
         $this->parameters = $parameters;
     }
 
+    /**
+     * @return array
+     */
     public function current()
     {
         $data = $this->source->current();

diff --git a/src/Test/AbstractTypedWriterTestCase.php b/src/Test/AbstractTypedWriterTestCase.php
@@ -18,6 +18,10 @@
 
 /**
  * @author Grégoire Paris <postmaster@greg0ire.fr>
+ *
+ * NEXT_MAJOR: Remove this class.
+ *
+ * @deprecated since sonata-project/exporter 2.x, to be removed in version 3.0.
  */
 abstract class AbstractTypedWriterTestCase extends TestCase
 {
@@ -33,11 +37,13 @@ protected function setUp(): void
 
     final public function testFormatIsString(): void
     {
+        // @phpstan-ignore-next-line
         static::assertIsString($this->writer->getFormat());
     }
 
     final public function testDefaultMimeTypeIsString(): void
     {
+        // @phpstan-ignore-next-line
         static::assertIsString($this->writer->getDefaultMimeType());
     }
 

diff --git a/src/Writer/CsvWriter.php b/src/Writer/CsvWriter.php
@@ -41,7 +41,9 @@ final class CsvWriter implements TypedWriterInterface
     private $escape;
 
     /**
-     * @var resource
+     * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 

diff --git a/src/Writer/GsaFeedWriter.php b/src/Writer/GsaFeedWriter.php
@@ -49,6 +49,8 @@ final class GsaFeedWriter implements WriterInterface
 
     /**
      * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $buffer;
 

diff --git a/src/Writer/JsonWriter.php b/src/Writer/JsonWriter.php
@@ -24,7 +24,9 @@ final class JsonWriter implements TypedWriterInterface
     private $filename;
 
     /**
-     * @var resource
+     * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 

diff --git a/src/Writer/SitemapWriter.php b/src/Writer/SitemapWriter.php
@@ -43,6 +43,8 @@ final class SitemapWriter implements WriterInterface
 
     /**
      * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $buffer;
 

diff --git a/src/Writer/XlsWriter.php b/src/Writer/XlsWriter.php
@@ -24,7 +24,9 @@ final class XlsWriter implements TypedWriterInterface
     private $filename;
 
     /**
-     * @var resource
+     * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 

diff --git a/src/Writer/XmlExcelWriter.php b/src/Writer/XmlExcelWriter.php
@@ -27,6 +27,8 @@ final class XmlExcelWriter implements WriterInterface
 
     /**
      * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 

diff --git a/src/Writer/XmlWriter.php b/src/Writer/XmlWriter.php
@@ -27,15 +27,12 @@ final class XmlWriter implements TypedWriterInterface
     private $filename;
 
     /**
-     * @var resource
+     * @var resource|null
+     * @phpstan-var resource|null
+     * @psalm-var resource|closed-resource|null
      */
     private $file;
 
-    /**
-     * @var int
-     */
-    private $position = 0;
-
     /**
      * @var string
      */

diff --git a/tests/Bridge/Symfony/DependencyInjection/ConfigurationTest.php b/tests/Bridge/Symfony/DependencyInjection/ConfigurationTest.php
@@ -17,7 +17,7 @@
 use PHPUnit\Framework\TestCase;
 use Sonata\Exporter\Bridge\Symfony\DependencyInjection\Configuration;
 
-class ConfigurationTest extends TestCase
+final class ConfigurationTest extends TestCase
 {
     use ConfigurationTestCaseTrait;
 

diff --git a/tests/Bridge/Symfony/DependencyInjection/ExporterCompilerPassTest.php b/tests/Bridge/Symfony/DependencyInjection/ExporterCompilerPassTest.php
@@ -19,7 +19,7 @@
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
-class ExporterCompilerPassTest extends AbstractCompilerPassTestCase
+final class ExporterCompilerPassTest extends AbstractCompilerPassTestCase
 {
     public function testWritersAreAddedToTheExporter(): void
     {

diff --git a/tests/Bridge/Symfony/DependencyInjection/SonataExporterExtensionTest.php b/tests/Bridge/Symfony/DependencyInjection/SonataExporterExtensionTest.php
@@ -16,7 +16,7 @@
 use Matthias\SymfonyDependencyInjectionTest\PhpUnit\AbstractExtensionTestCase;
 use Sonata\Exporter\Bridge\Symfony\DependencyInjection\SonataExporterExtension;
 
-class SonataExporterExtensionTest extends AbstractExtensionTestCase
+final class SonataExporterExtensionTest extends AbstractExtensionTestCase
 {
     public function testExporterServiceIsPresent(): void
     {