Spatie\Snapshots\MatchesSnapshots

Complexity

Total Complexity

12

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	assertMatchesSnapshot()	0	6	1
A	assertMatchesXmlSnapshot()	0	4	1
A	assertMatchesJsonSnapshot()	0	4	1
A	getSnapshotTestName()	0	4	1
A	getSnapshotTestCaseName()	0	4	1
A	getSnapshotDirectory()	0	6	1
A	shouldUpdateSnapshot()	0	4	1
A	createSnapshotWithDriver()	0	9	1
B	doSnapShotAssertion()	0	23	4

<?php

namespace Spatie\Snapshots;

use PHPUnit\Framework\ExpectationFailedException;
use ReflectionClass;
use Spatie\Snapshots\Drivers\JsonDriver;
use Spatie\Snapshots\Drivers\VarDriver;
use Spatie\Snapshots\Drivers\XmlDriver;

trait MatchesSnapshots
{
    public function assertMatchesSnapshot($actual, Driver $driver = null)
    {
        $snapshot = $this->createSnapshotWithDriver($driver ?? new VarDriver());

        $this->doSnapShotAssertion($snapshot, $actual);
    }

    public function assertMatchesXmlSnapshot($actual)
    {
        $this->assertMatchesSnapshot($actual, new XmlDriver());
    }

    public function assertMatchesJsonSnapshot($actual)
    {
        $this->assertMatchesSnapshot($actual, new JsonDriver());
    }

    /**
     * Determines the snapshot's test, which is the first part of the ID.
     * By default, the test class' name is used.
     *
     * @return string
     */
    protected function getSnapshotTestName(): string
    {
        return (new ReflectionClass($this))->getShortName();
    }

    /**
     * Determines the snapshot's test case, which is the second part of the ID.
     * By default, the test case's method name is used.
     *
     * @return string
     */
    protected function getSnapshotTestCaseName(): string
    {
        return $this->getName();

It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Determines the directory where snapshots are stored. By default a
     * `__snapshots__` directory is created at the same level as the test
     * class.
     *
     * @return string
     */
    protected function getSnapshotDirectory(): string
    {
        return dirname((new ReflectionClass($this))->getFileName()).
            DIRECTORY_SEPARATOR.
            '__snapshots__';
    }

    /**
     * Determines whether or not the snapshot should be updated instead of
     * matched.
     *
     * Override this method it you want to use a different flag or mechanism
     * than `-d --update-snapshots`.
     *
     * @return bool
     */
    protected function shouldUpdateSnapshot(): bool
    {
        return in_array('--update-snapshots', $_SERVER['argv'], true);
    }

    protected function createSnapshotWithDriver(Driver $driver): Snapshot
    {
        return Snapshot::forTestCase(
            $this->getSnapshotTestName(),
            $this->getSnapshotTestCaseName(),
            $this->getSnapshotDirectory(),
            $driver
        );
    }

    protected function doSnapShotAssertion(Snapshot $snapshot, $actual)
    {
        if (! $snapshot->exists()) {
            $snapshot->create($actual);

            return $this->markTestIncomplete("Snapshot created for {$snapshot->id()}");

It seems like markTestIncomplete() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($this->shouldUpdateSnapshot()) {
            try {
                // We only want to update snapshots which need updating. If the snapshot doesn't
                // match the expected output, we'll catch the failure, create a new snapshot and
                // mark the test as incomplete.
                $snapshot->assertMatches($actual);
            } catch (ExpectationFailedException $exception) {
                $snapshot->create($actual);

                return $this->markTestIncomplete("Snapshot updated for {$snapshot->id()}");

It seems like markTestIncomplete() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }
        }

        $snapshot->assertMatches($actual);
    }
}