PhpcsDiff::getOption() - Code Metrics - Inspection of "Support ruleset as argument" - olivertappin/phpcs-diff - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

unknown

created 2019-07-07 07:25 UTC

PhpcsDiff::getOption() A

↳ Parent: PhpcsDiff

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	5
c	1
b	0
f	0
dl	0
loc	11
rs	10
cc	3
nc	3
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
{
    const DEFAULT_RULESET = 'ruleset.xml';

    /**
     * @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;
        }

        $this->ruleset = $this->getOption('--ruleset', self::DEFAULT_RULESET);


        $this->baseBranch = $this->getArgument(1, '');
        $this->currentBranch = $this->getArgument(2, '');

        if ($this->isVerbose) {
            if (!$this->baseBranch && !$this->currentBranch) {
                $this->climate->comment("Comparing unstaged changes.");
            } else {
                $this->climate->comment(
                    'Comparing branch: "' . $this->baseBranch . '" against: "' . $this->currentBranch . '"'
                );
            }
        }
    }

    protected function getArgument($index, $default = null)
    {
        $arguments = array_filter($this->argv, function ($val) {
            return strpos($val, '-') === false;
        });

        return isset($arguments[$index]) ? $arguments[$index] : $default;
    }

    protected function getOption($name, $default = null)
    {
        foreach ($this->argv as $arg) {
            list($flag, $val) = explode('=', $arg);

            if ($flag == $name) {
                return $val;
            }
        }

        return $default;
    }

    /**
     * @param string $flag
     * @return bool
     */
    protected function isFlagSet($flag)
    {
        return in_array($flag, array_values($this->argv));
    }

    /**
     * @param int $exitCode
     */
    protected function setExitCode($exitCode)
    {
        if (!is_int($exitCode)) {

            throw new \UnexpectedValueException('The exit code provided is not a valid integer.');
        }

        $this->exitCode = $exitCode;
    }

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

    /**
     * @todo Automatically look at server envs for the travis base branch, if not provided?
     */
    public function run()
    {
        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 . ' file(s) for violations.'
            );
        }

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

        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 = [], $ruleset = 'ruleset.xml')
    {
        $exec = 'vendor/bin/phpcs';

        if (is_file(__DIR__ . '/../../../bin/phpcs')) {
            $exec = realpath(__DIR__ . '/../../../bin/phpcs');
        } elseif (is_file(__DIR__ . '/../bin/phpcs')) {
            $exec = realpath(__DIR__ . '/../bin/phpcs');
        }

        return json_decode(
            shell_exec($exec . ' --report=json --standard=' . $ruleset . ' ' . implode(' ', $files)),
            true
        );
    }

    /**
     * @param array $output
     */
    protected function outputViolations(array $output)
    {
        $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()
    {
        // Get a list of changed files (not including deleted files)
        $output = shell_exec(
            'git diff ' . $this->baseBranch . ' ' . $this->currentBranch . ' --name-only --diff-filter=d'
        );

        // 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)
    {
        $extract = [];
        $pattern = '/@@ -[0-9]+(?:,[0-9]+)? \+([0-9]+)(?:,([0-9]+))? @@/';

        foreach ($files as $file => $data) {
            $command = 'git diff -U0 ' . $this->baseBranch . ' ' . $this->currentBranch . ' ' . $file;
            $output = shell_exec($command);
            preg_match_all($pattern, $output, $lineDiff);
            $lines = array_values($lineDiff[0]);

            $linesChanged = [];

            foreach ($lines as $line) {
                preg_match($pattern, $line, $matches);


                $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($message, $exitCode = 1)
    {
        $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			const DEFAULT_RULESET = 'ruleset.xml';
15
16			/**
17			* @var array
18			*/
19			protected $argv = [];
20
21			/**
22			* @var CLImate
23			*/
24			protected $climate;
25
26			/**
27			* @var bool
28			*/
29			protected $isVerbose = false;
30
31			/**
32			* @var int
33			*/
34			protected $exitCode = 0;
35
36			/**
37			* @var string
38			*/
39			protected $baseBranch;
40
41			/**
42			* @var string
43			*/
44			protected $currentBranch = '';
45
46			/**
47			* @param array $argv
48			* @param CLImate $climate
49			*/
50			public function __construct(array $argv, CLImate $climate)
51			{
52			$this->argv = $argv;
53			$this->climate = $climate;
54
55			if ($this->isFlagSet('-v')) {
56			$this->climate->comment('Running in verbose mode.');
57			$this->isVerbose = true;
58			}
59
60			$this->ruleset = $this->getOption('--ruleset', self::DEFAULT_RULESET);
			0 ignored issues – show Bug Best Practice introduced 2019-07-07 07:54 UTC by Report Bug Copy Issue Report The property `ruleset` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
61
62			$this->baseBranch = $this->getArgument(1, '');
63			$this->currentBranch = $this->getArgument(2, '');
64
65			if ($this->isVerbose) {
66			if (!$this->baseBranch && !$this->currentBranch) {
67			$this->climate->comment("Comparing unstaged changes.");
68			} else {
69			$this->climate->comment(
70			'Comparing branch: "' . $this->baseBranch . '" against: "' . $this->currentBranch . '"'
71			);
72			}
73			}
74			}
75
76			protected function getArgument($index, $default = null)
77			{
78			$arguments = array_filter($this->argv, function ($val) {
79			return strpos($val, '-') === false;
80			});
81
82			return isset($arguments[$index]) ? $arguments[$index] : $default;
83			}
84
85			protected function getOption($name, $default = null)
86			{
87			foreach ($this->argv as $arg) {
88			list($flag, $val) = explode('=', $arg);
89
90			if ($flag == $name) {
91			return $val;
92			}
93			}
94
95			return $default;
96			}
97
98			/**
99			* @param string $flag
100			* @return bool
101			*/
102			protected function isFlagSet($flag)
103			{
104			return in_array($flag, array_values($this->argv));
105			}
106
107			/**
108			* @param int $exitCode
109			*/
110			protected function setExitCode($exitCode)
111			{
112			if (!is_int($exitCode)) {
			0 ignored issues – show introduced 2019-06-26 23:26 UTC by Report Bug Copy Issue Report The condition `is_int($exitCode)` is always `true`. Loading history...
113			throw new \UnexpectedValueException('The exit code provided is not a valid integer.');
114			}
115
116			$this->exitCode = $exitCode;
117			}
118
119			/**
120			* @return int
121			*/
122			public function getExitCode()
123			{
124			return $this->exitCode;
125			}
126
127			/**
128			* @todo Automatically look at server envs for the travis base branch, if not provided?
129			*/
130			public function run()
131			{
132			try {
133			$filter = new Filter([new PhpFileRule()], $this->getChangedFiles());
134			} catch (FilterException $exception) {
135			$this->error($exception->getMessage());
136			return;
137			}
138
139			$fileDiff = $filter->filter()->getFilteredData();
140
141			if (empty($fileDiff)) {
142			$this->climate->info('No difference to compare.');
143			return;
144			}
145
146			if ($this->isVerbose) {
147			$fileDiffCount = count($fileDiff);
148			$this->climate->comment(
149			'Checking ' . $fileDiffCount . ' file(s) for violations.'
150			);
151			}
152
153			$phpcsOutput = $this->runPhpcs($fileDiff, $this->ruleset);
154
155			if (is_null($phpcsOutput)) {
156			$this->error('Unable to run phpcs executable.');
157			return;
158			}
159
160			if ($this->isVerbose) {
161			$this->climate->comment('Filtering phpcs output.');
162			}
163
164			try {
165			$filter = new Filter([new HasMessagesRule()], $phpcsOutput['files']);
166			} catch (FilterException $exception) {
167			$this->error($exception->getMessage());
168			return;
169			}
170
171			$files = $filter->filter()->getFilteredData();
172
173			if ($this->isVerbose) {
174			$this->climate->comment('Getting changed lines from git diff.');
175			}
176
177			$changedLinesPerFile = $this->getChangedLinesPerFile($files);
178
179			if ($this->isVerbose) {
180			$this->climate->comment('Comparing phpcs output with changes lines from git diff.');
181			}
182
183			$violations = (new PhpcsViolationsMapper(
184			$changedLinesPerFile,
185			getcwd()
186			))->map($files);
187
188			if ($this->isVerbose) {
189			$this->climate->comment('Preparing report.');
190			}
191
192			if (empty($violations)) {
193			$this->climate->info('No violations to report.');
194			return;
195			}
196
197			$this->outputViolations($violations);
198			}
199
200			/**
201			* Run phpcs on a list of files passed into the method
202			*
203			* @param array $files
204			* @param string $ruleset
205			* @return mixed
206			*/
207			protected function runPhpcs(array $files = [], $ruleset = 'ruleset.xml')
208			{
209			$exec = 'vendor/bin/phpcs';
210
211			if (is_file(__DIR__ . '/../../../bin/phpcs')) {
212			$exec = realpath(__DIR__ . '/../../../bin/phpcs');
213			} elseif (is_file(__DIR__ . '/../bin/phpcs')) {
214			$exec = realpath(__DIR__ . '/../bin/phpcs');
215			}
216
217			return json_decode(
218			shell_exec($exec . ' --report=json --standard=' . $ruleset . ' ' . implode(' ', $files)),
219			true
220			);
221			}
222
223			/**
224			* @param array $output
225			*/
226			protected function outputViolations(array $output)
227			{
228			$this->climate->flank(strtoupper('Start of phpcs check'), '#', 10)->br();
229			$this->climate->out(implode(PHP_EOL, $output));
230			$this->climate->flank(strtoupper('End of phpcs check'), '#', 11)->br();
231
232			$this->error('Violations have been reported.');
233			}
234
235			/**
236			* Returns a list of files which are within the diff based on the current branch
237			*
238			* @return array
239			*/
240			protected function getChangedFiles()
241			{
242			// Get a list of changed files (not including deleted files)
243			$output = shell_exec(
244			'git diff ' . $this->baseBranch . ' ' . $this->currentBranch . ' --name-only --diff-filter=d'
245			);
246
247			// Convert files into an array
248			$output = explode(PHP_EOL, $output);
249
250			// Remove any empty values
251			return array_filter($output);
252			}
253
254			/**
255			* Extract the changed lines for each file from the git diff output
256			*
257			* @param array $files
258			* @return array
259			*/
260			protected function getChangedLinesPerFile(array $files)
261			{
262			$extract = [];
263			$pattern = '/@@ -[0-9]+(?:,[0-9]+)? \+([0-9]+)(?:,([0-9]+))? @@/';
264
265			foreach ($files as $file => $data) {
266			$command = 'git diff -U0 ' . $this->baseBranch . ' ' . $this->currentBranch . ' ' . $file;
267			$output = shell_exec($command);
268			preg_match_all($pattern, $output, $lineDiff);
269			$lines = array_values($lineDiff[0]);
270
271			$linesChanged = [];
272
273			foreach ($lines as $line) {
274			preg_match($pattern, $line, $matches);
275
276
277			$start = $end = (int)$matches[1];
278
279			// Multiple lines were changed, so we need to calculate the end line
280			if (isset($matches[2])) {
281			$length = (int)$matches[2];
282			$end = $start + $length - 1;
283			}
284
285			foreach (range($start, $end) as $l) {
286			$linesChanged[$l] = null;
287			}
288			}
289
290			$extract[$file] = array_keys($linesChanged);
291			}
292
293			return $extract;
294			}
295
296			/**
297			* @param string $message
298			* @param int $exitCode
299			*/
300			protected function error($message, $exitCode = 1)
301			{
302			$this->climate->error($message);
303			$this->setExitCode($exitCode);
304			}
305			}
306

olivertappin / phpcs-diff

Pull Request — master (#6)

PhpcsDiff::getOption() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like