jjsm01/kimai2
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

added rounding rules and hourly rates factor #112 (#128)

Browse Source 
* added unit tests and documentation #112
* fixed DashboardController
* added CONTRIBUTION guidelines
* fixed license year
This commit is contained in:
Kevin Papst
2018-02-07 12:51:00 +01:00
committed by GitHub
parent 65790f1fb7
commit 2e60e14132
22 changed files with 925 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
tests/Timesheet/Calculator/DurationCalculatorTest.php Normal file
View File

@@ -0,0 +1,152 @@
<?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\Calculator;
use App\Entity\Timesheet;
use App\Timesheet\Calculator\DurationCalculator;
use \PHPUnit\Framework\TestCase;
/**
* @covers \App\Timesheet\Calculator\DurationCalculator
*/
class DurationCalculatorTest extends TestCase
{
public function testCalculateWithEmptyEnd()
{
$record = new Timesheet();
$record->setBegin(new \DateTime());
$this->assertEquals(0, $record->getDuration());
$sut = new DurationCalculator([]);
$sut->calculate($record);
$this->assertEquals(0, $record->getDuration());
}
/**
* @dataProvider getTestData
*/
public function testCalculate($rules, $start, $end, $expectedDuration)
{
$record = new Timesheet();
$record->setBegin($start);
$record->setEnd($end);
$this->assertEquals(0, $record->getDuration());
$sut = new DurationCalculator($rules);
$sut->calculate($record);
$this->assertEquals($expectedDuration, $record->getDuration());
}
public function getTestData()
{
$start = new \DateTime();
$start->setTime(12, 0, 0);
$day = $start->format('l');
return [
[
[],
$start,
(clone $start)->setTimestamp($start->getTimestamp() + 1837),
1837
],
[
[
'default' => [
'days' => [$day],
'begin' => 15,
'end' => 15,
'duration' => 0,
],
],
(clone $start)->setTime(12, 17, 35),
(clone $start)->setTime(13, 32, 52),
5400
],
[
[
'default' => [
'days' => [$day],
'begin' => 0,
'end' => 0,
'duration' => 0,
],
],
(clone $start)->setTime(12, 17, 35),
(clone $start)->setTime(13, 32, 52),
4517
],
[
[
'default' => [
'days' => [$day],
'begin' => 1,
'end' => 1,
'duration' => 0,
],
],
(clone $start)->setTime(12, 17, 35),
(clone $start)->setTime(13, 32, 52),
4560
],
[
[
'default' => [
'days' => [$day],
'begin' => 0,
'end' => 0,
'duration' => 30,
],
],
(clone $start)->setTime(12, 10, 51),
(clone $start)->setTime(14, 40, 52),
10800
],
[
[
'default' => [
'days' => [$day],
'begin' => 15,
'end' => 0,
'duration' => 0,
],
'weekdays' => [
'days' => ['monday','tuesday','wednesday','thursday','friday','saturday','sunday'],
'begin' => 0,
'end' => 1,
'duration' => 30,
],
],
(clone $start)->setTime(12, 27, 35), // 12:15
(clone $start)->setTime(14, 32, 52), // 14:33 => 2:18 => 2:30
9000
],
[
[
'default' => [
'days' => [$day],
'begin' => 15,
'end' => 0,
'duration' => 30,
],
'weekdays' => [
'days' => ['monday','tuesday','wednesday','thursday','friday','saturday','sunday'],
'begin' => 0,
'end' => 1,
'duration' => 0,
],
],
(clone $start)->setTime(12, 27, 35), // 12:15
(clone $start)->setTime(14, 32, 52), // 14:33 => 2:18 (second duration will not be rounded)
8280
],
];
}
}

160
tests/Timesheet/Calculator/RateCalculatorTest.php Normal file
View File

@@ -0,0 +1,160 @@
<?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\Calculator;
use App\Entity\Timesheet;
use App\Entity\User;
use App\Entity\UserPreference;
use App\Timesheet\Calculator\RateCalculator;
use \PHPUnit\Framework\TestCase;
/**
* @covers \App\Timesheet\Calculator\RateCalculator
*/
class RateCalculatorTest extends TestCase
{
const HOURLY_RATE = 75;
protected function getTestUser()
{
$pref = new UserPreference();
$pref->setName(UserPreference::HOURLY_RATE);
$pref->setValue(self::HOURLY_RATE);
$user = new User();
$user->setPreferences([$pref]);
return $user;
}
public function testCalculateWithEmptyEnd()
{
$record = new Timesheet();
$record->setBegin(new \DateTime());
$this->assertEquals(0, $record->getRate());
$sut = new RateCalculator([]);
$sut->calculate($record);
$this->assertEquals(0, $record->getRate());
}
/**
* @expectedException \InvalidArgumentException
* @dataProvider getDisallowedFactors
*/
public function testCalculateWithInvalidFactor($factor)
{
$today = new \DateTime();
$day = $today->format('l');
$rules = [
'default' => [
'days' => [$day],
'factor' => $factor
],
];
$seconds = 41837;
$end = new \DateTime();
$start = clone $end;
$start->setTimestamp($end->getTimestamp() - $seconds);
$record = new Timesheet();
$record->setUser($this->getTestUser());
$record->setBegin($start);
$record->setDuration($seconds);
$this->assertEquals(0, $record->getRate());
$record->setEnd($end);
$sut = new RateCalculator($rules);
$sut->calculate($record);
}
public function getDisallowedFactors()
{
return [
[0],
[-1],
];
}
/**
* @dataProvider getRuleDefinitions
*/
public function testCalculateWithRules($rules, $expectedFactor)
{
$seconds = 41837;
$end = new \DateTime();
$start = clone $end;
$start->setTimestamp($end->getTimestamp() - $seconds);
$record = new Timesheet();
$record->setUser($this->getTestUser());
$record->setBegin($start);
$record->setDuration($seconds);
$this->assertEquals(0, $record->getRate());
$record->setEnd($end);
$sut = new RateCalculator($rules);
$sut->calculate($record);
$this->assertEquals(
$this->rateForSeconds(self::HOURLY_RATE, $seconds) * $expectedFactor,
$record->getRate()
);
}
public function getRuleDefinitions()
{
$start = new \DateTime();
$start->setTime(12, 0, 0);
$day = $start->format('l');
return [
[
[],
1
],
[
[
'default' => [
'days' => [$day],
'factor' => 2.0
],
'foo' => [
'days' => ['bar'],
'factor' => 1.5
],
],
2.0
],
[
[
'default' => [
'days' => [$day],
'factor' => 2.0
],
'weekdays' => [
'days' => ['monday','tuesday','wednesday','thursday','friday','saturday','sunday'],
'factor' => 1.5
],
],
3.5
],
];
}
protected function rateForSeconds($hourlyRate, $seconds)
{
return (float) $hourlyRate * ($seconds / 3600);
}
}