IsMemberOfTest::testFilterWillApplyFiltering() - Code Metrics - Inspection of "Feature/0.3.0" - alex-patterson-webdev/doctrine-query-filter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by Alex

created 2021-04-28 22:38 UTC

IsMemberOfTest::testFilterWillApplyFiltering() B

↳ Parent: IsMemberOfTest

Complexity

Conditions	5
Paths	16

Size

Total Lines	71
Code Lines	48

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	48
c	1
b	0
f	0
nc	16
nop	1
dl	0
loc	71
rs	8.8234

How to fix Long Method

<?php

declare(strict_types=1);

namespace ArpTest\DoctrineQueryFilter\Filter;

use Arp\DoctrineQueryFilter\Constant\WhereType;
use Arp\DoctrineQueryFilter\Filter\IsMemberOf;
use Doctrine\ORM\Query\Expr;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @covers \Arp\DoctrineQueryFilter\Filter\IsMemberOf
 * @covers \Arp\DoctrineQueryFilter\Filter\AbstractExpression
 * @covers \Arp\DoctrineQueryFilter\Filter\AbstractFilter
 *
 * @author  Alex Patterson <[email protected]>
 * @package ArpTest\DoctrineQueryFilter\Filter
 */
final class IsMemberOfTest extends AbstractComparisonTest
{
    /**
     * @var string
     */
    protected string $filterClassName = IsMemberOf::class;

    /**
     * @var string
     */
    protected string $expressionMethodName = 'isMemberOf';

    /**
     * @var string
     */
    protected string $expressionSymbol = 'MEMBER OF';

    /**
     * Assert that the IsMemberOf query filter can be applied with the provided $criteria
     *
     * @param array<mixed>$criteria
     *
     * @dataProvider getFilterWillApplyFilteringData
     */
    public function testFilterWillApplyFiltering(array $criteria): void
    {
        $fieldName = $criteria['field'] ?? 'testFieldName';
        $alias = $criteria['alias'] ?? null;

        $mapping = [
            'type' => 4
        ];

        $this->metadata->expects($this->once())
            ->method('hasField')
            ->with($fieldName)
            ->willReturn(true);

        $this->metadata->expects($this->once())
            ->method('hasAssociation')
            ->with($fieldName)
            ->willReturn(true);

        $this->metadata->expects($this->once())
            ->method('getAssociationMapping')
            ->with($fieldName)
            ->willReturn($mapping);

        /** @var Expr&MockObject $expr */
        $expr = $this->createMock(Expr::class);

        $this->queryBuilder->expects($this->once())
            ->method('expr')
            ->willReturn($expr);

        /** @var Expr\Comparison&MockObject $comparisonExpr */
        $comparisonExpr = $this->createMock(Expr\Comparison::class);

        if (null === $alias) {
            $alias = 'entity';
            $this->queryBuilder->expects($this->once())
                ->method('getRootAlias')
                ->willReturn($alias);
        }

        $expressionString = $this->getExpressionString($fieldName, $alias, $criteria);

        $expr->expects($this->once())
            ->method($this->expressionMethodName)
            ->willReturn($comparisonExpr);

        $comparisonExpr->expects($this->once())
            ->method('__toString')
            ->willReturn($expressionString);

        $methodName = (!isset($criteria['where']) || WhereType::AND === $criteria['where'])
            ? 'andWhere'
            : 'orWhere';

        $this->queryBuilder->expects($this->once())->method($methodName);

        if (array_key_exists('value', $criteria)) {
            $this->typecaster->expects($this->once())
                ->method('typecast')
                ->with($this->metadata, $fieldName, $criteria['value'])
                ->willReturn($criteria['value']);

            $this->queryBuilder->expects($this->once())
                ->method('setParameter')
                ->with($this->callback(static function ($argument) {
                    return is_string($argument);
                }), $criteria['value']);
        }

        $this->filter->filter($this->queryBuilder, $this->metadata, $criteria);
    }

    /**
     * @param string      $fieldName
     * @param string|null $alias
     * @param array<mixed>      $criteria
     *
     * @return string
     */
    protected function getExpressionString(string $fieldName, ?string $alias, array $criteria): string
    {
        return ':param_name ' . $this->expressionSymbol . $alias . '.' . $fieldName;
    }

