AggregateRoot - Code Metrics - Inspection of "[WIP] [Feature] Event sourced entities" - SmoothPhp/CQRS-ES-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#21)

by jrdn

created 2015-12-16 22:00 UTC

AggregateRoot A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	95
Duplicated Lines	8.42 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	8
loc	95
wmc	10
lcom	1
cbo	4
ccs	38
cts	38
cp	1
rs	10

7 Methods

Rating	Name	Duplication	Size	Complexity
A	apply()	0	12	1
A	handle()	8	8	2
A	handleRecursively()	0	9	2
A	getApplyMethod()	0	6	1
A	getUncommittedEvents()	0	8	1
A	initializeState()	0	7	2
A	addChildEntity()	0	4	1

How to fix Duplicated Code

<?php
namespace SmoothPhp\EventSourcing;

use SmoothPhp\Contracts\EventSourcing\AggregateRoot as AggregateRootInterface;
use SmoothPhp\Contracts\EventSourcing\Entity;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use SmoothPhp\Contracts\EventSourcing\Event;
use SmoothPhp\Domain\DomainEventStream;
use SmoothPhp\Domain\DomainMessage;
use SmoothPhp\Domain\Metadata;

/**
 * Class AggregateRoot
 * @author Simon Bennett <[email protected]>
 */
abstract class AggregateRoot implements AggregateRootInterface
{
    /**
     * @var []
     */
    private $uncommittedEvents = [];

    private $playHead = -1;

    /** @var Entity[] */
    private $children = [];

    /**
     * @param Event $event
     */
    public function apply(Event $event)
    {
        $this->handleRecursively($event);

        $this->playHead++;
        $this->uncommittedEvents[] = DomainMessage::recordNow(
            $this->getAggregateRootId(),
            $this->playHead,
            new Metadata(array()),
            $event
        );
    }


    /**
     * Handles event if capable.
     *
     * @param $event
     */
    protected function handle(Event $event)

    {
        $method = $this->getApplyMethod($event);
        if (!method_exists($this, $method)) {
            return;
        }
        $this->$method($event);
    }

    protected function handleRecursively(Event $event)
    {
        $this->handle($event);

        foreach ($this->children as $child) {
            $child->registerAggregateRoot($this);
            $child->handleRecursively($event);
        }
    }

    /**
     * @param Event $event
     * @return string
     */
    private function getApplyMethod(Event $event)
    {
        $classParts = explode('\\', get_class($event));

        return 'apply' . end($classParts);
    }

    /**
     * @return DomainEventStream
     */
    public function getUncommittedEvents()
    {
        $stream = new DomainEventStream($this->uncommittedEvents);

        $this->uncommittedEvents = [];

        return $stream;
    }

    /**
     * @param DomainEventStream $stream
     */
    public function initializeState(DomainEventStream $stream)
    {
        foreach ($stream as $message) {
            $this->playHead++;
            $this->handle($message->getPayload());
        }
    }

    /**
     * @param Entity $entity
     */
    public function addChildEntity(Entity $entity)
    {
        $this->children[] = $entity;
    }
}

1			<?php
2			namespace SmoothPhp\EventSourcing;
3
4			use SmoothPhp\Contracts\EventSourcing\AggregateRoot as AggregateRootInterface;
5			use SmoothPhp\Contracts\EventSourcing\Entity;
			0 ignored issues – show Bug introduced 2015-12-16 21:59 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `SmoothPhp\EventSourcing\Entity`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use SmoothPhp\Contracts\EventSourcing\Event;
7			use SmoothPhp\Domain\DomainEventStream;
8			use SmoothPhp\Domain\DomainMessage;
9			use SmoothPhp\Domain\Metadata;
10
11			/**
12			* Class AggregateRoot
13			* @author Simon Bennett <[email protected]>
14			*/
15			abstract class AggregateRoot implements AggregateRootInterface
16			{
17			/**
18			* @var []
19			*/
20			private $uncommittedEvents = [];
21
22			private $playHead = -1;
23
24			/** @var Entity[] */
25			private $children = [];
26
27			/**
28			* @param Event $event
29			*/
30	18		public function apply(Event $event)
31			{
32	18		$this->handleRecursively($event);
33
34	18		$this->playHead++;
35	18		$this->uncommittedEvents[] = DomainMessage::recordNow(
36	18		$this->getAggregateRootId(),
37	18		$this->playHead,
38	18		new Metadata(array()),
39			$event
40	18		);
41	18		}
42
43
44			/**
45			* Handles event if capable.
46			*
47			* @param $event
48			*/
49	24	View Code Duplication	protected function handle(Event $event)
			0 ignored issues – show Duplication introduced 2015-12-16 21:59 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
50			{
51	24		$method = $this->getApplyMethod($event);
52	24		if (!method_exists($this, $method)) {
53	18		return;
54			}
55	6		$this->$method($event);
56	6		}
57
58	18		protected function handleRecursively(Event $event)
59			{
60	18		$this->handle($event);
61
62	18		foreach ($this->children as $child) {
63	6		$child->registerAggregateRoot($this);
64	6		$child->handleRecursively($event);
65	18		}
66	18		}
67
68			/**
69			* @param Event $event
70			* @return string
71			*/
72	24		private function getApplyMethod(Event $event)
73			{
74	24		$classParts = explode('\\', get_class($event));
75
76	24		return 'apply' . end($classParts);
77			}
78
79			/**
80			* @return DomainEventStream
81			*/
82	15		public function getUncommittedEvents()
83			{
84	15		$stream = new DomainEventStream($this->uncommittedEvents);
85
86	15		$this->uncommittedEvents = [];
87
88	15		return $stream;
89			}
90
91			/**
92			* @param DomainEventStream $stream
93			*/
94	6		public function initializeState(DomainEventStream $stream)
95			{
96	6		foreach ($stream as $message) {
97	6		$this->playHead++;
98	6		$this->handle($message->getPayload());
99	6		}
100	6		}
101
102			/**
103			* @param Entity $entity
104			*/
105	6		public function addChildEntity(Entity $entity)
106			{
107	6		$this->children[] = $entity;
108			}
109			}

SmoothPhp / CQRS-ES-Framework

GitHub Access Token became invalid

Pull Request — develop (#21)

AggregateRoot A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like