TraderInteractive\Filter\DateTimeZoneTest

Complexity

Total Complexity

7

Size/Duplication

Total Lines	101
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	filterNullAllowed()	0	3	1
A	filter()	0	6	1
A	filterTimeZonePass()	0	4	1
A	filterNullNotAllowed()	0	5	1
A	filterNonStringArgument()	0	5	1
A	filterInvalidName()	0	5	1
A	filterEmptyValue()	0	5	1

<?php

namespace TraderInteractive\Filter;

use PHPUnit\Framework\TestCase;

/**
 * Unit tests for the \TraderInteractive\Filter\DateTimeZone class.
 *
 * @coversDefaultClass \TraderInteractive\Filter\DateTimeZone
 * @covers ::<private>
 */
final class DateTimeZoneTest extends TestCase
{
    /**
     * Verify basic usage of filter().
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filter()
    {
        $value = 'Pacific/Honolulu';
        $timezone = DateTimeZone::filter($value);
        $this->assertSame($value, $timezone->getName());
        $this->assertSame(-36000, $timezone->getOffset(new \DateTime('now', $timezone)));
    }

    /**
     * Verify behavior of filter() when $allowNull is true and $value is null.
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filterNullAllowed()
    {
        $this->assertNull(DateTimeZone::filter(null, true));
    }

    /**
     * Verify behavior of filter() when $allowNull is false and $value is null.
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filterNullNotAllowed()
    {
        $this->expectException(\TraderInteractive\Exceptions\FilterException::class);
        $this->expectExceptionMessage('Value failed filtering, $allowNull is set to false');
        $this->assertNull(DateTimeZone::filter(null, false));
    }

    /**
     * Verify behavior of filter() when $value is a \DateTimeZone object.
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filterTimeZonePass()
    {
        $timezone = new \DateTimeZone('America/New_York');
        $this->assertSame($timezone, DateTimeZone::filter($timezone));
    }

    /**
     * Verify behavior of filter() when $value is not a valid timezone.
     *
     * @test
     * @covers ::filter
     */
    public function filterInvalidName()
    {
        $this->expectException(\TraderInteractive\Exceptions\FilterException::class);
        $this->expectExceptionMessage('Unknown or bad timezone (INVALID)');
        DateTimeZone::filter('INVALID');
    }

    /**
     * Verify behavior of filter() $value is a string with only whitespace.
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filterEmptyValue()
    {
        $this->expectException(\TraderInteractive\Exceptions\FilterException::class);
        $this->expectExceptionMessage('$value not a non-empty string');
        DateTimeZone::filter("\n\t");
    }

    /**
     * Verify behavior of filter() when $value is not a string.
     *
     * @test
     * @covers ::filter
     *
     * @return void
     */
    public function filterNonStringArgument()
    {
        $this->expectException(\TraderInteractive\Exceptions\FilterException::class);
        $this->expectExceptionMessage('$value not a non-empty string');
        DateTimeZone::filter(42);
    }
}