Remove deprecated code (#584)

* Remove deprecated code * Remove propel from composer.json
sonata-project · May 22, 2022 · d7a0b3f · d7a0b3f
1 parent 7d42174
commit d7a0b3f
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 319 deletions.
diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md
@@ -0,0 +1,9 @@
+# UPGRADE 3.0
+
+## Deprecations
+
+All the deprecated code introduced on 2.x is removed on 3.0.
+
+Please read [2.x](https://github.com/sonata-project/exporter/tree/2.x) upgrade guides for more information.
+
+See also the [diff code](https://github.com/sonata-project/exporter/compare/2.x...3.0.0).
diff --git a/composer.json b/composer.json
@@ -39,7 +39,6 @@
         "phpstan/phpstan-strict-rules": "^1.0",
         "phpstan/phpstan-symfony": "^1.0",
         "phpunit/phpunit": "^9.5",
-        "propel/propel1": "^1.6",
         "psalm/plugin-phpunit": "^0.16",
         "psalm/plugin-symfony": "^3.0",
         "rector/rector": "^0.12",
@@ -58,7 +57,6 @@
     },
     "suggest": {
         "phpoffice/phpspreadsheet": "To be able to export the data in XLSX",
-        "propel/propel1": "To export propel collections",
         "symfony/property-access": "To be able to export from database entities",
         "symfony/routing": "To be able to export the routes of a Symfony app"
     },

diff --git a/docs/reference/sources.rst b/docs/reference/sources.rst
@@ -8,7 +8,6 @@ You may export data from various sources:
 * CSV
 * Doctrine Query (ORM & ODM supported)
 * PDO Statement
-* Propel Collection
 * PHP Iterator instance
 * PHP Iterator with a callback on current
 * XML

diff --git a/src/Bridge/Symfony/Bundle/SonataExporterBundle.php b/src/Bridge/Symfony/Bundle/SonataExporterBundle.php
diff --git a/src/Bridge/Symfony/SonataExporterSymfonyBundle.php b/src/Bridge/Symfony/SonataExporterSymfonyBundle.php
diff --git a/src/Source/AbstractPropertySourceIterator.php b/src/Source/AbstractPropertySourceIterator.php
@@ -18,7 +18,10 @@
 use Symfony\Component\PropertyAccess\PropertyAccessor;
 use Symfony\Component\PropertyAccess\PropertyPath;
 
-abstract class AbstractPropertySourceIterator implements SourceIteratorInterface
+/**
+ * @phpstan-implements \Iterator<array<mixed>>
+ */
+abstract class AbstractPropertySourceIterator implements \Iterator
 {
     private const DATE_PARTS = [
         'y' => 'Y',
@@ -104,34 +107,6 @@ public function getDateTimeFormat(): string
         return $this->dateTimeFormat;
     }
 
-    /**
-     * NEXT_MAJOR: Change the method visibility to private.
-     *
-     * @return string An ISO8601 duration
-     */
-    public function getDuration(\DateInterval $interval): string
-    {
-        $datePart = '';
-        foreach (self::DATE_PARTS as $datePartAttribute => $datePartAttributeString) {
-            if ($interval->$datePartAttribute !== 0) {
-                $datePart .= $interval->$datePartAttribute.$datePartAttributeString;
-            }
-        }
-
-        $timePart = '';
-        foreach (self::TIME_PARTS as $timePartAttribute => $timePartAttributeString) {
-            if ($interval->$timePartAttribute !== 0) {
-                $timePart .= $interval->$timePartAttribute.$timePartAttributeString;
-            }
-        }
-
-        if ('' === $datePart && '' === $timePart) {
-            return 'P0Y';
-        }
-
-        return 'P'.$datePart.('' !== $timePart ? 'T'.$timePart : '');
-    }
-
     /**
      * @param object|mixed[] $current
      *
@@ -179,4 +154,30 @@ protected function getValue($value)
                 return $value;
         }
     }
+
+    /**
+     * @return string An ISO8601 duration
+     */
+    private function getDuration(\DateInterval $interval): string
+    {
+        $datePart = '';
+        foreach (self::DATE_PARTS as $datePartAttribute => $datePartAttributeString) {
+            if ($interval->$datePartAttribute !== 0) {
+                $datePart .= $interval->$datePartAttribute.$datePartAttributeString;
+            }
+        }
+
+        $timePart = '';
+        foreach (self::TIME_PARTS as $timePartAttribute => $timePartAttributeString) {
+            if ($interval->$timePartAttribute !== 0) {
+                $timePart .= $interval->$timePartAttribute.$timePartAttributeString;
+            }
+        }
+
+        if ('' === $datePart && '' === $timePart) {
+            return 'P0Y';
+        }
+
+        return 'P'.$datePart.('' !== $timePart ? 'T'.$timePart : '');
+    }
 }
diff --git a/src/Source/AbstractXmlSourceIterator.php b/src/Source/AbstractXmlSourceIterator.php
@@ -17,8 +17,10 @@
  * Read data from a Xml file.
  *
  * @author Vincent Touzet <vincent.touzet@gmail.com>
+ *
+ * @phpstan-implements \Iterator<array<mixed>>
  */
-abstract class AbstractXmlSourceIterator implements SourceIteratorInterface
+abstract class AbstractXmlSourceIterator implements \Iterator
 {
     /**
      * @var string

diff --git a/src/Source/ChainSourceIterator.php b/src/Source/ChainSourceIterator.php
@@ -13,7 +13,10 @@
 
 namespace Sonata\Exporter\Source;
 
-final class ChainSourceIterator implements SourceIteratorInterface
+/**
+ * @phpstan-implements \Iterator<array<mixed>>
+ */
+final class ChainSourceIterator implements \Iterator
 {
     /**
      * @var \ArrayIterator<array-key, \Iterator>

diff --git a/src/Source/CsvSourceIterator.php b/src/Source/CsvSourceIterator.php
@@ -17,8 +17,10 @@
  * Read data from a csv file.
  *
  * @author Vincent Touzet <vincent.touzet@gmail.com>
+ *
+ * @phpstan-implements \Iterator<array<mixed>>
  */
-final class CsvSourceIterator implements SourceIteratorInterface
+final class CsvSourceIterator implements \Iterator
 {
     private string $filename;
 

diff --git a/src/Source/DoctrineDBALConnectionSourceIterator.php b/src/Source/DoctrineDBALConnectionSourceIterator.php
@@ -16,7 +16,10 @@
 use Doctrine\DBAL\Driver\Connection;
 use Doctrine\DBAL\Driver\Result;
 
-final class DoctrineDBALConnectionSourceIterator implements SourceIteratorInterface
+/**
+ * @phpstan-implements \Iterator<array<mixed>>
+ */
+final class DoctrineDBALConnectionSourceIterator implements \Iterator
 {
     private Connection $connection;
 

diff --git a/src/Source/IteratorSourceIterator.php b/src/Source/IteratorSourceIterator.php
@@ -15,8 +15,10 @@
 
 /**
  * SourceIterator implementation based on Iterator.
+ *
+ * @phpstan-implements \Iterator<array<mixed>>
  */
-class IteratorSourceIterator implements SourceIteratorInterface
+class IteratorSourceIterator implements \Iterator
 {
     /**
      * @var \Iterator<mixed, array<mixed>>

diff --git a/src/Source/PDOStatementSourceIterator.php b/src/Source/PDOStatementSourceIterator.php
@@ -15,7 +15,10 @@
 
 use Sonata\Exporter\Exception\InvalidMethodCallException;
 
-final class PDOStatementSourceIterator implements SourceIteratorInterface
+/**
+ * @phpstan-implements \Iterator<array<mixed>>
+ */
+final class PDOStatementSourceIterator implements \Iterator
 {
     private \PDOStatement $statement;
 

diff --git a/src/Source/PropelCollectionSourceIterator.php b/src/Source/PropelCollectionSourceIterator.php
diff --git a/src/Source/SourceIteratorInterface.php b/src/Source/SourceIteratorInterface.php
diff --git a/src/Source/SymfonySitemapSourceIterator.php b/src/Source/SymfonySitemapSourceIterator.php
@@ -16,7 +16,10 @@
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Routing\RouterInterface;
 
-final class SymfonySitemapSourceIterator implements SourceIteratorInterface
+/**
+ * @phpstan-implements \Iterator<array<mixed>>
+ */
+final class SymfonySitemapSourceIterator implements \Iterator
 {
     private RouterInterface $router;
 

diff --git a/src/Test/AbstractTypedWriterTestCase.php b/src/Test/AbstractTypedWriterTestCase.php