TestWithDuskReport::setUpReportFileForClass() - Code Metrics - Inspection of "new method setUpReportFileForClass" - yaroslawww/laravel-dusk-reporter - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 998827...3c47cb )

by Yaroslav

created 2021-11-19 17:55 UTC

TestWithDuskReport::setUpReportFileForClass() A

↳ Parent: TestWithDuskReport

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	6
c	1
b	0
f	0
dl	0
loc	12
ccs	0
cts	7
cp	0
rs	10
cc	3
nc	3
nop	1
crap	12

<?php


namespace LaravelDuskReporter;

use Carbon\Carbon;
use Illuminate\Support\Str;
use LaravelDuskReporter\Exceptions\LaravelDuskReporterException;
use LaravelDuskReporter\Generation\ReportFileContract;

trait TestWithDuskReport
{
    protected ?ReportFileContract $globalDuskTestReportFile = null;

    /**
     * Create report file for global usage
     *
     * @param string|null $initialisationFilename
     * @param \Closure|null $initialisationCallback
     *
     * @return ReportFileContract
     * @throws LaravelDuskReporterException
     */
    protected function duskReportFile(?string $initialisationFilename = null, ?\Closure $initialisationCallback = null): ReportFileContract
    {
        if (!$this->globalDuskTestReportFile) {
            if (!$initialisationFilename) {
                throw new LaravelDuskReporterException('On initialisation you should specify $initialisationFilename');
            }
            $this->globalDuskTestReportFile = $this->newDuskReportFile($initialisationFilename);
            if (is_callable($initialisationCallback) && $this->globalDuskTestReportFile->isEmpty()) {
                call_user_func_array($initialisationCallback, [ &$this->globalDuskTestReportFile ]);
                call_user_func_array(/** @scrutinizer ignore-type */ $initialisationCallback, [ &$this->globalDuskTestReportFile ]);
            }
        }

        return $this->globalDuskTestReportFile;
    }

    /**
     * Create new report file
     *
     * @param string|null $filename
     *
     * @return ReportFileContract
     */
    protected function newDuskReportFile(?string $filename = null): ReportFileContract
    {
        return LaravelDuskReporter::newFile($filename ?? $this->duskReportFileName());
    }

    /**
     * Get File Name for Report
     *
     * @return string
     */
    protected function duskReportFileName(): string
    {
        $names            = array_reverse(explode('\\', get_class($this)));
        $reportFolderName = rtrim(Str::ucfirst(Str::camel(($names[1] ?? '') . $names[0])), '/');

        if (method_exists($this, 'getDuskReportFileName')) {
            $name = $this->getDuskReportFileName();
        } elseif (method_exists($this, 'getName')) {
            $name = $this->getName();
        } else {
            $name = Carbon::now()->format('Y_m_d_h_i_s-') . Str::random(60);
        }

        return "{$reportFolderName}/{$name}";
    }

    /**
     * Set up report file with initial data.
     *
     * @param string $name
     * @param string|null $title
     *
     * @return ReportFileContract
     * @throws LaravelDuskReporterException
     */
    protected function duskReportSetUp(string $name, ?string $title = null): ReportFileContract
    {
        $name = trim($name, '/');

        return $this->duskReportFile($name, function (ReportFileContract $file) use ($name, $title) {
            $file->h1($title ?? Str::title(Str::snake(Str::afterLast($name, '/'), ' ')));

            if (method_exists($this, 'duskReportFileInitialisationContent')) {
                $this->duskReportFileInitialisationContent($file);

                return;
            }

            $parts    = explode('/', $name);
            $backPath = Reporter::getValidFileName(Reporter::$indexFileBaseName);
            for ($i = 1; $i < count($parts); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $backPath = "../{$backPath}";
            }
            $file->link($backPath, trans('dusk-reporter::report.back_to_home_link'))->br(2, PHP_EOL)
            $file->link($backPath, /** @scrutinizer ignore-type */ trans('dusk-reporter::report.back_to_home_link'))->br(2, PHP_EOL)
                 ->listItem(trans('dusk-reporter::report.date_of_test', [ 'date' => Carbon::now()->format('Y-m-d H:i:s') ]));
                 ->listItem(/** @scrutinizer ignore-type */ trans('dusk-reporter::report.date_of_test', [ 'date' => Carbon::now()->format('Y-m-d H:i:s') ]));

            if (method_exists($this, 'duskReportFileInitialisationAdditionalContent')) {
                $this->duskReportFileInitialisationAdditionalContent($file);
            }
        });
    }

    /**
     * Set up report file with initial data using class name.
     *
     * @param string|null $path
     * @param string|null $title
     *
     * @return ReportFileContract
     * @throws LaravelDuskReporterException
     */
    protected function duskReportSetUpUsingTestClassName(?string $path = null, ?string $title = null): ReportFileContract
    {
        $path = $path ? (rtrim($path, '/') . '/') : '';
        $name = $path . trim(Str::beforeLast(class_basename(get_class($this)), 'Test'), '/');

        return $this->duskReportSetUp($name, $title);
    }

    /**
     * Add new heading to file using method name.
     *
     * @param string $methodName
     * @param string $headerType
     *
     * @return ReportFileContract
     * @throws LaravelDuskReporterException
     */
    protected function duskReportSetHeadingFromTestMethod(string $methodName, string $headerType = 'h2'): ReportFileContract
    {
        return call_user_func([
            $this->duskReportFile(),
            $headerType,
        ], Str::title(Str::snake(Str::camel(Str::after($methodName, 'test')), ' ')));
    }

    /**
     * Set up report file for entry class.
     *
     * @param string|null $testHeading
     *
     * @return ReportFileContract|null
     * @throws LaravelDuskReporterException
     */
    protected function setUpReportFileForClass(?string $testHeading = 'h2'): ?ReportFileContract
    {
        if (property_exists($this, 'duskReportClassFilePath')) {
            $reporter = $this->duskReportSetUpUsingTestClassName($this->duskReportClassFilePath);
            if ($testHeading) {
                $this->duskReportSetHeadingFromTestMethod($this->getName(), $testHeading);
                $this->duskReportSetHeadingFromTestMethod($this->/** @scrutinizer ignore-call */ getName(), $testHeading);
            }

            return $reporter;
        }

        return null;
    }
}


yaroslawww / laravel-dusk-reporter

Push — master ( 998827...3c47cb )

TestWithDuskReport::setUpReportFileForClass() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like