PhpConfigReader::read() - Code Metrics - Inspection of "Add ConfigReaderEvents" - gacela-project/gacela - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#216)

by Jesús

created 2022-10-30 14:44 UTC

PhpConfigReader::read() A

↳ Parent: PhpConfigReader

Complexity

Conditions	5
Paths	5

Size

Total Lines	31
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	5.0909

Importance

Changes

Metric	Value
cc	5
eloc	12
nc	5
nop	1
dl	0
loc	31
rs	9.5555
c	0
b	0
f	0
ccs	11
cts	13
cp	0.8462
crap	5.0909

<?php

declare(strict_types=1);

namespace Gacela\Framework\Config\ConfigReader;

use Gacela\Framework\Config\Config;
use Gacela\Framework\Config\ConfigReaderInterface;
use Gacela\Framework\EventListener\ConfigReader\ReadPhpConfigEvent;
use Gacela\Framework\EventListener\GacelaEventInterface;
use JsonSerializable;
use RuntimeException;

use function is_array;

final class PhpConfigReader implements ConfigReaderInterface
{
    /**
     * @return array<string,mixed>
     */
    public function read(string $absolutePath): array
    {
        if (!$this->canRead($absolutePath)) {
            return [];
        }

        $this->triggerEvent(new ReadPhpConfigEvent($absolutePath));

        /**
         * @psalm-suppress UnresolvableInclude
         *
         * @var null|string[]|JsonSerializable|mixed $content
         */
        $content = include $absolutePath;

        if ($content === null) {
            return [];
        }

        if ($content instanceof JsonSerializable) {
            /** @var array<string,mixed> $jsonSerialized */
            $jsonSerialized = $content->jsonSerialize();
            return $jsonSerialized;
        }

        if (!is_array($content)) {
            throw new RuntimeException('The PHP config file must return an array or a JsonSerializable object!');
        }

        /** @var array<string,mixed> $content */
        return $content;
    }

    private function canRead(string $absolutePath): bool
    {
        $extension = pathinfo($absolutePath, PATHINFO_EXTENSION);

        return $extension === 'php' && file_exists($absolutePath);
    }

    private function triggerEvent(GacelaEventInterface $event): void
    {
        Config::getEventDispatcher()->dispatch($event);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Gacela\Framework\Config\ConfigReader;
6
7		use Gacela\Framework\Config\Config;
8		use Gacela\Framework\Config\ConfigReaderInterface;
9		use Gacela\Framework\EventListener\ConfigReader\ReadPhpConfigEvent;
10		use Gacela\Framework\EventListener\GacelaEventInterface;
11		use JsonSerializable;
12		use RuntimeException;
13
14		use function is_array;
15
16		final class PhpConfigReader implements ConfigReaderInterface
17		{
18		/**
19		* @return array<string,mixed>
20		*/
21	22	public function read(string $absolutePath): array
22		{
23	22	if (!$this->canRead($absolutePath)) {
24	20	return [];
25		}
26
27	21	$this->triggerEvent(new ReadPhpConfigEvent($absolutePath));
28
29		/**
30		* @psalm-suppress UnresolvableInclude
31		*
32		* @var null\|string[]\|JsonSerializable\|mixed $content
33		*/
34	21	$content = include $absolutePath;
35
36	21	if ($content === null) {
37		return [];
38		}
39
40	21	if ($content instanceof JsonSerializable) {
41		/** @var array<string,mixed> $jsonSerialized */
42	1	$jsonSerialized = $content->jsonSerialize();
43	1	return $jsonSerialized;
44		}
45
46	21	if (!is_array($content)) {
47		throw new RuntimeException('The PHP config file must return an array or a JsonSerializable object!');
48		}
49
50		/** @var array<string,mixed> $content */
51	21	return $content;
52		}
53
54	22	private function canRead(string $absolutePath): bool
55		{
56	22	$extension = pathinfo($absolutePath, PATHINFO_EXTENSION);
57
58	22	return $extension === 'php' && file_exists($absolutePath);
59		}
60
61	21	private function triggerEvent(GacelaEventInterface $event): void
62		{
63	21	Config::getEventDispatcher()->dispatch($event);
64		}
65		}
66

gacela-project / gacela

Pull Request — master (#216)

PhpConfigReader::read() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like