Wip

Author: sebastiandedeyne

tests/ExampleTest.php

@@ -7,10 +7,26 @@ class ExampleTest extends \PHPUnit_Framework_TestCase
     use MatchesSnapshots;
 
     /** @test */
-    public function true_is_true()
+    public function can_match_a_string_snapshot()
     {
         $data = 'Foo';
 
         $this->assertMatchesSnapshot($data);
     }
+
+    /** @test */
+    public function can_match_an_xml_screenshot()
+    {
+        $data = '<foo><bar>Baz</bar></foo>';
+
+        $this->assertMatchesXmlSnapshot($data);
+    }
+
+    /** @test */
+    public function can_match_a_json_screenshot()
+    {
+        $data = '{"foo":"foo","bar":"bar","baz":"baz"}';
+
+        $this->assertMatchesJsonSnapshot($data);
+    }
 }

tests/MatchesSnapshots.php

@@ -4,45 +4,37 @@
 
 trait MatchesSnapshots
 {
-    private $snapshotCount = 0;
-
-    public function assertMatchesSnapshot($serializable)
+    public function assertMatchesSnapshot($actual, $type = 'var', $methodTrace = null)
     {
-        $this->snapshotCount++;
-
-        $snapshotHandler = SnapshotHandler::forTestMethod(
-            debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1],
-            $this->snapshotCount
+        $snapshot = Snapshot::forTestMethod(
+            $methodTrace ?? debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1],
+            $type
         );
 
-        if (! $snapshotHandler->exists()) {
-            $snapshotHandler->create($this->serializeForSnapshot($serializable));
+        if (! $snapshot->exists()) {
+            $snapshot->create($actual);
 
-            return $this->markTestIncomplete("Snapshot created for {$snapshotHandler->id()}");
+            return $this->markTestIncomplete("Snapshot created for {$snapshot->id()}");
         }
 
-        if ($this->shouldUpdateSnapshots()) {
-            $snapshotHandler->update($this->serializeForSnapshot($serializable));
-
-            return $this->markTestIncomplete("Snapshot updated for {$snapshotHandler->id()}");
+        if ($type === 'xml') {
+            return $this->assertXmlStringEqualsXmlString($snapshot->get(), $actual);
         }
 
-        return $this->assertEquals($snapshotHandler->get(), $serializable);
-    }
+        if ($type === 'json') {
+            return $this->assertJsonStringEqualsJsonString($snapshot->get(), $actual);
+        }
 
-    /** @after **/
-    public function resetSnapshotCounter()
-    {
-        $this->snapshotCount = 0;
+        $this->assertEquals($snapshot->get(), $actual);
     }
 
-    protected function shouldUpdateSnapshots(): bool
+    public function assertMatchesXmlSnapshot($actual)
     {
-        return getenv('UPDATE_SNAPSHOTS');
+        $this->assertMatchesSnapshot($actual, 'xml', debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1]);
     }
 
-    protected function serializeForSnapshot($serializable)
+    public function assertMatchesJsonSnapshot($actual)
     {
-        return $serializable;
+        $this->assertMatchesSnapshot($actual, 'json', debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2)[1]);
     }
 }

tests/Snapshot.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Spatie\Snapshots\Test;
+
+use DOMDocument;
+use ReflectionClass;
+use SimpleXMLElement;
+
+class Snapshot
+{
+    /** @var string */
+    protected $directory, $id, $type;
+
+    private function __construct(string $directory, string $id, string $type)
+    {
+        $this->directory = $directory;
+        $this->id = $id;
+        $this->type = $type;
+    }
+
+    public static function forTestMethod($backtrace, $type): self
+    {
+        $class = new ReflectionClass($backtrace['class']);
+        $method = $backtrace['function'];
+
+        $directory = dirname($class->getFileName()).'/__snapshots__';
+        $id = "{$class->getShortName()}__{$method}";
+
+        return new self($directory, $id, $type);
+    }
+
+    public function id(): string
+    {
+        return $this->id;
+    }
+
+    public function path(): string
+    {
+        $extension = $this->type === 'var' ? 'php' : $this->type;
+
+        return "{$this->directory}/{$this->id}.{$extension}";
+    }
+
+    public function exists(): bool
+    {
+        return file_exists($this->path());
+    }
+
+    public function get()
+    {
+        if ($this->type === 'var') {
+            return include $this->path();
+        }
+
+        return file_get_contents($this->path());
+    }
+
+    public function create($actual)
+    {
+        if (! file_exists($this->directory)) {
+            mkdir($this->directory);
+        }
+
+        file_put_contents($this->path(), $this->serializeForSnapshot($actual));
+    }
+
+    protected function serializeForSnapshot($data): string
+    {
+        if ($this->type === 'xml') {
+            return $this->formatXml($data);
+        }
+
+        if ($this->type === 'json') {
+            return $this->formatJson($data);
+        }
+
+        return '<?php return '.var_export($data, true).';';
+    }
+
+    protected function formatXml(string $xml): string
+    {
+        $domDocument = new DOMDocument('1.0');
+        $domDocument->preserveWhiteSpace = false;
+        $domDocument->formatOutput = true;
+
+        $domDocument->loadXML($xml);
+
+        return $domDocument->saveXML();
+    }
+
+    protected function formatJson(string $json): string
+    {
+        return json_encode(json_decode($json), JSON_PRETTY_PRINT);
+    }
+}

tests/SnapshotHandler.php

@@ -0,0 +1,5 @@
+{
+    "foo": "foo",
+    "bar": "bar",
+    "baz": "baz"
+}

tests/__snapshots__/ExampleTest.php

@@ -0,0 +1 @@
+<?php return 'Foo';

tests/__snapshots__/ExampleTest__can_match_a_json_screenshot.json

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<foo>
+  <bar>Baz</bar>
+</foo>