Store::saveEvent() - Code Metrics - Inspection of "Refactor Event Store to push into the DB immediate..." - C4Tech/laravel-ray-emitter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3bd81e...ed2a5b )

by Christopher

created 2016-03-01 16:50 UTC

Store::saveEvent() A

↳ Parent: Store

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	19
ccs	16
cts	16
cp	1
rs	9.4285
cc	1
eloc	14
nc	1
nop	1
crap	1

<?php namespace C4tech\RayEmitter\Event;

use C4tech\RayEmitter\Contracts\Domain\Event as EventInterface;
use C4tech\RayEmitter\Contracts\Event\Store as StoreInterface;
use Illuminate\Support\Facades\Event as EventBus;
use Illuminate\Database\Eloquent\Model;

class Store extends Model implements StoreInterface
{
    protected static $queue = [];

    /**
     * @inheritDoc
     */
    protected $table = 'event_store';

    /**
     * @inheritDoc
     */
    protected $fillable = [
        'identifier',
        'sequence',
        'event',
        'payload'
    ];

    /**
     * @inheritDoc
     */
    public function getFor($identifier)
    {
        $events = new Collection;

        $recorded_events = $this->newQuery()->forEntity($identifier)->get();
        foreach ($recorded_events as $record) {
            $events->append($this->restoreEvent($record));
        }

        return $events;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function replayAll()
    {
        $records = $this->all();

        $records->each(function ($record) {
            $event = $this->restoreEvent($record);
            EventBus::fire('replay:' . $record->event, [$event]);
        });
    }

    /**
     * Restore Event
     *
     * Unserialize saved record back into an Event.
     * @param  static         $record Event Store model record
     * @return EventInterface
     */
    protected function restoreEvent($record)
    {
        $class = $record->event;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $class::unserialize($record);
    }


    /**
     * @inheritDoc
     */
    public function saveEvent(EventInterface $event)
    {
        $class = get_class($event);
        $record = [
            'event'      => $class,
            'identifier' => $event->getId(),
            'payload'    => $event->serialize(),
            'sequence'   => $this->newQuery()
                                ->forEntity($event->getId())
                                ->count()
        ];
        static::create($record);

        self::$queue[] = [
            'event' => $class,
            'payload' => [$event]
        ];
        EventBus::fire('save:' . $class, [$event]);
    }

    /**
     * Save Queue
     *
     * Persist all queued Events into Event Store.
     * @return void
     */
    public function publishQueue()
    {
        foreach (static::$queue as $record) {
            EventBus::fire('publish:' . $record['event'], $record['payload']);
        }

        static::$queue = [];
    }

    /**
     * Scope: For Entity
     *
     * Query scope for Entity identifier.
     * @param  Query  $query      Query Builder
     * @param  string $identifier Entity identifier
     * @return Query
     */
    public function scopeForEntity($query, $identifier)
    {
        return $query->where('identifier', '=', $identifier);
    }
}


1		<?php namespace C4tech\RayEmitter\Event;
2
3		use C4tech\RayEmitter\Contracts\Domain\Event as EventInterface;
4		use C4tech\RayEmitter\Contracts\Event\Store as StoreInterface;
5		use Illuminate\Support\Facades\Event as EventBus;
6		use Illuminate\Database\Eloquent\Model;
7
8		class Store extends Model implements StoreInterface
9		{
10		protected static $queue = [];
11
12		/**
13		* @inheritDoc
14		*/
15		protected $table = 'event_store';
16
17		/**
18		* @inheritDoc
19		*/
20		protected $fillable = [
21		'identifier',
22		'sequence',
23		'event',
24		'payload'
25		];
26
27		/**
28		* @inheritDoc
29		*/
30	1	public function getFor($identifier)
31		{
32	1	$events = new Collection;
33
34	1	$recorded_events = $this->newQuery()->forEntity($identifier)->get();
35	1	foreach ($recorded_events as $record) {
36	1	$events->append($this->restoreEvent($record));
37	1	}
38
39	1	return $events;
		0 ignored issues – show Bug Best Practice introduced 2016-01-06 20:38 UTC by Report Bug Copy Issue Report The return type of `return $events;` (`C4tech\RayEmitter\Event\Collection`) is incompatible with the return type declared by the interface `C4tech\RayEmitter\Contracts\Event\Store::getFor` of type `C4tech\RayEmitter\Contra...tracts\Event\Collection`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
40		}
41
42	1	public function replayAll()
43		{
44	1	$records = $this->all();
45
46	1	$records->each(function ($record) {
47	1	$event = $this->restoreEvent($record);
48	1	EventBus::fire('replay:' . $record->event, [$event]);
49	1	});
50	1	}
51
52		/**
53		* Restore Event
54		*
55		* Unserialize saved record back into an Event.
56		* @param static $record Event Store model record
57		* @return EventInterface
58		*/
59	1	protected function restoreEvent($record)
60		{
61	1	$class = $record->event;
		0 ignored issues – show Documentation introduced 2016-01-25 22:43 UTC by Report Bug Copy Issue Report The property `event` does not exist on `object<C4tech\RayEmitter\Event\Store>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
62
63	1	return $class::unserialize($record);
64		}
65
66
67		/**
68		* @inheritDoc
69		*/
70	1	public function saveEvent(EventInterface $event)
71		{
72	1	$class = get_class($event);
73		$record = [
74	1	'event' => $class,
75	1	'identifier' => $event->getId(),
76	1	'payload' => $event->serialize(),
77	1	'sequence' => $this->newQuery()
78	1	->forEntity($event->getId())
79	1	->count()
80	1	];
81	1	static::create($record);
82
83	1	self::$queue[] = [
84	1	'event' => $class,
85	1	'payload' => [$event]
86	1	];
87	1	EventBus::fire('save:' . $class, [$event]);
88	1	}
89
90		/**
91		* Save Queue
92		*
93		* Persist all queued Events into Event Store.
94		* @return void
95		*/
96	1	public function publishQueue()
97		{
98	1	foreach (static::$queue as $record) {
99	1	EventBus::fire('publish:' . $record['event'], $record['payload']);
100	1	}
101
102	1	static::$queue = [];
103	1	}
104
105		/**
106		* Scope: For Entity
107		*
108		* Query scope for Entity identifier.
109		* @param Query $query Query Builder
110		* @param string $identifier Entity identifier
111		* @return Query
112		*/
113	1	public function scopeForEntity($query, $identifier)
114		{
115	1	return $query->where('identifier', '=', $identifier);
116		}
117		}
118

C4Tech / laravel-ray-emitter

Push — master ( 3bd81e...ed2a5b )

Store::saveEvent() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like