Merge pull request #10 from TotalWipeOut/master

olivertappin · web-flow · commit 3404c585fbdd · 2023-01-06T10:24:58.000Z
PHP version and other upgrades
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 .DS_Store
 .idea
 vendor
+.phpunit.cache
+coverage.clover
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
@@ -25,7 +25,7 @@ tools:
     php_code_coverage: true
     php_code_sniffer:
         config:
-            standard: PSR2
+            standard: PSR12
         filter:
             paths: ['src']
     php_loc:
diff --git a/.styleci.yml b/.styleci.yml
@@ -1 +1 @@
-preset: psr2
+preset: psr12
diff --git a/.travis.yml b/.travis.yml
@@ -1,22 +1,23 @@
 language: php
 
-dist: trusty
+dist: xenial
 
 sudo: false
 
 php:
-  - 5.6
-  - 7.0
-  - 7.1
-  - 7.2
+  - 7.3
+  - 7.4
+  - 8.0
   - nightly
 
 matrix:
   allow_failures:
   - php: nightly
 
 before_script:
+  - wget https://scrutinizer-ci.com/ocular.phar
   - composer update --no-interaction
 
 script:
-  - vendor/bin/phpunit --stop-on-failure
+  - XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-clover=coverage.clover --stop-on-failure
+  - if [ -f coverage.clover ]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi;
diff --git a/bin/phpcs-diff b/bin/phpcs-diff
@@ -8,11 +8,18 @@
  */
 
 if (is_file(__DIR__ . '/../../../autoload.php')) {
-    include_once __DIR__ . '/../../../autoload.php';
+    $autoload = __DIR__ . '/../../../autoload.php';
 } elseif (is_file(__DIR__ . '/../autoload.php')) {
-    include_once __DIR__ . '/../autoload.php';
+    $autoload = __DIR__ . '/../autoload.php';
+} elseif (is_file(__DIR__ . '/../vendor/autoload.php')) {
+    $autoload = __DIR__ . '/../vendor/autoload.php';
+}
+
+if (isset($autoload)) {
+    require $autoload;
 } else {
-    include_once 'vendor/autoload.php';
+    echo 'Can not find autoloader, did you run composer? ' . __DIR__;
+    die(1);
 }
 
 $climate = new League\CLImate\CLImate();
