clean filenames on MatchesFileSnapshot

Author: Khartir

src/Filename.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Spatie\Snapshots;
+
+class Filename
+{
+    static public function cleanFilename(string $raw): string
+    {
+        // Remove anything which isn't a word, whitespace, number
+        // or any of the following caracters -_~,;[]().
+        $file = preg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $raw);
+
+        // Remove any runs of periods
+        $file = preg_replace("([\.]{2,})", '', $file);
+
+        return $file;
+    }
+}

src/MatchesSnapshots.php

@@ -207,6 +207,7 @@ protected function doFileSnapshotAssertion(string $filePath): void
         $this->snapshotIncrementor++;
 
         $snapshotId = $this->getSnapshotId().'.'.$fileExtension;
+        $snapshotId = Filename::cleanFilename($snapshotId);
 
         // If $filePath has a different file extension than the snapshot, the test should fail
         if ($namesWithDifferentExtension = $fileSystem->getNamesWithDifferentExtension($snapshotId)) {

src/Snapshot.php

@@ -42,14 +42,7 @@ public function filename(): string
     {
         $file = $this->id.'.'.$this->driver->extension();
 
-        // Remove anything which isn't a word, whitespace, number
-        // or any of the following caracters -_~,;[]().
-        $file = preg_replace("([^\w\s\d\-_~,;\[\]\(\).])", '', $file);
-
-        // Remove any runs of periods
-        $file = preg_replace("([\.]{2,})", '', $file);
-
-        return $file;
+        return Filename::cleanFilename($file);
     }
 
     public function exists(): bool

tests/Integration/MatchesSnapshotTest.php

@@ -292,6 +292,23 @@ public function it_deletes_the_persisted_failed_file_before_a_file_snapshot_asse
         $this->assertFileDoesNotExist($persistedFailedFile);
     }
 
+    /** @test */
+    public function it_cleans_filenames_on_file_snapshot()
+    {
+        $mockTrait = $this->getMatchesSnapshotMock(false);
+        $mockTrait
+            ->expects($this->any())
+            ->method('getSnapshotId')
+            ->willReturn('MatchesSnapshotTest__it_cleans_filenames_on_file_snapshot with dataset "Empty"__1');
+
+        $this->expectFail(
+            $mockTrait,
+            'File did not match snapshot (MatchesSnapshotTest__it_cleans_filenames_on_file_snapshot with dataset Empty__1.jpg)'
+        );
+
+        $mockTrait->assertMatchesFileSnapshot(__DIR__.'/stubs/test_files/troubled_man.jpg');
+    }
+
     /** @test */
     public function it_can_update_a_string_snapshot()
     {
@@ -447,7 +464,7 @@ private function expectFailedMatchesSnapshotTest()
     /**
      * @return \PHPUnit\Framework\MockObject\MockObject|\Spatie\Snapshots\MatchesSnapshots
      */
-    private function getMatchesSnapshotMock(): MockObject
+    private function getMatchesSnapshotMock(bool $mockGetSnapshotId = true): MockObject
     {
         $mockMethods = [
             'markTestIncomplete',
@@ -468,10 +485,12 @@ private function getMatchesSnapshotMock(): MockObject
             $mockMethods
         );
 
-        $matchesSnapshotMock
-            ->expects($this->any())
-            ->method('getSnapshotId')
-            ->willReturn('MatchesSnapshotTest__'.$this->getName().'__1');
+        if ($mockGetSnapshotId) {
+            $matchesSnapshotMock
+                ->expects($this->any())
+                ->method('getSnapshotId')
+                ->willReturn('MatchesSnapshotTest__'.$this->getName().'__1');
+        }
 
         $matchesSnapshotMock
             ->expects($this->any())

tests/Integration/stubs/__snapshots__/files/MatchesSnapshotTest__it_cleans_filenames_on_file_snapshot with dataset Empty__1.jpg

@@ -0,0 +1,17 @@
+<?php
+
+namespace Spatie\Snapshots\Test\Unit;
+
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\Filename;
+
+class FilenameTest extends TestCase
+{
+    /** @test */
+    public function it_creates_a_filename_which_is_valid_on_all_systems()
+    {
+        $name = 'ClassTest__testOne with... data set "Empty".php';
+
+        $this->assertEquals('ClassTest__testOne with data set Empty.php', Filename::cleanFilename($name));
+    }
+}