Merge pull request #8 from Aeliot-Tm/extend_compatibility

Aeliot-Tm · web-flow · commit f82e2d077984 · 2023-02-03T00:28:41.000+03:00
Add compatibility with PHP 7.1
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -14,10 +14,12 @@ jobs:
             fail-fast: false
             matrix:
                 php-version:
+                    - '7.1'
                     - '7.4'
                     - '8.0'
                     - '8.1'
                 include:
+                    - php-version: '7.1'
                     - php-version: '7.4'
                     - php-version: '8.0'
                     - php-version: '8.1'
diff --git a/bin/pccb_clover_compare b/bin/pccb_clover_compare
@@ -48,7 +48,9 @@ if ($isVerbose) {
     ]);
 
     $rows = $results->getRows();
-    array_walk($rows, static fn (ComparingRow $x) => $table->addComparingRow($x));
+    array_walk($rows, static function (ComparingRow $x) use ($table) {
+        $table->addComparingRow($x);
+    });
 
     echo $table->getContent();
 }
diff --git a/composer.json b/composer.json
@@ -3,19 +3,11 @@
   "type": "library",
   "description": "Script for the comparing of current code coverage with baseline.",
   "license": "MIT",
-  "keywords": ["phpunit", "clover", "baseline"],
-  "require": {
-    "php": "^7.4|^8.0",
-    "ext-simplexml": "*",
-    "ext-json": "*"
-  },
-  "require-dev": {
-    "phpunit/phpunit": "^9.5",
-    "dg/bypass-finals": "^1.4",
-    "phpstan/phpstan": "^1.9",
-    "phpstan/phpstan-phpunit": "^1.3",
-    "phpstan/extension-installer": "^1.2"
-  },
+  "keywords": [
+    "phpunit",
+    "clover",
+    "baseline"
+  ],
   "autoload": {
     "psr-4": {
       "Aeliot\\PHPUnitCodeCoverageBaseline\\": "src/"
@@ -30,13 +22,26 @@
     "bin/pccb_clover_build_baseline",
     "bin/pccb_clover_compare"
   ],
-  "scripts": {
-    "test": "vendor/bin/phpunit",
-    "phpstan-analise": "vendor/bin/phpstan analyse"
-  },
   "config": {
     "allow-plugins": {
       "phpstan/extension-installer": true
-    }
+    },
+    "sort-packages": true
+  },
+  "require": {
+    "php": "^7.1|^8.0",
+    "ext-json": "*",
+    "ext-simplexml": "*"
+  },
+  "require-dev": {
+    "dg/bypass-finals": "^1.4",
+    "phpstan/extension-installer": "*",
+    "phpstan/phpstan": "*",
+    "phpstan/phpstan-phpunit": "*",
+    "phpunit/phpunit": "*"
+  },
+  "scripts": {
+    "test": "vendor/bin/phpunit",
+    "phpstan-analise": "vendor/bin/phpstan analyse"
   }
 }
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,5 +1,10 @@
 parameters:
 	ignoreErrors:
+		-
+			message: "#^Method Aeliot\\\\PHPUnitCodeCoverageBaseline\\\\Enum\\\\SupportedType\\:\\:getCoveredTypes\\(\\) should return array\\<string, string\\> but returns array\\<string, string\\>\\|false\\.$#"
+			count: 1
+			path: src/Enum/SupportedType.php
+
 		-
 			message: "#^Return type of call to method PHPUnit\\\\Framework\\\\TestCase\\:\\:createMock\\(\\) contains unresolvable type\\.$#"
 			count: 2
@@ -19,3 +24,19 @@ parameters:
 			message: "#^Return type of call to method PHPUnit\\\\Framework\\\\TestCase\\:\\:createMock\\(\\) contains unresolvable type\\.$#"
 			count: 1
 			path: tests/Unit/Model/ConsoleTableTest.php
