PhpcsDiff::__construct() - Code Metrics - olivertappin/phpcs-diff - Measure and Improve Code Quality continuously with Scrutinizer

PhpcsDiff::__construct() A
last analyzed 2023-01-06 11:01 UTC

↳ Parent: PhpcsDiff

Complexity

Conditions	4
Paths	6

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	12
c	1
b	0
f	0
dl	0
loc	20
rs	9.8666
cc	4
nc	6
nop	2

<?php

namespace PhpcsDiff;

use League\CLImate\CLImate;
use PhpcsDiff\Filter\Exception\FilterException;
use PhpcsDiff\Filter\Filter;
use PhpcsDiff\Filter\Rule\HasMessagesRule;
use PhpcsDiff\Filter\Rule\PhpFileRule;
use PhpcsDiff\Mapper\PhpcsViolationsMapper;

class PhpcsDiff
{
    /**
     * @var array
     */
    protected $argv = [];

    /**
     * @var CLImate
     */
    protected $climate;

    /**
     * @var bool
     */
    protected $isVerbose = false;

    /**
     * @var int
     */
    protected $exitCode = 0;

    /**
     * @var string
     */
    protected $baseBranch;

    /**
     * @var string
     */
    protected $currentBranch = '';

    /**
     * @param array $argv
     * @param CLImate $climate
     */
    public function __construct(array $argv, CLImate $climate)
    {
        $this->argv = $argv;
        $this->climate = $climate;

        if ($this->isFlagSet('-v')) {
            $this->climate->comment('Running in verbose mode.');
            $this->isVerbose = true;
        }

        if (!isset($this->argv[1])) {
            $this->error('Please provide a <bold>base branch</bold> as the first argument.');
            return;
        }

        $this->baseBranch = 'origin/' . str_replace('origin/', '', $this->argv[1]);
        $this->currentBranch = trim(shell_exec('git rev-parse --verify HEAD'));

        if (empty($this->currentBranch)) {
            $this->error('Unable to get <bold>current</bold> branch.');
        }
    }

    /**
     * @param string $flag
     * @return bool
     */
    protected function isFlagSet(string $flag)
    {
        $isFlagSet = false;
        $argv = $this->argv;

        $key = array_search($flag, $argv, true);
        if (false !== $key) {
            unset($argv[$key]);
            $argv = array_values($argv);

            $isFlagSet = true;
        }

        $this->argv = $argv;
        return $isFlagSet;
    }

    /**
     * @param int $exitCode
     */
    protected function setExitCode(int $exitCode)
    {
        $this->exitCode = $exitCode;
    }

    /**
     * @return int
     */
    public function getExitCode(): int
    {
        return $this->exitCode;
    }

    /**
     * @todo Automatically look at server envs for the travis base branch, if not provided?
     * @todo Define custom ruleset from command line argv for runPhpcs()
     */
    public function run(): void
    {
        try {
            $filter = new Filter([new PhpFileRule()], $this->getChangedFiles());
        } catch (FilterException $exception) {
            $this->error($exception->getMessage());
            return;
        }

        $fileDiff = $filter->filter()->getFilteredData();

        if (empty($fileDiff)) {
            $this->climate->info('No difference to compare.');
            return;
        }

        if ($this->isVerbose) {
            $fileDiffCount = count($fileDiff);
            $this->climate->comment(
                'Checking ' . $fileDiffCount . ' ' .
                ngettext('file', 'files', $fileDiffCount) . ' for violations.'
            );
        }

        $phpcsOutput = $this->runPhpcs($fileDiff);

        if (is_null($phpcsOutput)) {
            $this->error('Unable to run phpcs executable.');
            return;
        }

        if ($this->isVerbose) {
            $this->climate->comment('Filtering phpcs output.');
        }

        try {
            $filter = new Filter([new HasMessagesRule()], $phpcsOutput['files']);
        } catch (FilterException $exception) {
            $this->error($exception->getMessage());
            return;
        }

        $files = $filter->filter()->getFilteredData();

        if ($this->isVerbose) {
            $this->climate->comment('Getting changed lines from git diff.');
        }

        $changedLinesPerFile = $this->getChangedLinesPerFile($files);

        if ($this->isVerbose) {
            $this->climate->comment('Comparing phpcs output with changes lines from git diff.');
        }

        $violations = (new PhpcsViolationsMapper(
            $changedLinesPerFile,
            getcwd()
        ))->map($files);

        if ($this->isVerbose) {
            $this->climate->comment('Preparing report.');
        }

        if (empty($violations)) {
            $this->climate->info('No violations to report.');
            return;
        }

        $this->outputViolations($violations);
    }

