AbstractRepositoryFactory::createRepository() - Code Metrics - Inspection of "Merge pull request #2116 from Steveb-p/gh-2113" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8fc9bf...b852d4 )

by Andreas

created 2020-04-22 10:10 UTC

AbstractRepositoryFactory::createRepository() B

↳ Parent: AbstractRepositoryFactory

Complexity

Conditions	10
Paths	36

Size

Total Lines

Duplication

Lines	9
Ratio	23.08 %

Code Coverage

Tests	19
CRAP Score	10.2537

Importance

Changes

Metric	Value
dl	9
loc	39
c	0
b	0
f	0
ccs	19
cts	22
cp	0.8636
rs	7.6666
cc	10
nc	36
nop	2
crap	10.2537

How to fix Complexity

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Repository;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Mapping\MappingException;
use Doctrine\ODM\MongoDB\MongoDBException;
use Doctrine\Persistence\ObjectRepository;
use function is_a;
use function ltrim;
use function spl_object_hash;

/**
 * Abstract factory for creating document repositories.
 */
abstract class AbstractRepositoryFactory implements RepositoryFactory
{
    /**
     * The list of DocumentRepository instances.
     *
     * @var ObjectRepository[]
     */
    private $repositoryList = [];

    /**
     * {@inheritdoc}
     */
    public function getRepository(DocumentManager $documentManager, string $documentName) : ObjectRepository
    {
        $metadata = $documentManager->getClassMetadata($documentName);
        $hashKey  = $metadata->getName() . spl_object_hash($documentManager);


        if (isset($this->repositoryList[$hashKey])) {
            return $this->repositoryList[$hashKey];
        }

        $repository = $this->createRepository($documentManager, ltrim($documentName, '\\'));

        $this->repositoryList[$hashKey] = $repository;

        return $repository;
    }

    /**
     * Create a new repository instance for a document class.
     *
     * @return ObjectRepository|GridFSRepository|ViewRepository
     */
    protected function createRepository(DocumentManager $documentManager, string $documentName) : ObjectRepository
    {
        $metadata = $documentManager->getClassMetadata($documentName);

        $repositoryClassName = $metadata->isFile
            ? $documentManager->getConfiguration()->getDefaultGridFSRepositoryClassName()
            : $documentManager->getConfiguration()->getDefaultDocumentRepositoryClassName();

        if ($metadata->customRepositoryClassName) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $repositoryClassName = $metadata->customRepositoryClassName;
        }

        switch (true) {
            case $metadata->isFile:
                if (! is_a($repositoryClassName, GridFSRepository::class, true)) {

                    throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, GridFSRepository::class);
                }
                break;

            case $metadata->isView():
                if (! is_a($repositoryClassName, ViewRepository::class, true)) {

                    throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, ViewRepository::class);
                }
                break;

            case $metadata->isEmbeddedDocument:
                throw MongoDBException::cannotCreateRepository($documentName);
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

            case $metadata->isMappedSuperclass:
            default:
                if (! is_a($repositoryClassName, DocumentRepository::class, true)) {

                    throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, DocumentRepository::class);
                }
                break;
        }

        return $this->instantiateRepository($repositoryClassName, $documentManager, $metadata);
    }

    /**
     * Instantiates requested repository.
     */
    abstract protected function instantiateRepository(string $repositoryClassName, DocumentManager $documentManager, ClassMetadata $metadata) : ObjectRepository;
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Doctrine\ODM\MongoDB\Repository;
6
7			use Doctrine\ODM\MongoDB\DocumentManager;
8			use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
9			use Doctrine\ODM\MongoDB\Mapping\MappingException;
10			use Doctrine\ODM\MongoDB\MongoDBException;
11			use Doctrine\Persistence\ObjectRepository;
12			use function is_a;
13			use function ltrim;
14			use function spl_object_hash;
15
16			/**
17			* Abstract factory for creating document repositories.
18			*/
19			abstract class AbstractRepositoryFactory implements RepositoryFactory
20			{
21			/**
22			* The list of DocumentRepository instances.
23			*
24			* @var ObjectRepository[]
25			*/
26			private $repositoryList = [];
27
28			/**
29			* {@inheritdoc}
30			*/
31	371		public function getRepository(DocumentManager $documentManager, string $documentName) : ObjectRepository
32			{
33	371		$metadata = $documentManager->getClassMetadata($documentName);
34	371		$hashKey = $metadata->getName() . spl_object_hash($documentManager);
			0 ignored issues – show Bug introduced 2018-01-06 12:29 UTC by Report Bug Copy Issue Report Consider using `$metadata->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
35
36	371		if (isset($this->repositoryList[$hashKey])) {
37	170		return $this->repositoryList[$hashKey];
38			}
39
40	371		$repository = $this->createRepository($documentManager, ltrim($documentName, '\\'));
41
42	367		$this->repositoryList[$hashKey] = $repository;
43
44	367		return $repository;
45			}
46
47			/**
48			* Create a new repository instance for a document class.
49			*
50			* @return ObjectRepository\|GridFSRepository\|ViewRepository
51			*/
52	371		protected function createRepository(DocumentManager $documentManager, string $documentName) : ObjectRepository
53			{
54	371		$metadata = $documentManager->getClassMetadata($documentName);
55
56	371		$repositoryClassName = $metadata->isFile
57	12		? $documentManager->getConfiguration()->getDefaultGridFSRepositoryClassName()
58	371		: $documentManager->getConfiguration()->getDefaultDocumentRepositoryClassName();
59
60	371		if ($metadata->customRepositoryClassName) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 10:40 UTC by Report Bug Copy Issue Report The expression `$metadata->customRepositoryClassName` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
61	26		$repositoryClassName = $metadata->customRepositoryClassName;
62			}
63
64			switch (true) {
65	371		case $metadata->isFile:
66	12	View Code Duplication	if (! is_a($repositoryClassName, GridFSRepository::class, true)) {
			0 ignored issues – show Duplication introduced 2020-02-18 15:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
67			throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, GridFSRepository::class);
68			}
69	12		break;
70
71	360		case $metadata->isView():
72	15	View Code Duplication	if (! is_a($repositoryClassName, ViewRepository::class, true)) {
			0 ignored issues – show Duplication introduced 2020-02-18 15:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
73	4		throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, ViewRepository::class);
74			}
75	11		break;
76
77	346		case $metadata->isEmbeddedDocument:
78			throw MongoDBException::cannotCreateRepository($documentName);
79			break;
			0 ignored issues – show Unused Code introduced 2020-02-18 15:54 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
80
81	346		case $metadata->isMappedSuperclass:
82			default:
83	346	View Code Duplication	if (! is_a($repositoryClassName, DocumentRepository::class, true)) {
			0 ignored issues – show Duplication introduced 2020-02-18 15:54 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
84			throw MappingException::invalidRepositoryClass($documentName, $repositoryClassName, DocumentRepository::class);
85			}
86	346		break;
87			}
88
89	367		return $this->instantiateRepository($repositoryClassName, $documentManager, $metadata);
90			}
91
92			/**
93			* Instantiates requested repository.
94			*/
95			abstract protected function instantiateRepository(string $repositoryClassName, DocumentManager $documentManager, ClassMetadata $metadata) : ObjectRepository;
96			}
97

doctrine / mongodb-odm

Push — master ( 8fc9bf...b852d4 )

AbstractRepositoryFactory::createRepository() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like