Merge pull request #63 from spatie/v2

Use YAML by default for associative arrays

Author: sebastiandedeyne

composer.json

@@ -21,7 +21,8 @@
     ],
     "require": {
         "php": "^7.1",
-        "phpunit/phpunit": "^6.0.5|^7.0"
+        "phpunit/phpunit": "^7.0",
+        "symfony/yaml": "^4.2"
     },
     "autoload": {
         "psr-4": {

src/Drivers/YamlDriver.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Spatie\Snapshots\Drivers;
+
+use PHPUnit\Framework\Assert;
+use Spatie\Snapshots\Driver;
+use Spatie\Snapshots\Exceptions\CantBeSerialized;
+use Symfony\Component\Yaml\Yaml;
+
+class YamlDriver implements Driver
+{
+    public function serialize($data): string
+    {
+        if (is_string($data)) {
+            $data = Yaml::parse($data);
+        }
+
+        if (! is_array($data)) {
+            throw new CantBeSerialized('Only strings can be serialized to json');
+        }
+
+        return Yaml::dump($data, PHP_INT_MAX);
+    }
+
+    public function extension(): string
+    {
+        return 'yml';
+    }
+
+    public function match($expected, $actual)
+    {
+        if (is_array($actual)) {
+            $actual = Yaml::dump($actual, PHP_INT_MAX);
+        }
+
+        Assert::assertEquals($expected, $actual);
+    }
+}

src/MatchesSnapshots.php

@@ -8,6 +8,7 @@
 use Spatie\Snapshots\Drivers\JsonDriver;
 use Spatie\Snapshots\Drivers\VarDriver;
 use Spatie\Snapshots\Drivers\XmlDriver;
+use Spatie\Snapshots\Drivers\YamlDriver;
 
 trait MatchesSnapshots
 {
@@ -45,6 +46,12 @@ 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 VarDriver());
     }
 
@@ -58,6 +65,11 @@ public function assertMatchesJsonSnapshot($actual)
         $this->assertMatchesSnapshot($actual, new JsonDriver());
     }
 
+    public function assertMatchesYamlSnapshot($actual)
+    {
+        $this->assertMatchesSnapshot($actual, new YamlDriver());
+    }
+
     public function assertMatchesFileHashSnapshot($filePath)
     {
         if (! file_exists($filePath)) {

tests/Integration/MatchesSnapshotTest.php

@@ -34,11 +34,26 @@ public function it_can_create_a_snapshot_from_a_string()
         });
 
         $this->assertSnapshotMatchesExample(
-            'MatchesSnapshotTest__it_can_match_an_existing_string_snapshot__1.php',
+            'MatchesSnapshotTest__it_can_create_a_snapshot_from_a_string__1.php',
             'snapshot.php'
         );
     }
 
+    /** @test */
+    public function it_can_create_a_snapshot_from_an_array()
+    {
+        $mockTrait = $this->getMatchesSnapshotMock();
+
+        $this->expectIncompleteMatchesSnapshotTest($mockTrait, function ($mockTrait) {
+            $mockTrait->assertMatchesSnapshot(['foo' => 'bar']);
+        });
+
+        $this->assertSnapshotMatchesExample(
+            'MatchesSnapshotTest__it_can_create_a_snapshot_from_an_array__1.yml',
+            'snapshot.yml'
+        );
+    }
+
     /** @test */
     public function it_can_create_a_snapshot_from_xml()
     {

tests/Integration/stubs/example_snapshots/snapshot.yml

@@ -0,0 +1 @@
+foo: bar

tests/Unit/Drivers/JsonDriverTest.php

@@ -4,8 +4,6 @@
 
 use PHPUnit\Framework\TestCase;
 use Spatie\Snapshots\Drivers\JsonDriver;
-use Spatie\Snapshots\Exceptions\CantBeSerialized;
-use stdClass;
 
 class JsonDriverTest extends TestCase
 {
@@ -86,14 +84,4 @@ public function it_can_serialize_a_json_array_to_pretty_json()
 
         $this->assertEquals($expected, $driver->serialize(['foo', 'bar', 'baz']));
     }
-
-    /** @test */
-    public function it_can_only_serialize_strings_and_arrays()
-    {
-        $this->expectException(CantBeSerialized::class);
-
-        $driver = new JsonDriver();
-
-        $driver->serialize(new stdClass);
-    }
 }

tests/Unit/Drivers/YamlDriverTest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Spatie\Snapshots\Test\Unit\Drivers;
+
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\Drivers\YamlDriver;
+
+class YamlDriverTest extends TestCase
+{
+    /** @test */
+    public function it_can_serialize_a_yaml_string()
+    {
+        $driver = new YamlDriver();
+
+        $yamlString = implode(PHP_EOL, [
+            'foo: bar',
+            'baz: qux',
+            '',
+        ]);
+
+        $this->assertEquals($yamlString, $driver->serialize($yamlString));
+    }
+
+    /** @test */
+    public function it_can_serialize_a_yaml_array()
+    {
+        $driver = new YamlDriver();
+
+        $expected = implode(PHP_EOL, [
+            'foo: bar',
+            'baz: qux',
+            '',
+         ]);
+
+        $this->assertEquals($expected, $driver->serialize([
+            'foo' => 'bar',
+            'baz' => 'qux',
+        ]));
+    }
+}