    /**
     * @return array<mixed>
     */
    public function getFilterWillApplyFilteringData(): array
    {
        return [
            [
                [
                    'name' => 'test',
                    'field' => 'hello',
                    'value' => 123,
                ],
            ],
        ];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace ArpTest\DoctrineQueryFilter\Filter;
6
7			use Arp\DoctrineQueryFilter\Constant\WhereType;
8			use Arp\DoctrineQueryFilter\Filter\IsMemberOf;
9			use Doctrine\ORM\Query\Expr;
10			use PHPUnit\Framework\MockObject\MockObject;
11
12			/**
13			* @covers \Arp\DoctrineQueryFilter\Filter\IsMemberOf
14			* @covers \Arp\DoctrineQueryFilter\Filter\AbstractExpression
15			* @covers \Arp\DoctrineQueryFilter\Filter\AbstractFilter
16			*
17			* @author Alex Patterson <[email protected]>
18			* @package ArpTest\DoctrineQueryFilter\Filter
19			*/
20			final class IsMemberOfTest extends AbstractComparisonTest
21			{
22			/**
23			* @var string
24			*/
25			protected string $filterClassName = IsMemberOf::class;
26
27			/**
28			* @var string
29			*/
30			protected string $expressionMethodName = 'isMemberOf';
31
32			/**
33			* @var string
34			*/
35			protected string $expressionSymbol = 'MEMBER OF';
36
37			/**
38			* Assert that the IsMemberOf query filter can be applied with the provided $criteria
39			*
40			* @param array<mixed>$criteria
41			*
42			* @dataProvider getFilterWillApplyFilteringData
43			*/
44			public function testFilterWillApplyFiltering(array $criteria): void
45			{
46			$fieldName = $criteria['field'] ?? 'testFieldName';
47			$alias = $criteria['alias'] ?? null;
48
49			$mapping = [
50			'type' => 4
51			];
52
53			$this->metadata->expects($this->once())
54			->method('hasField')
55			->with($fieldName)
56			->willReturn(true);
57
58			$this->metadata->expects($this->once())
59			->method('hasAssociation')
60			->with($fieldName)
61			->willReturn(true);
62
63			$this->metadata->expects($this->once())
64			->method('getAssociationMapping')
65			->with($fieldName)
66			->willReturn($mapping);
67
68			/** @var Expr&MockObject $expr */
69			$expr = $this->createMock(Expr::class);
70
71			$this->queryBuilder->expects($this->once())
72			->method('expr')
73			->willReturn($expr);
74
75			/** @var Expr\Comparison&MockObject $comparisonExpr */
76			$comparisonExpr = $this->createMock(Expr\Comparison::class);
77
78			if (null === $alias) {
79			$alias = 'entity';
80			$this->queryBuilder->expects($this->once())
81			->method('getRootAlias')
82			->willReturn($alias);
83			}
84
85			$expressionString = $this->getExpressionString($fieldName, $alias, $criteria);
86
87			$expr->expects($this->once())
88			->method($this->expressionMethodName)
89			->willReturn($comparisonExpr);
90
91			$comparisonExpr->expects($this->once())
92			->method('__toString')
93			->willReturn($expressionString);
94
95			$methodName = (!isset($criteria['where']) \|\| WhereType::AND === $criteria['where'])
96			? 'andWhere'
97			: 'orWhere';
98
99			$this->queryBuilder->expects($this->once())->method($methodName);
100
101			if (array_key_exists('value', $criteria)) {
102			$this->typecaster->expects($this->once())
103			->method('typecast')
104			->with($this->metadata, $fieldName, $criteria['value'])
105			->willReturn($criteria['value']);
106
107			$this->queryBuilder->expects($this->once())
108			->method('setParameter')
109			->with($this->callback(static function ($argument) {
110			return is_string($argument);
111			}), $criteria['value']);
112			}
113
114			$this->filter->filter($this->queryBuilder, $this->metadata, $criteria);
115			}
116
117			/**
118			* @param string $fieldName
119			* @param string\|null $alias
120			* @param array<mixed> $criteria
121			*
122			* @return string
123			*/
124			protected function getExpressionString(string $fieldName, ?string $alias, array $criteria): string
125			{
126			return ':param_name ' . $this->expressionSymbol . $alias . '.' . $fieldName;
127			}
128
129			/**
130			* @return array<mixed>
131			*/
132			public function getFilterWillApplyFilteringData(): array
133			{
134			return [
135			[
136			[
137			'name' => 'test',
138			'field' => 'hello',
139			'value' => 123,
140			],
141			],
142			];
143			}
144			}
145

alex-patterson-webdev / doctrine-query-filter

Pull Request — master (#4)

IsMemberOfTest::testFilterWillApplyFiltering() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like