ArpTest\DateTime\DateTimeImmutableFactoryTest

Complexity

Total Complexity

6

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getCreatFromFormatWillReturnDateTimeImmutableData()	0	11	1
A	testCreatFromFormatWillReturnDateTimeImmutable()	0	5	1
A	testCreatDateTimeWillReturnDateTimeImmutable()	0	7	1
A	testImplementsDateTimeFactoryInterface()	0	5	1
A	testCreateDateTimeWillThrowDateTimeFactoryExceptionIfDateTimeClassNameIsNotDateTimeImmutable()	0	11	1
A	getCreatDateTimeWillReturnDateTimeImmutableData()	0	12	1

<?php

declare(strict_types=1);

namespace ArpTest\DateTime;

use Arp\DateTime\DateTimeFactoryInterface;
use Arp\DateTime\DateTimeImmutableFactory;
use Arp\DateTime\Exception\DateTimeFactoryException;
use PHPUnit\Framework\TestCase;

/**
 * @covers  \Arp\DateTime\DateTimeImmutableFactory
 *
 * @author  Alex Patterson <alex.patterson.webdev@gmail.com>
 * @package ArpTest\DateTime
 */
final class DateTimeImmutableFactoryTest extends TestCase
{
    /**
     * Assert the class implements DateTimeFactoryInterface
     */
    public function testImplementsDateTimeFactoryInterface(): void
    {
        $factory = new DateTimeImmutableFactory();

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

    /**
     * Assert that an exception will be thrown if the provided $dateTimeClassName option is a class that does not
     * implement \DateTimeInterface.
     */
    public function testCreateDateTimeWillThrowDateTimeFactoryExceptionIfDateTimeClassNameIsNotDateTimeImmutable(): void
    {
        $this->expectException(DateTimeFactoryException::class);
        $this->expectExceptionMessage(
            sprintf(
                'The \'dateTimeClassName\' parameter must be a class name that implements \'%s\'',
                \DateTimeImmutable::class
            )
        );

        new DateTimeImmutableFactory(\DateTime::class);
    }

    /**
     * Assert that calls to createDateTime() will return a DateTimeImmutable instance,
     * matching the provided $spec and $timeZone
     *
     * @param string|null               $spec
     * @param \DateTimeZone|string|null $timeZone
     *
     * @dataProvider getCreatDateTimeWillReturnDateTimeImmutableData
     *
     * @throws DateTimeFactoryException
     * @throws \Exception
     */
    public function testCreatDateTimeWillReturnDateTimeImmutable(?string $spec, $timeZone = null): void
    {
        $factory = new DateTimeImmutableFactory();

        $immutableDateTime = $factory->createDateTime($spec, $timeZone);

        $this->assertInstanceOf(\DateTimeImmutable::class, $immutableDateTime);
    }

    /**
     * @return array<mixed>
     */
    public function getCreatDateTimeWillReturnDateTimeImmutableData(): array
    {
        return [
            [
                null,
            ],
            [
                'now',
                'UTC',
            ],
            [
                '2021-05-01',
            ],
        ];
    }

    /**
     * @param string                    $format
     * @param string                    $spec
     * @param string|\DateTimeZone|null $timeZone
     *
     * @dataProvider getCreatFromFormatWillReturnDateTimeImmutableData
     *
     * @throws DateTimeFactoryException
     */
    public function testCreatFromFormatWillReturnDateTimeImmutable(string $format, string $spec, $timeZone = null): void
    {
        $factory = new DateTimeImmutableFactory();

        $this->assertInstanceOf(\DateTimeImmutable::class, $factory->createFromFormat($format, $spec, $timeZone));
    }

    /**
     * @return array<mixed>
     */
    public function getCreatFromFormatWillReturnDateTimeImmutableData(): array
    {
        return [
            [
                'Y/m/d H:i:s',
                '2021/05/03 14:36:47',
            ],
            [
                'Y-d-m H:i:s',
                '1999-01-12 11:06:01',
                'UTC',
            ],
        ];
    }
}