diff --git a/composer.json b/composer.json
@@ -2,12 +2,15 @@
     "name": "olivertappin/phpcs-diff",
     "description": "Detects violations of a defined coding standard based on a git diff.",
     "require": {
-        "php": "^5.6|^7.0",
-        "squizlabs/php_codesniffer": "*",
+        "php": "^7.3 || ^8.0",
+        "ext-json": "*",
+        "ext-gettext": "*",
+        "squizlabs/php_codesniffer": "^3.5.7",
         "league/climate": "^3.4"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7.16"
+        "phpunit/phpunit": "^7.5.20 || ^8.5.21 || ^9.5.10",
+        "phpunit/php-code-coverage": "^9.2"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,17 +1,27 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
          bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
->
+         cacheResultFile=".phpunit.cache/test-results"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
     <testsuites>
-        <testsuite name="Package Test Suite">
-            <directory suffix=".php">./tests/</directory>
+        <testsuite name="default">
+            <directory>tests</directory>
         </testsuite>
     </testsuites>
+
+    <coverage cacheDirectory=".phpunit.cache/code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
 </phpunit>
diff --git a/src/Filter/Filter.php b/src/Filter/Filter.php
@@ -51,7 +51,7 @@ public function __construct(array $rules, array $unfilteredData)
     /**
      * @return $this
      */
-    public function filter()
+    public function filter(): Filter
     {
         foreach ($this->unfilteredData as $key => $item) {
             foreach ($this->rules as $rule) {
@@ -70,15 +70,15 @@ public function filter()
     /**
      * @return array
      */
-    public function getFilteredData()
+    public function getFilteredData(): array
     {
         return $this->filteredData;
     }
 
     /**
      * @return array
      */
-    public function getContaminatedData()
+    public function getContaminatedData(): array
     {
         return $this->contaminatedData;
     }
diff --git a/src/Filter/Rule/FileRule.php b/src/Filter/Rule/FileRule.php
@@ -3,13 +3,14 @@
 namespace PhpcsDiff\Filter\Rule;
 
 use PhpcsDiff\Filter\Rule\Exception\InvalidArgumentException;
+use PhpcsDiff\Filter\Rule\Exception\RuleException;
 use PhpcsDiff\Filter\Rule\Exception\RuntimeException;
 
 class FileRule implements RuleInterface
 {
     /**
      * @param mixed $data
-     * @throws \PhpcsDiff\Filter\Rule\Exception\RuleException
+     * @throws RuleException
      */
     public function __invoke($data)
     {
diff --git a/src/Filter/Rule/HasMessagesRule.php b/src/Filter/Rule/HasMessagesRule.php
@@ -3,12 +3,13 @@
 namespace PhpcsDiff\Filter\Rule;
 
 use PhpcsDiff\Filter\Rule\Exception\InvalidArgumentException;
+use PhpcsDiff\Filter\Rule\Exception\RuleException;
 
 class HasMessagesRule implements RuleInterface
 {
     /**
      * @param mixed $data
-     * @throws \PhpcsDiff\Filter\Rule\Exception\RuleException
+     * @throws RuleException
      */
     public function __invoke($data)
     {
diff --git a/src/Filter/Rule/PhpFileRule.php b/src/Filter/Rule/PhpFileRule.php
@@ -2,13 +2,14 @@
 
 namespace PhpcsDiff\Filter\Rule;
 
+use PhpcsDiff\Filter\Rule\Exception\RuleException;
 use PhpcsDiff\Filter\Rule\Exception\RuntimeException;
 
 class PhpFileRule extends FileRule
 {
     /**
      * @param mixed $data
-     * @throws \PhpcsDiff\Filter\Rule\Exception\RuleException
+     * @throws RuleException
      */
     public function __invoke($data)
     {
diff --git a/src/Mapper/PhpcsViolationsMapper.php b/src/Mapper/PhpcsViolationsMapper.php
@@ -18,7 +18,7 @@ class PhpcsViolationsMapper implements MapperInterface
      * @param array $changedLinesPerFile
      * @param string $currentDirectory
      */
-    public function __construct(array $changedLinesPerFile, $currentDirectory)
+    public function __construct(array $changedLinesPerFile, string $currentDirectory)
     {
         $this->changedLinesPerFile = $changedLinesPerFile;
         $this->currentDirectory = $currentDirectory;
@@ -28,7 +28,7 @@ public function __construct(array $changedLinesPerFile, $currentDirectory)
      * @param array $data
      * @return array
      */
-    public function map(array $data)
+    public function map(array $data): array
     {
         $mappedData = [];
 
diff --git a/src/PhpcsDiff.php b/src/PhpcsDiff.php
@@ -65,15 +65,14 @@ public function __construct(array $argv, CLImate $climate)
 
         if (empty($this->currentBranch)) {
             $this->error('Unable to get <bold>current</bold> branch.');
-            return;
         }
     }
 
     /**
      * @param string $flag
      * @return bool
      */
-    protected function isFlagSet($flag)
+    protected function isFlagSet(string $flag)
     {
         $isFlagSet = false;
         $argv = $this->argv;
@@ -93,19 +92,15 @@ protected function isFlagSet($flag)
     /**
      * @param int $exitCode
      */
-    protected function setExitCode($exitCode)
+    protected function setExitCode(int $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()
+    public function getExitCode(): int
     {
         return $this->exitCode;
     }
@@ -114,7 +109,7 @@ public function getExitCode()
      * @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()
+    public function run(): void
     {
         try {
             $filter = new Filter([new PhpFileRule()], $this->getChangedFiles());
@@ -192,26 +187,57 @@ public function run()
      * @param string $ruleset
      * @return mixed
      */
-    protected function runPhpcs(array $files = [], $ruleset = 'ruleset.xml')
+    protected function runPhpcs(array $files = [], string $ruleset = 'ruleset.xml')
     {
-        $exec = 'vendor/bin/phpcs';
+        $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',
+        ];
 
-        if (is_file(__DIR__ . '/../../../bin/phpcs')) {
-            $exec = realpath(__DIR__ . '/../../../bin/phpcs');
-        } elseif (is_file(__DIR__ . '/../bin/phpcs')) {
-            $exec = realpath(__DIR__ . '/../bin/phpcs');
+        foreach ($locations as $location) {
+            if (is_file($location)) {
+                $exec = $location;
+                break;
+            }
         }
 
-        return json_decode(
-            shell_exec($exec . ' --report=json --standard=' . $ruleset . ' ' . implode(' ', $files)),
-            true
-        );
+        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)
+    protected function outputViolations(array $output): void
     {
         $this->climate->flank(strtoupper('Start of phpcs check'), '#', 10)->br();
         $this->climate->out(implode(PHP_EOL, $output));
@@ -225,7 +251,7 @@ protected function outputViolations(array $output)
      *
      * @return array
      */
-    protected function getChangedFiles()
+    protected function getChangedFiles(): array
     {
         // Get a list of changed files (not including deleted files)
         $output = shell_exec(
@@ -245,7 +271,7 @@ protected function getChangedFiles()
      * @param array $files
      * @return array
      */
-    protected function getChangedLinesPerFile(array $files)
+    protected function getChangedLinesPerFile(array $files): array
     {
         $extract = [];
         $pattern = [
@@ -292,7 +318,7 @@ protected function getChangedLinesPerFile(array $files)
      * @param string $message
      * @param int $exitCode
      */
-    protected function error($message, $exitCode = 1)
+    protected function error(string $message, int $exitCode = 1): void
     {
         $this->climate->error($message);
         $this->setExitCode($exitCode);
diff --git a/src/Validator/RuleValidator.php b/src/Validator/RuleValidator.php
@@ -4,14 +4,14 @@
 
 use PhpcsDiff\Filter\Rule\RuleInterface;
 use PhpcsDiff\Validator\Exception\InvalidArgumentException;
+use PhpcsDiff\Validator\Exception\ValidatorException;
 
 class RuleValidator extends AbstractValidator implements ValidatorInterface
 {
     /**
-     * @return mixed|void
-     * @throws \PhpcsDiff\Validator\Exception\ValidatorException
+     * @throws ValidatorException
      */
-    public function validate()
+    public function validate(): void
     {
         if (empty($this->data)) {
             throw new InvalidArgumentException('The data provided is empty.');
diff --git a/tests/Filter/FilterTest.php b/tests/Filter/FilterTest.php
diff --git a/tests/Filter/Rule/FileRuleTest.php b/tests/Filter/Rule/FileRuleTest.php
diff --git a/tests/Filter/Rule/HasMessagesRuleTest.php b/tests/Filter/Rule/HasMessagesRuleTest.php
diff --git a/tests/Filter/Rule/PhpFileRuleTest.php b/tests/Filter/Rule/PhpFileRuleTest.php
diff --git a/tests/Mapper/PhpcsViolationsMapperTest.php b/tests/Mapper/PhpcsViolationsMapperTest.php
diff --git a/tests/PhpcsDiffTest.php b/tests/PhpcsDiffTest.php
diff --git a/tests/Validator/RuleValidatorTest.php b/tests/Validator/RuleValidatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function __construct(array $rules, array $unfilteredData)`
`51`	`51`	`/**`
`52`	`52`	`* @return $this`
`53`	`53`	`*/`
`54`		`- public function filter()`
	`54`	`+ public function filter(): Filter`
`55`	`55`	`{`
`56`	`56`	`foreach ($this->unfilteredData as $key => $item) {`
`57`	`57`	`foreach ($this->rules as $rule) {`
`@@ -70,15 +70,15 @@ public function filter()`
`70`	`70`	`/**`
`71`	`71`	`* @return array`
`72`	`72`	`*/`
`73`		`- public function getFilteredData()`
	`73`	`+ public function getFilteredData(): array`
`74`	`74`	`{`
`75`	`75`	`return $this->filteredData;`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`/**`
`79`	`79`	`* @return array`
`80`	`80`	`*/`
`81`		`- public function getContaminatedData()`
	`81`	`+ public function getContaminatedData(): array`
`82`	`82`	`{`
`83`	`83`	`return $this->contaminatedData;`
`84`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,14 @@`
`3`	`3`	`namespace PhpcsDiff\Filter\Rule;`
`4`	`4`
`5`	`5`	`use PhpcsDiff\Filter\Rule\Exception\InvalidArgumentException;`
	`6`	`+use PhpcsDiff\Filter\Rule\Exception\RuleException;`
`6`	`7`	`use PhpcsDiff\Filter\Rule\Exception\RuntimeException;`
`7`	`8`
`8`	`9`	`class FileRule implements RuleInterface`
`9`	`10`	`{`
`10`	`11`	`/**`
`11`	`12`	`* @param mixed $data`
`12`		`- * @throws \PhpcsDiff\Filter\Rule\Exception\RuleException`
	`13`	`+ * @throws RuleException`
`13`	`14`	`*/`
`14`	`15`	`public function __invoke($data)`
`15`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,13 @@`
`3`	`3`	`namespace PhpcsDiff\Filter\Rule;`
`4`	`4`
`5`	`5`	`use PhpcsDiff\Filter\Rule\Exception\InvalidArgumentException;`
	`6`	`+use PhpcsDiff\Filter\Rule\Exception\RuleException;`
`6`	`7`
`7`	`8`	`class HasMessagesRule implements RuleInterface`
`8`	`9`	`{`
`9`	`10`	`/**`
`10`	`11`	`* @param mixed $data`
`11`		`- * @throws \PhpcsDiff\Filter\Rule\Exception\RuleException`
	`12`	`+ * @throws RuleException`
`12`	`13`	`*/`
`13`	`14`	`public function __invoke($data)`
`14`	`15`	`{`