    /**
     * Run phpcs on a list of files passed into the method
     *
     * @param array $files
     * @param string $ruleset
     * @return mixed
     */
    protected function runPhpcs(array $files = [], string $ruleset = 'ruleset.xml')
    {
        $exec = null;
        $root = dirname(__DIR__);

        $locations = [
            'vendor/bin/phpcs',
            $root . '/../../bin/phpcs',
            $root . '/../bin/phpcs',
            $root . '/bin/phpcs',
            $root . '/vendor/bin/phpcs',
            '~/.config/composer/vendor/bin/phpcs',
            '~/.composer/vendor/bin/phpcs',
        ];

        foreach ($locations as $location) {
            if (is_file($location)) {
                $exec = $location;
                break;
            }
        }

        if (!$exec) {
            return null;
        }

        if ($this->isVerbose) {
            $this->climate->info('Using phpcs executable: ' . $exec);
        }

        $exec = PHP_BINARY . ' ' . $exec;
        $command = $exec . ' --report=json --standard=' . $ruleset . ' ' . implode(' ', $files);
        $output = shell_exec($command);

        if ($this->isVerbose) {
            $this->climate->info('Running: ' . $command);
        }

        $json = $output ? json_decode($output, true) : null;
        if ($json === null && $output) {
            $this->climate->error($output);
        }

        return $json;
    }

    /**
     * @param array $output
     */
    protected function outputViolations(array $output): void
    {
        $this->climate->flank(strtoupper('Start of phpcs check'), '#', 10)->br();
        $this->climate->out(implode(PHP_EOL, $output));
        $this->climate->flank(strtoupper('End of phpcs check'), '#', 11)->br();

        $this->error('Violations have been reported.');
    }

    /**
     * Returns a list of files which are within the diff based on the current branch
     *
     * @return array
     */
    protected function getChangedFiles(): array
    {
        // Get a list of changed files (not including deleted files)
        $output = shell_exec(
            'git diff ' . $this->baseBranch . ' ' . $this->currentBranch . ' --name-only --diff-filter=ACM'
        );

        // Convert files into an array
        $output = explode(PHP_EOL, $output);

        // Remove any empty values
        return array_filter($output);
    }

    /**
     * Extract the changed lines for each file from the git diff output
     *
     * @param array $files
     * @return array
     */
    protected function getChangedLinesPerFile(array $files): array
    {
        $extract = [];
        $pattern = [
            'basic' => '^@@ (.*) @@',
            'specific' => '@@ -[0-9]+(?:,[0-9]+)? \+([0-9]+)(?:,([0-9]+))? @@',
        ];

        foreach ($files as $file => $data) {
            $command = 'git diff -U0 ' . $this->baseBranch . ' ' . $this->currentBranch . ' ' . $file .
                ' | grep -E ' . escapeshellarg($pattern['basic']);

            $lineDiff = shell_exec($command);
            $lines = array_filter(explode(PHP_EOL, $lineDiff));
            $linesChanged = [];

            foreach ($lines as $line) {
                preg_match('/' . $pattern['specific'] . '/', $line, $matches);

                // If there were no specific matches, skip this line
                if ([] === $matches) {
                    continue;
                }

                $start = $end = (int)$matches[1];

                // Multiple lines were changed, so we need to calculate the end line
                if (isset($matches[2])) {
                    $length = (int)$matches[2];
                    $end = $start + $length - 1;
                }

                foreach (range($start, $end) as $l) {
                    $linesChanged[$l] = null;
                }
            }

            $extract[$file] = array_keys($linesChanged);
        }

        return $extract;
    }

    /**
     * @param string $message
     * @param int $exitCode
     */
    protected function error(string $message, int $exitCode = 1): void
    {
        $this->climate->error($message);
        $this->setExitCode($exitCode);
    }
}


