Merge pull request #82 from nclavaud/object_driver

Add ObjectDriver

Author: sebastiandedeyne

README.md

@@ -203,6 +203,28 @@ protected function getSnapshotDirectory(): string
 }
 ```
 
+### Using specific Drivers
+
+The driver used to serialize the data can be specificied as second argument of the
+`assertMatchesSnapshot` method, so you can pick one that better suits your needs:
+
+```php
+use Spatie\Snapshots\Drivers\ObjectDriver;
+use Spatie\Snapshots\MatchesSnapshots;
+
+class OrderTest
+{
+    use MatchesSnapshots;
+
+    public function test_snapshot_with_object_driver()
+    {
+        $order = new Order(1);
+
+        $this->assertMatchesSnapshot($order, new ObjectDriver());
+    }
+}
+```
+
 ### Writing Custom Drivers
 
 Drivers ensure that different types of data can be serialized and matched in their own way. A driver is a class that implements the `Spatie\Snapshots\Driver` interface, which requires three method implementations: `serialize`, `extension` and `match`.

composer.json

@@ -22,7 +22,9 @@
     "require": {
         "php": "^7.4",
         "ext-dom": "*",
-        "phpunit/phpunit": "^8.3|^9",
+        "phpunit/phpunit": "^8.3|^9.0",
+        "symfony/property-access": "^4.0|^5.0",
+        "symfony/serializer": "^4.0|^5.0",
         "symfony/yaml": "^4.0|^5.0"
     },
     "autoload": {

src/Drivers/ObjectDriver.php

@@ -0,0 +1,45 @@
+<?php
+
+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 Symfony\Component\Serializer\Serializer;
+
+class ObjectDriver implements Driver
+{
+    public function serialize($data): string
+    {
+        $normalizers = [
+            new DateTimeNormalizer(),
+            new ObjectNormalizer(),
+        ];
+
+        $encoders = [
+            new JsonEncoder(),
+        ];
+
+        $serializer = new Serializer($normalizers, $encoders);
+
+        return $serializer->serialize(
+            $data,
+            'json',
+            [
+                'json_encode_options' => JSON_PRETTY_PRINT,
+            ]
+        );
+    }
+
+    public function extension(): string
+    {
+        return 'json';
+    }
+
+    public function match($expected, $actual)
+    {
+        Assert::assertJsonStringEqualsJsonString($expected, $this->serialize($actual));
+    }
+}

tests/Unit/Drivers/ObjectDriverTest.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Spatie\Snapshots\Test\Unit\Drivers;
+
+use PHPUnit\Framework\TestCase;
+use Spatie\Snapshots\Drivers\ObjectDriver;
+
+class ObjectDriverTest extends TestCase
+{
+    /** @test */
+    public function it_can_serialize_a_string()
+    {
+        $driver = new ObjectDriver();
+
+        $this->assertEquals('"foo"', $driver->serialize('foo'));
+    }
+
+    /** @test */
+    public function it_can_serialize_an_integer()
+    {
+        $driver = new ObjectDriver();
+
+        $this->assertEquals('1', $driver->serialize(1));
+    }
+
+    /** @test */
+    public function it_can_serialize_a_float()
+    {
+        $driver = new ObjectDriver();
+
+        $this->assertEquals('1.5', $driver->serialize(1.5));
+    }
+
+    /** @test */
+    public function it_can_serialize_an_associative_array()
+    {
+        $driver = new ObjectDriver();
+
+        $expected = <<<'JSON'
+{
+    "foo": {
+        "bar": "baz"
+    }
+}
+JSON;
+
+        $this->assertEquals($expected, $driver->serialize(['foo' => ['bar' => 'baz']]));
+    }
+
+    /** @test */
+    public function it_can_serialize_an_indexed_array_without_keys()
+    {
+        $driver = new ObjectDriver();
+
+        $expected = <<<'JSON'
+[
+    "foo",
+    "bar"
+]
+JSON;
+
+        $this->assertEquals($expected, $driver->serialize(['foo', 'bar']));
+    }
+
+    /** @test */
+    public function it_can_serialize_a_simple_object()
+    {
+        $driver = new ObjectDriver();
+
+        $expected = <<<'JSON'
+{
+    "foo": "bar"
+}
+JSON;
+
+        $this->assertEquals($expected, $driver->serialize((object) ['foo' => 'bar']));
+    }
+
+    /** @test */
+    public function it_can_serialize_a_class_instance()
+    {
+        $driver = new ObjectDriver();
+
+        $expected = <<<'JSON'
+{
+    "name": "My name",
+    "valid": true,
+    "dateTime": "2020-01-01T15:00:00+01:00",
+    "public": "public"
+}
+JSON;
+
+        $this->assertEquals($expected, $driver->serialize(new Obj()));
+    }
+}
+
+class Obj
+{
+    private $private = 'private';
+    public $public = 'public';
+
+    public function getName()
+    {
+        return 'My name';
+    }
+
+    public function isValid()
+    {
+        return true;
+    }
+
+    public function getDateTime()
+    {
+        return new \DateTimeImmutable('2020-01-01 15:00:00+01:00');
+    }
+}