Automatically fix blade variable typos and optional variables

src/IgnitionServiceProvider.php

@@ -46,6 +46,7 @@
 use Facade\Ignition\SolutionProviders\TableNotFoundSolutionProvider;
 use Illuminate\View\Engines\CompilerEngine as LaravelCompilerEngine;
 use Facade\Ignition\SolutionProviders\MissingPackageSolutionProvider;
+use Facade\Ignition\SolutionProviders\UndefinedVariableSolutionProvider;
 use Facade\Ignition\SolutionProviders\InvalidRouteActionSolutionProvider;
 use Facade\Ignition\SolutionProviders\IncorrectValetDbCredentialsSolutionProvider;
 use Facade\IgnitionContracts\SolutionProviderRepository as SolutionProviderRepositoryContract;
@@ -301,6 +302,7 @@ protected function getDefaultSolutions(): array
             MissingPackageSolutionProvider::class,
             InvalidRouteActionSolutionProvider::class,
             ViewNotFoundSolutionProvider::class,
+            UndefinedVariableSolutionProvider::class,
         ];
     }
 

src/SolutionProviders/UndefinedVariableSolutionProvider.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Facade\Ignition\SolutionProviders;
+
+use Throwable;
+use Facade\IgnitionContracts\Solution;
+use Facade\IgnitionContracts\BaseSolution;
+use Facade\Ignition\Exceptions\ViewException;
+use Facade\IgnitionContracts\HasSolutionsForThrowable;
+use Facade\Ignition\Solutions\MakeViewVariableOptionalSolution;
+use Facade\Ignition\Solutions\SuggestCorrectVariableNameSolution;
+
+class UndefinedVariableSolutionProvider implements HasSolutionsForThrowable
+{
+    private $variableName;
+
+    private $viewFile;
+
+    public function canSolve(Throwable $throwable): bool
+    {
+        if (! $throwable instanceof ViewException) {
+            return false;
+        }
+
+        return $this->getNameAndView($throwable) !== null;
+    }
+
+    public function getSolutions(Throwable $throwable): array
+    {
+        $solutions = [];
+
+        extract($this->getNameAndView($throwable));
+        $solutions = collect($throwable->getViewData())->map(function ($value, $key) use ($variableName) {
+            similar_text($variableName, $key, $percentage);
+
+            return ['match' => $percentage, 'value' => $value];
+        })->sortByDesc('match')->filter(function ($var, $key) {
+            return $var['match'] > 40;
+        })->keys()->map(function ($suggestion) use ($variableName, $viewFile) {
+            return new SuggestCorrectVariableNameSolution($variableName, $viewFile, $suggestion);
+        })->map(function ($solution) {
+            // If the solution isn't runnable, then just return the suggestions without the fix
+            if ($solution->isRunnable()) {
+                return $solution;
+            } else {
+                return BaseSolution::create($solution->getSolutionTitle())
+                    ->setSolutionDescription($solution->getSolutionActionDescription());
+            }
+        })->toArray();
+
+        $optionalSolution = new MakeViewVariableOptionalSolution($variableName, $viewFile);
+        if ($optionalSolution->isRunnable()) {
+            $solutions[] = $optionalSolution;
+        } else {
+            $solutions[] = BaseSolution::create($optionalSolution->getSolutionTitle())
+                ->setSolutionDescription($optionalSolution->getSolutionActionDescription());
+        }
+
+        return $solutions;
+    }
+
+    private function getNameAndView(Throwable $throwable)
+    {
+        $pattern = '/Undefined variable: (.*?) \(View: (.*?)\)/';
+
+        preg_match($pattern, $throwable->getMessage(), $matches);
+        if (count($matches) === 3) {
+            [$string, $variableName, $viewFile] = $matches;
+
+            return compact('variableName', 'viewFile');
+        }
+    }
+}

