RelationBuilder::apply() - Code Metrics - Inspection of "Completely refactoring" - rambler-digital-solutions/hydrogen - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( b17eba...69b436 )

by Kirill

created 2018-09-02 05:44 UTC

RelationBuilder::apply() A

↳ Parent: RelationBuilder

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	0
cts	14
cp	0
rs	9.6666
c	0
b	0
f	0
cc	3
nc	3
nop	2
crap	12

<?php
/**
 * This file is part of Hydrogen package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace RDS\Hydrogen\Processor\DatabaseProcessor;

use Doctrine\ORM\QueryBuilder;
use RDS\Hydrogen\Criteria\Common\Field;
use RDS\Hydrogen\Criteria\CriterionInterface;
use RDS\Hydrogen\Criteria\Relation;

/**
 * Class RelationBuilder
 */
class RelationBuilder extends WhereBuilder
{
    /**
     * @var array
     */
    private $relations = [];

    /**
     * @param QueryBuilder $builder
     * @param CriterionInterface|Relation $relation
     * @return \Generator
     */
    public function apply($builder, CriterionInterface $relation): \Generator
    {
        $field = $relation->getField();
        $alias = $relation->getAlias();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        foreach ($field->getChunks() as $chunk) {
            if (isset($this->relations[$chunk])) {
                $alias = $this->relations[$chunk];
                continue;
            }

            $alias = $this->join($builder, $chunk, $alias);

            $this->relations[$chunk] = $alias;
        }

        yield $relation->getQuery()->withAlias($alias);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @param QueryBuilder $builder
     * @param string $child
     * @param string $parent
     * @return string
     */
    private function join(QueryBuilder $builder, string $child, string $parent): string
    {
        $relation = Field::new($child)->withAlias($parent);
        $alias = \str_replace('.', '_', $relation->toString());

        $builder->leftJoin($relation->toString(), $alias);
        $builder->addSelect($alias);

        return $alias;
    }
}


Push — master ( b17eba...69b436 )

RelationBuilder::apply() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2			/**
3			* This file is part of Hydrogen package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8			declare(strict_types=1);
9
10			namespace RDS\Hydrogen\Processor\DatabaseProcessor;
11
12			use Doctrine\ORM\QueryBuilder;
13			use RDS\Hydrogen\Criteria\Common\Field;
14			use RDS\Hydrogen\Criteria\CriterionInterface;
15			use RDS\Hydrogen\Criteria\Relation;
16
17			/**
18			* Class RelationBuilder
19			*/
20			class RelationBuilder extends WhereBuilder
21			{
22			/**
23			* @var array
24			*/
25			private $relations = [];
26
27			/**
28			* @param QueryBuilder $builder
29			* @param CriterionInterface\|Relation $relation
30			* @return \Generator
31			*/
32			public function apply($builder, CriterionInterface $relation): \Generator
33			{
34			$field = $relation->getField();
35			$alias = $relation->getAlias();
			0 ignored issues – show Bug introduced 2018-09-02 05:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `RDS\Hydrogen\Criteria\CriterionInterface` as the method `getAlias()` does only exist in the following implementations of said interface: `RDS\Hydrogen\Criteria\Relation`, `RDS\Hydrogen\Criteria\Selection`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
36
37			foreach ($field->getChunks() as $chunk) {
38			if (isset($this->relations[$chunk])) {
39			$alias = $this->relations[$chunk];
40			continue;
41			}
42
43			$alias = $this->join($builder, $chunk, $alias);
44
45			$this->relations[$chunk] = $alias;
46			}
47
48			yield $relation->getQuery()->withAlias($alias);
			0 ignored issues – show Bug introduced 2018-09-02 05:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `RDS\Hydrogen\Criteria\CriterionInterface` as the method `getQuery()` does only exist in the following implementations of said interface: `RDS\Hydrogen\Criteria\Group`, `RDS\Hydrogen\Criteria\Relation`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
49			}
50
51			/**
52			* @param QueryBuilder $builder
53			* @param string $child
54			* @param string $parent
55			* @return string
56			*/
57			private function join(QueryBuilder $builder, string $child, string $parent): string
58			{
59			$relation = Field::new($child)->withAlias($parent);
60			$alias = \str_replace('.', '_', $relation->toString());
61
62			$builder->leftJoin($relation->toString(), $alias);
63			$builder->addSelect($alias);
64
65			return $alias;
66			}
67			}
68

rambler-digital-solutions / hydrogen

Push — master ( b17eba...69b436 )

RelationBuilder::apply() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like