Completed
Push — develop ( 373768...b82813 )
by Mike
05:50
created

StopwatchMiddleware   A

Complexity

Total Complexity 6

Size/Duplication

Total Lines 64
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 100%

Importance

Changes 0
Metric Value
dl 0
loc 64
rs 10
c 0
b 0
f 0
ccs 26
cts 26
cp 1
wmc 6
lcom 1
cbo 3

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 5 1
A execute() 0 23 2
A log() 0 4 1
A formatMemoryInMegabytes() 0 4 1
A formatMemoryInKilobytes() 0 4 1
1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * This file is part of phpDocumentor.
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 *
10
 * @author    Mike van Riel <[email protected]>
11
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
12
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
13
 * @link      http://phpdoc.org
14
 */
15
16
namespace phpDocumentor\Parser\Middleware;
17
18
use phpDocumentor\Reflection\Middleware\Command;
19
use phpDocumentor\Reflection\Middleware\Middleware;
20
use Psr\Log\LoggerInterface;
21
use Psr\Log\LogLevel;
22
use Symfony\Component\Stopwatch\Stopwatch;
23
24
final class StopwatchMiddleware implements Middleware
25
{
26
    /** @var int $memory amount of memory used */
27
    private $memory = 0;
28
29
    /** @var Stopwatch */
30
    private $stopwatch;
31
32
    /** @var LoggerInterface */
33
    private $logger;
34
35 1
    public function __construct(Stopwatch $stopwatch, LoggerInterface $logger)
36
    {
37 1
        $this->stopwatch = $stopwatch;
38 1
        $this->logger = $logger;
39 1
    }
40
41
    /**
42
     * Executes this middleware class.
43
     *
44
     * @return object
45
     */
46 1
    public function execute(Command $command, callable $next)
47
    {
48 1
        $result = $next($command);
49
50 1
        $lap = $this->stopwatch->lap('parser.parse');
51 1
        $oldMemory = $this->memory;
52 1
        $periods = $lap->getPeriods();
53 1
        $memory = end($periods)->getMemory();
54
55 1
        $differenceInMemory = $memory - $oldMemory;
56 1
        $this->log(
57 1
            sprintf(
58 1
                '>> Memory after processing of file: %s megabytes (%s kilobytes)',
59 1
                $this->formatMemoryInMegabytes($memory),
60 1
                (($differenceInMemory >= 0) ? '+' : '-') . $this->formatMemoryInKilobytes($differenceInMemory)
61
            ),
62 1
            LogLevel::DEBUG
63
        );
64
65 1
        $this->memory = $memory;
0 ignored issues
show
Documentation Bug introduced by Jaapio
It seems like $memory can also be of type double. However, the property $memory is declared as type integer. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
66
67 1
        return $result;
68
    }
69
70
    /**
71
     * Dispatches a logging request.
72
     */
73 1
    private function log(string $message, string $priority = LogLevel::INFO, array $parameters = [])
74
    {
75 1
        $this->logger->log($priority, $message, $parameters);
76 1
    }
77
78 1
    private function formatMemoryInMegabytes(int $memory): string
79
    {
80 1
        return number_format($memory / 1024 / 1024, 2);
81
    }
82
83 1
    private function formatMemoryInKilobytes(int $memory): string
84
    {
85 1
        return number_format($memory / 1024);
86
    }
87
}
88