src/Solutions/MakeViewVariableOptionalSolution.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Facade\Ignition\Solutions;
+
+use Illuminate\Support\Facades\Blade;
+use Facade\IgnitionContracts\RunnableSolution;
+
+class MakeViewVariableOptionalSolution implements RunnableSolution
+{
+    private $variableName;
+    private $viewFile;
+
+    public function __construct($variableName = null, $viewFile = null)
+    {
+        $this->variableName = $variableName;
+        $this->viewFile = $viewFile;
+    }
+
+    public function getSolutionTitle(): string
+    {
+        return '$'.$this->variableName.' is undefined';
+    }
+
+    public function getDocumentationLinks(): array
+    {
+        return [];
+    }
+
+    public function getSolutionActionDescription(): string
+    {
+        $path = str_replace(base_path().'/', '', $this->viewFile);
+        $output = [
+            'Make the variable optional in the blade template.',
+            'Replace `{{ $'.$this->variableName.' }}` with `{{ $'.$this->variableName.' ?? \'\' }}`',
+        ];
+
+        return implode(PHP_EOL, $output);
+    }
+
+    public function getRunButtonText(): string
+    {
+        return 'Make variable optional';
+    }
+
+    public function getSolutionDescription(): string
+    {
+        return '';
+    }
+
+    public function getRunParameters(): array
+    {
+        return [
+            'variableName' => $this->variableName,
+            'viewFile' => $this->viewFile,
+        ];
+    }
+
+    public function isRunnable(array $parameters = [])
+    {
+        return $this->makeOptional($this->getRunParameters()) !== false;
+    }
+
+    public function run(array $parameters = [])
+    {
+        $output = $this->makeOptional($parameters);
+        if ($output !== false) {
+            file_put_contents($parameters['viewFile'], $output);
+        }
+    }
+
+    public function makeOptional(array $parameters = [])
+    {
+        $originalContents = file_get_contents($parameters['viewFile']);
+        $newContents = str_replace('$'.$parameters['variableName'], '$'.$parameters['variableName']." ?? ''", $originalContents);
+        // Compile blade, tokenize
+        $originalTokens = token_get_all(Blade::compileString($originalContents));
+        $newTokens = token_get_all(Blade::compileString($newContents));
+        // Generate what we expect the tokens to be after we change the blade file
+        $expectedTokens = [];
+        foreach ($originalTokens as $key => $token) {
+            $expectedTokens[] = $token;
+            if ($token[0] === T_VARIABLE && $token[1] === '$'.$parameters['variableName']) {
+                $expectedTokens[] = [T_WHITESPACE, ' ', $token[2]];
+                $expectedTokens[] = [T_COALESCE, '??', $token[2]];
+                $expectedTokens[] = [T_WHITESPACE, ' ', $token[2]];
+                $expectedTokens[] = [T_CONSTANT_ENCAPSED_STRING, "''", $token[2]];
+            }
+        }
+        if ($expectedTokens !== $newTokens) {
+            return false;
+        }
+
+        return $newContents;
+    }
+}

src/Solutions/SuggestCorrectVariableNameSolution.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace Facade\Ignition\Solutions;
+
+use Illuminate\Support\Facades\Blade;
+use Facade\IgnitionContracts\RunnableSolution;
+
+class SuggestCorrectVariableNameSolution implements RunnableSolution
+{
+    private $variableName;
+    private $viewFile;
+
+    public function __construct($variableName = null, $viewFile = null, $suggested = null)
+    {
+        $this->variableName = $variableName;
+        $this->viewFile = $viewFile;
+        $this->suggested = $suggested;
+    }
+
+    public function getSolutionTitle(): string
+    {
+        return 'Possible typo $'.$this->variableName;
+    }
+
+    public function getDocumentationLinks(): array
+    {
+        return [];
+    }
+
+    public function getSolutionActionDescription(): string
+    {
+        $path = str_replace(base_path().'/', '', $this->viewFile);
+        $output = [
+            'Did you mean `$'.$this->suggested.'`?',
+        ];
+
+        return implode(PHP_EOL, $output);
+    }
+
+    public function getRunButtonText(): string
+    {
+        return 'Fix typo';
+    }
+
+    public function getSolutionDescription(): string
+    {
+        return '';
+    }
+
+    public function getRunParameters(): array
+    {
+        return [
+            'variableName' => $this->variableName,
+            'viewFile' => $this->viewFile,
+            'suggested' => $this->suggested,
+        ];
+    }
+
+    public function isRunnable(array $parameters = [])
+    {
+        return $this->fixTypo($this->getRunParameters()) !== false;
+    }
+
+    public function run(array $parameters = [])
+    {
+        $output = $this->fixTypo($parameters);
+        if ($output !== false) {
+            file_put_contents($parameters['viewFile'], $output);
+        }
+    }
+
+    public function fixTypo(array $parameters = [])
+    {
+        // Make sure suggested variable is valid alpha-numeric with underscore, or return false
+        if (! preg_match('/^[a-zA-Z]+[a-zA-Z0-9_]+$/', $parameters['suggested'])) {
+            return false;
+        }
+
+        $originalContents = file_get_contents($parameters['viewFile']);
+        $newContents = str_replace('$'.$parameters['variableName'], '$'.$parameters['suggested'], $originalContents);
+
+        // Compile blade, tokenize
+        $originalTokens = token_get_all(Blade::compileString($originalContents));
+        $newTokens = token_get_all(Blade::compileString($newContents));
+
+        // Generate what we expect the tokens to be after we change the blade file
+        $expectedTokens = $originalTokens;
+        foreach ($expectedTokens as $key => $token) {
+            if ($token[0] === T_VARIABLE && $token[1] === '$'.$parameters['variableName']) {
+                $expectedTokens[$key][1] = '$'.$parameters['suggested'];
+            }
+        }
+        if ($expectedTokens !== $newTokens) {
+            return false;
+        }
+
+        return $newContents;
+    }
+}

