Reduce memory consumption in FilesCollection

psalm.xml

@@ -32,5 +32,10 @@
                 <directory name="src/" />
             </errorLevel>
         </ClassMustBeFinal>
+        <DeprecatedMethod>
+            <errorLevel type="suppress">
+                <directory name="src/" />
+            </errorLevel>
+        </DeprecatedMethod>
     </issueHandlers>
 </psalm>

src/Collection/FilesCollection.php

@@ -7,26 +7,17 @@
 use Closure;
 use Doctrine\Common\Collections\ArrayCollection;
 use GrumPHP\Util\Regex;
-use Symfony\Component\Finder\Comparator;
-use Symfony\Component\Finder\Iterator;
 use SplFileInfo;
-use Symfony\Component\Finder\SplFileInfo as SymfonySplFileInfo;
 use Traversable;
 
 /**
- * @extends ArrayCollection<array-key, \SplFileInfo>
+ * @extends ArrayCollection<array-key, string>
  */
 class FilesCollection extends ArrayCollection
 {
     /**
-     * @param \Traversable<array-key, \SplFileInfo> $iterator
-     */
-    public static function fromTraversable(\Traversable $iterator): FilesCollection
-    {
-        return new self(array_values(iterator_to_array($iterator)));
-    }
-
-    /**
+     * @deprecated use FilesCollectionFilter::name directly
+     *
      * Adds a rule that files must match.
      *
      * You can use a pattern (delimited with / sign), a glob or a simple string.
@@ -39,10 +30,12 @@ public static function fromTraversable(\Traversable $iterator): FilesCollection
      */
     public function name($pattern): self
     {
-        return $this->names([$pattern]);
+        return FilesCollectionFilter::name($this, $pattern);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::names directly
+     *
      * Adds rules that files must match.
      *
      * You can use patterns (delimited with / sign), globs or simple strings.
@@ -53,12 +46,12 @@ public function name($pattern): self
      */
     public function names(array $patterns): self
     {
-        $filter = new Iterator\FilenameFilterIterator($this->getIterator(), $patterns, []);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::names($this, $patterns);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::notName directly
+     *
      * Adds rules that files must match.
      *
      * You can use patterns (delimited with / sign), globs or simple strings.
@@ -69,36 +62,36 @@ public function names(array $patterns): self
      */
     public function notName(string $pattern): self
     {
-        $filter = new Iterator\FilenameFilterIterator($this->getIterator(), [], [$pattern]);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::notName($this, $pattern);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::path directly
+     *
      * Filter by path.
      *
      * $collection->path('/^spec\/')
      */
     public function path(string $pattern): self
     {
-        return $this->paths([$pattern]);
+        return FilesCollectionFilter::path($this, $pattern);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::paths directly
+     *
      * Filter by paths.
      *
      * $collection->paths(['/^spec\/','/^src\/'])
-     *
-     * @psalm-suppress ArgumentTypeCoercion - Works on int, \SplFileInfo as well
      */
     public function paths(array $patterns): self
     {
-        $filter = new Iterator\PathFilterIterator($this->getIterator(), $patterns, []);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::paths($this, $patterns);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::notPath directly
+     *
      * Adds rules that filenames must not match.
      *
      * You can use patterns (delimited with / sign) or simple strings.
@@ -107,54 +100,50 @@ public function paths(array $patterns): self
      */
     public function notPath(string $pattern): self
     {
-        return $this->notPaths([$pattern]);
+        return FilesCollectionFilter::notPath($this, $pattern);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::notPaths directly
+     *
      * Adds rules that filenames must not match.
      *
      * You can use patterns (delimited with / sign) or simple strings.
      *
      * $collection->notPaths(['/^spec\/','/^src\/'])
-     *
-     * @psalm-suppress ArgumentTypeCoercion - Works on int, \SplFileInfo as well
      */
     public function notPaths(array $pattern): self
     {
-        $filter = new Iterator\PathFilterIterator($this->getIterator(), [], $pattern);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::notPaths($this, $pattern);
     }
 
+    /**
+     * @deprecated use FilesCollectionFilter::extensions directly
+     */
     public function extensions(array $extensions): self
     {
-        if (!\count($extensions)) {
-            return new self();
-        }
-
-        return $this->name(sprintf('/\.(%s)$/i', implode('|', $extensions)));
+        return FilesCollectionFilter::extensions($this, $extensions);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::size directly
+     *
      * Adds tests for file sizes.
      *
      * $collection->filterBySize('> 10K');
      * $collection->filterBySize('<= 1Ki');
      * $collection->filterBySize(4);
      *
-     *
-     *
      * @see NumberComparator
      */
     public function size(string $size): self
     {
-        $comparator = new Comparator\NumberComparator($size);
-        $filter = new Iterator\SizeRangeFilterIterator($this->getIterator(), [$comparator]);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::size($this, $size);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::date directly
+     *
      * Adds tests for file dates (last modified).
      *
      * The date must be something that strtotime() is able to parse:
@@ -164,26 +153,21 @@ public function size(string $size): self
      * $collection->filterByDate('> now - 2 hours');
      * $collection->filterByDate('>= 2005-10-15');
      *
-     *
-     *
      * @see DateComparator
      */
     public function date(string $date): self
     {
-        $comparator = new Comparator\DateComparator($date);
-        $filter = new Iterator\DateRangeFilterIterator($this->getIterator(), [$comparator]);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::date($this, $date);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::filter directly
+     *
      * Filters the iterator with an anonymous function.
      *
      * The anonymous function receives a \SplFileInfo and must return false
      * to remove files.
      *
-     *
-     *
      * @see CustomFilterIterator
      *
      * @psalm-suppress LessSpecificImplementedReturnType
@@ -192,26 +176,20 @@ public function date(string $date): self
      */
     public function filter(Closure $p): self
     {
-        $filter = new Iterator\CustomFilterIterator($this->getIterator(), [$p]);
-
-        return self::fromTraversable($filter);
+        return FilesCollectionFilter::filter($this, $p);
     }
 
     /**
+     * @deprecated use FilesCollectionFilter::filterByFileList directly
+     *
      * @param Traversable<array-key, SplFileInfo> $fileList
      */
-    public function filterByFileList(Traversable $fileList): FilesCollection
+    public function filterByFileList(Traversable $fileList): self
     {
-        $allowedFiles = array_map(function (SplFileInfo $file) {
-            return $file->getPathname();
-        }, iterator_to_array($fileList));
-
-        return $this->filter(function (SplFileInfo $file) use ($allowedFiles) {
-            return \in_array($file->getPathname(), $allowedFiles, true);
-        });
+        return FilesCollectionFilter::filterByFileList($this, $fileList);
     }
 
-    public function ensureFiles(self $files): FilesCollection
+    public function ensureFiles(self $files): self
     {
         $newFiles = new self($this->toArray());
 
@@ -224,49 +202,27 @@ public function ensureFiles(self $files): FilesCollection
         return $newFiles;
     }
 
-    public function ignoreSymlinks(): FilesCollection
+    /**
+     * @deprecated use FilesCollectionFilter::ignoreSymlinks directly
+     */
+    public function ignoreSymlinks(): self
     {
-        return $this->filter(function (SplFileInfo $file) {
-            return !$file->isLink();
-        });
+        return FilesCollectionFilter::ignoreSymlinks($this);
     }
 
-    /**
-     * SplFileInfo cannot be serialized. Therefor, we help PHP a bit.
-     * This stuff is used for running tasks in parallel.
-     */
     public function __serialize(): array
     {
-        return $this->map(function (SplFileInfo $fileInfo): string {
-            return $fileInfo instanceof SymfonySplFileInfo
-                ? $fileInfo->getRelativePathname()
-                : $fileInfo->getPathname();
-        })->toArray();
+        return $this->toArray();
     }
 
-    /**
-     * SplFileInfo cannot be serialized. Therefor, we help PHP a bit.
-     * This stuff is used for running tasks in parallel.
-     */
     public function __unserialize(array $data): void
     {
-        $files = $data;
         $this->clear();
-        foreach ($files as $file) {
-            $this->add(new SymfonySplFileInfo($file, dirname($file), $file));
+        foreach ($data as $path) {
+            $this->add($path);
         }
     }
 
-    /**
-     * Help Psalm out a bit:
-     *
-     * @return \ArrayIterator<array-key, SplFileInfo>
-     */
-    public function getIterator(): \ArrayIterator
-    {
-        return new \ArrayIterator($this->toArray());
-    }
-
     public function toFileList(): string
     {
         return \implode(PHP_EOL, $this->toArray());