add "duration + fixed start time" tracking mode (#859)

tests/Timesheet/TrackingMode/AbstractTrackingModeTest.php

@@ -0,0 +1,205 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Timesheet\TrackingMode;
+
+use App\Entity\Timesheet;
+use App\Timesheet\TrackingMode\AbstractTrackingMode;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @covers \App\Timesheet\TrackingMode\AbstractTrackingMode
+ */
+abstract class AbstractTrackingModeTest extends TestCase
+{
+    /**
+     * @return AbstractTrackingMode
+     */
+    abstract protected function createSut();
+
+    public function testCreateDoesNotChangeAnythingOnEmptyRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+
+        self::assertNull($timesheet->getBegin());
+        self::assertNull($timesheet->getEnd());
+
+        $sut->create($timesheet, new Request());
+
+        self::assertNull($timesheet->getBegin());
+        self::assertNull($timesheet->getEnd());
+    }
+
+    public function testCreateUseBeginWithoutEndDateFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'begin' => '2017-07-23',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertEquals('2017-07-23', $timesheet->getBegin()->format('Y-m-d'));
+        self::assertNotEquals('10:00:00', $timesheet->getBegin()->format('H:i:s'));
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+
+    public function testCreateUseBeginEndDateFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'begin' => '2017-07-23',
+            'end' => '2017-07-23',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertNotNull($timesheet->getBegin());
+        self::assertNotNull($timesheet->getEnd());
+
+        self::assertEquals('2017-07-23 10:00:00', $timesheet->getBegin()->format('Y-m-d H:i:s'));
+        self::assertEquals('2017-07-23 18:00:00', $timesheet->getEnd()->format('Y-m-d H:i:s'));
+        self::assertEquals(28800, $timesheet->getDuration());
+    }
+
+    public function testCreateIgnoresValidEndOnInvalidBeginDateFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'begin' => '10x0-99-99',
+            'end' => '2017-07-23',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertNull($timesheet->getBegin());
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+
+    public function testCreateUsesBeginAndIgnoresInvalidEndDateFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'begin' => '2017-07-23',
+            'end' => '20xx-07-23',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertEquals('2017-07-23', $timesheet->getBegin()->format('Y-m-d'));
+        self::assertNotEquals('10:00:00', $timesheet->getBegin()->format('H:i:s'));
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+
+    public function testCreateUseFromWithoutToDatetimeFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'from' => '2018-05-23 21:47:55',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertEquals('2018-05-23 21:47:55', $timesheet->getBegin()->format('Y-m-d H:i:s'));
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+
+    public function testCreateUseFromToDatetimeFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'from' => '2018-05-23 21:47:55',
+            'to' => '2018-05-24 01:11:11',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertNotNull($timesheet->getBegin());
+        self::assertNotNull($timesheet->getEnd());
+
+        self::assertEquals('2018-05-23 21:47:55', $timesheet->getBegin()->format('Y-m-d H:i:s'));
+        self::assertEquals('2018-05-24 01:11:11', $timesheet->getEnd()->format('Y-m-d H:i:s'));
+        self::assertEquals(12196, $timesheet->getDuration());
+    }
+
+    public function testCreateUseFromToDatetimeOverwritesBeginEndTatesFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'begin' => '2017-07-23',
+            'end' => '2017-07-23',
+            'from' => '2018-05-23 21:47:55',
+            'to' => '2018-05-24 01:11:11',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertNotNull($timesheet->getBegin());
+        self::assertNotNull($timesheet->getEnd());
+
+        self::assertEquals('2018-05-23 21:47:55', $timesheet->getBegin()->format('Y-m-d H:i:s'));
+        self::assertEquals('2018-05-24 01:11:11', $timesheet->getEnd()->format('Y-m-d H:i:s'));
+        self::assertEquals(12196, $timesheet->getDuration());
+    }
+
+    public function testCreateIgnoresValidToOnInvalidFromDatetimeFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'from' => '2018-xx-23 21:47:55',
+            'to' => '2018-05-24 01:11:11',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertNull($timesheet->getBegin());
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+
+    public function testCreateUsesFromAndIgnoresInvalidToDatetimeFromRequest()
+    {
+        $sut = $this->createSut();
+
+        $timesheet = new Timesheet();
+        $request = new Request([
+            'from' => '2018-05-23 21:47:55',
+            'to' => '2018-xx-24 01:11:11',
+        ]);
+
+        $sut->create($timesheet, $request);
+
+        self::assertEquals('2018-05-23 21:47:55', $timesheet->getBegin()->format('Y-m-d H:i:s'));
+        self::assertNull($timesheet->getEnd());
+        self::assertEquals(0, $timesheet->getDuration());
+    }
+}

