Factory\Hydrator\Strategy\DateTimeStrategyFactoryTest

Complexity

Total Complexity

6

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getInvokeReturnsDateTimeStrategyData()	0	14	1
A	testInvokeWillThrowServiceNotCreatedExceptionIfTheFormatOptionIsNotProvided()	0	18	1
A	testInvokeReturnsDateTimeStrategy()	0	26	2
A	testImplementsFactoryInterface()	0	5	1
A	testInvokeWillThrowServiceNotCreatedExceptionIfTheFormatOptionIsNotLoaded()	0	38	1

<?php

declare(strict_types=1);

namespace Factory\Hydrator\Strategy;

use Arp\LaminasDateTime\Factory\Hydrator\Strategy\DateTimeStrategyFactory;
use Interop\Container\ContainerInterface;
use Laminas\Hydrator\Strategy\DateTimeFormatterStrategy;
use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
use Laminas\ServiceManager\Factory\FactoryInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

/**
 * @covers \Arp\LaminasDateTime\Factory\Hydrator\Strategy\DateTimeStrategyFactory
 *
 * @author  Alex Patterson <alex.patterson.webdev@gmail.com>
 * @package Factory\Hydrator\Strategy
 */
final class DateTimeStrategyFactoryTest extends TestCase
{
    /**
     * Assert the factory class implements FactoryInterface
     */
    public function testImplementsFactoryInterface(): void
    {
        $factory = new DateTimeStrategyFactory();

        $this->assertInstanceOf(FactoryInterface::class, $factory);
    }

    /**
     * Assert that a ServiceNotCreatedException will be thrown if calling __invoke without a format option
     */
    public function testInvokeWillThrowServiceNotCreatedExceptionIfTheFormatOptionIsNotProvided(): void
    {
        $factory = new DateTimeStrategyFactory();

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

        $requestedName = DateTimeFormatterStrategy::class;

        $this->expectException(ServiceNotCreatedException::class);
        $this->expectExceptionMessage(
            sprintf(
                'The required \'format\' configuration option is missing for service \'%s\'',
                $requestedName
            )
        );

        $factory($container, $requestedName, []);
    }

    /**
     * Assert that a ServiceNotCreatedException will be thrown if unable to load a 'format' option from
     * configuration
     */
    public function testInvokeWillThrowServiceNotCreatedExceptionIfTheFormatOptionIsNotLoaded(): void
    {
        $factory = new DateTimeStrategyFactory();

        $applicationConfig = [
            'arp' => [
                'services' => [
                    DateTimeFormatterStrategy::class => [
                        // Missing format option
                    ],
                ],
            ]
        ];

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

        $requestedName = DateTimeFormatterStrategy::class;

        $container->expects($this->once())
            ->method('has')
            ->with('config')
            ->willReturn(true);

        $container->expects($this->once())
            ->method('get')
            ->with('config')
            ->willReturn($applicationConfig);

        $this->expectException(ServiceNotCreatedException::class);
        $this->expectExceptionMessage(
            sprintf(
                'The required \'format\' configuration option is missing for service \'%s\'',
                $requestedName
            )
        );

        $factory($container, $requestedName);
    }

    /**
     * Assert that the __invoke() method will return a configured DateTimeStrategy
     *
     * @param array|null $options
     *
     * @dataProvider getInvokeReturnsDateTimeStrategyData
     */
    public function testInvokeReturnsDateTimeStrategy(?array $options): void
    {
        $factory = new DateTimeStrategyFactory();

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

        $requestedName = DateTimeFormatterStrategy::class;

        if (null === $options) {

The condition null === $options is always false.

            $applicationConfig = [
                'arp' => [
                    'services' => [
                        DateTimeFormatterStrategy::class => [
                            'format' => \DateTime::RFC3339,
                        ],
                    ],
                ]
            ];

            $container->expects($this->once())->method('has')->with('config')->willReturn(true);
            $container->expects($this->once())->method('get')->with('config')->willReturn($applicationConfig);
        }

        /** @noinspection UnnecessaryAssertionInspection */
        $this->assertInstanceOf(DateTimeFormatterStrategy::class, $factory($container, $requestedName, $options));
    }

    /**
     * @return array
     */
    public function getInvokeReturnsDateTimeStrategyData(): array
    {
        return [
            [
                null,
            ],
            [
                [
                    'format' => \DateTime::ATOM,
                ]
            ],
            [
                [
                    'format' => \DateTime::RFC3339_EXTENDED,
                ]
            ],
        ];
    }
}