Use YAML with ObjectDriver

Author: sebastiandedeyne

src/Drivers/ObjectDriver.php

@@ -2,12 +2,13 @@
 
 namespace Spatie\Snapshots\Drivers;
 
-use PHPUnit\Framework\Assert;
 use Spatie\Snapshots\Driver;
-use Symfony\Component\Serializer\Encoder\JsonEncoder;
-use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
-use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use PHPUnit\Framework\Assert;
+use Symfony\Component\Yaml\Yaml;
 use Symfony\Component\Serializer\Serializer;
+use Symfony\Component\Serializer\Encoder\YamlEncoder;
+use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
+use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
 
 class ObjectDriver implements Driver
 {
@@ -19,7 +20,7 @@ public function serialize($data): string
         ];
 
         $encoders = [
-            new JsonEncoder(),
+            new YamlEncoder(),
         ];
 
         $serializer = new Serializer($normalizers, $encoders);
@@ -30,22 +31,27 @@ public function serialize($data): string
             $data = (array) $data;
         }
 
-        return $serializer->serialize(
-            $data,
-            'json',
-            [
-                'json_encode_options' => JSON_PRETTY_PRINT,
-            ]
+        return $this->dedent(
+            $serializer->serialize($data, 'yaml', [
+                'yaml_inline' => 2,
+                'yaml_indent' => 4,
+                'yaml_flags' => Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,
+            ])
         );
     }
 
     public function extension(): string
     {
-        return 'json';
+        return 'yml';
     }
 
     public function match($expected, $actual)
     {
-        Assert::assertJsonStringEqualsJsonString($expected, $this->serialize($actual));
+        Assert::assertEquals($expected, $this->serialize($actual));
+    }
+
+    protected function dedent(string $string): string
+    {
+        return preg_replace('/^ {4}/m', '', $string);
     }
 }

src/MatchesSnapshots.php

@@ -43,12 +43,6 @@ public function markTestIncompleteIfSnapshotsHaveChanged()
 
     public function assertMatchesSnapshot($actual, Driver $driver = null)
     {
-        if (is_null($driver) && is_array($actual)) {
-            $this->assertMatchesYamlSnapshot($actual);
-
-            return;
-        }
-
         $this->doSnapshotAssertion($actual, $driver ?? new ObjectDriver());
     }
 
@@ -166,6 +160,8 @@ protected function doSnapshotAssertion($actual, Driver $driver)
             } catch (ExpectationFailedException $exception) {
                 $this->updateSnapshotAndMarkTestIncomplete($snapshot, $actual);
             }
+
+            return;
         }
 
         try {

src/Snapshot.php

@@ -41,9 +41,11 @@ public function id(): string
     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);
 

tests/Integration/MatchesSnapshotTest.php

@@ -34,8 +34,8 @@ public function it_can_create_a_snapshot_from_a_string()
         });
 
         $this->assertSnapshotMatchesExample(
-            'MatchesSnapshotTest__it_can_create_a_snapshot_from_a_string__1.json',
-            'string_snapshot.json'
+            'MatchesSnapshotTest__it_can_create_a_snapshot_from_a_string__1.yml',
+            'string_snapshot.yml'
         );
     }
 
@@ -285,8 +285,8 @@ public function it_can_update_a_string_snapshot()
         });
 
         $this->assertSnapshotMatchesExample(
-            'MatchesSnapshotTest__it_can_update_a_string_snapshot__1.json',
-            'string_snapshot.json'
+            'MatchesSnapshotTest__it_can_update_a_string_snapshot__1.yml',
+            'string_snapshot.yml'
         );
     }
 

tests/Integration/stubs/__snapshots__/AssertionTest__can_do_multiple_snapshot_assertions__1.json

@@ -0,0 +1 @@
+Foo

tests/Integration/stubs/__snapshots__/AssertionTest__can_do_multiple_snapshot_assertions__1.yml

@@ -0,0 +1 @@
+Bar

tests/Integration/stubs/__snapshots__/AssertionTest__can_do_multiple_snapshot_assertions__2.json

@@ -0,0 +1 @@
+f558f8149e33fba2916877b2d3de4a42ebd544b4