Message::withTimeOfRecording() - Code Metrics - Inspection of "Version: 1.0.0" - EventSaucePHP/EventSauce - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#84)

by Frank

created 2020-12-21 20:31 UTC

Message::withTimeOfRecording() A

↳ Parent: Message

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace EventSauce\EventSourcing;

use DateTimeImmutable;
use RuntimeException;

final class Message
{
    private const TIME_OF_RECORDING_FORMAT = 'Y-m-d H:i:s.uO';

    /**
     * @var object
     */
    private $event;

    /**
     * @var array
     */
    private $headers;

    public function __construct(object $event, array $headers = [])
    {
        $this->event = $event;
        $this->headers = $headers;
    }

    /**
     * @param mixed $value
     */
    public function withHeader(string $key, $value): Message
    {
        $clone = clone $this;
        $clone->headers[$key] = $value;

        return $clone;
    }

    public function withHeaders(array $headers): Message
    {
        $clone = clone $this;
        $clone->headers = $headers + $clone->headers;

        return $clone;
    }

    public function withTimeOfRecording(DateTimeImmutable $timeOfRecording): Message
    {
        return $this->withHeader(Header::TIME_OF_RECORDING, $timeOfRecording->format(self::TIME_OF_RECORDING_FORMAT));
    }

    public function aggregateVersion(): int
    {
        $version = $this->headers[Header::AGGREGATE_ROOT_VERSION] ?? null;

        if (null === $version) {
            throw new RuntimeException("Can't get the version if the message has none.");
        }

        return (int) $version;
    }

    public function aggregateRootId(): ?AggregateRootId
    {
        return $this->headers[Header::AGGREGATE_ROOT_ID] ?? null;
    }

    public function timeOfRecording(): DateTimeImmutable
    {
        /** @var DateTimeImmutable */
        return DateTimeImmutable::createFromFormat(

            self::TIME_OF_RECORDING_FORMAT,
            $this->headers[Header::TIME_OF_RECORDING]
        );
    }

    /**
     * @return mixed|null
     */
    public function header(string $key)
    {
        return $this->headers[$key] ?? null;
    }

    public function headers(): array
    {
        return $this->headers;
    }

    public function event(): object
    {
        return $this->event;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace EventSauce\EventSourcing;
6
7		use DateTimeImmutable;
8		use RuntimeException;
9
10		final class Message
11		{
12		private const TIME_OF_RECORDING_FORMAT = 'Y-m-d H:i:s.uO';
13
14		/**
15		* @var object
16		*/
17		private $event;
18
19		/**
20		* @var array
21	25	*/
22		private $headers;
23	25
24	25	public function __construct(object $event, array $headers = [])
25	25	{
26		$this->event = $event;
27		$this->headers = $headers;
28		}
29
30	5	/**
31		* @param mixed $value
32	5	*/
33	5	public function withHeader(string $key, $value): Message
34		{
35	5	$clone = clone $this;
36		$clone->headers[$key] = $value;
37
38	14	return $clone;
39		}
40	14
41	14	public function withHeaders(array $headers): Message
42		{
43	14	$clone = clone $this;
44		$clone->headers = $headers + $clone->headers;
45
46	7	return $clone;
47		}
48	7
49		public function withTimeOfRecording(DateTimeImmutable $timeOfRecording): Message
50	7	{
51	1	return $this->withHeader(Header::TIME_OF_RECORDING, $timeOfRecording->format(self::TIME_OF_RECORDING_FORMAT));
52		}
53
54	6	public function aggregateVersion(): int
55		{
56		$version = $this->headers[Header::AGGREGATE_ROOT_VERSION] ?? null;
57	1
58		if (null === $version) {
59	1	throw new RuntimeException("Can't get the version if the message has none.");
60		}
61
62	1	return (int) $version;
63		}
64	1
65		public function aggregateRootId(): ?AggregateRootId
66		{
67		return $this->headers[Header::AGGREGATE_ROOT_ID] ?? null;
68		}
69
70	9	public function timeOfRecording(): DateTimeImmutable
71		{
72	9	/** @var DateTimeImmutable */
73		return DateTimeImmutable::createFromFormat(
		0 ignored issues – show Bug Best Practice introduced 2020-12-21 20:41 UTC by Report Bug Copy Issue Report The expression `return DateTimeImmutable...er::TIME_OF_RECORDING])` could return the type `false` which is incompatible with the type-hinted return `DateTimeImmutable`. Consider adding an additional type-check to rule them out. Loading history...
74		self::TIME_OF_RECORDING_FORMAT,
75	12	$this->headers[Header::TIME_OF_RECORDING]
76		);
77	12	}
78
79		/**
80	20	* @return mixed\|null
81		*/
82	20	public function header(string $key)
83		{
84		return $this->headers[$key] ?? null;
85		}
86
87		public function headers(): array
88		{
89		return $this->headers;
90		}
91
92		public function event(): object
93		{
94		return $this->event;
95		}
96		}
97

EventSaucePHP / EventSauce

Pull Request — master (#84)

Message::withTimeOfRecording() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like