1			<?php
2
3			namespace PhpcsDiff;
4
5			use League\CLImate\CLImate;
6			use PhpcsDiff\Filter\Exception\FilterException;
7			use PhpcsDiff\Filter\Filter;
8			use PhpcsDiff\Filter\Rule\HasMessagesRule;
9			use PhpcsDiff\Filter\Rule\PhpFileRule;
10			use PhpcsDiff\Mapper\PhpcsViolationsMapper;
11
12			class PhpcsDiff
13			{
14			/**
15			* @var array
16			*/
17			protected $argv = [];
18
19			/**
20			* @var CLImate
21			*/
22			protected $climate;
23
24			/**
25			* @var bool
26			*/
27			protected $isVerbose = false;
28
29			/**
30			* @var int
31			*/
32			protected $exitCode = 0;
33
34			/**
35			* @var string
36			*/
37			protected $baseBranch;
38
39			/**
40			* @var string
41			*/
42			protected $currentBranch = '';
43
44			/**
45			* @param array $argv
46			* @param CLImate $climate
47			*/
48			public function __construct(array $argv, CLImate $climate)
49			{
50			$this->argv = $argv;
51			$this->climate = $climate;
52
53			if ($this->isFlagSet('-v')) {
54			$this->climate->comment('Running in verbose mode.');
55			$this->isVerbose = true;
56			}
57
58			if (!isset($this->argv[1])) {
59			$this->error('Please provide a <bold>base branch</bold> as the first argument.');
60			return;
61			}
62
63			$this->baseBranch = 'origin/' . str_replace('origin/', '', $this->argv[1]);
64			$this->currentBranch = trim(shell_exec('git rev-parse --verify HEAD'));
65
66			if (empty($this->currentBranch)) {
67			$this->error('Unable to get <bold>current</bold> branch.');
68			}
69			}
70
71			/**
72			* @param string $flag
73			* @return bool
74			*/
75			protected function isFlagSet(string $flag)
76			{
77			$isFlagSet = false;
78			$argv = $this->argv;
79
80			$key = array_search($flag, $argv, true);
81			if (false !== $key) {
82			unset($argv[$key]);
83			$argv = array_values($argv);
84
85			$isFlagSet = true;
86			}
87
88			$this->argv = $argv;
89			return $isFlagSet;
90			}
91
92			/**
93			* @param int $exitCode
94			*/
95			protected function setExitCode(int $exitCode)
96			{
97			$this->exitCode = $exitCode;
98			}
99
100			/**
101			* @return int
102			*/
103			public function getExitCode(): int
104			{
105			return $this->exitCode;
106			}
107
108			/**
109			* @todo Automatically look at server envs for the travis base branch, if not provided?
110			* @todo Define custom ruleset from command line argv for runPhpcs()
111			*/
112			public function run(): void
113			{
114			try {
115			$filter = new Filter([new PhpFileRule()], $this->getChangedFiles());
116			} catch (FilterException $exception) {
117			$this->error($exception->getMessage());
118			return;
119			}
120
121			$fileDiff = $filter->filter()->getFilteredData();
122
123			if (empty($fileDiff)) {
124			$this->climate->info('No difference to compare.');
125			return;
126			}
127
128			if ($this->isVerbose) {
129			$fileDiffCount = count($fileDiff);
130			$this->climate->comment(
131			'Checking ' . $fileDiffCount . ' ' .
132			ngettext('file', 'files', $fileDiffCount) . ' for violations.'
133			);
134			}
135
136			$phpcsOutput = $this->runPhpcs($fileDiff);
137
138			if (is_null($phpcsOutput)) {
139			$this->error('Unable to run phpcs executable.');
140			return;
141			}
142
143			if ($this->isVerbose) {
144			$this->climate->comment('Filtering phpcs output.');
145			}
146
147			try {
148			$filter = new Filter([new HasMessagesRule()], $phpcsOutput['files']);
149			} catch (FilterException $exception) {
150			$this->error($exception->getMessage());
151			return;
152			}
153
154			$files = $filter->filter()->getFilteredData();
155
156			if ($this->isVerbose) {
157			$this->climate->comment('Getting changed lines from git diff.');
158			}
159
160			$changedLinesPerFile = $this->getChangedLinesPerFile($files);
161
162			if ($this->isVerbose) {
163			$this->climate->comment('Comparing phpcs output with changes lines from git diff.');
164			}
165
166			$violations = (new PhpcsViolationsMapper(
167			$changedLinesPerFile,
168			getcwd()
169			))->map($files);
170
171			if ($this->isVerbose) {
172			$this->climate->comment('Preparing report.');
173			}
174
175			if (empty($violations)) {
176			$this->climate->info('No violations to report.');
177			return;
178			}
179
180			$this->outputViolations($violations);
181			}
182
183			/**
184			* Run phpcs on a list of files passed into the method
185			*
186			* @param array $files
187			* @param string $ruleset
188			* @return mixed
189			*/
190			protected function runPhpcs(array $files = [], string $ruleset = 'ruleset.xml')
191			{
192			$exec = null;
193			$root = dirname(__DIR__);
194
195			$locations = [
196			'vendor/bin/phpcs',
197			$root . '/../../bin/phpcs',
198			$root . '/../bin/phpcs',
199			$root . '/bin/phpcs',
200			$root . '/vendor/bin/phpcs',
201			'~/.config/composer/vendor/bin/phpcs',
202			'~/.composer/vendor/bin/phpcs',
203			];
204
205			foreach ($locations as $location) {
206			if (is_file($location)) {
207			$exec = $location;
208			break;
209			}
210			}
211
212			if (!$exec) {
213			return null;
214			}
215
216			if ($this->isVerbose) {
217			$this->climate->info('Using phpcs executable: ' . $exec);
218			}
219
220			$exec = PHP_BINARY . ' ' . $exec;
221			$command = $exec . ' --report=json --standard=' . $ruleset . ' ' . implode(' ', $files);
222			$output = shell_exec($command);
223
224			if ($this->isVerbose) {
225			$this->climate->info('Running: ' . $command);
226			}
227
228			$json = $output ? json_decode($output, true) : null;
229			if ($json === null && $output) {
230			$this->climate->error($output);
231			}
232
233			return $json;
234			}
235
236			/**
237			* @param array $output
238			*/
239			protected function outputViolations(array $output): void
240			{
241			$this->climate->flank(strtoupper('Start of phpcs check'), '#', 10)->br();
242			$this->climate->out(implode(PHP_EOL, $output));
243			$this->climate->flank(strtoupper('End of phpcs check'), '#', 11)->br();
244
245			$this->error('Violations have been reported.');
246			}
247
248			/**
249			* Returns a list of files which are within the diff based on the current branch
250			*
251			* @return array
252			*/
253			protected function getChangedFiles(): array
254			{
255			// Get a list of changed files (not including deleted files)
256			$output = shell_exec(
257			'git diff ' . $this->baseBranch . ' ' . $this->currentBranch . ' --name-only --diff-filter=ACM'
258			);
259
260			// Convert files into an array
261			$output = explode(PHP_EOL, $output);
262
263			// Remove any empty values
264			return array_filter($output);
265			}
266
267			/**
268			* Extract the changed lines for each file from the git diff output
269			*
270			* @param array $files
271			* @return array
272			*/
273			protected function getChangedLinesPerFile(array $files): array
274			{
275			$extract = [];
276			$pattern = [
277			'basic' => '^@@ (.*) @@',
278			'specific' => '@@ -[0-9]+(?:,[0-9]+)? \+([0-9]+)(?:,([0-9]+))? @@',
279			];
280
281			foreach ($files as $file => $data) {
282			$command = 'git diff -U0 ' . $this->baseBranch . ' ' . $this->currentBranch . ' ' . $file .
283			' \| grep -E ' . escapeshellarg($pattern['basic']);
284
285			$lineDiff = shell_exec($command);
286			$lines = array_filter(explode(PHP_EOL, $lineDiff));
287			$linesChanged = [];
288
289			foreach ($lines as $line) {
290			preg_match('/' . $pattern['specific'] . '/', $line, $matches);
291
292			// If there were no specific matches, skip this line
293			if ([] === $matches) {
294			continue;
295			}
296
297			$start = $end = (int)$matches[1];
298
299			// Multiple lines were changed, so we need to calculate the end line
300			if (isset($matches[2])) {
301			$length = (int)$matches[2];
302			$end = $start + $length - 1;
303			}
304
305			foreach (range($start, $end) as $l) {
306			$linesChanged[$l] = null;
307			}
308			}
309
310			$extract[$file] = array_keys($linesChanged);
311			}
312
313			return $extract;
314			}
315
316			/**
317			* @param string $message
318			* @param int $exitCode
319			*/
320			protected function error(string $message, int $exitCode = 1): void
321			{
322			$this->climate->error($message);
323			$this->setExitCode($exitCode);
324			}
325			}
326

olivertappin / phpcs-diff

PhpcsDiff::__construct() A last analyzed 2023-01-06 11:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PhpcsDiff::__construct() A
last analyzed 2023-01-06 11:01 UTC