IsBetweenTest::testImplementsFilterInterface() - Code Metrics - alex-patterson-webdev/doctrine-query-filter - Measure and Improve Code Quality continuously with Scrutinizer

IsBetweenTest::testImplementsFilterInterface() A
last analyzed 2024-02-11 20:16 UTC

↳ Parent: IsBetweenTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	2
c	1
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	0
<?php

declare(strict_types=1);

namespace ArpTest\DoctrineQueryFilter\Filter;

use Arp\DoctrineQueryFilter\Enum\WhereType;
use Arp\DoctrineQueryFilter\Filter\Exception\FilterException;
use Arp\DoctrineQueryFilter\Filter\Exception\InvalidArgumentException;
use Arp\DoctrineQueryFilter\Filter\FilterInterface;
use Arp\DoctrineQueryFilter\Filter\IsBetween;
use Doctrine\ORM\Query\Expr;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * @covers  \Arp\DoctrineQueryFilter\Filter\IsBetween
 * @covers  \Arp\DoctrineQueryFilter\Filter\AbstractFilter
 */
final class IsBetweenTest extends AbstractFilterTest
{
    /**
     * Assert that the class implements FilterInterface
     */
    public function testImplementsFilterInterface(): void
    {
        $filter = new IsBetween($this->queryFilterManager, $this->typecaster, $this->paramNameGenerator);

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

    /**
     * Assert that a InvalidArgumentException is thrown when attempting to call filter() without
     * the required 'from' key
     *
     * @throws FilterException
     * @throws InvalidArgumentException
     */
    public function testFilterWillThrowInvalidArgumentExceptionIfTheRequiredFromCriteriaIsMissing(): void
    {
        $filter = new IsBetween($this->queryFilterManager, $this->typecaster, $this->paramNameGenerator);

        $criteria = [
            // Missing 'from' key
        ];

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

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

    /**
     * Assert that a InvalidArgumentException is thrown when attempting to call filter() without
     * the required 'to' key
     *
     * @throws FilterException
     * @throws InvalidArgumentException
     */
    public function testFilterWillThrowInvalidArgumentExceptionIfTheRequiredToCriteriaIsMissing(): void
    {
        $filter = new IsBetween($this->queryFilterManager, $this->typecaster, $this->paramNameGenerator);

        $criteria = [
            'from' => '2021-03-01 00:00:00',
            // Missing required 'to' key
        ];

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

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

    /**
     * @param array<mixed> $criteria
     *
     * @throws FilterException
     * @throws InvalidArgumentException
     *
     * @dataProvider getFilterIsBetweenData
     */
    public function testFilterIsBetween(array $criteria): void
    {
        /** @var IsBetween&MockObject $filter */
        $filter = $this->getMockBuilder(IsBetween::class)
            ->setConstructorArgs([$this->queryFilterManager, $this->typecaster, $this->paramNameGenerator])
            ->onlyMethods(['createParamName'])
            ->getMock();

        $rootAlias = 'entity';
        $from = $criteria['from'] ?? '';
        $to = $criteria['to'] ?? '';
        $alias = $criteria['alias'] ?? 'entity';
        $fieldName = $criteria['field'] = $criteria['field'] ?? 'test';
        $formatType = $criteria['format'] ?? null;

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

        if (empty($criteria['alias'])) {
            $alias = $rootAlias;

            $this->queryBuilder->expects($this->once())
                                 expects($this->once())
                ->method('getRootAlias')
                ->willReturn($rootAlias);
        }

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

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

        $fromParam = $alias . 'abc123';
        $toParam = $alias . 'zyx999';

        $filter->expects($this->exactly(2))
        /** @scrutinizer ignore-deprecated */ $filter->expects($this->exactly(2))
            ->method('createParamName')
            ->withConsecutive(
                ['from', $fieldName, $alias],
                ['to', $fieldName, $alias]
            )->willReturnOnConsecutiveCalls(
                $fromParam,
                $toParam
            );

        $isBetween = $alias . '.' . $fieldName . ' BETWEEN ' . $fromParam . ' AND ' . $toParam;
        $expr->expects($this->once())
            ->method('between')
            ->with(
                $alias . '.' . $fieldName,
                ':' . $fromParam,
                ':' . $toParam
            )->willReturn(
                $isBetween
            );

        if (empty($criteria['where']) || WhereType::AND === $criteria['where']) {
            $this->queryBuilder->expects($this->once())
                ->method('andWhere')
                ->with($isBetween);
        } else {
            $this->queryBuilder->expects($this->once())
                ->method('orWhere')
                ->with($isBetween);
        }

        $this->typecaster->expects($this->exactly(2))
                           expects($this->exactly(2))
            ->method('typecast')
            ->withConsecutive(
                [$this->metadata, $fieldName, $from, $formatType, []],
                [$this->metadata, $fieldName, $to, $formatType, []],
            )->willReturnOnConsecutiveCalls(
                $from,
                $to
            );

        $this->queryBuilder->expects($this->exactly(2))
            ->method('setParameter')
            ->withConsecutive(
                [$fromParam, $from],
                [$toParam, $to]
            );

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

    /**
     * @return array<mixed><mixed>
     */
    public function getFilterIsBetweenData(): array
    {
        return [
            [
                [
                    'to'   => '2021-01-01 00:00:00',
                    'from' => '2021-02-01 00:00:00',
                ],
            ],

            [
                [
                    'to'    => '2021-01-01 00:00:00',
                    'from'  => '2021-02-01 00:00:00',
                    'where' => WhereType::AND,
                ],
            ],

            [
                [
                    'to'    => '2021-01-01 00:00:00',
                    'from'  => '2021-02-01 00:00:00',
                    'where' => WhereType::OR,
                ],
            ],

            [
                [
                    'to'    => '2000-01-01 11:12:45',
                    'from'  => '2021-01-01 07:35:17',
                    'alias' => 'test_alias_123',
                ],
            ],
        ];
    }
}

alex-patterson-webdev / doctrine-query-filter

IsBetweenTest::testImplementsFilterInterface() A last analyzed 2024-02-11 20:16 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IsBetweenTest::testImplementsFilterInterface() A
last analyzed 2024-02-11 20:16 UTC
