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

Passed

Pull Request — master (#10)

by Alex

created 2024-02-11 20:06 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	2
Bugs	0	Features	0

Metric	Value
cc	5
eloc	48
c	2
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\Enum\WhereType;
use Arp\DoctrineQueryFilter\Filter\Exception\FilterException;
use Arp\DoctrineQueryFilter\Filter\IsMemberOf;
use Doctrine\ORM\Mapping\ClassMetadataInfo;
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
 */
final class IsMemberOfTest extends AbstractComparisonTest
{
    protected string $filterClassName = IsMemberOf::class;

    protected string $expressionMethodName = 'isMemberOf';

    protected string $expressionSymbol = 'MEMBER OF';

    /**
     * @dataProvider getInvalidNonCollectionFieldWillThrowInvalidArgumentExceptionData
     */
    public function testInvalidNonCollectionFieldWillThrowInvalidArgumentException(
        string $fieldName,
        ?int $associationType
    ): void {
        $parts = explode('.', $fieldName);
        $fieldName = array_pop($parts);

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

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

        $associationMapping = [
            'type' => $associationType,
        ];

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


        $this->expectException(FilterException::class);
        $this->expectExceptionMessage(
            sprintf(
                'Unable to apply query filter \'%s\': '
                . 'The field \'%s\' is not a valid collection valued association',
                IsMemberOf::class,
                $fieldName,
            ),
        );

        $this->filter->filter($this->queryBuilder, $this->metadata, ['field' => $fieldName]);
    }

    public static function getInvalidNonCollectionFieldWillThrowInvalidArgumentExceptionData(): array
    {
        return [
            [
                'testFieldName',
                ClassMetadataInfo::MANY_TO_ONE,
            ],
            [
                'x.testFieldName',
                ClassMetadataInfo::ONE_TO_ONE,
            ],
            [
                'x.fooFieldName',
                null,
            ],
        ];
    }

    /**
     * Assert that the IsMemberOf query filter can be applied with the provided $criteria
     *
     * @dataProvider getFilterWillApplyFilteringData
     * @throws FilterException
     */
    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())
                             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())
                               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);
    }

    protected function getExpressionString(string $fieldName, ?string $alias, array $criteria): string
    {
        return ':param_name ' . $this->expressionSymbol . $alias . '.' . $fieldName;
    }

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


alex-patterson-webdev / doctrine-query-filter

Pull Request — master (#10)

IsMemberOfTest::testFilterWillApplyFiltering() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like