Support php8 by removing safe library (#39)

ttomdewit · web-flow · commit 831ac87c037e · 2021-07-02T08:50:44.000+02:00
* Add PHP8 to PHP matrix

* Update Phan to ^4.0 for PHP8 support

* Update PHPUnit to latest version for code coverage to work with PHP8

* Re-implement Safe methods and ignore them in code coverage, strenghten CI runs with PHPUnit and Infection and make sure 100% is minimum requirement

* Run PHPUnit and Infection in one go so XML files are available to Infection

* Inline Exceptions and remove static method and update PHP-CS-Fixer
diff --git a/.github/workflows/actions.yaml b/.github/workflows/actions.yaml
@@ -16,6 +16,7 @@ jobs:
         php:
           - 7.3
           - 7.4
+          - 8.0
         suite:
           - php-cs-fixer-ci
           - phplint
diff --git a/.gitignore b/.gitignore
@@ -6,4 +6,6 @@ coverage
 .idea
 .phpunit.result.cache
 .phplint-cache
-.php_cs.cache
+.php_cs.cache
+code-climate.json
+infection.log
diff --git a/.php_cs b/.php_cs
@@ -15,6 +15,7 @@ return PhpCsFixer\Config::create()
         'multiline_whitespace_before_semicolons' => [
             'strategy' => 'no_multi_line',
         ],
+        'global_namespace_import' => true,
     ])
     ->setFinder(PhpCsFixer\Finder::create()
         ->exclude('vendor')
diff --git a/composer.json b/composer.json
@@ -27,23 +27,20 @@
         }
     ],
     "require": {
-        "php": "^7.3",
+        "php": "^7.3|^8.0",
         "ext-json": "*",
         "phlak/config": "^7.0",
-        "symfony/console": "^4.0|^5.0",
-        "thecodingmachine/safe": "^1.0"
+        "symfony/console": "^4.0|^5.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",
         "infection/infection": "^0.18.2",
         "overtrue/phplint": "^1.2",
-        "phan/phan": "^2.4",
+        "phan/phan": "^4.0",
         "phpstan/phpstan": "^0.12.7",
-        "phpunit/phpunit": "^8.0",
-        "rector/rector": "^0.6.13",
+        "phpunit/phpunit": "^9.0",
         "rregeer/phpunit-coverage-check": "^0.3.1",
         "squizlabs/php_codesniffer": "^3.5",
-        "thecodingmachine/phpstan-safe-rule": "^1.0",
         "vimeo/psalm": "^3.8"
     },
     "bin": [
@@ -61,8 +58,15 @@
     },
     "scripts": {
         "phpunit": "vendor/bin/phpunit",
-        "infection": "vendor/bin/infection",
-        "infection-ci": "XDEBUG_MODE=coverage vendor/bin/infection",
+        "phpunit-ci": "vendor/bin/phpunit && vendor/bin/coverage-check build/coverage/clover.xml 100",
+        "infection": [
+            "phpunit",
+            "vendor/bin/infection --coverage=build/coverage"
+        ],
+        "infection-ci": [
+            "phpunit",
+            "XDEBUG_MODE=coverage vendor/bin/infection --coverage=build/coverage --min-msi=100 --min-covered-msi=100"
+        ],
         "phpstan": "vendor/bin/phpstan analyse src --level max",
         "psalm": "vendor/bin/psalm src",
         "phplint": "vendor/bin/phplint src",
@@ -71,7 +75,6 @@
         "php-cbf": "vendor/bin/phpcbf src --standard=PSR1,PSR2,PSR12",
         "php-cs": "vendor/bin/phpcs src --standard=PSR1,PSR2,PSR12",
         "phan": "vendor/bin/phan --allow-polyfill-parser src",
-        "rector-safe": "vendor/bin/rector process src/ --config vendor/thecodingmachine/safe/rector-migrate-0.6.yml",
         "docker-build": "docker build -t converter ."
     },
     "config": {
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         bootstrap="vendor/autoload.php"
          backupGlobals="false"
          backupStaticAttributes="false"
          colors="true"
@@ -8,15 +9,23 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="true">
+         stopOnFailure="true"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage>
+        <include>
+            <directory suffix=".php">src/</directory>
+        </include>
+        <report>
+            <xml outputDirectory="build/coverage/coverage-xml"/>
+            <clover outputFile="build/coverage/clover.xml"/>
+        </report>
+    </coverage>
     <testsuites>
         <testsuite name="Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
+    <logging>
+        <junit outputFile="build/coverage/junit.xml"/>
+    </logging>
 </phpunit>
diff --git a/src/AbstractConverter.php b/src/AbstractConverter.php
@@ -12,6 +12,7 @@
 use BeechIt\JsonToCodeClimateSubsetConverter\Interfaces\OutputInterface;
 use BeechIt\JsonToCodeClimateSubsetConverter\Interfaces\SafeMethodsInterface;
 use function debug_backtrace;
+use LogicException;
 use Safe\Exceptions\JsonException;
 use Safe\Exceptions\StringsException;
 
@@ -53,7 +54,7 @@ public function __construct(
         $constructingClass = $backtrace[1]['class'];
 
         if (ConverterFactory::class !== $constructingClass) {
-            throw new \LogicException('Converter was not built via it\'s factory');
+            throw new LogicException('Converter was not built via it\'s factory');
         }
 
         $this->abstractJsonValidator = $abstractJsonValidator;
diff --git a/src/AbstractJsonValidator.php b/src/AbstractJsonValidator.php
@@ -8,6 +8,7 @@
 use BeechIt\JsonToCodeClimateSubsetConverter\Factories\ValidatorFactory;
 use BeechIt\JsonToCodeClimateSubsetConverter\Interfaces\JsonValidatorInterface;
 use function debug_backtrace;
+use LogicException;
 
 abstract class AbstractJsonValidator implements JsonValidatorInterface
 {
@@ -29,7 +30,7 @@ public function __construct($json)
         $constructingClass = $backtrace[1]['class'];
 
         if (ValidatorFactory::class !== $constructingClass) {
-            throw new \LogicException('Validator was not built via it\'s factory');
+            throw new LogicException('Validator was not built via it\'s factory');
         }
 
         $this->json = $json;
diff --git a/src/Exceptions/FilesystemException.php b/src/Exceptions/FilesystemException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
+
+use ErrorException;
+
+/**
+ * @codeCoverageIgnore
+ */
+class FilesystemException extends ErrorException
+{
+}
diff --git a/src/Exceptions/InvalidJsonException.php b/src/Exceptions/InvalidJsonException.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class InvalidJsonException extends \Exception
+use Exception;
+
+class InvalidJsonException extends Exception
 {
 }
diff --git a/src/Exceptions/JsonException.php b/src/Exceptions/JsonException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
+
+use Exception;
+
+/**
+ * @codeCoverageIgnore
+ */
+class JsonException extends Exception
+{
+}
diff --git a/src/Exceptions/NoConvertersEnabledException.php b/src/Exceptions/NoConvertersEnabledException.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class NoConvertersEnabledException extends \Exception
+use Exception;
+
+class NoConvertersEnabledException extends Exception
 {
 }
diff --git a/src/Exceptions/NoValidatorsEnabledException.php b/src/Exceptions/NoValidatorsEnabledException.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class NoValidatorsEnabledException extends \Exception
+use Exception;
+
+class NoValidatorsEnabledException extends Exception
 {
 }
diff --git a/src/Exceptions/StringsException.php b/src/Exceptions/StringsException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
+
+use ErrorException;
+
+/**
+ * @codeCoverageIgnore
+ */
+class StringsException extends ErrorException
+{
+}
diff --git a/src/Exceptions/UnableToAddOption.php b/src/Exceptions/UnableToAddOption.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToAddOption extends \Exception
+use Exception;
+
+class UnableToAddOption extends Exception
 {
 }
diff --git a/src/Exceptions/UnableToCreateDescription.php b/src/Exceptions/UnableToCreateDescription.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToCreateDescription extends \Exception
+use Exception;
+
+class UnableToCreateDescription extends Exception
 {
 }
diff --git a/src/Exceptions/UnableToCreateFilenameException.php b/src/Exceptions/UnableToCreateFilenameException.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToCreateFilenameException extends \Exception
+use Exception;
+
+class UnableToCreateFilenameException extends Exception
 {
 }
diff --git a/src/Exceptions/UnableToCreateFingerprint.php b/src/Exceptions/UnableToCreateFingerprint.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToCreateFingerprint extends \Exception
+use Exception;
+
+class UnableToCreateFingerprint extends Exception
 {
 }
diff --git a/src/Exceptions/UnableToGetJsonEncodedOutputException.php b/src/Exceptions/UnableToGetJsonEncodedOutputException.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToGetJsonEncodedOutputException extends \Exception
+use Exception;
+
+class UnableToGetJsonEncodedOutputException extends Exception
 {
 }
diff --git a/src/Exceptions/UnableToWriteOutputLine.php b/src/Exceptions/UnableToWriteOutputLine.php
@@ -4,6 +4,8 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;
 
-class UnableToWriteOutputLine extends \Exception
+use Exception;
+
+class UnableToWriteOutputLine extends Exception
 {
 }
diff --git a/src/Interfaces/SafeMethodsInterface.php b/src/Interfaces/SafeMethodsInterface.php
@@ -4,9 +4,9 @@
 
 namespace BeechIt\JsonToCodeClimateSubsetConverter\Interfaces;
 
-use Safe\Exceptions\FilesystemException;
-use Safe\Exceptions\JsonException;
-use Safe\Exceptions\StringsException;
+use BeechIt\JsonToCodeClimateSubsetConverter\Exceptions\FilesystemException;
+use BeechIt\JsonToCodeClimateSubsetConverter\Exceptions\JsonException;
+use BeechIt\JsonToCodeClimateSubsetConverter\Exceptions\StringsException;
 
 interface SafeMethodsInterface
 {
@@ -17,7 +17,7 @@ interface SafeMethodsInterface
     const FILE_PUT_CONTENTS_FLAGS = 0;
 
     /**
-     * @param $value
+     * @param mixed $value
      *
      * @throws JsonException
      */
@@ -51,18 +51,24 @@ public function sprintf(string $format, ...$params): string;
      * @param null  $context
      *
      * @throws FilesystemException
-     *
-     * @return mixed
      */
     public function file_put_contents(
         string $filename,
         $data,
         int $flags = self::FILE_PUT_CONTENTS_FLAGS,
         $context = null
-    );
+    ): int;
 
     /**
-     * @return mixed
+     * @param null $context
+     *
+     * @throws FilesystemException
      */
-    public function file_get_contents(string $filename);
+    public function file_get_contents(
+        string $filename,
+        bool $use_include_path = false,
+        $context = null,
+        int $offset = 0,
+        int $maxlen = null
+    ): string;
 }
diff --git a/src/Utilities/SafeMethods.php b/src/Utilities/SafeMethods.php
diff --git a/tests/PHPLint/PhpLintConverterTest.php b/tests/PHPLint/PhpLintConverterTest.php
diff --git a/tests/PHPLint/PhpLintValidationTest.php b/tests/PHPLint/PhpLintValidationTest.php

-Original file line number
+Diff line change
         php:
           - 7.3
           - 7.4
 +          - 8.0
         suite:
           - php-cs-fixer-ci
           - phplint
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`	`use BeechIt\JsonToCodeClimateSubsetConverter\Factories\ValidatorFactory;`
`9`	`9`	`use BeechIt\JsonToCodeClimateSubsetConverter\Interfaces\JsonValidatorInterface;`
`10`	`10`	`use function debug_backtrace;`
	`11`	`+use LogicException;`
`11`	`12`
`12`	`13`	`abstract class AbstractJsonValidator implements JsonValidatorInterface`
`13`	`14`	`{`
`@@ -29,7 +30,7 @@ public function __construct($json)`
`29`	`30`	`$constructingClass = $backtrace[1]['class'];`
`30`	`31`
`31`	`32`	`if (ValidatorFactory::class !== $constructingClass) {`
`32`		`- throw new \LogicException('Validator was not built via it\'s factory');`
	`33`	`+ throw new LogicException('Validator was not built via it\'s factory');`
`33`	`34`	`}`
`34`	`35`
`35`	`36`	`$this->json = $json;`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace BeechIt\JsonToCodeClimateSubsetConverter\Exceptions;`
`6`	`6`
`7`		`-class InvalidJsonException extends \Exception`
	`7`	`+use Exception;`
	`8`	`+`
	`9`	`+class InvalidJsonException extends Exception`
`8`	`10`	`{`
`9`	`11`	`}`