Merge pull request php-annotations#100 from php-annotations/bug/99

Fix parsing of PHP file with annotations without context

Author: Alexander Obuhovich

src/annotations/AnnotationParser.php

@@ -69,7 +69,7 @@ public function parse($source, $path)
     {
         $index = array();
 
-        $annotations = array();
+        $docblocks = array();
         $state = self::SCAN;
         $nesting = 0;
         $class = null;
@@ -154,8 +154,8 @@ public function parse($source, $path)
                 case self::CLASS_NAME:
                     if ($type == T_STRING) {
                         $class = ($namespace ? $namespace . '\\' : '') . $str;
-                        $index[$class] = $annotations;
-                        $annotations = array();
+                        $index[$class] = $docblocks;
+                        $docblocks = array();
                         $state = self::SCAN_CLASS;
                     }
                     break;
@@ -171,8 +171,8 @@ public function parse($source, $path)
 
                 case self::MEMBER:
                     if ($type == T_VARIABLE) {
-                        $index[$class . '::' . $str] = $annotations;
-                        $annotations = array();
+                        $index[$class . '::' . $str] = $docblocks;
+                        $docblocks = array();
                         $state = self::SCAN_CLASS;
                     }
                     if ($type == T_FUNCTION) {
@@ -182,8 +182,8 @@ public function parse($source, $path)
 
                 case self::METHOD_NAME:
                     if ($type == T_STRING) {
-                        $index[$class . '::' . $str] = $annotations;
-                        $annotations = array();
+                        $index[$class . '::' . $str] = $docblocks;
+                        $docblocks = array();
                         $state = self::SCAN_CLASS;
                     }
                     break;
@@ -206,7 +206,7 @@ public function parse($source, $path)
             }
 
             if ($type == T_COMMENT || $type == T_DOC_COMMENT) {
-                $annotations = array_merge($annotations, $this->findAnnotations($str));
+                $docblocks[] = $str;
             }
 
             if ($type == T_CURLY_OPEN) {
@@ -223,14 +223,16 @@ public function parse($source, $path)
             echo '</table>';
         }
 
-        if (count($annotations)) {
-            throw new AnnotationException("Orphaned annotation(s) found at end of a file {$path}: " . implode(",\r", $annotations));
-        }
+        unset($docblocks);
 
         $code = "return array(\n";
         $code .= "  '#namespace' => " . var_export($namespace, true) . ",\n";
         $code .= "  '#uses' => " . var_export($uses, true) . ",\n";
-        foreach ($index as $key => $array) {
+        foreach ($index as $key => $docblocks) {
+            $array = array();
+            foreach ($docblocks as $str) {
+                $array = array_merge($array, $this->findAnnotations($str));
+            }
             if (count($array)) {
                 $code .= "  " . trim(var_export($key, true)) . " => array(\n    " . implode(
                     ",\n    ",

test/suite/Annotations.test.php

@@ -7,6 +7,7 @@
 use mindplay\annotations\AnnotationManager;
 use mindplay\annotations\Annotations;
 use mindplay\annotations\Annotation;
+use mindplay\annotations\standard\ReturnAnnotation;
 use mindplay\test\annotations\Package;
 use mindplay\test\lib\xTest;
 use mindplay\test\lib\xTestRunner;
@@ -811,6 +812,22 @@ public function testMalformedParamAnnotationThrowsException()
         Annotations::ofMethod('BrokenParamAnnotationClass', 'brokenParamAnnotation');
     }
 
+    protected function testOrphanedAnnotationsAreIgnored()
+    {
+        $manager = new AnnotationManager();
+        $manager->namespace = 'mindplay\test\Sample';
+        $manager->cache = false;
+
+        /** @var Annotation[] $annotations */
+        $annotations = $manager->getMethodAnnotations('mindplay\test\Sample\OrphanedAnnotations', 'someMethod');
+
+        $this->check(count($annotations) == 1, 'the @return annotation was found');
+        $this->check(
+            $annotations[0] instanceof ReturnAnnotation,
+            'the @return annotation has correct type'
+        );
+    }
+
 }
 
 return new AnnotationsTest;

test/suite/Sample/OrphanedAnnotations.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace mindplay\test\Sample;
+
+class OrphanedAnnotations
+{
+
+    /**
+     * Some method.
+     *
+     * @return void
+     */
+    public function someMethod()
+    {
+        $a = 5;
+
+        // @codeCoverageIgnoreStart
+        if (false) {
+            $a = 6;
+        }
+        // @codeCoverageIgnoreEnd
+
+        $a = 5;
+    }
+
+}