tests/Solutions/UndefinedVariableSolutionProviderTest.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace Facade\Ignition\Tests\Solutions;
+
+use Facade\Ignition\Tests\TestCase;
+use Illuminate\Support\Facades\View;
+use Facade\Ignition\Exceptions\ViewException;
+use Facade\Ignition\Support\ComposerClassMap;
+use Facade\Ignition\SolutionProviders\UndefinedVariableSolutionProvider;
+
+class UndefinedVariableSolutionProviderTest extends TestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        View::addLocation(__DIR__.'/../stubs/views');
+
+        $this->app->bind(
+            ComposerClassMap::class,
+            function () {
+                return new ComposerClassMap(__DIR__.'/../../vendor/autoload.php');
+            }
+        );
+    }
+
+    /** @test */
+    public function it_can_solve_the_exception()
+    {
+        $canSolve = app(UndefinedVariableSolutionProvider::class)->canSolve($this->getUndefinedVariableException());
+
+        $this->assertTrue($canSolve);
+    }
+
+    /** @test */
+    public function it_can_recommend_fixing_a_variable_name_typo()
+    {
+        $viewData = [
+            'footerDescription' => 'foo',
+        ];
+
+        try {
+            view('undefined-variable-1', $viewData)->render();
+        } catch (ViewException $exception) {
+            $viewException = $exception;
+        }
+
+        $canSolve = app(UndefinedVariableSolutionProvider::class)->canSolve($viewException);
+        $this->assertTrue($canSolve);
+
+        /** @var \Facade\IgnitionContracts\Solution $solution */
+        $solutions = app(UndefinedVariableSolutionProvider::class)->getSolutions($viewException);
+        $this->assertStringContainsString('Did you mean `$footerDescription`?', $solutions[0]->getSolutionActionDescription());
+        $this->assertStringContainsString('Replace `{{ $footerDescriptin }}` with `{{ $footerDescriptin ?? \'\' }}`', $solutions[1]->getSolutionActionDescription());
+    }
+
+    /** @test */
+    public function it_can_fix_a_variable_name_typo()
+    {
+        $viewData = [
+            'footerDescription' => 'foo',
+        ];
+
+        try {
+            view('undefined-variable-1', $viewData)->render();
+        } catch (ViewException $exception) {
+            $viewException = $exception;
+        }
+
+        $canSolve = app(UndefinedVariableSolutionProvider::class)->canSolve($viewException);
+        $this->assertTrue($canSolve);
+
+        /** @var \Facade\IgnitionContracts\Solution $solution */
+        $solutions = app(UndefinedVariableSolutionProvider::class)->getSolutions($viewException);
+        $parameters = $solutions[0]->getRunParameters();
+        $parameters['viewFile'] = tempnam(sys_get_temp_dir(), 'undefined-variable-blade');
+        $solutions[0]->run($parameters);
+    }
+
+    protected function getUndefinedVariableException(): ViewException
+    {
+        return new ViewException('Undefined variable: notSet (View: ./views/welcome.blade.php)');
+    }
+}

tests/stubs/views/undefined-variable-1.blade.php

@@ -0,0 +1,11 @@
+{{-- Intentional typo for test --}}
+
+This is some contents
+
+<footer>{{ $footerDescriptin }}</footer>
+
+@isset($something)
+    {{ $something }}
+@endisset
+
+Test