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

Passed

Pull Request — master (#2)

by Alex

created 2021-02-28 23:05 UTC

testFilterWillApplyIsNotEqualFiltering() A

↳ Parent: IsNotEqualTest

Complexity

Conditions	4
Paths	8

Size

Total Lines	58
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	40
c	1
b	0
f	0
dl	0
loc	58
rs	9.28
cc	4
nc	8
nop	0

How to fix Long Method

<?php

declare(strict_types=1);

namespace ArpTest\DoctrineQueryFilter\Filter;

use Arp\DoctrineQueryFilter\Constant\WhereType;
use Arp\DoctrineQueryFilter\Filter\Exception\InvalidArgumentException;
use Arp\DoctrineQueryFilter\Filter\FilterInterface;
use Arp\DoctrineQueryFilter\Filter\IsNotEqual;
use Arp\DoctrineQueryFilter\Filter\TypecasterInterface;
use Arp\DoctrineQueryFilter\Metadata\MetadataInterface;
use Arp\DoctrineQueryFilter\QueryBuilderInterface;
use Arp\DoctrineQueryFilter\QueryFilterManager;
use Doctrine\ORM\Query\Expr;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

/**
 * @covers \Arp\DoctrineQueryFilter\Filter\IsNotEqual
 *
 * @author  Alex Patterson <[email protected]>
 * @package ArpTest\DoctrineQueryFilter\Filter
 */
final class IsNotEqualTest extends TestCase
{
    /**
     * @var QueryFilterManager|MockObject
     */
    private $queryFilterManager;

    /**
     * @var MetadataInterface|MockObject
     */
    private $metadata;

    /**
     * @var QueryBuilderInterface|MockObject
     */
    private $queryBuilder;

    /**
     * @var TypecasterInterface|MockObject
     */
    private TypecasterInterface $typecaster;

    /**
     * Prepare the test case dependencies
     */
    public function setUp(): void
    {
        $this->queryFilterManager = $this->createMock(QueryFilterManager::class);

        $this->metadata = $this->createMock(MetadataInterface::class);

        $this->queryBuilder = $this->createMock(QueryBuilderInterface::class);

        $this->typecaster = $this->createMock(TypecasterInterface::class);
    }

    /**
     * Assert that IsEqual implement FilterInterface
     */
    public function testImplementsFilterInterface(): void
    {
        $filter = new IsNotEqual($this->queryFilterManager, $this->typecaster);

        $this->assertInstanceOf(FilterInterface::class, $filter);
    }

    /**
     * @throws InvalidArgumentException
     */
    public function testFilterWillThrowInvalidArgumentExceptionIfTheRequiredFieldNameCriteriaIsMissing(): void
    {
        $filter = new IsNotEqual($this->queryFilterManager, $this->typecaster);

        $criteria = [
            // No field 'name' will raise exception
        ];

        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage(
            sprintf('The required \'field\' criteria value is missing for filter \'%s\'', IsNotEqual::class)
        );

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

    /**
     * Assert that the IsNotEqual query filter can be applied with the provided $criteria
     *
     * @throws InvalidArgumentException
     */
    public function testFilterWillApplyIsNotEqualFiltering(): void
    {
        $filter = new IsNotEqual($this->queryFilterManager, $this->typecaster);

        $fieldName = 'FieldNameTest';
        $criteria = [
            'field'  => $fieldName,
            'alias'  => 'test',
            'where'  => WhereType::AND,
            'value'  => 123,
            'format' => null,
        ];

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

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

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

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

        $isNotEqualString = $criteria['alias'] . '.' . $fieldName . '!=' . ':param_name';
        $expr->expects($this->once())
            ->method('neq')
            ->with($criteria['alias'] . '.' . $fieldName, $this->stringStartsWith(':'))
            ->willReturn($neq);

        $neq->expects($this->once())
            ->method('__toString')
            ->willReturn($isNotEqualString);

        $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']);
        }

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


alex-patterson-webdev / doctrine-query-filter

Pull Request — master (#2)

testFilterWillApplyIsNotEqualFiltering() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like