UndefinedVariableSolutionProvider::getSolutions() - Code Metrics - Inspection of "Automatically fix blade variable typos and optiona..." - facade/ignition - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e2aab6...02a6e4 )

by Marcel

created 2019-09-18 19:03 UTC

UndefinedVariableSolutionProvider::getSolutions() A

↳ Parent: UndefinedVariableSolutionProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.7666
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace Facade\Ignition\SolutionProviders;

use Throwable;
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 = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        extract($this->getNameAndView($throwable));


        if (! isset($variableName)) {
            return [];
        }

        $solutions = $this->findCorrectVariableSolutions($throwable, $variableName, $viewFile);
        $solutions[] = $this->findOptionalVariableSolution($variableName, $viewFile);

        return $solutions;
    }

    protected function findCorrectVariableSolutions(Throwable $throwable, string $variableName, string $viewFile): array
    {
        return 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) {
            return $solution->isRunnable()
                ? $solution
                : BaseSolution::create($solution->getSolutionTitle())
                    ->setSolutionDescription($solution->getSolutionActionDescription());
        })->toArray();
    }

    protected function findOptionalVariableSolution(string $variableName, string $viewFile)
    {
        $optionalSolution = new MakeViewVariableOptionalSolution($variableName, $viewFile);

        return $optionalSolution->isRunnable()
            ? $optionalSolution
            : BaseSolution::create($optionalSolution->getSolutionTitle())
                ->setSolutionDescription($optionalSolution->getSolutionActionDescription());
    }

    protected function getNameAndView(Throwable $throwable): ?array
    {
        $pattern = '/Undefined variable: (.*?) \(View: (.*?)\)/';

        preg_match($pattern, $throwable->getMessage(), $matches);
        if (count($matches) === 3) {
            [$string, $variableName, $viewFile] = $matches;


            return compact('variableName', 'viewFile');
        }
    }
}


1			<?php
2
3			namespace Facade\Ignition\SolutionProviders;
4
5			use Throwable;
6			use Facade\IgnitionContracts\BaseSolution;
7			use Facade\Ignition\Exceptions\ViewException;
8			use Facade\IgnitionContracts\HasSolutionsForThrowable;
9			use Facade\Ignition\Solutions\MakeViewVariableOptionalSolution;
10			use Facade\Ignition\Solutions\SuggestCorrectVariableNameSolution;
11
12			class UndefinedVariableSolutionProvider implements HasSolutionsForThrowable
13			{
14			private $variableName;
15
16			private $viewFile;
17
18			public function canSolve(Throwable $throwable): bool
19			{
20			if (! $throwable instanceof ViewException) {
21			return false;
22			}
23
24			return $this->getNameAndView($throwable) !== null;
25			}
26
27			public function getSolutions(Throwable $throwable): array
28			{
29			$solutions = [];
			0 ignored issues – show Unused Code introduced 2019-09-01 13:44 UTC by Report Bug Copy Issue Report `$solutions` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
30
31			extract($this->getNameAndView($throwable));
			0 ignored issues – show Bug introduced 2019-09-01 13:44 UTC by Report Bug Copy Issue Report `$this->getNameAndView($throwable)` cannot be passed to `extract()` as the parameter `$var_array` expects a reference. Loading history...
32
33			if (! isset($variableName)) {
34			return [];
35			}
36
37			$solutions = $this->findCorrectVariableSolutions($throwable, $variableName, $viewFile);
38			$solutions[] = $this->findOptionalVariableSolution($variableName, $viewFile);
39
40			return $solutions;
41			}
42
43			protected function findCorrectVariableSolutions(Throwable $throwable, string $variableName, string $viewFile): array
44			{
45			return collect($throwable->getViewData())->map(function ($value, $key) use ($variableName) {
46			similar_text($variableName, $key, $percentage);
47
48			return ['match' => $percentage, 'value' => $value];
49			})->sortByDesc('match')->filter(function ($var, $key) {
			0 ignored issues – show Unused Code introduced 2019-09-01 13:44 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
50			return $var['match'] > 40;
51			})->keys()->map(function ($suggestion) use ($variableName, $viewFile) {
52			return new SuggestCorrectVariableNameSolution($variableName, $viewFile, $suggestion);
53			})->map(function ($solution) {
54			return $solution->isRunnable()
55			? $solution
56			: BaseSolution::create($solution->getSolutionTitle())
57			->setSolutionDescription($solution->getSolutionActionDescription());
58			})->toArray();
59			}
60
61			protected function findOptionalVariableSolution(string $variableName, string $viewFile)
62			{
63			$optionalSolution = new MakeViewVariableOptionalSolution($variableName, $viewFile);
64
65			return $optionalSolution->isRunnable()
66			? $optionalSolution
67			: BaseSolution::create($optionalSolution->getSolutionTitle())
68			->setSolutionDescription($optionalSolution->getSolutionActionDescription());
69			}
70
71			protected function getNameAndView(Throwable $throwable): ?array
72			{
73			$pattern = '/Undefined variable: (.?) \(View: (.?)\)/';
74
75			preg_match($pattern, $throwable->getMessage(), $matches);
76			if (count($matches) === 3) {
77			[$string, $variableName, $viewFile] = $matches;
			0 ignored issues – show Bug introduced 2019-09-01 13:48 UTC by Report Bug Copy Issue Report The variable `$string` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-09-01 13:48 UTC by Report Bug Copy Issue Report The variable `$variableName` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-09-01 13:48 UTC by Report Bug Copy Issue Report The variable `$viewFile` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
78
79			return compact('variableName', 'viewFile');
80			}
81			}
82			}
83

facade / ignition

Push — master ( e2aab6...02a6e4 )

UndefinedVariableSolutionProvider::getSolutions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like