tests/Timesheet/TrackingMode/DefaultModeTest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Timesheet\TrackingMode;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Tests\Configuration\TestConfigLoader;
+use App\Tests\Mocks\Security\UserDateTimeFactoryFactory;
+use App\Timesheet\TrackingMode\DefaultMode;
+
+/**
+ * @covers \App\Timesheet\TrackingMode\DefaultMode
+ */
+class DefaultModeTest extends AbstractTrackingModeTest
+{
+    /**
+     * @return DefaultMode
+     */
+    protected function createSut()
+    {
+        $loader = new TestConfigLoader([]);
+        $dateTime = (new UserDateTimeFactoryFactory($this))->create();
+        $configuration = new TimesheetConfiguration($loader, ['default_begin' => '13:47']);
+
+        return new DefaultMode($dateTime, $configuration);
+    }
+
+    public function testDefaultValues()
+    {
+        $sut = $this->createSut();
+
+        self::assertTrue($sut->canEditBegin());
+        self::assertTrue($sut->canEditEnd());
+        self::assertFalse($sut->canEditDuration());
+        self::assertTrue($sut->canUpdateTimesWithAPI());
+        self::assertTrue($sut->canSeeBeginAndEndTimes());
+        self::assertEquals('default', $sut->getId());
+    }
+}

tests/Timesheet/TrackingMode/DurationFixedStartModeTest.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Timesheet\TrackingMode;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Entity\Timesheet;
+use App\Tests\Configuration\TestConfigLoader;
+use App\Tests\Mocks\Security\UserDateTimeFactoryFactory;
+use App\Timesheet\TrackingMode\DurationFixedStartMode;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @covers \App\Timesheet\TrackingMode\DurationFixedStartMode
+ */
+class DurationFixedStartModeTest extends TestCase
+{
+    protected function createSut()
+    {
+        $loader = new TestConfigLoader([]);
+        $dateTime = (new UserDateTimeFactoryFactory($this))->create();
+        $configuration = new TimesheetConfiguration($loader, ['default_begin' => '13:47']);
+
+        return new DurationFixedStartMode($dateTime, $configuration);
+    }
+
+    public function testDefaultValues()
+    {
+        $sut = $this->createSut();
+
+        self::assertFalse($sut->canEditBegin());
+        self::assertFalse($sut->canEditEnd());
+        self::assertTrue($sut->canEditDuration());
+        self::assertFalse($sut->canUpdateTimesWithAPI());
+        self::assertFalse($sut->canSeeBeginAndEndTimes());
+        self::assertEquals('duration_fixed_start', $sut->getId());
+    }
+
+    public function testCreate()
+    {
+        $timesheet = new Timesheet();
+        $timesheet->setBegin(new \DateTime('22:54'));
+        $request = new Request();
+
+        $sut = $this->createSut();
+        self::assertEquals('22:54', $timesheet->getBegin()->format('H:i'));
+        $sut->create($timesheet, $request);
+        self::assertEquals('13:47', $timesheet->getBegin()->format('H:i'));
+    }
+}

tests/Timesheet/TrackingMode/DurationOnlyModeTest.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Timesheet\TrackingMode;
+
+use App\Configuration\TimesheetConfiguration;
+use App\Tests\Configuration\TestConfigLoader;
+use App\Tests\Mocks\Security\UserDateTimeFactoryFactory;
+use App\Timesheet\TrackingMode\DurationOnlyMode;
+
+/**
+ * @covers \App\Timesheet\TrackingMode\DurationOnlyMode
+ */
+class DurationOnlyModeTest extends AbstractTrackingModeTest
+{
+    protected function createSut()
+    {
+        $loader = new TestConfigLoader([]);
+        $dateTime = (new UserDateTimeFactoryFactory($this))->create();
+        $configuration = new TimesheetConfiguration($loader, []);
+
+        return new DurationOnlyMode($dateTime, $configuration);
+    }
+
+    public function testDefaultValues()
+    {
+        $sut = $this->createSut();
+
+        self::assertTrue($sut->canEditBegin());
+        self::assertFalse($sut->canEditEnd());
+        self::assertTrue($sut->canEditDuration());
+        self::assertTrue($sut->canUpdateTimesWithAPI());
+        self::assertFalse($sut->canSeeBeginAndEndTimes());
+        self::assertEquals('duration_only', $sut->getId());
+    }
+}

tests/Timesheet/TrackingMode/PunchInOutModeTest.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Timesheet\TrackingMode;
+
+use App\Entity\Timesheet;
+use App\Timesheet\TrackingMode\PunchInOutMode;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @covers \App\Timesheet\TrackingMode\PunchInOutMode
+ */
+class PunchInOutModeTest extends TestCase
+{
+    public function testDefaultValues()
+    {
+        $sut = new PunchInOutMode();
+
+        self::assertFalse($sut->canEditBegin());
+        self::assertFalse($sut->canEditEnd());
+        self::assertFalse($sut->canEditDuration());
+        self::assertFalse($sut->canUpdateTimesWithAPI());
+        self::assertTrue($sut->canSeeBeginAndEndTimes());
+        self::assertEquals('punch', $sut->getId());
+    }
+
+    public function testCreate()
+    {
+        $timesheet = new Timesheet();
+        $timesheet->setBegin(new \DateTime('22:54'));
+        $request = new Request();
+        $timesheetNew = clone $timesheet;
+
+        $sut = new PunchInOutMode();
+        $sut->create($timesheet, $request);
+        self::assertEquals($timesheet, $timesheetNew);
+    }
+}