+
+		-
+			message: "#^Call to an undefined static method PHPUnit\\\\Framework\\\\TestCase\\:\\:expectExceptionMessageMatches\\(\\)\\.$#"
+			count: 1
+			path: tests/Unit/UnitTestCase.php
+
+		-
+			message: "#^Call to an undefined static method PHPUnit\\\\Framework\\\\TestCase\\:\\:expectWarning\\(\\)\\.$#"
+			count: 1
+			path: tests/Unit/UnitTestCase.php
+
+		-
+			message: "#^Call to an undefined static method PHPUnit\\\\Framework\\\\TestCase\\:\\:expectWarningMessageMatches\\(\\)\\.$#"
+			count: 1
+			path: tests/Unit/UnitTestCase.php
+
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -27,4 +27,16 @@
             <crap4j outputFile="build/coverage/crap4j.xml" threshold="50"/>
         </report>
     </coverage>
+
+    <!-- >>>: Code coverage report for old versions of PHPUnit -->
+    <filter>
+        <whitelist processUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+    <logging>
+        <log type="coverage-html" target="build/coverage"/>
+        <log type="coverage-clover" target="build/coverage/clover.xml"/>
+    </logging>
+    <!-- <<<: Code coverage report for old versions of PHPUnit -->
 </phpunit>
