Merge pull request #189 from mglaman/improve-annotation-inspection

Use regex for better annotation key detection

Author: mglaman

src/Rules/Deprecations/ConfigEntityConfigExportRule.php

@@ -6,6 +6,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\ShouldNotHappenException;
 
 final class ConfigEntityConfigExportRule extends DeprecatedAnnotationsRuleBase
 {
@@ -23,8 +24,11 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         if ($annotation === null) {
             return [];
         }
-        $hasMatch = strpos($annotation->getPhpDocString(), 'config_export = {') === false;
-        if ($hasMatch) {
+        $hasMatch = preg_match('/config_export\s?=\s?{/', $annotation->getPhpDocString());
+        if ($hasMatch === false) {
+            throw new ShouldNotHappenException('Unexpected error when trying to run match on phpDoc string.');
+        }
+        if ($hasMatch === 0) {
             return [
                 'Configuration entity must define a `config_export` key. See https://www.drupal.org/node/2481909',
             ];

src/Rules/Deprecations/PluginAnnotationContextDefinitionsRule.php

@@ -6,6 +6,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\ShouldNotHappenException;
 
 final class PluginAnnotationContextDefinitionsRule extends DeprecatedAnnotationsRuleBase
 {
@@ -23,8 +24,11 @@ protected function doProcessNode(ClassReflection $reflection, Node\Stmt\Class_ $
         if ($annotation === null) {
             return [];
         }
-        $hasMatch = strpos($annotation->getPhpDocString(), 'context = {') !== false;
-        if ($hasMatch) {
+        $hasMatch = preg_match('/context\s?=\s?{/', $annotation->getPhpDocString());
+        if ($hasMatch === false) {
+            throw new ShouldNotHappenException('Unexpected error when trying to run match on phpDoc string.');
+        }
+        if ($hasMatch === 1) {
             return [
                 'Providing context definitions via the "context" key is deprecated in Drupal 8.7.x and will be removed before Drupal 9.0.0. Use the "context_definitions" key instead.',
             ];