Adjusted handling of internal doc comment detection

In BetterReflection v6, `#getDocComment()` returns `null` for missing docblocks.
uzibhalepu · Oct 10, 2022 · 5082a4a · 5082a4a
1 parent 71361c3
commit 5082a4a
Show file tree

Hide file tree

Showing 12 changed files with 36 additions and 24 deletions.
diff --git a/src/CompareClasses.php b/src/CompareClasses.php
@@ -92,8 +92,9 @@ private function examineSymbol(
         yield from ($this->classBasedComparisons)($oldSymbol, $newClass);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/ClassBased/ClassBecameInternal.php b/src/DetectChanges/BCBreak/ClassBased/ClassBecameInternal.php
@@ -32,8 +32,9 @@ public function __invoke(ReflectionClass $fromClass, ReflectionClass $toClass):
         return Changes::empty();
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/ClassBased/ExcludeInternalClass.php b/src/DetectChanges/BCBreak/ClassBased/ExcludeInternalClass.php
@@ -26,8 +26,9 @@ public function __invoke(ReflectionClass $fromClass, ReflectionClass $toClass):
         return ($this->check)($fromClass, $toClass);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/ClassBased/MethodRemoved.php b/src/DetectChanges/BCBreak/ClassBased/MethodRemoved.php
@@ -58,8 +58,9 @@ private function accessibleMethods(ReflectionClass $class): array
         );
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/ClassBased/PropertyRemoved.php b/src/DetectChanges/BCBreak/ClassBased/PropertyRemoved.php
@@ -50,8 +50,9 @@ private function accessibleProperties(ReflectionClass $class): array
         });
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/FunctionBased/ExcludeInternalFunction.php b/src/DetectChanges/BCBreak/FunctionBased/ExcludeInternalFunction.php
@@ -29,8 +29,9 @@ public function __invoke(
         return ($this->check)($fromFunction, $toFunction);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/FunctionBased/FunctionBecameInternal.php b/src/DetectChanges/BCBreak/FunctionBased/FunctionBecameInternal.php
@@ -43,8 +43,9 @@ public function __invoke(
         return Changes::empty();
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/InterfaceBased/ExcludeInternalInterface.php b/src/DetectChanges/BCBreak/InterfaceBased/ExcludeInternalInterface.php
@@ -26,8 +26,9 @@ public function __invoke(ReflectionClass $fromInterface, ReflectionClass $toInte
         return ($this->check)($fromInterface, $toInterface);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/MethodBased/ExcludeInternalMethod.php b/src/DetectChanges/BCBreak/MethodBased/ExcludeInternalMethod.php
@@ -26,8 +26,9 @@ public function __invoke(ReflectionMethod $fromMethod, ReflectionMethod $toMetho
         return ($this->check)($fromMethod, $toMethod);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/PropertyBased/ExcludeInternalProperty.php b/src/DetectChanges/BCBreak/PropertyBased/ExcludeInternalProperty.php
@@ -23,8 +23,9 @@ public function __invoke(ReflectionProperty $fromProperty, ReflectionProperty $t
         return ($this->propertyBased)($fromProperty, $toProperty);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/PropertyBased/PropertyBecameInternal.php b/src/DetectChanges/BCBreak/PropertyBased/PropertyBecameInternal.php
@@ -40,8 +40,9 @@ public function __invoke(ReflectionProperty $fromProperty, ReflectionProperty $t
         return Changes::empty();
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }
diff --git a/src/DetectChanges/BCBreak/TraitBased/ExcludeInternalTrait.php b/src/DetectChanges/BCBreak/TraitBased/ExcludeInternalTrait.php
@@ -26,8 +26,9 @@ public function __invoke(ReflectionClass $fromTrait, ReflectionClass $toTrait):
         return ($this->check)($fromTrait, $toTrait);
     }
 
-    private function isInternalDocComment(string $comment): bool
+    private function isInternalDocComment(string|null $comment): bool
     {
-        return Regex\matches($comment, '/\s+@internal\s+/');
+        return $comment !== null
+            && Regex\matches($comment, '/\s+@internal\s+/');
     }
 }