Reportable::prepareForReport() - Code Metrics - Inspection of "exception getReport() before run()" - alecrabbit/php-simple-profiler - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1472b6...a5e0bb )

by Alec

created 2019-02-20 16:52 UTC

Reportable::prepareForReport() A

↳ Parent: Reportable

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	0
nc	1
nop	0
dl	0
loc	2
ccs	1
cts	1
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace AlecRabbit\Tools\Reports\Traits;

use AlecRabbit\Tools\Benchmark;
use AlecRabbit\Tools\Reports\Contracts\ReportInterface;
use AlecRabbit\Tools\Reports\Factory;

trait Reportable
{
    /** @var ReportInterface|null */
    protected $reportObject;

    /** @var bool */
    private $launched = false;

    /**
     * @param bool $rebuild Rebuild report object
     * @return ReportInterface
     */
    public function getReport(bool $rebuild = true): ReportInterface
    {
        if ($this instanceof Benchmark && $this->isNotLaunched()) {
            throw new \RuntimeException('You should launch a benchmark by run() before getting a report');
        }
        if (null === $this->reportObject || true === $rebuild) {
            $this->prepareForReport();
            $this->reportObject =
                Factory::makeReport(
                    /** @scrutinizer ignore-type */
                    $this
                );
        }
        return
            $this->reportObject;
    }

    /**
     * @return bool
     */
    public function isNotLaunched(): bool
    {
        return !$this->launched;
    }


    /**
     * Makes all necessary actions before report
     */
    protected function prepareForReport(): void
    {
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace AlecRabbit\Tools\Reports\Traits;
6
7		use AlecRabbit\Tools\Benchmark;
8		use AlecRabbit\Tools\Reports\Contracts\ReportInterface;
9		use AlecRabbit\Tools\Reports\Factory;
10
11		trait Reportable
12		{
13		/** @var ReportInterface\|null */
14		protected $reportObject;
15
16		/** @var bool */
17		private $launched = false;
18
19		/**
20		* @param bool $rebuild Rebuild report object
21		* @return ReportInterface
22		*/
23	14	public function getReport(bool $rebuild = true): ReportInterface
24		{
25	14	if ($this instanceof Benchmark && $this->isNotLaunched()) {
26	1	throw new \RuntimeException('You should launch a benchmark by run() before getting a report');
27		}
28	14	if (null === $this->reportObject \|\| true === $rebuild) {
29	14	$this->prepareForReport();
30	14	$this->reportObject =
31	14	Factory::makeReport(
32		/** @scrutinizer ignore-type */
33	14	$this
34		);
35		}
36		return
37	14	$this->reportObject;
38		}
39
40		/**
41		* @return bool
42		*/
43	5	public function isNotLaunched(): bool
44		{
45	5	return !$this->launched;
46		}
47
48
49		/**
50		* Makes all necessary actions before report
51		*/
52	9	protected function prepareForReport(): void
53		{
54	9	}
55		}
56

alecrabbit / php-simple-profiler

Push — master ( 1472b6...a5e0bb )

Reportable::prepareForReport() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like