ProjectsEvents::groupProjectorStatusBy() - Code Metrics - Inspection of "rename method" - spatie/laravel-event-projector - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 06db97...7bf108 )

by Freek

created 2018-06-26 16:11 UTC

ProjectsEvents::groupProjectorStatusBy() A

↳ Parent: ProjectsEvents

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Spatie\EventProjector\Projectors;

use Carbon\Carbon;
use Illuminate\Support\Collection;
use Spatie\EventProjector\Models\StoredEvent;
use Spatie\EventProjector\Models\ProjectorStatus;
use Spatie\EventProjector\EventHandlers\HandlesEvents;
use Spatie\EventProjector\Exceptions\CouldNotResetProjector;

trait ProjectsEvents
{
    use HandlesEvents;

    public function getName(): string
    {
        if (isset($this->name)) {
            return $this->name;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        return get_class($this);
    }

    public function rememberReceivedEvent(StoredEvent $storedEvent)
    {
        $streamFullNames = collect($this->streamEventsBy($storedEvent))
            ->map(function ($streamValue, $streamName) {
                return "{$streamName}-{$streamValue}";
            })
            ->toArray();

        if (count($streamFullNames) === 0) {
            $streamFullNames = ['main'];
        }

        foreach ($streamFullNames as $streamName) {
            $this->getStatus($streamName)->rememberLastProcessedEvent($storedEvent, $this);
        }
    }

    public function hasReceivedAllPriorEvents(StoredEvent $storedEvent): bool
    {
        $streams = collect($this->streamEventsBy($storedEvent));

        if ($streams->isEmpty()) {
            $lastStoredEvent = StoredEvent::query()
                ->whereIn('event_class', $this->handlesEventClassNames())
                ->where('id', '<', $storedEvent->id)
                ->orderBy('id', 'desc')
                ->first();

            $lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;

            $lastProcessedEventId = (int) $this->getStatus()->last_processed_event_id ?? 0;

            return $lastStoredEventId === $lastProcessedEventId;
        }

        foreach ($streams as $streamName => $streamValue) {
            $streamFullName = "{$streamName}-{$streamValue}";
            $whereJsonClause = str_replace('.', '->', $streamName);

            $lastStoredEvent = StoredEvent::query()
                ->whereIn('event_class', $this->handlesEventClassNames())
                ->where('id', '<', $storedEvent->id)
                ->where("event_properties->{$whereJsonClause}", $streamValue)
                ->orderBy('id', 'desc')
                ->first();

            $lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;

            $lastProcessedEventId = (int) $this->getStatus($streamFullName)->last_processed_event_id ?? 0;

            if ($lastStoredEventId !== $lastProcessedEventId) {
                return false;
            }
        }

        return true;
    }

    public function hasReceivedAllEvents(): bool
    {
        return ProjectorStatus::hasReceivedAllEvents($this);
    }

    public function getLastProcessedEventId(): int
    {
        return $this->getStatus()->last_processed_event_id ?? 0;
    }

    public function lastEventProcessedAt(): Carbon
    {
        return $this->getStatus()->updated_at;
    }

    public function reset()
    {
        if (! method_exists($this, 'resetState')) {
            throw CouldNotResetProjector::doesNotHaveResetStateMethod($this);
        }

        $this->resetState();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->getAllStatuses()->each->delete();
    }

    public function shouldBeCalledImmediately(): bool
    {
        return ! $this instanceof QueuedProjector;
    }

    public function streamEventsBy(StoredEvent $storedEvent): array

    {
        return [];
    }

    protected function getStatus(string $stream = 'main'): ProjectorStatus
    {
        return ProjectorStatus::getForProjector($this, $stream);
    }

    protected function getAllStatuses(): Collection
    {
        return ProjectorStatus::getAllForProjector($this);
    }
}


1			<?php
2
3			namespace Spatie\EventProjector\Projectors;
4
5			use Carbon\Carbon;
6			use Illuminate\Support\Collection;
7			use Spatie\EventProjector\Models\StoredEvent;
8			use Spatie\EventProjector\Models\ProjectorStatus;
9			use Spatie\EventProjector\EventHandlers\HandlesEvents;
10			use Spatie\EventProjector\Exceptions\CouldNotResetProjector;
11
12			trait ProjectsEvents
13			{
14			use HandlesEvents;
15
16			public function getName(): string
17			{
18			if (isset($this->name)) {
19			return $this->name;
			0 ignored issues – show Bug introduced 2018-05-22 18:48 UTC by Report Bug Copy Issue Report The property `name` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
20			}
21
22			return get_class($this);
23			}
24
25			public function rememberReceivedEvent(StoredEvent $storedEvent)
26			{
27			$streamFullNames = collect($this->streamEventsBy($storedEvent))
28			->map(function ($streamValue, $streamName) {
29			return "{$streamName}-{$streamValue}";
30			})
31			->toArray();
32
33			if (count($streamFullNames) === 0) {
34			$streamFullNames = ['main'];
35			}
36
37			foreach ($streamFullNames as $streamName) {
38			$this->getStatus($streamName)->rememberLastProcessedEvent($storedEvent, $this);
39			}
40			}
41
42			public function hasReceivedAllPriorEvents(StoredEvent $storedEvent): bool
43			{
44			$streams = collect($this->streamEventsBy($storedEvent));
45
46			if ($streams->isEmpty()) {
47			$lastStoredEvent = StoredEvent::query()
48			->whereIn('event_class', $this->handlesEventClassNames())
49			->where('id', '<', $storedEvent->id)
50			->orderBy('id', 'desc')
51			->first();
52
53			$lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;
54
55			$lastProcessedEventId = (int) $this->getStatus()->last_processed_event_id ?? 0;
56
57			return $lastStoredEventId === $lastProcessedEventId;
58			}
59
60			foreach ($streams as $streamName => $streamValue) {
61			$streamFullName = "{$streamName}-{$streamValue}";
62			$whereJsonClause = str_replace('.', '->', $streamName);
63
64			$lastStoredEvent = StoredEvent::query()
65			->whereIn('event_class', $this->handlesEventClassNames())
66			->where('id', '<', $storedEvent->id)
67			->where("event_properties->{$whereJsonClause}", $streamValue)
68			->orderBy('id', 'desc')
69			->first();
70
71			$lastStoredEventId = (int) optional($lastStoredEvent)->id ?? 0;
72
73			$lastProcessedEventId = (int) $this->getStatus($streamFullName)->last_processed_event_id ?? 0;
74
75			if ($lastStoredEventId !== $lastProcessedEventId) {
76			return false;
77			}
78			}
79
80			return true;
81			}
82
83			public function hasReceivedAllEvents(): bool
84			{
85			return ProjectorStatus::hasReceivedAllEvents($this);
86			}
87
88			public function getLastProcessedEventId(): int
89			{
90			return $this->getStatus()->last_processed_event_id ?? 0;
91			}
92
93			public function lastEventProcessedAt(): Carbon
94			{
95			return $this->getStatus()->updated_at;
96			}
97
98			public function reset()
99			{
100			if (! method_exists($this, 'resetState')) {
101			throw CouldNotResetProjector::doesNotHaveResetStateMethod($this);
102			}
103
104			$this->resetState();
			0 ignored issues – show Bug introduced 2018-06-01 16:16 UTC by Report Bug Copy Issue Report It seems like `resetState()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
105
106			$this->getAllStatuses()->each->delete();
107			}
108
109			public function shouldBeCalledImmediately(): bool
110			{
111			return ! $this instanceof QueuedProjector;
112			}
113
114			public function streamEventsBy(StoredEvent $storedEvent): array
			0 ignored issues – show Unused Code introduced 2018-06-26 16:16 UTC by Report Bug Copy Issue Report The parameter `$storedEvent` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
115			{
116			return [];
117			}
118
119			protected function getStatus(string $stream = 'main'): ProjectorStatus
120			{
121			return ProjectorStatus::getForProjector($this, $stream);
122			}
123
124			protected function getAllStatuses(): Collection
125			{
126			return ProjectorStatus::getAllForProjector($this);
127			}
128			}
129

spatie / laravel-event-projector

Push — master ( 06db97...7bf108 )

ProjectsEvents::groupProjectorStatusBy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like