iger
/
engelsystem
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Metrics: Strict types and type hinting

This commit is contained in:
Igor Scheller 2019-12-25 09:57:11 +01:00
parent c023c8a9c6
commit 45d13ac998
2 changed files with 43 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
src/Controllers/Metrics/Stats.php
View File

@ -1,15 +1,20 @@
<?php <?php
declare(strict_types=1);
namespace Engelsystem\Controllers\Metrics; namespace Engelsystem\Controllers\Metrics;
use Carbon\Carbon; use Carbon\Carbon;
use Engelsystem\Database\Database; use Engelsystem\Database\Database;
use Engelsystem\Models\EventConfig; use Engelsystem\Models\EventConfig;
use Engelsystem\Models\LogEntry;
use Engelsystem\Models\News; use Engelsystem\Models\News;
use Engelsystem\Models\Question; use Engelsystem\Models\Question;
use Engelsystem\Models\User\PasswordReset;
use Engelsystem\Models\User\State; use Engelsystem\Models\User\State;
use Illuminate\Database\Query\Builder as QueryBuilder; use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Database\Query\Expression as QueryExpression; use Illuminate\Database\Query\Expression as QueryExpression;
use Illuminate\Support\Collection;
class Stats class Stats
{ {
@ -27,22 +32,18 @@ class Stats
/** /**
* The number of not arrived users * The number of not arrived users
* *
* @param null $working * @param bool|null $working
* @return int * @return int
*/ */
public function arrivedUsers($working = null): int public function arrivedUsers(bool $working = null): int
{ {
/** @var QueryBuilder $query */ $query = State::whereArrived(true);
$query = $this
->getQuery('users')
->join('users_state', 'user_id', '=', 'id')
->where('arrived', '=', 1);
if (!is_null($working)) { if (!is_null($working)) {
// @codeCoverageIgnoreStart // @codeCoverageIgnoreStart
$query $query
->leftJoin('UserWorkLog', 'UserWorkLog.user_id', '=', 'users.id') ->leftJoin('UserWorkLog', 'UserWorkLog.user_id', '=', 'users_state.user_id')
->leftJoin('ShiftEntry', 'ShiftEntry.UID', '=', 'users.id') ->leftJoin('ShiftEntry', 'ShiftEntry.UID', '=', 'users_state.user_id')
->distinct(); ->distinct();
$query->where(function ($query) use ($working) { $query->where(function ($query) use ($working) {
@ -62,8 +63,7 @@ class Stats
// @codeCoverageIgnoreEnd // @codeCoverageIgnoreEnd
} }
return $query return $query->count('users_state.user_id');
->count('users.id');
} }
/** /**
@ -73,11 +73,7 @@ class Stats
*/ */
public function newUsers(): int public function newUsers(): int
{ {
return $this return State::whereArrived(false)->count();
->getQuery('users')
->join('users_state', 'user_id', '=', 'id')
->where('arrived', '=', 0)
->count();
} }
/** /**
@ -91,11 +87,11 @@ class Stats
/** /**
* The number of currently working users * The number of currently working users
* *
* @param null $freeloaded * @param bool|null $freeloaded
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function currentlyWorkingUsers($freeloaded = null): int public function currentlyWorkingUsers(bool $freeloaded = null): int
{ {
$query = $this $query = $this
->getQuery('users') ->getQuery('users')
@ -116,9 +112,7 @@ class Stats
*/ */
public function vouchers(): int public function vouchers(): int
{ {
return $this return (int)State::query()->sum('got_voucher');
->getQuery('users_state')
->sum('got_voucher');
} }
/** /**
@ -126,16 +120,13 @@ class Stats
*/ */
public function tshirts(): int public function tshirts(): int
{ {
return $this return State::whereGotShirt(true)->count();
->getQuery('users_state')
->where('got_shirt', '=', true)
->count();
} }
/** /**
* @return \Illuminate\Support\Collection * @return Collection
*/ */
public function tshirtSizes() public function tshirtSizes(): Collection
{ {
return $this return $this
->getQuery('users_personal_data') ->getQuery('users_personal_data')
@ -150,7 +141,7 @@ class Stats
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function licenses($vehicle = null) public function licenses(string $vehicle = null): int
{ {
$mapping = [ $mapping = [
'forklift' => 'has_license_forklift', 'forklift' => 'has_license_forklift',
@ -178,7 +169,7 @@ class Stats
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function workSeconds($done = null, $freeloaded = null): int public function workSeconds(bool $done = null, bool $freeloaded = null): int
{ {
$query = $this $query = $this
->getQuery('ShiftEntry') ->getQuery('ShiftEntry')
@ -192,25 +183,25 @@ class Stats
$query->where('end', ($done == true ? '<' : '>='), time()); $query->where('end', ($done == true ? '<' : '>='), time());
} }
return $query->sum($this->raw('end - start')); return (int)$query->sum($this->raw('end - start'));
} }
/** /**
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function worklogSeconds() public function worklogSeconds(): int
{ {
return round($this return (int)$this
->getQuery('UserWorkLog') ->getQuery('UserWorkLog')
->sum($this->raw('work_hours * 60*60'))); ->sum($this->raw('work_hours * 60*60'));
} }
/** /**
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function shifts() public function shifts(): int
{ {
return $this return $this
->getQuery('Shifts') ->getQuery('Shifts')
@ -218,10 +209,10 @@ class Stats
} }
/** /**
* @param bool $meeting * @param bool|null $meeting
* @return int * @return int
*/ */
public function announcements($meeting = null) public function announcements(bool $meeting = null): int
{ {
$query = is_null($meeting) ? News::query() : News::whereIsMeeting($meeting); $query = is_null($meeting) ? News::query() : News::whereIsMeeting($meeting);
@ -229,10 +220,10 @@ class Stats
} }
/** /**
* @param bool $answered * @param bool|null $answered
* @return int * @return int
*/ */
public function questions($answered = null) public function questions(bool $answered = null): int
{ {
$query = Question::query(); $query = Question::query();
if (!is_null($answered)) { if (!is_null($answered)) {
@ -250,7 +241,7 @@ class Stats
* @return int * @return int
* @codeCoverageIgnore * @codeCoverageIgnore
*/ */
public function messages() public function messages(): int
{ {
return $this return $this
->getQuery('Messages') ->getQuery('Messages')
@ -260,7 +251,7 @@ class Stats
/** /**
* @return int * @return int
*/ */
public function sessions() public function sessions(): int
{ {
return $this return $this
->getQuery('sessions') ->getQuery('sessions')
@ -270,7 +261,7 @@ class Stats
/** /**
* @return float * @return float
*/ */
public function databaseRead() public function databaseRead(): float
{ {
$start = microtime(true); $start = microtime(true);
@ -282,7 +273,7 @@ class Stats
/** /**
* @return float * @return float
*/ */
public function databaseWrite() public function databaseWrite(): float
{ {
$config = (new EventConfig())->findOrNew('last_metrics'); $config = (new EventConfig())->findOrNew('last_metrics');
$config $config
@ -297,17 +288,12 @@ class Stats
} }
/** /**
* @param string $level * @param string|null $level
* @return int * @return int
*/ */
public function logEntries($level = null) public function logEntries(string $level = null): int
{ {
$query = $this $query = is_null($level) ? LogEntry::query() : LogEntry::whereLevel($level);
->getQuery('log_entries');
if (!is_null($level)) {
$query->where('level', '=', $level);
}
return $query->count(); return $query->count();
} }
@ -315,11 +301,9 @@ class Stats
/** /**
* @return int * @return int
*/ */
public function passwordResets() public function passwordResets(): int
{ {
return $this return PasswordReset::query()->count();
->getQuery('password_resets')
->count();
} }
/** /**
@ -337,7 +321,7 @@ class Stats
* @param mixed $value * @param mixed $value
* @return QueryExpression * @return QueryExpression
*/ */
protected function raw($value) protected function raw($value): QueryExpression
{ {
return $this->db->getConnection()->raw($value); return $this->db->getConnection()->raw($value);
} }

9
tests/Unit/Controllers/Metrics/StatsTest.php
View File

@ -13,7 +13,6 @@ use Engelsystem\Models\User\State;
use Engelsystem\Models\User\User; use Engelsystem\Models\User\User;
use Engelsystem\Test\Unit\HasDatabase; use Engelsystem\Test\Unit\HasDatabase;
use Engelsystem\Test\Unit\TestCase; use Engelsystem\Test\Unit\TestCase;
use Illuminate\Support\Collection;
use Illuminate\Support\Str; use Illuminate\Support\Str;
use Psr\Log\LogLevel; use Psr\Log\LogLevel;
@ -23,7 +22,6 @@ class StatsTest extends TestCase
/** /**
* @covers \Engelsystem\Controllers\Metrics\Stats::__construct * @covers \Engelsystem\Controllers\Metrics\Stats::__construct
* @covers \Engelsystem\Controllers\Metrics\Stats::getQuery
* @covers \Engelsystem\Controllers\Metrics\Stats::newUsers * @covers \Engelsystem\Controllers\Metrics\Stats::newUsers
*/ */
public function testNewUsers() public function testNewUsers()
@ -57,8 +55,9 @@ class StatsTest extends TestCase
} }
/** /**
* @covers \Engelsystem\Controllers\Metrics\Stats::raw
* @covers \Engelsystem\Controllers\Metrics\Stats::tshirtSizes * @covers \Engelsystem\Controllers\Metrics\Stats::tshirtSizes
* @covers \Engelsystem\Controllers\Metrics\Stats::raw
* @covers \Engelsystem\Controllers\Metrics\Stats::getQuery
*/ */
public function testTshirtSizes() public function testTshirtSizes()
{ {
@ -67,10 +66,10 @@ class StatsTest extends TestCase
$stats = new Stats($this->database); $stats = new Stats($this->database);
$sizes = $stats->tshirtSizes(); $sizes = $stats->tshirtSizes();
$this->assertCount(2, $sizes); $this->assertCount(2, $sizes);
$this->assertEquals(new Collection([ $this->assertEquals([
(object)['shirt_size' => 'L', 'count' => 2], (object)['shirt_size' => 'L', 'count' => 2],
(object)['shirt_size' => 'XXL', 'count' => 1], (object)['shirt_size' => 'XXL', 'count' => 1],
]), $sizes); ], $sizes->toArray());
} }