DBALEventStore::eventLog() - Code Metrics - Inspection of "Major storage changes to the way EventStore works...." - rawkode/eidetic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#41)

by David

created 2015-12-03 15:34 UTC

DBALEventStore::eventLog() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
ccs	9
cts	9
cp	1
rs	9.4286
cc	2
eloc	10
nc	2
nop	1
crap	2

<?php

namespace Rawkode\Eidetic\EventStore\DBALEventStore;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DriverManager;
use Rawkode\Eidetic\EventStore\EventStore;
use Rawkode\Eidetic\EventStore\NoEventsFoundForKeyException;
use Rawkode\Eidetic\EventSourcing\EventSourcedEntity;

final class DBALEventStore extends EventStore
{
    /**
     * @var string
     */
    private $tableName;

    /**
     * @var Connection
     */
    private $connection;

    /**
     * @param string     $tableName
     * @param Connection $connection
     */
    private function __construct($tableName, Connection $connection)
    {
        $this->tableName = $tableName;
        $this->connection = $connection;
    }

    /**
     * @param string $tableName
     * @param array  $options
     *
     * @return self
     */
    public static function createWithOptions($tableName, array $options)
    {
        $connection = DriverManager::getConnection($options);

        return new self($tableName, $connection);
    }

    /**
     * @param EventSourcedEntity $eventSourcedEntity
     */
    protected function persist(EventSourcedEntity $eventSourcedEntity)
    {
        $eventCount = $this->countEntityEvents($eventSourcedEntity->identifier());

        array_map(function ($event) use ($eventSourcedEntity, &$eventCount) {
            $this->connection->insert($this->tableName, [
                'entity_identifier' => $eventSourcedEntity->identifier(),
                'serial_number' => ++$eventCount,
                'entity_class' => get_class($eventSourcedEntity),
                'recorded_at' => new \DateTime('now', new \DateTimeZone('UTC')),
                'event_class' => get_class($event),
                'event' => $this->serialize($event),
            ], [
                \PDO::PARAM_STR,
                \PDO::PARAM_INT,
                \PDO::PARAM_STR,
                'datetime',
                \PDO::PARAM_STR,
                \PDO::PARAM_STR,
            ]);

            array_push($this->stagedEvents, $event);

        }, $eventSourcedEntity->stagedEvents());
    }

    /**
     * @param string $entityIdentifier
     *
     * @throws NoEventsFoundForKeyException
     *
     * @return array
     */
    protected function eventLog($entityIdentifier)
    {
        if (0 === $this->countEntityEvents($entityIdentifier)) {
            throw new NoEventsFoundForKeyException();
        }

        $statement = $this->eventLogQuery($entityIdentifier)->execute();

        $eventLog = $statement->fetchAll();

        return array_map(function ($eventLogEntry) {
            $eventLogEntry['event'] = $this->unserialize($eventLogEntry['event']);
            $eventLogEntry['recorded_at'] = new \DateTime($eventLogEntry['recorded_at']);

            return $eventLogEntry;
        }, $eventLog);
    }

    /**
     */
    protected function startTransaction()
    {
        $this->connection->beginTransaction();
        $this->stagedEvents = [];

    }

    /**
     */
    protected function abortTransaction()
    {
        $this->connection->rollBack();
        $this->stagedEvents = [];

    }

    /**
     */
    protected function completeTransaction()
    {
        $this->connection->commit();

        array_map(function ($event) {
            $this->publish(self::EVENT_STORED, $event);
        }, $this->stagedEvents);


        $this->stagedEvents = [];

    }

    /**
     */
    public function createTable()
    {
        $schemaManager = $this->connection->getSchemaManager();
        $schema = $schemaManager->createSchema();

        if ($schema->hasTable($this->tableName)) {
            return;
        }

        $table = $schema->createTable($this->tableName);

        $table->addColumn('entity_identifier', 'string', ['length' => 255]);
        $table->addColumn('serial_number', 'integer');

        $table->setPrimaryKey(['entity_identifier', 'serial_number']);

        $table->addColumn('entity_class', 'string', ['length' => 255]);
        $table->addColumn('recorded_at', 'datetime');
        $table->addColumn('event_class', 'string', ['length' => 255]);
        $table->addColumn('event', 'text');

        $table->addIndex(['entity_class']);
        $table->addIndex(['recorded_at']);
        $table->addIndex(['event_class']);

        $schemaManager->createTable($table);
    }

    /**
     */
    public function dropTable()
    {
        $this->connection->getSchemaManager()->dropTable($this->tableName);
    }

