doctrine / DoctrineModule

tests/DoctrineModuleTest/Validator/ObjectExistsTest.php

<?php

declare(strict_types=1);

namespace DoctrineModuleTest\Validator\Adapter;

use DoctrineModule\Validator\ObjectExists;
use PHPUnit\Framework\TestCase as BaseTestCase;
use stdClass;
use function str_replace;

/**
 * Tests for the ObjectExists validator
 *
 * @link    http://www.doctrine-project.org/
 *
 * @covers \DoctrineModule\Validator\ObjectExists
 */
class ObjectExistsTest extends BaseTestCase
{
    public function testCanValidateWithSingleField() : void
    {
        $repository = $this->createMock('Doctrine\Persistence\ObjectRepository');

        $repository
            ->expects($this->exactly(2))
            ->method('findOneBy')
            ->with(['matchKey' => 'matchValue'])
            ->will($this->returnValue(new stdClass()));

        $validator = new ObjectExists(['object_repository' => $repository, 'fields' => 'matchKey']);

        $this->assertTrue($validator->isValid('matchValue'));
        $this->assertTrue($validator->isValid(['matchKey' => 'matchValue']));
    }

    public function testCanValidateWithMultipleFields() : void
    {
        $repository = $this->createMock('Doctrine\Persistence\ObjectRepository');
        $repository
            ->expects($this->exactly(2))
            ->method('findOneBy')
            ->with(['firstMatchKey' => 'firstMatchValue', 'secondMatchKey' => 'secondMatchValue'])
            ->will($this->returnValue(new stdClass()));

        $validator = new ObjectExists([
            'object_repository' => $repository,
            'fields'            => [
                'firstMatchKey',
                'secondMatchKey',
            ],
        ]);
        $this->assertTrue(
            $validator->isValid([
                'firstMatchKey'  => 'firstMatchValue',
                'secondMatchKey' => 'secondMatchValue',
            ])
        );
        $this->assertTrue($validator->isValid(['firstMatchValue', 'secondMatchValue']));
    }

    public function testCanValidateFalseOnNoResult() : void
    {
        $repository = $this->createMock('Doctrine\Persistence\ObjectRepository');
        $repository
            ->expects($this->once())
            ->method('findOneBy')
            ->will($this->returnValue(null));

        $validator = new ObjectExists([
            'object_repository' => $repository,
            'fields'            => 'field',
        ]);
        $this->assertFalse($validator->isValid('value'));
    }

    public function testWillRefuseMissingRepository() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists(['fields' => 'field']);
    }

    public function testWillRefuseNonObjectRepository() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists(['object_repository' => 'invalid', 'fields' => 'field']);
    }

    public function testWillRefuseInvalidRepository() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists(['object_repository' => new stdClass(), 'fields' => 'field']);
    }

    public function testWillRefuseMissingFields() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
        ]);
    }

    public function testWillRefuseEmptyFields() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
            'fields'            => [],
        ]);
    }

    public function testWillRefuseNonStringFields() : void
    {
        $this->expectException('Laminas\Validator\Exception\InvalidArgumentException');

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

        new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
            'fields'            => [123],
        ]);
    }

    public function testWillNotValidateOnFieldsCountMismatch() : void
    {
        $this->expectException(

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

            'Laminas\Validator\Exception\RuntimeException'
        );
        $this->expectExceptionMessage(

The method expectExceptionMessage() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

            'Provided values count is 1, while expected number of fields to be matched is 2'
        );
        $validator = new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
            'fields'            => ['field1', 'field2'],
        ]);
        $validator->isValid(['field1Value']);
    }

    public function testWillNotValidateOnFieldKeysMismatch() : void
    {
        $this->expectException(

The method expectException() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

            'Laminas\Validator\Exception\RuntimeException'
        );
        $this->expectExceptionMessage(

The method expectExceptionMessage() does not seem to exist on object<DoctrineModuleTest\Validator\Adapter\ObjectExistsTest>.

            'Field "field2" was not provided, but was expected since the configured field lists needs it for validation'
        );

        $validator = new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
            'fields'            => ['field1', 'field2'],
        ]);

        $validator->isValid(['field1' => 'field1Value']);
    }

    public function testErrorMessageIsStringInsteadArray() : void
    {
        $repository = $this->createMock('Doctrine\Persistence\ObjectRepository');
        $validator  = new ObjectExists([
            'object_repository' => $this->createMock('Doctrine\Persistence\ObjectRepository'),
            'fields'            => 'field',
        ]);

        $this->assertFalse($validator->isValid('value'));

        $messageTemplates = $validator->getMessageTemplates();

        $expectedMessage = str_replace(
            '%value%',
            'value',
            $messageTemplates[ObjectExists::ERROR_NO_OBJECT_FOUND]
        );
        $messages        = $validator->getMessages();
        $receivedMessage = $messages[ObjectExists::ERROR_NO_OBJECT_FOUND];

        $this->assertSame($expectedMessage, $receivedMessage);
    }
}