TimeTest::testInBounds() - Code Metrics - Inspection of "WIP: Rip out score" - CorWatts/fasterscale - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#163)

by Corey
created 2019-04-18 03:38 UTC
TimeTest::testInBounds() A

↳ Parent: TimeTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	15
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	10
dl	0
loc	15
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	0
<?php

namespace common\tests\unit\components;

use \DateTime;
use \DateTimeZone;
use Yii;
use common\components\Time;

date_default_timezone_set('UTC');

/**
 * Time test
 */

class TimeTest extends \Codeception\Test\Unit
{
    use \Codeception\Specify;

    public function setUp()
    {
      $this->container = new \yii\di\Container;

      $this->container->set('common\interfaces\UserInterface', '\site\tests\_support\MockUser');
      $this->container->set('common\interfaces\UserBehaviorInterface', '\site\tests\_support\MockUserBehavior');
      $this->container->set('common\interfaces\QuestionInterface', '\site\tests\_support\MockQuestion');

      $this->container->set('common\interfaces\TimeInterface', function () {
        return new \common\components\Time('America/Los_Angeles');
      });

      $this->time = $this->container->get('common\interfaces\TimeInterface');


      parent::setUp();
    }

    protected function tearDown()
    {
        parent::tearDown();
    }

    public function testNow()
    {
      expect('now should return a \DateTime object', $this->assertInstanceOf(\DateTime::class, $this->time->now()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('now should return a \DateTime object with the correct timezone', $this->assertEquals('America/Los_Angeles', $this->time->now()->getTimezone()->getName()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('now should return a \DateTime object with the current date', $this->assertEquals($this->time->getLocalDate(), $this->time->now()->format('Y-m-d')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    public function testGetLocalTime()
    {
      $this->specify('getLocalTime should function correctly', function () {
        expect("getLocalTime should work with user's set time", $this->assertEquals($this->time->getLocalTime(), (new DateTime("now", new DateTimeZone("America/Los_Angeles")))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('getLocalTime should work with a custom timezone', $this->assertEquals($this->time->getLocalTime("UTC"), (new DateTime("now"))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testConvertLocalToUTC()
    {
      $this->specify('convertLocalToUTC should function correctly', function () {
        $la_tz = (new DateTime("now", new DateTimeZone("America/Los_Angeles")))->format("Y-m-d H:i:s");

        expect('convertLocalToUTC should convert a Los Angeles tz to UTC with the included time', $this->assertEquals($this->time->convertLocalToUTC($la_tz), (new DateTime("now"))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('convertLocalToUTC should convert a Los Angeles tz to UTC without the included time', $this->assertEquals($this->time->convertLocalToUTC($la_tz, false), (new DateTime("now"))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        // with UTC
        $this->container->set('common\interfaces\TimeInterface', function () {
          return new \common\components\Time('UTC');
        });
        $time = $this->container->get('common\interfaces\TimeInterface');
        
        $utc_tz = (new DateTime("now"))->format("Y-m-d H:i:s");
        expect('convertLocalToUTC should convert a UTC tz correctly with the included time', $this->assertEquals($time->convertLocalToUTC($utc_tz), (new DateTime("now"))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('convertLocalToUTC should convert a UTC tz correctly without the included time', $this->assertEquals($time->convertLocalToUTC($utc_tz, false), (new DateTime("now"))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testConvertUTCToLocal()
    {
      $this->specify('convertUTCToLocal should function correctly', function () {
        $utc_tz = (new DateTime("now"))->format("Y-m-d H:i:s");

        expect('convertUTCToLocal should convert a UTC tz to Los Angeles with the included timezone', $this->assertEquals((new DateTime("now", new DateTimeZone("America/Los_Angeles")))->format(DateTime::ATOM), $this->time->convertUTCToLocal($utc_tz)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('convertUTCToLocal should convert a UTC tz to Los Angeles without the included timezone', $this->assertEquals($this->time->convertUTCToLocal($utc_tz, false), (new DateTime("now", new DateTimeZone("America/Los_Angeles")))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

        // with UTC
        $this->container->set('common\interfaces\TimeInterface', function () {
          return new \common\components\Time('UTC');
        });
        $time = $this->container->get('common\interfaces\TimeInterface');
        $utc_tz = (new DateTime("now"))->format("Y-m-d H:i:s");

        expect('convertLocalToUTC should convert a UTC tz correctly with the included time', $this->assertEquals($time->convertLocalToUTC($utc_tz), (new DateTime("now"))->format("Y-m-d H:i:s")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('convertLocalToUTC should convert a UTC tz correctly without the included time', $this->assertEquals($time->convertLocalToUTC($utc_tz, false), (new DateTime("now"))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testGetLocalDate()
    {
      $this->specify('getLocalDate should function correctly', function () {
        expect("getLocalDate should correctly get the user's local date", $this->assertEquals($this->time->getLocalDate(), (new DateTime("now", new DateTimeZone("America/Los_Angeles")))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect("getLocalDate should correctly get the local date of a specified timezone", $this->assertEquals($this->time->getLocalDate("UTC"), (new DateTime("now", new DateTimeZone("UTC")))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testAlterLocalDate()
    {
      $this->specify('alterLocalDate should function correctly', function() {
        expect('alterLocalDate should add one day to the local time', $this->assertEquals($this->time->alterLocalDate('2016-05-01 00:00:00', '+1 day'), (new DateTime("2016-05-01 00:00:00 +1 day"))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('alterLocalDate should subtract one week to the local time and change the year correctly', $this->assertEquals($this->time->alterLocalDate('2016-01-01 04:03:00', '-1 week'), (new DateTime("2016-01-01 04:03:00 -1 week"))->format("Y-m-d")));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testGetUTCBookends()
    {
      $this->specify('getUTCBookends should function correctly', function() {
        expect('getUTCBookends should return false if there is a space in the time string', $this->assertFalse($this->time->getUTCBookends('2016-05-30 00:00:00')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('getUTCBookends should return false if there is a space at the start of the time string', $this->assertFalse($this->time->getUTCBookends(' 2016-05-30 00:00:00')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('getUTCBookends should return false if there is a space at the end of the time string', $this->assertFalse($this->time->getUTCBookends('2016-05-30 00:00:00 ')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('getUTCBookends should return UTC bookend times from the Los_Angeles tz', $this->assertEquals($this->time->getUTCBookends('2016-05-30'), ['2016-05-30 07:00:00', '2016-05-31 06:59:59']));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        // with UTC
        $this->container->set('common\interfaces\TimeInterface', function () {
          return new \common\components\Time('UTC');
        });
        $time = $this->container->get('common\interfaces\TimeInterface');
        expect('getUTCBookends should return UTC bookend times from UTC tz', $this->assertEquals($time->getUTCBookends('2016-05-30'), ['2016-05-30 00:00:00', '2016-05-30 23:59:59']));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });
    }

    public function testParse() {
      $good = new DateTime('2016-05-05', new DateTimeZone('America/Los_Angeles'));
      expect('parse should accept a String time and verify it is in YYYY-MM-DD format, then return it as a \DateTime', $this->assertEquals($this->time->parse('2016-05-05'), $good));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

      $observer = $this
        ->getMockBuilder("common\components\Time")
        ->setConstructorArgs(['America/Los_Angeles'])
        ->setMethods(['inBounds'])
        ->getMock();
      $observer->expects($this->once())
        ->method('inBounds')
        ->with($this->equalTo($good))
        ->willReturn(true);
      expect('parse should return a \DateTime object if the date is in bounds', $this->assertInstanceOf(DateTime::class, $observer->parse('2016-05-05')));
      expect('parse should return a \DateTime object if the date is in bounds', $this->assertInstanceOf(DateTime::class, $observer->/** @scrutinizer ignore-call */ parse('2016-05-05')));
      expect('parse should return the default value (false) if the date itself is null', $this->assertFalse($this->time->parse(null)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

      $observer2 = $this
        ->getMockBuilder("common\components\Time")
        ->setConstructorArgs(['America/Los_Angeles'])
        ->setMethods(['inBounds'])
        ->getMock();
      $observer2->expects($this->exactly(2))
        ->method('inBounds')
        ->with($this->equalTo($good))
        ->willReturn(false);
      expect('parse should return the default value (false) if the date is not in bounds', $this->assertFalse($observer2->parse('2016-05-05')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('parse should return the default value if the date is not in bounds', $this->assertEquals($observer2->now()->format('Y-m-d'), $observer2->parse('2016-05-05', $observer2->now())->format('Y-m-d')));
      expect('parse should return the default value if the date is not in bounds', $this->assertEquals($observer2->/** @scrutinizer ignore-call */ now()->format('Y-m-d'), $observer2->parse('2016-05-05', $observer2->now())->format('Y-m-d')));

      $this->specify('should all return false', function() {
        expect('parse should return false if the date itself is empty', $this->assertFalse($this->time->parse('')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date itself is unacceptable or is in an unacceptable format', $this->assertFalse($this->time->parse('aaaa-aa-aa')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date is not in bounds', $this->assertFalse($this->time->parse('aaaa-aa-aa')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date itself is nonsensical', $this->assertFalse($this->time->parse('2018-22-44')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });

      $this->specify('should still work fine with other timezones', function() {
        $this->time->timezone = 'UTC';
        $good = new DateTime('2016-05-05', new DateTimeZone('UTC'));
        expect('parse should accept a String time and verify it is in YYYY-MM-DD format, then return it as a \DateTime', $this->assertEquals($this->time->parse('2016-05-05'), $good));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

        expect('parse should return false if the date itself is empty', $this->assertFalse($this->time->parse('')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date itself is unacceptable or is in an unacceptable format', $this->assertFalse($this->time->parse('aaaa-aa-aa')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date is not in bounds', $this->assertFalse($this->time->parse('aaaa-aa-aa')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
        expect('parse should return false if the date itself is nonsensical', $this->assertFalse($this->time->parse('2018-22-44')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      });

    }

    public function testInBounds() {
    
      $dt = new DateTime('2016-05-05');
      expect('a sensible date should be in bounds', $this->assertTrue($this->time->inBounds($dt)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

      $early = '0111-10-01';
      $dt = new DateTime($early);
      $this->assertTrue($this->time::EARLIEST_DATE > $early);
      expect('a too-early date should be not in bounds', $this->assertFalse($this->time->inBounds($dt)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

      $tomorrow = new DateTime("now + 1 day", new DateTimeZone('America/Los_Angeles'));
      expect('tomorrow\'s date should be not in bounds', $this->assertFalse($this->time->inBounds($tomorrow)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    
      $dt = new DateTime('2016-05-05 05:14:22');
      expect('different formats of sensible dates should be in bounds', $this->assertTrue($this->time->inBounds($dt)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    public function testValidate() {
      expect('validate should return the local date by default', $this->assertEquals($this->time->validate(), $this->time->now()->format('Y-m-d')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('validate should return same date string if given a valid format', $this->assertEquals($this->time->validate('2015-02-02'), '2015-02-02'));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('validate should return the local date if given an invalid format', $this->assertEquals($this->time->validate('definitelynotadate9000'), $this->time->now()->format('Y-m-d')));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    public function testGetDateTimesInPeriod() {
      expect('getDateTImesInPeriod should return an a \DatePeriod', $this->assertInstanceOf(\DatePeriod::class, $this->time->getDateTimesInPeriod()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('getDateTimesInPeriod should return a 30 day period by default', $this->assertCount(30, $this->time->getDateTimesInPeriod()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
      expect('getDateTimesInPeriod should return an arbitrary period length if supplied', $this->assertCount(42, $this->time->getDateTimesInPeriod(42)));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }
}

CorWatts / fasterscale

Pull Request — master (#163)

TimeTest::testInBounds() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