diff --git a/src/BaselineBuilder.php b/src/BaselineBuilder.php
@@ -9,8 +9,15 @@
 
 final class BaselineBuilder
 {
-    private BaselineWriter $baselineWriter;
-    private CloverReader $cloverReader;
+    /**
+     * @var BaselineWriter
+     */
+    private $baselineWriter;
+
+    /**
+     * @var CloverReader
+     */
+    private $cloverReader;
 
     public function __construct(BaselineWriter $baselineWriter, CloverReader $cloverReader)
     {
diff --git a/src/Comparator.php b/src/Comparator.php
@@ -12,8 +12,15 @@
 
 final class Comparator
 {
-    private BaselineReader $baselineReader;
-    private CloverReader $cloverReader;
+    /**
+     * @var BaselineReader
+     */
+    private $baselineReader;
+
+    /**
+     * @var CloverReader
+     */
+    private $cloverReader;
 
     public function __construct(BaselineReader $baselineReader, CloverReader $cloverReader)
     {
diff --git a/src/Console/OptionsConfig.php b/src/Console/OptionsConfig.php
@@ -9,12 +9,12 @@ final class OptionsConfig
     /**
      * @var array<string,string>
      */
-    private array $aliases = [];
+    private $aliases = [];
 
     /**
      * @var array<string,array{ longName: string, shortName: string, defaultValue: string|null }>
      */
-    private array $options = [];
+    private $options = [];
 
     public function add(
         string $longName,
@@ -70,7 +70,9 @@ public function prepareShortOptions(): string
      */
     private function mapToRequired(array $keys): array
     {
-        return array_map(static fn (string $x): string => "$x:", $keys);
+        return array_map(static function (string $x): string {
+            return "$x:";
+        }, $keys);
     }
 
     private function validateNames(string $longName, string $shortName): void
diff --git a/src/Console/OptionsReader.php b/src/Console/OptionsReader.php
@@ -6,8 +6,15 @@
 
 final class OptionsReader
 {
-    private OptionsConfig $config;
-    private GetOpt $getOpt;
+    /**
+     * @var OptionsConfig
+     */
+    private $config;
+
+    /**
+     * @var GetOpt
+     */
+    private $getOpt;
 
     public function __construct(OptionsConfig $config, GetOpt $getOpt)
     {
@@ -33,10 +40,10 @@ public function read(): array
      */
     private function checkOnDuplicates(array $data): void
     {
-        $duplicates = [
-            ...$this->filterArrayValues($data),
-            ...$this->filterDefinedByBothNames($data),
-        ];
+        $duplicates = array_merge(
+            $this->filterArrayValues($data),
+            $this->filterDefinedByBothNames($data)
+        );
 
         if ($duplicates) {
             $duplicates = array_unique($duplicates);
@@ -56,7 +63,9 @@ private function filterArrayValues(array $data): array
     {
         $duplicates = [];
         $aliases = $this->config->getAliases();
-        $arrays = array_filter($data, static fn ($x): bool => \is_array($x));
+        $arrays = array_filter($data, static function ($x): bool {
+            return \is_array($x);
+        });
         foreach (array_keys($arrays) as $optionName) {
             $duplicates[] = $aliases[$optionName] ?? $optionName;
         }
@@ -90,7 +99,7 @@ private function setDefaults(array $data): array
     {
         $options = $this->config->getOptions();
         foreach ($this->config->getAliases() as $longName) {
-            if(isset($data[$longName])){
+            if (isset($data[$longName])) {
                 continue;
             }
 
diff --git a/src/Enum/SupportedType.php b/src/Enum/SupportedType.php
@@ -53,6 +53,8 @@ public static function getSupportedTypes(): array
      */
     private static function mapCoveredTypes(array $supportedTypes): array
     {
-        return array_map(static fn (string $x): string => 'covered' . $x, $supportedTypes);
+        return array_map(static function (string $x): string {
+            return 'covered' . $x;
+        }, $supportedTypes);
     }
 }
diff --git a/src/Model/ComparingResult.php b/src/Model/ComparingResult.php
@@ -6,17 +6,20 @@
 
 final class ComparingResult
 {
-    private bool $hasImprovement = false;
+    /**
+     * @var bool
+     */
+    private $hasImprovement = false;
 
     /**
      * @var ComparingRow[]
      */
-    private array $rows = [];
+    private $rows = [];
 
     /**
      * @var string[]
      */
-    private array $regressedNames = [];
+    private $regressedNames = [];
 
     public function addRow(ComparingRow $row): void
     {
diff --git a/src/Model/ComparingRow.php b/src/Model/ComparingRow.php
@@ -6,10 +6,25 @@
 
 final class ComparingRow
 {
-    private string $name;
-    private float $old;
-    private float $new;
-    private float $progress;
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var float
+     */
+    private $old;
+
+    /**
+     * @var float
+     */
+    private $new;
+
+    /**
+     * @var float
+     */
+    private $progress;
 
     public function __construct(string $name, float $old, float $new)
     {
diff --git a/src/Model/ConsoleTable.php b/src/Model/ConsoleTable.php
@@ -9,24 +9,27 @@ final class ConsoleTable
     /**
      * @var string[]
      */
-    private array $columns;
+    private $columns;
 
-    private int $columnsCount;
+    /**
+     * @var int
+     */
+    private $columnsCount;
 
     /**
      * @var array<int,int|string>
      */
-    private array $columnsKeys;
+    private $columnsKeys;
 
     /**
      * @var array<int,int>
      */
-    private array $columnsWidth;
+    private $columnsWidth;
 
     /**
      * @var array<int,array<string>>
      */
-    private array $values = [];
+    private $values = [];
 
     /**
      * @param string[] $columns
diff --git a/src/Reader/BaselineReader.php b/src/Reader/BaselineReader.php
@@ -8,7 +8,10 @@
 
 final class BaselineReader
 {
-    private string $path;
+    /**
+     * @var string
+     */
+    private $path;
 
     public function __construct(string $path)
     {
@@ -26,7 +29,10 @@ public function read(): array
             throw new \DomainException('Empty baseline');
         }
 
-        if (array_filter($baseline, static fn ($x) => !\is_int($x))) {
+        $notIntValues = array_filter($baseline, static function ($x): bool {
+            return !\is_int($x);
+        });
+        if ($notIntValues) {
             throw new \DomainException('Invalid baseline data');
         }
 
@@ -42,7 +48,10 @@ private function getBaseline(): array
             throw new \RuntimeException(sprintf('Code coverage baseline "%s" does not exist.', $this->path));
         }
 
-        $baseline = json_decode((string) file_get_contents($this->path), true, 512, JSON_THROW_ON_ERROR);
+        $baseline = json_decode((string) file_get_contents($this->path), true);
+        if (json_last_error()) {
+            throw new \LogicException(json_last_error_msg());
+        }
         if (!\is_array($baseline)) {
             throw new \DomainException('Cannot read baseline');
         }
diff --git a/src/Reader/CloverReader.php b/src/Reader/CloverReader.php
@@ -8,7 +8,10 @@
 
 final class CloverReader
 {
-    private string $path;
+    /**
+     * @var string
+     */
+    private $path;
 
     public function __construct(string $path)
     {
diff --git a/src/Writer/BaselineWriter.php b/src/Writer/BaselineWriter.php
diff --git a/tests/Unit/Model/ConsoleTableTest.php b/tests/Unit/Model/ConsoleTableTest.php
diff --git a/tests/Unit/Reader/BaselineReaderTest.php b/tests/Unit/Reader/BaselineReaderTest.php
diff --git a/tests/Unit/Reader/CloverReaderTest.php b/tests/Unit/Reader/CloverReaderTest.php
diff --git a/tests/Unit/UnitTestCase.php b/tests/Unit/UnitTestCase.php

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ if ($isVerbose) {`
`48`	`48`	`]);`
`49`	`49`
`50`	`50`	`$rows = $results->getRows();`
`51`		`- array_walk($rows, static fn (ComparingRow $x) => $table->addComparingRow($x));`
	`51`	`+ array_walk($rows, static function (ComparingRow $x) use ($table) {`
	`52`	`+ $table->addComparingRow($x);`
	`53`	`+ });`
`52`	`54`
`53`	`55`	`echo $table->getContent();`
`54`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,8 @@ public static function getSupportedTypes(): array`
`53`	`53`	`*/`
`54`	`54`	`private static function mapCoveredTypes(array $supportedTypes): array`
`55`	`55`	`{`
`56`		`- return array_map(static fn (string $x): string => 'covered' . $x, $supportedTypes);`
	`56`	`+ return array_map(static function (string $x): string {`
	`57`	`+ return 'covered' . $x;`
	`58`	`+ }, $supportedTypes);`
`57`	`59`	`}`
`58`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,10 @@`
`8`	`8`
`9`	`9`	`final class BaselineReader`
`10`	`10`	`{`
`11`		`- private string $path;`
	`11`	`+ /**`
	`12`	`+ * @var string`
	`13`	`+ */`
	`14`	`+ private $path;`
`12`	`15`
`13`	`16`	`public function __construct(string $path)`
`14`	`17`	`{`
`@@ -26,7 +29,10 @@ public function read(): array`
`26`	`29`	`throw new \DomainException('Empty baseline');`
`27`	`30`	`}`
`28`	`31`
`29`		`- if (array_filter($baseline, static fn ($x) => !\is_int($x))) {`
	`32`	`+ $notIntValues = array_filter($baseline, static function ($x): bool {`
	`33`	`+ return !\is_int($x);`
	`34`	`+ });`
	`35`	`+ if ($notIntValues) {`
`30`	`36`	`throw new \DomainException('Invalid baseline data');`
`31`	`37`	`}`
`32`	`38`
`@@ -42,7 +48,10 @@ private function getBaseline(): array`
`42`	`48`	`throw new \RuntimeException(sprintf('Code coverage baseline "%s" does not exist.', $this->path));`
`43`	`49`	`}`
`44`	`50`
`45`		`- $baseline = json_decode((string) file_get_contents($this->path), true, 512, JSON_THROW_ON_ERROR);`
	`51`	`+ $baseline = json_decode((string) file_get_contents($this->path), true);`
	`52`	`+ if (json_last_error()) {`
	`53`	`+ throw new \LogicException(json_last_error_msg());`
	`54`	`+ }`
`46`	`55`	`if (!\is_array($baseline)) {`
`47`	`56`	`throw new \DomainException('Cannot read baseline');`
`48`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,10 @@`
`8`	`8`
`9`	`9`	`final class CloverReader`
`10`	`10`	`{`
`11`		`- private string $path;`
	`11`	`+ /**`
	`12`	`+ * @var string`
	`13`	`+ */`
	`14`	`+ private $path;`
`12`	`15`
`13`	`16`	`public function __construct(string $path)`
`14`	`17`	`{`