DateTest.php

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Tests\Rule\Date;

use DateTimeImmutable;
use DateTimeZone;
use IntlDateFormatter;
use LogicException;
use stdClass;
use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Rule\Date\Date;
use Yiisoft\Validator\Rule\Date\DateHandler;
use Yiisoft\Validator\Rule\Date\DateTime;
use Yiisoft\Validator\Rule\Date\Time;
use Yiisoft\Validator\Tests\Rule\Base\RuleTestCase;
use Yiisoft\Validator\Tests\Rule\Base\SkipOnErrorTestTrait;
use Yiisoft\Validator\Tests\Rule\Base\WhenTestTrait;
use Yiisoft\Validator\Tests\Support\Rule\RuleWithCustomHandler;
use Yiisoft\Validator\Validator;

final class DateTest extends RuleTestCase
{
    use SkipOnErrorTestTrait;
    use WhenTestTrait;

    public function testGetName(): void
    {
        $rule = new Date();
        $this->assertSame('date', $rule->getName());
    }

    public static function dataValidationPassed(): array
    {
        return [
            'php-format' => ['2021-01-01', new Date(format: 'php:Y-m-d')],
            'intl-format' => ['2021-01-01', new Date(format: 'yyyy-MM-dd')],
            'datetime' => [new DateTimeImmutable('2021-01-01'), new Date()],
            'min' => ['2021-01-01', new Date(format: 'yyyy-MM-dd', min: '2020-01-01')],
            'max' => ['2021-01-01', new Date(format: 'yyyy-MM-dd', max: '2022-01-01')],
            'min-equal' => ['2021-01-01', new Date(format: 'yyyy-MM-dd', min: '2021-01-01')],
            'max-equal' => ['2021-01-01', new Date(format: 'yyyy-MM-dd', max: '2021-01-01')],
            'timezone' => [
                '12.11.2003',
                new Date(
                    format: 'php:d.m.Y',
                    timeZone: 'UTC',
                    min: new DateTimeImmutable('12.11.2003, 1:00:00', new DateTimeZone('GMT+3')),
                ),
            ],
            'timestamp' => [1711705158, new Date(min: 1711705100)],
            'zero-time' => [
                '2021-01-01',
                new Date(format: 'php:Y-m-d', max: new DateTimeImmutable('2021-01-01, 00:00:00')),
            ],
            'rule-locale' => [
                '29.03.2024',
                new Date(locale: 'ru'),
            ],
        ];
    }

