Merge 2.x into 3.x

sonata-project · Jan 4, 2022 · 75ff542 · 75ff542
2 parents 5c1657b + bea28f5
commit 75ff542
Show file tree

Hide file tree

Showing 19 changed files with 66 additions and 62 deletions.
diff --git a/.github/workflows/qa.yaml b/.github/workflows/qa.yaml
@@ -32,7 +32,7 @@ jobs:
                   extensions: mongodb
 
             - name: Install Composer dependencies (highest)
-              uses: ramsey/composer-install@v1
+              uses: ramsey/composer-install@v2
               with:
                   dependency-versions: highest
                   composer-options: --prefer-dist --prefer-stable
@@ -57,7 +57,7 @@ jobs:
                   extensions: mongodb
 
             - name: Install Composer dependencies (highest)
-              uses: ramsey/composer-install@v1
+              uses: ramsey/composer-install@v2
               with:
                   dependency-versions: highest
                   composer-options: --prefer-dist --prefer-stable

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -95,7 +95,7 @@ jobs:
               run: composer config minimum-stability dev
 
             - name: Install Composer dependencies (${{ matrix.dependencies }})
-              uses: ramsey/composer-install@v1
+              uses: ramsey/composer-install@v2
               with:
                   dependency-versions: ${{ matrix.dependencies }}
                   composer-options: --prefer-dist --prefer-stable

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,22 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.10.1](https://github.com/sonata-project/exporter/compare/2.10.0...2.10.1) - 2022-01-03
+### Fixed
+- [[#567](https://github.com/sonata-project/exporter/pull/567)] SourceIteratorInterface unresolvable generics ([@VincentLanglet](https://github.com/VincentLanglet))
+
+## [2.10.0](https://github.com/sonata-project/exporter/compare/2.9.1...2.10.0) - 2022-01-02
+### Added
+- [[#560](https://github.com/sonata-project/exporter/pull/560)] Added class `XlsxWriter` that uses "phpoffice/phpspreadsheet" as suggested package. ([@willemverspyck](https://github.com/willemverspyck))
+- [[#560](https://github.com/sonata-project/exporter/pull/560)] Default the XLSX export is not enabled. You can enable it by adding "xlsx" to "default_writers" in configuration. ([@willemverspyck](https://github.com/willemverspyck))
+- [[#560](https://github.com/sonata-project/exporter/pull/560)] Added tests for the `XlsxWriter` class. ([@willemverspyck](https://github.com/willemverspyck))
+
+### Deprecated
+- [[#565](https://github.com/sonata-project/exporter/pull/565)] AbstractTypedWriterTestCase ([@VincentLanglet](https://github.com/VincentLanglet))
+
+### Fixed
+- [[#562](https://github.com/sonata-project/exporter/pull/562)] DBAL v3 compatibility ([@VincentLanglet](https://github.com/VincentLanglet))
+
 ## [2.9.1](https://github.com/sonata-project/exporter/compare/2.9.0...2.9.1) - 2021-11-12
 ### Fixed
 - [[#550](https://github.com/sonata-project/exporter/pull/550)] Fixed compatibility with doctrine/dbal ^2.13 ([@jordisala1991](https://github.com/jordisala1991))

diff --git a/UPGRADE-1.x.md b/UPGRADE-1.x.md
diff --git a/UPGRADE-2.0.md b/UPGRADE-2.0.md
diff --git a/UPGRADE-2.x.md b/UPGRADE-2.x.md
@@ -1,6 +1,9 @@
 # UPGRADE 2.x
 
-### `Sonata\Exporter\Bridge\Symfony\Bundle\SonataExporterBundle`
+UPGRADE FROM 2.3 to 2.4
+=======================
 
-Deprecated `Sonata\Exporter\Bridge\Symfony\Bundle\SonataExporterBundle`. Use `Sonata\Exporter\Bridge\Symfony\SonataExporterBundle`
-instead.
+## `Sonata\Exporter\Bridge\Symfony\Bundle\SonataExporterBundle`
+
+Deprecated `Sonata\Exporter\Bridge\Symfony\Bundle\SonataExporterBundle`.
+Use `Sonata\Exporter\Bridge\Symfony\SonataExporterBundle` instead.
diff --git a/src/Source/AbstractXmlSourceIterator.php b/src/Source/AbstractXmlSourceIterator.php
@@ -58,7 +58,7 @@ abstract class AbstractXmlSourceIterator implements SourceIteratorInterface
     protected $currentColumnIndex = 0;
 
     /**
-     * @var mixed
+     * @var array<mixed>|null
      */
     protected $currentRow;
 
@@ -105,11 +105,13 @@ abstract public function tagEnd($parser, string $name);
     abstract public function tagContent($parser, string $data);
 
     /**
-     * @return mixed
+     * @return array<mixed>
      */
     #[\ReturnTypeWillChange]
     final public function current()
     {
+        \assert(\is_array($this->currentRow));
+
         return $this->currentRow;
     }
 

diff --git a/src/Source/ChainSourceIterator.php b/src/Source/ChainSourceIterator.php
@@ -16,10 +16,13 @@
 final class ChainSourceIterator implements SourceIteratorInterface
 {
     /**
-     * @var \ArrayIterator
+     * @var \ArrayIterator<array-key, SourceIteratorInterface>
      */
     private $sources;
 
+    /**
+     * @param array<SourceIteratorInterface> $sources
+     */
     public function __construct(array $sources = [])
     {
         $this->sources = new \ArrayIterator();
@@ -35,7 +38,7 @@ public function addSource(SourceIteratorInterface $source): void
     }
 
     /**
-     * @return mixed
+     * @return array<mixed>
      */
     #[\ReturnTypeWillChange]
     public function current()
@@ -59,6 +62,10 @@ public function key()
 
     public function valid(): bool
     {
+        if (!$this->sources->valid()) {
+            return false;
+        }
+
         while (!$this->sources->current()->valid()) {
             $this->sources->next();
 
@@ -74,7 +81,7 @@ public function valid(): bool
 
     public function rewind(): void
     {
-        if ($this->sources->current()) {
+        if ($this->sources->valid()) {
             $this->sources->current()->rewind();
         }
     }

diff --git a/src/Source/CsvSourceIterator.php b/src/Source/CsvSourceIterator.php
@@ -82,11 +82,13 @@ public function __construct(
     }
 
     /**
-     * @return array|false
+     * @return array
      */
     #[\ReturnTypeWillChange]
     public function current()
     {
+        \assert(\is_array($this->currentLine));
+
         return $this->currentLine;
     }
 

diff --git a/src/Source/DoctrineDBALConnectionSourceIterator.php b/src/Source/DoctrineDBALConnectionSourceIterator.php
@@ -59,11 +59,13 @@ public function __construct(Connection $connection, string $query, array $parame
     }
 
     /**
-     * @return array<string, mixed>|false
+     * @return array<string, mixed>
      */
     #[\ReturnTypeWillChange]
     public function current()
     {
+        \assert(\is_array($this->current));
+
         return $this->current;
     }
 

diff --git a/src/Source/DoctrineODMQuerySourceIterator.php b/src/Source/DoctrineODMQuerySourceIterator.php
@@ -15,7 +15,7 @@
 
 use Doctrine\ODM\MongoDB\Query\Query;
 
-final class DoctrineODMQuerySourceIterator extends AbstractPropertySourceIterator implements SourceIteratorInterface
+final class DoctrineODMQuerySourceIterator extends AbstractPropertySourceIterator
 {
     /**
      * @var Query

diff --git a/src/Source/DoctrineORMQuerySourceIterator.php b/src/Source/DoctrineORMQuerySourceIterator.php
@@ -18,7 +18,7 @@
 /**
  * @final since sonata-project/exporter 2.4.
  */
-class DoctrineORMQuerySourceIterator extends AbstractPropertySourceIterator implements SourceIteratorInterface
+class DoctrineORMQuerySourceIterator extends AbstractPropertySourceIterator
 {
     /**
      * @var Query

diff --git a/src/Source/IteratorCallbackSourceIterator.php b/src/Source/IteratorCallbackSourceIterator.php
@@ -37,7 +37,7 @@ public function __construct(\Iterator $iterator, \Closure $transformer)
     }
 
     /**
-     * @return mixed
+     * @return array<mixed>
      */
     public function current()
     {

diff --git a/src/Source/IteratorSourceIterator.php b/src/Source/IteratorSourceIterator.php
@@ -19,12 +19,12 @@
 class IteratorSourceIterator implements SourceIteratorInterface
 {
     /**
-     * @var \Iterator
+     * @var \Iterator<mixed, array<mixed>>
      */
     protected $iterator;
 
     /**
-     * @param \Iterator $iterator Iterator with string array elements
+     * @param \Iterator<mixed, array<mixed>> $iterator Iterator with string array elements
      */
     public function __construct(\Iterator $iterator)
     {
@@ -37,7 +37,7 @@ final public function getIterator(): \Iterator
     }
 
     /**
-     * @return mixed
+     * @return array<mixed>
      */
     #[\ReturnTypeWillChange]
     public function current()

diff --git a/src/Source/PDOStatementSourceIterator.php b/src/Source/PDOStatementSourceIterator.php
@@ -43,7 +43,7 @@ public function __construct(\PDOStatement $statement)
     }
 
     /**
-     * @return mixed
+     * @return array<mixed>
      */
     #[\ReturnTypeWillChange]
     public function current()

diff --git a/src/Source/PropelCollectionSourceIterator.php b/src/Source/PropelCollectionSourceIterator.php
@@ -20,7 +20,7 @@
  *
  * @author Kévin Gomez <contact@kevingomez.fr>
  */
-final class PropelCollectionSourceIterator extends AbstractPropertySourceIterator implements SourceIteratorInterface
+final class PropelCollectionSourceIterator extends AbstractPropertySourceIterator
 {
     /**
      * @var \PropelCollection

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

diff --git a/src/Test/AbstractTypedWriterTestCase.php b/src/Test/AbstractTypedWriterTestCase.php
@@ -21,7 +21,7 @@
  *
  * NEXT_MAJOR: Remove this class.
  *
- * @deprecated since sonata-project/exporter 2.x, to be removed in version 3.0.
+ * @deprecated since sonata-project/exporter 2.10, to be removed in version 3.0.
  */
 abstract class AbstractTypedWriterTestCase extends TestCase
 {

diff --git a/tests/Source/ChainSourceIteratorTest.php b/tests/Source/ChainSourceIteratorTest.php
@@ -31,4 +31,15 @@ public function testIterator(): void
         foreach ($iterator as $data) {
         }
     }
+
+    /**
+     * @doesNotPerformAssertions
+     */
+    public function testEmptyIterator(): void
+    {
+        $iterator = new ChainSourceIterator([]);
+
+        foreach ($iterator as $data) {
+        }
+    }
 }