Merge pull request #90 from sasezaki/php74cs

Update codebase to PHP 7.4

Author: sasezaki

composer.json

@@ -13,7 +13,7 @@
         "struggle-for-php/sfp-stubs-psr-log": "^1.0.1 || ^2 || ^3.0.1"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "^2.5.0",
+        "laminas/laminas-coding-standard": "^3",
         "maglnet/composer-require-checker": "^3 || ^4.15",
         "phpstan/phpstan-phpunit": "^2.0.7",
         "phpstan/phpstan-strict-rules": "^2.0.7",

example/src/Example.php

@@ -5,6 +5,7 @@
 namespace src;
 
 use Psr\Log\LoggerInterface;
+use Throwable;
 
 use function sprintf;
 
@@ -19,8 +20,7 @@ public function __construct(LoggerInterface $logger)
     }
 
     public function exceptionKeyOnlyAllowThrowable(
-		// phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-        \Throwable $throwable
+        Throwable $throwable
     ): void {
         // invalid
         $this->logger->notice('foo', ['exception' => $throwable->getMessage()]);
@@ -31,8 +31,7 @@ public function exceptionKeyOnlyAllowThrowable(
     }
 
     public function mustIncludesCurrentScopeThrowableIntoContext(
-		// phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-        \Throwable $throwable
+        Throwable $throwable
     ): void {
         // Parameter $context of logger method Psr\Log\LoggerInterface::info() requires 'exception' key. Current scope has Throwable variable - $throwable
         $this->logger->notice('foo');
@@ -41,8 +40,7 @@ public function mustIncludesCurrentScopeThrowableIntoContext(
     }
 
     public function reportContextExceptionLogLevel(
-		// phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-        \Throwable $throwable
+        Throwable $throwable
     ): void {
         // phpstan.enableContextTypeRule.neon sfpPsrLog.reportContextExceptionLogLevel is 'notice'
         // so bellow would not report.

phpcs.xml

@@ -13,6 +13,7 @@
 	<arg value="p"/>
 
 	<!-- Paths to check -->
+	<file>example/src</file>
 	<file>src</file>
 	<file>test</file>
 
@@ -22,8 +23,11 @@
 	<!-- Include all rules from Laminas Coding Standard -->
 	<rule ref="LaminasCodingStandard">
 		<exclude name="SlevomatCodingStandard.Commenting.ForbiddenAnnotations" />
+		<exclude name="Squiz.WhiteSpace.LanguageConstructSpacing" />
 	</rule>
 
+	<rule ref="Generic.WhiteSpace.LanguageConstructSpacing" />
+
 	<rule ref="PSR12">
 		<exclude name="Generic.Files.LineLength"/>
 		<exclude name="WebimpressCodingStandard.Formatting.StringClassReference" />

src/Rules/ContextKeyRule.php

@@ -8,9 +8,11 @@
 use Override;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\ObjectType;
 
 use function count;
@@ -29,8 +31,7 @@ final class ContextKeyRule implements Rule
 
     private const ERROR_NOT_MATCH_ORIGINAL_PATTERN = 'Parameter $context of logger method Psr\Log\LoggerInterface::%s(), key should be match %s.';
 
-    /** @var string|null */
-    private $contextKeyOriginalPattern;
+    private ?string $contextKeyOriginalPattern;
 
     public function __construct(?string $contextKeyOriginalPattern = null)
     {
@@ -109,10 +110,8 @@ public function processNode(Node $node, Scope $scope): array
     }
 
     /**
-     * phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-     * @phpstan-param list<\PHPStan\Type\Constant\ConstantArrayType> $constantArrays
-     * phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-     * @phpstan-return list<\PHPStan\Rules\IdentifierRuleError>
+     * @phpstan-param list<ConstantArrayType> $constantArrays
+     * @phpstan-return list<IdentifierRuleError>
      */
     private static function keysAreNonEmptyString(array $constantArrays, string $methodName): array
     {
@@ -133,10 +132,8 @@ private static function keysAreNonEmptyString(array $constantArrays, string $met
     }
 
     /**
-     * phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-     * @phpstan-param list<\PHPStan\Type\Constant\ConstantArrayType> $constantArrays
-     * phpcs:ignore SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
-     * @phpstan-return list<\PHPStan\Rules\IdentifierRuleError>
+     * @phpstan-param list<ConstantArrayType> $constantArrays
+     * @phpstan-return list<IdentifierRuleError>
      */
     private function originalPatternMatches(array $constantArrays, string $methodName): array
     {

src/Rules/ContextRequireExceptionKeyRule.php

@@ -36,9 +36,10 @@ final class ContextRequireExceptionKeyRule implements Rule
 
     private const ERROR_MISSED_EXCEPTION_KEY = 'Parameter $context of logger method Psr\Log\LoggerInterface::%s() requires \'exception\' key. Current scope has Throwable variable - %s';
 
-    /** @var string */
-    private $reportContextExceptionLogLevel;
+    /** @var value-of<LogLevelListInterface::LOGGER_LEVEL_METHODS> */
+    private string $reportContextExceptionLogLevel;
 
+    /** @param value-of<LogLevelListInterface::LOGGER_LEVEL_METHODS> $reportContextExceptionLogLevel */
     public function __construct(string $reportContextExceptionLogLevel = 'debug')
     {
         $this->reportContextExceptionLogLevel = $reportContextExceptionLogLevel;

src/Rules/ContextTypeRule.php

@@ -25,11 +25,9 @@
  */
 final class ContextTypeRule implements Rule
 {
-    /** @var RuleLevelHelper */
-    private $ruleLevelHelper;
+    private RuleLevelHelper $ruleLevelHelper;
 
-    /** @var ContextTypeProviderResolverInterface */
-    private $contextTypeProviderResolver;
+    private ContextTypeProviderResolverInterface $contextTypeProviderResolver;
 
     public function __construct(
         RuleLevelHelper $ruleLevelHelper,

src/Rules/LogMethodLevelRule.php

@@ -27,11 +27,9 @@ final class LogMethodLevelRule implements Rule
 Parameter #1 $level of method Psr\Log\LoggerInterface::log() expects %s, %s given.
 MESSAGE;
 
-    /** @var RuleLevelHelper */
-    private $ruleLevelHelper;
+    private RuleLevelHelper $ruleLevelHelper;
 
-    /** @var UnionType */
-    private $acceptingLogLevel;
+    private UnionType $acceptingLogLevel;
 
     public function __construct(RuleLevelHelper $ruleLevelHelper)
     {

src/TypeProvider/BigQueryContextTypeProvider.php

@@ -25,14 +25,12 @@
  */
 final class BigQueryContextTypeProvider implements ContextTypeProviderInterface
 {
-    /** @var string */
-    private $schemaFile;
+    private string $schemaFile;
 
-    /** @var TableFieldSchemaJsonPayloadTypeMapperInterface */
-    private $tableFieldSchemaJsonPayloadTypeMapper;
+    private TableFieldSchemaJsonPayloadTypeMapperInterface $tableFieldSchemaJsonPayloadTypeMapper;
 
     /** @phpstan-var ?list<schema_item> */
-    private $jsonPayloadFields;
+    private ?array $jsonPayloadFields = null;
 
     public function __construct(
         string $schemaFile,
@@ -96,7 +94,6 @@ private function getJsonPayloadFields(): array
                 throw new Exception('schemaFile must have jsonPayload field');
             }
 
-            // phpcs:ignore
             /**
              * @todo validate list<schema_item>
              * @phpstan-var list<schema_item> $jsonPayloadFields

src/TypeProvider/Psr3ContextTypeProvider.php

@@ -13,9 +13,10 @@
 
 final class Psr3ContextTypeProvider implements ContextTypeProviderInterface
 {
-    /** @var string */
-    private $exceptionClass;
+    /** @var class-string */
+    private string $exceptionClass;
 
+    /** @param class-string $exceptionClass */
     public function __construct(string $exceptionClass = Throwable::class)
     {
         $this->exceptionClass = $exceptionClass;

src/TypeProviderResolver/AnyScopeContextTypeProviderResolver.php

@@ -10,8 +10,7 @@
 
 final class AnyScopeContextTypeProviderResolver implements ContextTypeProviderResolverInterface
 {
-    /** @var ContextTypeProviderInterface */
-    private $contextTypeProvider;
+    private ContextTypeProviderInterface $contextTypeProvider;
     public function __construct(ContextTypeProviderInterface $contextTypeProvider)
     {
         $this->contextTypeProvider = $contextTypeProvider;