TranslatableRepositoryTrait - Code Metrics - Inspection of "[Translation] Introduce translatable repository tr..." - php-lug/lug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Eric

created 2016-07-17 11:44 UTC

TranslatableRepositoryTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	90
Duplicated Lines	11.11 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	8
c	1
b	0
f	0
lcom	1
cbo	1
dl	10
loc	90
rs	10

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getTranslationAlias()	0	4	1
A	getLocales()	10	10	2

How to fix Duplicated Code

<?php

/*
 * This file is part of the Lug package.
 *
 * (c) Eric GELOEN <[email protected]>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Lug\Component\Translation\Repository\Doctrine\MongoDB;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\UnitOfWork;
use Lug\Component\Resource\Model\ResourceInterface;
use Lug\Component\Resource\Repository\Doctrine\MongoDB\RepositoryTrait;
use Lug\Component\Translation\Context\LocaleContextInterface;

/**
 * @author GeLo <[email protected]>
 */
trait TranslatableRepositoryTrait
{
    use RepositoryTrait {
        __construct as private constructFromRepositoryTrait;
        createQueryBuilderForCollection as private createQueryBuilderForCollectionFromRepositoryTrait;
        getProperty as private getPropertyFromRepositoryTrait;
    }

    /**
     * @var LocaleContextInterface
     */
    private $localeContext;

    /**
     * @var string[]
     */
    private $cache;

    /**
     * @param DocumentManager        $dm
     * @param UnitOfWork             $uow
     * @param ClassMetadata          $class
     * @param ResourceInterface      $resource
     * @param LocaleContextInterface $localeContext
     */
    public function __construct(
        DocumentManager $dm,
        UnitOfWork $uow,
        ClassMetadata $class,
        ResourceInterface $resource,
        LocaleContextInterface $localeContext
    ) {
        $this->constructFromRepositoryTrait($dm, $uow, $class, $resource);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $this->localeContext = $localeContext;
    }

    /**
     * {@inheritdoc}
     */
    public function createQueryBuilderForCollection()
    {
        return $this->createQueryBuilderForCollectionFromRepositoryTrait()

            ->field($this->getProperty('locale'))
            ->in($this->getLocales());
    }

    /**
     * {@inheritdoc}
     */
    public function getProperty($property, $root = null)
    {
        if ($this->cache === null) {
            $translatableFields = $this->getClassMetadata()->getFieldNames();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $translationFields = $this->getDocumentManager()
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                ->getClassMetadata($this->getClassMetadata()->getAssociationTargetClass($this->getTranslationAlias()))
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                ->getFieldNames();

            $this->cache = array_diff($translationFields, $translatableFields);
        }

        if (in_array($property, $this->cache, true)) {
            $root = $this->getTranslationAlias();
        }

        return $this->getPropertyFromRepositoryTrait($property, $root);

    }

    /**
     * @return string
     */
    private function getTranslationAlias()
    {
        return 'translations';
    }

    /**
     * @return string[]
     */
    private function getLocales()

    {
        $locales = $this->localeContext->getLocales();

        if (($fallbackLocale = $this->localeContext->getFallbackLocale()) !== null) {
            $locales[] = $fallbackLocale;
        }

        return $locales;
    }
}


1		<?php
2
3		/*
4		* This file is part of the Lug package.
5		*
6		* (c) Eric GELOEN <[email protected]>
7		*
8		* For the full copyright and license information, please read the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Lug\Component\Translation\Repository\Doctrine\MongoDB;
13
14		use Doctrine\ODM\MongoDB\DocumentManager;
15		use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
16		use Doctrine\ODM\MongoDB\UnitOfWork;
17		use Lug\Component\Resource\Model\ResourceInterface;
18		use Lug\Component\Resource\Repository\Doctrine\MongoDB\RepositoryTrait;
19		use Lug\Component\Translation\Context\LocaleContextInterface;
20
21		/**
22		* @author GeLo <[email protected]>
23		*/
24		trait TranslatableRepositoryTrait
25		{
26		use RepositoryTrait {
27		__construct as private constructFromRepositoryTrait;
28		createQueryBuilderForCollection as private createQueryBuilderForCollectionFromRepositoryTrait;
29		getProperty as private getPropertyFromRepositoryTrait;
30		}
31
32		/**
33		* @var LocaleContextInterface
34		*/
35		private $localeContext;
36
37		/**
38		* @var string[]
39		*/
40		private $cache;
41
42		/**
43		* @param DocumentManager $dm
44		* @param UnitOfWork $uow
45		* @param ClassMetadata $class
46		* @param ResourceInterface $resource
47		* @param LocaleContextInterface $localeContext
48		*/
49		public function __construct(
50		DocumentManager $dm,
51		UnitOfWork $uow,
52		ClassMetadata $class,
53		ResourceInterface $resource,
54		LocaleContextInterface $localeContext
55		) {
56		$this->constructFromRepositoryTrait($dm, $uow, $class, $resource);
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report It seems like `constructFromRepositoryTrait()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
57
58		$this->localeContext = $localeContext;
59		}
60
61		/**
62		* {@inheritdoc}
63		*/
64		public function createQueryBuilderForCollection()
65		{
66		return $this->createQueryBuilderForCollectionFromRepositoryTrait()
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report The method `createQueryBuilderForCol...onFromRepositoryTrait()` does not exist on `Lug\Component\Translatio...slatableRepositoryTrait`. Did you maybe mean `createQueryBuilderForCollection()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
67		->field($this->getProperty('locale'))
68		->in($this->getLocales());
69		}
70
71		/**
72		* {@inheritdoc}
73		*/
74		public function getProperty($property, $root = null)
75		{
76		if ($this->cache === null) {
77		$translatableFields = $this->getClassMetadata()->getFieldNames();
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report It seems like `getClassMetadata()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
78		$translationFields = $this->getDocumentManager()
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report It seems like `getDocumentManager()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
79		->getClassMetadata($this->getClassMetadata()->getAssociationTargetClass($this->getTranslationAlias()))
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report It seems like `getClassMetadata()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
80		->getFieldNames();
81
82		$this->cache = array_diff($translationFields, $translatableFields);
83		}
84
85		if (in_array($property, $this->cache, true)) {
86		$root = $this->getTranslationAlias();
87		}
88
89		return $this->getPropertyFromRepositoryTrait($property, $root);
		0 ignored issues – show Bug introduced 2016-07-17 12:15 UTC by Report Bug Copy Issue Report The method `getPropertyFromRepositoryTrait()` does not exist on `Lug\Component\Translatio...slatableRepositoryTrait`. Did you maybe mean `getProperty()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
90		}
91
92		/**
93		* @return string
94		*/
95		private function getTranslationAlias()
96		{
97		return 'translations';
98		}
99
100		/**
101		* @return string[]
102		*/
103	View Code Duplication	private function getLocales()
		0 ignored issues – show Duplication introduced 2016-07-17 12:15 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...
104		{
105		$locales = $this->localeContext->getLocales();
106
107		if (($fallbackLocale = $this->localeContext->getFallbackLocale()) !== null) {
108		$locales[] = $fallbackLocale;
109		}
110
111		return $locales;
112		}
113		}
114

php-lug / lug

Pull Request — master (#61)

TranslatableRepositoryTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like