    /**
     * @param string $entityIdentifier
     *
     * @return int
     */
    private function countEntityEvents($entityIdentifier)
    {
        $queryBuilder = $this->connection->createQueryBuilder();

        $queryBuilder->select('COUNT(entity_identifier)');
        $queryBuilder->from($this->tableName);
        $queryBuilder->where('entity_identifier = :entity_identifier');

        $queryBuilder->setParameter('entity_identifier', $entityIdentifier);

        return (int) $queryBuilder->execute()->fetchColumn(0);
    }

    /**
     * @param string $entityIdentifier
     *
     * @return \Doctrine\DBAL\Query\QueryBuilder
     */
    protected function eventLogQuery($entityIdentifier)
    {
        $queryBuilder = $this->connection->createQueryBuilder();

        $queryBuilder->select('*');
        $queryBuilder->from($this->tableName);
        $queryBuilder->where('entity_identifier = :entity_identifier');
        $queryBuilder->orderBy('serial_number', 'ASC');

        $queryBuilder->setParameter('entity_identifier', $entityIdentifier);

        return $queryBuilder;
    }

    /**
     * @param string $entityIdentifier
     *
     * @return array
     */
    protected function singleLogForKey($entityIdentifier)
    {
        $queryBuilder = $this->eventLogQuery($entityIdentifier);

        $queryBuilder->setMaxResults(1);

        $statement = $queryBuilder->execute();

        $results = $statement->fetchAll();

        return $results;
    }
}


