yaroslawww / laravel-dusk-reporter

src/TestWithDuskReport.php

<?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 ]);

It seems like $initialisationCallback can also be of type null; however, parameter $callback of call_user_func_array() does only seem to accept callable, maybe add an additional type check?

            }
        }

        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++) {

It seems like you are calling the size function count() as part of the test condition. You might want to compute the size beforehand, and not on each iteration.

                $backPath = "../{$backPath}";
            }
            $file->link($backPath, trans('dusk-reporter::report.back_to_home_link'))->br(2, PHP_EOL)

It seems like trans('dusk-reporter::report.back_to_home_link') can also be of type array and array; however, parameter $text of LaravelDuskReporter\Generation\ReportFileContract::link() does only seem to accept string, maybe add an additional type check?

                 ->listItem(trans('dusk-reporter::report.date_of_test', [ 'date' => Carbon::now()->format('Y-m-d H:i:s') ]));

It seems like trans('dusk-reporter::report.date_of_test', array('date' => Carbon\Carbon::now()->format('Y-m-d H:i:s'))) can also be of type array and array; however, parameter $content of LaravelDuskReporter\Generation\ReportFileContract::listItem() does only seem to accept string, maybe add an additional type check?

            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);

It seems like getName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            }

            return $reporter;
        }

        return null;
    }
}