yaroslawww / laravel-dusk-reporter

src/HasDuskReporter.php

<?php

namespace LaravelDuskReporter;

use Illuminate\Support\Str;
use Laravel\Dusk\Browser;
use LaravelDuskReporter\Generation\ReportFileContract;

trait HasDuskReporter
{
    public static ?ReportFileContract $duskReporter = null;

    /**
     * Set dusk reporter.
     *
     * @param ReportFileContract $reporter
     *
     * @return void
     */
    public static function withDuskReporter(?ReportFileContract $reporter): void
    {
        static::$duskReporter = $reporter;
    }

    /**
     * Callback to add text to report file.
     *
     * @param Browser $browser
     * @param \Closure $callback
     *
     * @return Browser
     */
    public function reportAppend(Browser $browser, \Closure $callback): Browser
    {
        if (!is_null(static::$duskReporter)) {
            call_user_func($callback, static::$duskReporter, $browser);
        }

        return $browser;
    }

    /**
     * Add to report information about current screen.
     *
     * @param Browser $browser
     * @param string|null $caption
     * @param array $options
     *
     * @return Browser
     */
    public function reportUserSee(Browser $browser, ?string $caption = null, array $options = []): Browser
    {
        if (!is_null(static::$duskReporter)) {
            if (isset($options['screenshot']) && is_array($options['screenshot'])) {
                call_user_func_array([ static::$duskReporter, 'screenshot' ], $options['screenshot']);
            } else {
                static::$duskReporter->screenshotWithCombineScreen($browser);
            }
            if ($caption) {
                static::$duskReporter->p($caption);
            }
        }

        return $browser;
    }

    /**
     * Add to report information about current page.
     *
     * @param Browser $browser
     * @param string|null $pageName
     * @param array $options
     *
     * @return Browser
     */
    public function reportUserSeePage(Browser $browser, ?string $pageName = null, array $options = []): Browser
    {
        return $this->reportUserSee(
            $browser,
            trans('dusk-reporter::report.user_see_page', [

It seems like trans('dusk-reporter::report.user_see_page', array('page' => $pageName ?? Illuminate\Support\Str::title(Illuminate\Support\Str::kebab(Illuminate\Support\Str::beforeLast(class_basename(get_class($this)), 'Page'), ' ')))) can also be of type array and array; however, parameter $caption of LaravelDuskReporter\HasDuskReporter::reportUserSee() does only seem to accept null|string, maybe add an additional type check?

                'page' => $pageName ?? Str::title(Str::kebab(Str::beforeLast(class_basename(get_class($this)), 'Page'), ' ')),

The call to Illuminate\Support\Str::kebab() has too many arguments starting with ' '.

            ]),
            $options
        );
    }
}