Mapper::map() - Code Metrics - Inspection of "Pass annotation reader into the constructor" - WyriHaximus/php-tactician-job-command-mapper - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 128140...20fff1 )

by Cees-Jan

created 2019-01-14 17:55 UTC

Mapper::map() A

↳ Parent: Mapper

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	4.0312

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	7
cts	8
cp	0.875
rs	9.7333
c	0
b	0
f	0
cc	4
nc	3
nop	1
crap	4.0312

<?php declare(strict_types=1);

namespace WyriHaximus\Tactician\JobCommand;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\Reader;
use Exception;
use ReflectionClass;
use WyriHaximus\Tactician\JobCommand\Annotations\Job;
use function WyriHaximus\listClassesInDirectory;

final class Mapper implements MapperInterface
{
    /**
     * @var array
     */
    private $map = [];

    /** @var Reader */
    private $reader;

    /**
     * @param Reader|null $reader
     */
    public function __construct(?Reader $reader = null)
    {
        $this->reader = $reader ?? new AnnotationReader();
    }

    /**
     * @param  string $path
     * @return Mapper
     */
    public function map(string $path): Mapper
    {
        foreach (listClassesInDirectory($path) as $class) {
            $jobs = self::getJobsFromCommand($class);

            if (\count($jobs) === 0) {
                continue;
            }

            foreach ($jobs as $job) {
                $this->map[$job] = $class;
            }
        }

        return $this;
    }

    /**
     * @param  string $command
     * @param  Reader $reader
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     */
    public function getJobsFromCommand(string $command): array
    {
        $annotation = $this->reader->getClassAnnotation(new ReflectionClass($command), Job::class);

        if (!($annotation instanceof Job)) {
            return [];
        }

        return $annotation->getJobs();
    }

    /**
     * @param  string $job
     * @return bool
     */
    public function hasCommand(string $job): bool
    {
        return isset($this->map[$job]);
    }

    /**
     * @param  string    $job
     * @throws Exception
     * @return string
     */
    public function getCommand(string $job): string
    {
        if (isset($this->map[$job])) {
            return $this->map[$job];
        }

        throw new Exception('No command known for job: ' . $job);
    }
}


1		<?php declare(strict_types=1);
2
3		namespace WyriHaximus\Tactician\JobCommand;
4
5		use Doctrine\Common\Annotations\AnnotationReader;
6		use Doctrine\Common\Annotations\Reader;
7		use Exception;
8		use ReflectionClass;
9		use WyriHaximus\Tactician\JobCommand\Annotations\Job;
10		use function WyriHaximus\listClassesInDirectory;
11
12		final class Mapper implements MapperInterface
13		{
14		/**
15		* @var array
16		*/
17		private $map = [];
18
19		/** @var Reader */
20		private $reader;
21
22		/**
23		* @param Reader\|null $reader
24		*/
25	6	public function __construct(?Reader $reader = null)
26		{
27	6	$this->reader = $reader ?? new AnnotationReader();
28	6	}
29
30		/**
31		* @param string $path
32		* @return Mapper
33		*/
34	2	public function map(string $path): Mapper
35		{
36	2	foreach (listClassesInDirectory($path) as $class) {
37	2	$jobs = self::getJobsFromCommand($class);
38
39	2	if (\count($jobs) === 0) {
40		continue;
41		}
42
43	2	foreach ($jobs as $job) {
44	2	$this->map[$job] = $class;
45		}
46		}
47
48	2	return $this;
49		}
50
51		/**
52		* @param string $command
53		* @param Reader $reader
		0 ignored issues – show Bug introduced 2019-01-14 17:57 UTC by Report Bug Copy Issue Report There is no parameter named `$reader`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
54		* @return array
55		*/
56	5	public function getJobsFromCommand(string $command): array
57		{
58	5	$annotation = $this->reader->getClassAnnotation(new ReflectionClass($command), Job::class);
59
60	5	if (!($annotation instanceof Job)) {
61	1	return [];
62		}
63
64	4	return $annotation->getJobs();
65		}
66
67		/**
68		* @param string $job
69		* @return bool
70		*/
71	2	public function hasCommand(string $job): bool
72		{
73	2	return isset($this->map[$job]);
74		}
75
76		/**
77		* @param string $job
78		* @throws Exception
79		* @return string
80		*/
81	3	public function getCommand(string $job): string
82		{
83	3	if (isset($this->map[$job])) {
84	2	return $this->map[$job];
85		}
86
87	1	throw new Exception('No command known for job: ' . $job);
88		}
89		}
90

WyriHaximus / php-tactician-job-command-mapper

GitHub Access Token became invalid

Push — master ( 128140...20fff1 )

Mapper::map() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like