1		<?php
2
3		namespace Rawkode\Eidetic\EventStore\DBALEventStore;
4
5		use Doctrine\DBAL\Connection;
6		use Doctrine\DBAL\DriverManager;
7		use Rawkode\Eidetic\EventStore\EventStore;
8		use Rawkode\Eidetic\EventStore\NoEventsFoundForKeyException;
9		use Rawkode\Eidetic\EventSourcing\EventSourcedEntity;
10
11		final class DBALEventStore extends EventStore
12		{
13		/**
14		* @var string
15		*/
16		private $tableName;
17
18		/**
19		* @var Connection
20		*/
21		private $connection;
22
23		/**
24		* @param string $tableName
25		* @param Connection $connection
26		*/
27	5	private function __construct($tableName, Connection $connection)
28		{
29	5	$this->tableName = $tableName;
30	5	$this->connection = $connection;
31	5	}
32
33		/**
34		* @param string $tableName
35		* @param array $options
36		*
37		* @return self
38		*/
39	5	public static function createWithOptions($tableName, array $options)
40		{
41	5	$connection = DriverManager::getConnection($options);
42
43	5	return new self($tableName, $connection);
44		}
45
46		/**
47		* @param EventSourcedEntity $eventSourcedEntity
48		*/
49	4	protected function persist(EventSourcedEntity $eventSourcedEntity)
50		{
51	4	$eventCount = $this->countEntityEvents($eventSourcedEntity->identifier());
52
53		array_map(function ($event) use ($eventSourcedEntity, &$eventCount) {
54	4	$this->connection->insert($this->tableName, [
55	4	'entity_identifier' => $eventSourcedEntity->identifier(),
56	4	'serial_number' => ++$eventCount,
57	4	'entity_class' => get_class($eventSourcedEntity),
58	4	'recorded_at' => new \DateTime('now', new \DateTimeZone('UTC')),
59	4	'event_class' => get_class($event),
60	4	'event' => $this->serialize($event),
61	4	], [
62	4	\PDO::PARAM_STR,
63	4	\PDO::PARAM_INT,
64	4	\PDO::PARAM_STR,
65	4	'datetime',
66	4	\PDO::PARAM_STR,
67	4	\PDO::PARAM_STR,
68	4	]);
69
70	4	array_push($this->stagedEvents, $event);
		0 ignored issues – show Bug introduced 2015-12-03 15:40 UTC by Report Bug Copy Issue Report The property `stagedEvents` cannot be accessed from this context as it is declared `private` in class `Rawkode\Eidetic\EventStore\EventStore`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
71	4	}, $eventSourcedEntity->stagedEvents());
72	4	}
73
74		/**
75		* @param string $entityIdentifier
76		*
77		* @throws NoEventsFoundForKeyException
78		*
79		* @return array
80		*/
81	4	protected function eventLog($entityIdentifier)
82		{
83	4	if (0 === $this->countEntityEvents($entityIdentifier)) {
84	1	throw new NoEventsFoundForKeyException();
85		}
86
87	3	$statement = $this->eventLogQuery($entityIdentifier)->execute();
88
89	3	$eventLog = $statement->fetchAll();
90
91		return array_map(function ($eventLogEntry) {
92	3	$eventLogEntry['event'] = $this->unserialize($eventLogEntry['event']);
93	3	$eventLogEntry['recorded_at'] = new \DateTime($eventLogEntry['recorded_at']);
94
95	3	return $eventLogEntry;
96	3	}, $eventLog);
97		}
98
99		/**
100		*/
101	4	protected function startTransaction()
102		{
103	4	$this->connection->beginTransaction();
104	4	$this->stagedEvents = [];
		0 ignored issues – show Bug introduced 2015-12-03 15:40 UTC by Report Bug Copy Issue Report The property `stagedEvents` cannot be accessed from this context as it is declared `private` in class `Rawkode\Eidetic\EventStore\EventStore`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
105	4	}
106
107		/**
108		*/
109		protected function abortTransaction()
110		{
111		$this->connection->rollBack();
112		$this->stagedEvents = [];
		0 ignored issues – show Bug introduced 2015-12-03 15:40 UTC by Report Bug Copy Issue Report The property `stagedEvents` cannot be accessed from this context as it is declared `private` in class `Rawkode\Eidetic\EventStore\EventStore`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
113		}
114
115		/**
116		*/
117	4	protected function completeTransaction()
118		{
119	4	$this->connection->commit();
120
121	4	array_map(function ($event) {
122	4	$this->publish(self::EVENT_STORED, $event);
123	4	}, $this->stagedEvents);
		0 ignored issues – show Bug introduced 2015-12-03 15:40 UTC by Report Bug Copy Issue Report The property `stagedEvents` cannot be accessed from this context as it is declared `private` in class `Rawkode\Eidetic\EventStore\EventStore`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
124
125	4	$this->stagedEvents = [];
		0 ignored issues – show Bug introduced 2015-12-03 15:40 UTC by Report Bug Copy Issue Report The property `stagedEvents` cannot be accessed from this context as it is declared `private` in class `Rawkode\Eidetic\EventStore\EventStore`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
126	4	}
127
128		/**
129		*/
130	5	public function createTable()
131		{
132	5	$schemaManager = $this->connection->getSchemaManager();
133	5	$schema = $schemaManager->createSchema();
134
135	5	if ($schema->hasTable($this->tableName)) {
136		return;
137		}
138
139	5	$table = $schema->createTable($this->tableName);
140
141	5	$table->addColumn('entity_identifier', 'string', ['length' => 255]);
142	5	$table->addColumn('serial_number', 'integer');
143
144	5	$table->setPrimaryKey(['entity_identifier', 'serial_number']);
145
146	5	$table->addColumn('entity_class', 'string', ['length' => 255]);
147	5	$table->addColumn('recorded_at', 'datetime');
148	5	$table->addColumn('event_class', 'string', ['length' => 255]);
149	5	$table->addColumn('event', 'text');
150
151	5	$table->addIndex(['entity_class']);
152	5	$table->addIndex(['recorded_at']);
153	5	$table->addIndex(['event_class']);
154
155	5	$schemaManager->createTable($table);
156	5	}
157
158		/**
159		*/
160	5	public function dropTable()
161	1	{
162	5	$this->connection->getSchemaManager()->dropTable($this->tableName);
163	5	}
164
165		/**
166		* @param string $entityIdentifier
167		*
168		* @return int
169		*/
170	5	private function countEntityEvents($entityIdentifier)
171		{
172	5	$queryBuilder = $this->connection->createQueryBuilder();
173
174	5	$queryBuilder->select('COUNT(entity_identifier)');
175	5	$queryBuilder->from($this->tableName);
176	5	$queryBuilder->where('entity_identifier = :entity_identifier');
177
178	5	$queryBuilder->setParameter('entity_identifier', $entityIdentifier);
179
180	5	return (int) $queryBuilder->execute()->fetchColumn(0);
181		}
182
183		/**
184		* @param string $entityIdentifier
185		*
186		* @return \Doctrine\DBAL\Query\QueryBuilder
187		*/
188	3	protected function eventLogQuery($entityIdentifier)
189		{
190	3	$queryBuilder = $this->connection->createQueryBuilder();
191
192	3	$queryBuilder->select('*');
193	3	$queryBuilder->from($this->tableName);
194	3	$queryBuilder->where('entity_identifier = :entity_identifier');
195	3	$queryBuilder->orderBy('serial_number', 'ASC');
196
197	3	$queryBuilder->setParameter('entity_identifier', $entityIdentifier);
198
199	3	return $queryBuilder;
200		}
201
202		/**
203		* @param string $entityIdentifier
204		*
205		* @return array
206		*/
207		protected function singleLogForKey($entityIdentifier)
208		{
209		$queryBuilder = $this->eventLogQuery($entityIdentifier);
210
211		$queryBuilder->setMaxResults(1);
212
213		$statement = $queryBuilder->execute();
214
215		$results = $statement->fetchAll();
216
217		return $results;
218		}
219		}
220

rawkode / eidetic

Pull Request — master (#41)

DBALEventStore::eventLog() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like