    public static function dataValidationFailed(): array
    {
        $invalidDateMessage = ['' => ['Value must be a date.']];
        return [
            'php-format-invalid' => ['2021.01.01', new Date(format: 'php:Y-m-d'), $invalidDateMessage],
            'intl-format-invalid' => ['2021.01.01', new Date(format: 'yyyy-MM-dd'), $invalidDateMessage],
            'invalid-date' => ['2021.02.30', new Date(format: 'yyyy-MM-dd'), $invalidDateMessage],
            'invalid-value' => [new stdClass(), new Date(), $invalidDateMessage],
            'invalid-value-custom-message' => [
                ['a' => new stdClass()],
                ['a' => new Date(incorrectInputMessage: 'Invalid — {property}.')],
                ['a' => ['Invalid — a.']],
            ],
            'min' => [
                '2024-03-29',
                new Date(format: 'yyyy-MM-dd', min: '2025-01-01'),
                ['' => ['Value must be no earlier than 1/1/25.']],
            ],
            'min-custom-message' => [
                ['a' => '2024-03-29'],
                [
                    'a' => new Date(
                        format: 'php:Y-m-d',
                        min: '2025-01-01',
                        tooEarlyMessage: 'Prop — {property}. Date — {value}. Min — {limit}.',
                    ),
                ],
                ['a' => ['Prop — a. Date — 3/29/24. Min — 1/1/25.']],
            ],
            'max' => [
                '2024-03-29',
                new Date(format: 'php:Y-m-d', max: '2024-01-01'),
                ['' => ['Value must be no later than 1/1/24.']],
            ],
            'max-custom-message' => [
                ['a' => '2024-03-29'],
                [
                    'a' => new Date(
                        format: 'php:Y-m-d',
                        max: '2024-01-01',
                        tooLateMessage: 'Prop — {property}. Date — {value}. Max — {limit}.',
                    ),
                ],
                ['a' => ['Prop — a. Date — 3/29/24. Max — 1/1/24.']],
            ],
            'rule-and-handler-locales' => [
                '2024-03-29',
                new Date(format: 'php:Y-m-d', locale: 'ru', max: '2024-01-01'),
                ['' => ['Value must be no later than 01.01.2024.']],
                [DateHandler::class => new DateHandler(locale: 'en')],
            ],
            'handler-locale' => [
                '2024-03-29',
                new Date(format: 'php:Y-m-d', max: '2024-01-01'),
                ['' => ['Value must be no later than 01.01.2024.']],
                [DateHandler::class => new DateHandler(locale: 'ru')],
            ],
            'timestamp' => [
                1711705158,
                new Date(min: 1711705200),
                ['' => ['Value must be no earlier than 3/29/24.']],
            ],
            'without-message-date-type' => [
                '29*03*2024',
                new Date(format: 'php:d*m*Y', max: '11*11*2023', ),
                ['' => ['Value must be no later than 11/11/23.']],
                [DateHandler::class => new DateHandler(messageDateType: null)],
            ],
            'rule-message-format' => [
                '29*03*2024',
                new Date(format: 'php:d*m*Y', max: '11*11*2023', messageFormat: 'php:d=m=Y'),
                ['' => ['Value must be no later than 11=11=2023.']],
                [DateHandler::class => new DateHandler(messageFormat: 'php:d_m_Y')],
            ],
            'handler-message-type' => [
                'Mar 29, 2024',
                new Date(max: 'Dec 11, 2019', dateType: IntlDateFormatter::MEDIUM),
                ['' => ['Value must be no later than Wednesday, December 11, 2019.']],
                [DateHandler::class => new DateHandler(messageDateType: IntlDateFormatter::FULL)],
            ],
            'rule-message-type-override-handler' => [
                '3/29/2024',
                new Date(max: '12/11/2019', messageDateType: IntlDateFormatter::SHORT),
                ['' => ['Value must be no later than 12/11/19.']],
                [DateHandler::class => new DateHandler(messageDateType: IntlDateFormatter::FULL)],
            ],
            'rule-locale-override-handler' => [
                '12.11.2002',
                new Date(max: '10.11.2002', locale: 'ru'),
                ['' => ['Value must be no later than 10.11.2002.']],
                [DateHandler::class => new DateHandler(locale: 'en')],
            ],
        ];
    }

    public function testDifferentRuleInHandlerItems(): array
    {
        $rule = new RuleWithCustomHandler(DateHandler::class);
        $validator = new Validator();

        $this->expectException(UnexpectedRuleException::class);
        $this->expectExceptionMessage(
            'Expected "' . Date::class . '", "' . DateTime::class . '", "' . Time::class . '", but "' . RuleWithCustomHandler::class . '" given.',
        );
        $validator->validate([], $rule);
    }

    public function testInvalidMinValue(): void
    {
        $rule = new Date(format: 'php:Y-m-d', min: '12.11.2023');
        $validator = new Validator();

        $this->expectException(LogicException::class);
        $this->expectExceptionMessage('Invalid date value.');
        $validator->validate('2024-11-01', $rule);
    }

    public function testInvalidMaxValue(): void
    {
        $rule = new Date(format: 'php:Y-m-d', max: '12.11.2023');
        $validator = new Validator();

        $this->expectException(LogicException::class);
        $this->expectExceptionMessage('Invalid date value.');
        $validator->validate('2024-11-01', $rule);
    }

    public function testSkipOnError(): void
    {
        $this->testSkipOnErrorInternal(new Date(), new Date(skipOnError: true));
    }

    public function testWhen(): void
    {
        $this->testWhenInternal(
            new Date(),
            new Date(
                when: static fn(mixed $value): bool => $value !== null,
            ),
        );
    }
}