Spatie\EventProjector\Snapshots\Snapshot

Complexity

Total Complexity

17

Size/Duplication

Total Lines	129
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	isValid()	0	4	1
A	fileName()	0	4	1
A	lastProcessedEventId()	0	4	1
A	lastProcessedEvent()	0	14	2
A	projectorName()	0	4	1
A	projector()	0	10	2
A	name()	0	4	1
A	write()	0	4	1
A	read()	0	4	1
A	readStream()	0	4	1
A	delete()	0	4	1
A	createdAt()	0	6	1
A	fileNameParts()	0	14	1
A	restore()	0	8	1

<?php

namespace Spatie\EventProjector\Snapshots;

use Carbon\Carbon;
use Spatie\EventProjector\EventProjectionist;
use Illuminate\Contracts\Filesystem\Filesystem;
use Spatie\EventProjector\Exceptions\InvalidSnapshot;
use Spatie\EventProjector\Models\StoredEvent;

class Snapshot
{
    /** @var \Spatie\EventProjector\EventProjectionist */
    protected $eventProjectionist;

    /** @var \Illuminate\Contracts\Filesystem\Filesystem */
    protected $disk;

    /** @var string */
    protected $fileName;

    public function __construct(
        EventProjectionist $eventProjectionist,
        array $config,

The parameter $config is not used and could be removed.

        Filesystem $disk,
        string $fileName)
    {
        $this->eventProjectionist = $eventProjectionist;

        $this->disk = $disk;

        $this->fileName = $fileName;
    }

    public function isValid(): bool
    {
        return $this->projectorName() !== '';
    }

    public function fileName(): string
    {
        return $this->fileName;
    }

    public function lastProcessedEventId(): int
    {
        return $this->fileNameParts()['lastProcessedEventId'];
    }

    public function lastProcessedEvent(): StoredEvent
    {
        $storedEventModelClass = $this->config['stored_event_model'];

The property config does not exist. Did you maybe forget to declare it?

        $storedEvent = $storedEventModelClass::query()
            ->where('last_processed_event_id', $this->lastProcessedEventId())
            ->first();

        if (! $storedEvent) {
            throw InvalidSnapshot::lastProcessedEventDoesNotExist($this);
        }

        return $storedEvent;
    }

    public function projectorName(): string
    {
        return $this->fileNameParts()['projectorName'];
    }

    public function projector(): Snapshottable
    {
        $projectorName = $this->projectorName();

        if (! $projector = $this->eventProjectionist->getProjector($projectorName)) {
            throw InvalidSnapshot::projectorDoesNotExist($this);
        }

        return $projector;
    }

    public function name(): string
    {
        return $this->fileNameParts()['name'];
    }

    /**
     * @param string|resource $contents
     */
    public function write($contents)
    {
        $this->disk->put($this->fileName, $contents);
    }

    public function read(): ?string
    {
        return $this->disk->get($this->fileName);
    }

    public function readStream()
    {
        return $this->disk->readStream($this->fileName);

The method readStream() does not seem to exist on object<Illuminate\Contracts\Filesystem\Filesystem>.

    }

    public function restore(): self
    {
        $storedEvent = $this->lastProcessedEvent();

        $this->projector()->restoreSnapshot($this);

        $this->config['projector_status_model']::rememberLastProcessedEvent($storedEvent);
    }

    public function delete()
    {
        $this->disk->delete($this->fileName);
    }

    public function createdAt(): Carbon
    {
        $timestamp = $this->disk->lastModified($this->fileName);

        return Carbon::createFromTimestamp($timestamp);
    }

    protected function fileNameParts(): array
    {
        $baseName = pathinfo($this->fileName, PATHINFO_FILENAME);

        $nameParts = explode('---', $baseName);

        $projectorName = str_replace('+', '\\', $nameParts[1] ?? '');

        $lastProcessedEventId = $nameParts[2] ?? 0;

        $name = $nameParts[3] ?? '';

        return compact('projectorName', 'lastProcessedEventId', 'name');
    }
}