Facade\Ignition\Solutions\SuggestCorrectVariableNameSolution

Complexity

Total Complexity

18

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getRunButtonText()	0	4	1
A	getSolutionDescription()	0	4	1
A	getRunParameters()	0	8	1
A	isRunnable()	0	4	1
A	__construct()	0	6	1
A	getSolutionTitle()	0	4	1
A	getDocumentationLinks()	0	4	1
A	getSolutionActionDescription()	0	6	1
A	run()	0	9	2
A	fixTypo()	0	20	3
A	isAlphaNumericWithUnderscore()	0	4	1
A	generateExpectedTokens()	0	11	4

<?php

namespace Facade\Ignition\Solutions;

use Illuminate\Support\Facades\Blade;
use Facade\IgnitionContracts\RunnableSolution;

class SuggestCorrectVariableNameSolution implements RunnableSolution
{
    /** @var string */
    private $variableName;

    /** @var string */
    private $viewFile;

    public function __construct($variableName = null, $viewFile = null, $suggested = null)
    {
        $this->variableName = $variableName;
        $this->viewFile = $viewFile;
        $this->suggested = $suggested;

The property suggested does not exist. Did you maybe forget to declare it?

    }

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

$path is not used, you could remove the assignment.

        return "Did you mean `$$this->suggested`?";
    }

    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 = []): bool

The parameter $parameters is not used and could be removed.

    {
        return $this->fixTypo($this->getRunParameters()) !== false;
    }

    public function run(array $parameters = []): void
    {
        $output = $this->fixTypo($parameters);
        if ($output === false) {
            return;
        }

        file_put_contents($parameters['viewFile'], $output);
    }

    protected function fixTypo(array $parameters = [])
    {
        if (! $this->isAlphaNumericWithUnderscore($parameters['suggested'])) {
            return false;
        }

        $originalContents = file_get_contents($parameters['viewFile']);
        $newContents = str_replace('$'.$parameters['variableName'], '$'.$parameters['suggested'], $originalContents);

        $originalTokens = token_get_all(Blade::compileString($originalContents));
        $newTokens = token_get_all(Blade::compileString($newContents));

        $expectedTokens = $this->generateExpectedTokens($originalTokens, $parameters['variableName'], $parameters['suggested']);

        if ($expectedTokens !== $newTokens) {
            return false;
        }

        return $newContents;
    }

    protected function isAlphaNumericWithUnderscore(string $input): bool
    {
        return preg_match('/^[a-zA-Z]+[a-zA-Z0-9_]+$/', $input);
    }

    protected function generateExpectedTokens(array $originalTokens, string $variableName, string $suggested): array
    {
        $expectedTokens = $originalTokens;
        foreach ($expectedTokens as $key => $token) {
            if ($token[0] === T_VARIABLE && $token[1] === '$'.$variableName) {
                $expectedTokens[$key][1] = "$$suggested";
            }
        }

        return $expectedTokens;
    }
}