inline docblock is now supported: /** @Alpha @beta @gama */

more parser optimizations closes #15
marcioAlmada · Dec 3, 2013 · aba3c56 · aba3c56
1 parent c440592
commit aba3c56
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 10 deletions.
diff --git a/src/Minime/Annotations/Parser.php b/src/Minime/Annotations/Parser.php
@@ -58,23 +58,28 @@ public function parse()
         $identifier = $this->rules->getAnnotationIdentifier();
         $pattern = '/\\'.$identifier.$this->rules->getAnnotationNameRegex().'/';
         $types_pattern = '/('.implode('|', $this->types).')/';
-        $lines = array_map('rtrim', explode("\n", $this->raw_doc_block));
+        $lines = array_map('trim', explode("\n", $this->raw_doc_block));
         array_walk(
             $lines,
-            function ($line) use (&$parameters, $identifier, $pattern, $types_pattern) {
-                $line = new StringScanner($line);
-                $line->skip('/\s+\*\s+/');
+            function ($line_string) use (&$parameters, $identifier, $pattern, $types_pattern) {
+                $line = new StringScanner($line_string);
+                if (! $line->skip('/(\*\s*)/')) { // tries to skip *s
+                    if ($line->skip('/(\/\*{2}\s*)/')) { // tries to skip /**s
+                        $remainder = trim(str_replace('*/', '', $line->getRemainder()));
+                        $line = new StringScanner($remainder);
+                    } else {
+                        $line->terminate(); // terminates earlier in case none of the skip strategies work
+                    }
+                }
                 while (! $line->hasTerminated()) {
+
                     $key = $line->scan($pattern);
-                    if (! $key) { // next line when no annotation is found
+                    if (null === $key) { // next line when no annotation is found
                         $line->terminate();
                         continue;
                     }
 
                     $key = substr($key, strlen($identifier));
-                    if (! array_key_exists($key, $parameters)) {
-                        $parameters[$key] = [];
-                    }
 
                     $line->skip('/\s+/');
                     if ('' == $line->peek() || $line->check('/\\'.$identifier.'/')) { // if implicit boolean
@@ -83,10 +88,11 @@ function ($line) use (&$parameters, $identifier, $pattern, $types_pattern) {
                     }
 
                     $type = 'dynamic';
-                    if ($line->check($types_pattern)) { //if strong typed
+                    if ($line->check($types_pattern)) { // if strong typed
                         $type = $line->scan('/\w+/');
                         $line->skip('/\s+/');
                     }
+
                     $parameters[$key][] = self::parseValue($line->getRemainder(), $type);
                 }
             }
@@ -144,7 +150,7 @@ protected static function parseDynamic($value)
     }
 
     /**
-     * Parse a given value
+     * Parse a given valueas string
      * @param string $value
      *
      * @return scalar|object

diff --git a/test/lib/Minime/Annotations/Fixtures/AnnotationsFixture.php b/test/lib/Minime/Annotations/Fixtures/AnnotationsFixture.php
@@ -147,6 +147,15 @@ class AnnotationsFixture
      */
     private $namespaced_fixture;
 
+    /** @value foo */
+    private $inline_docblock_fixture;
+
+    /** @alpha */
+    private $inline_docblock_implicit_boolean_fixture;
+
+    /** @alpha @beta @gama */
+    private $inline_docblock_multiple_implicit_boolean_fixture;
+
     /**
      * @get @post @ajax
      * @postParam x

diff --git a/test/suite/Minime/Annotations/ParserTest.php b/test/suite/Minime/Annotations/ParserTest.php
@@ -216,6 +216,23 @@ public function tolerateUnrecognizedTypes()
         $this->assertEquals("footype Tolerate me. DockBlocks can't be evaluated rigidly.", $annotations['value']);
     }
 
+    /**
+     * @test
+     */
+    public function parseInlineDocblocks()
+    {
+        $annotations = $this->getParser('inline_docblock_fixture')->parse();
+        $this->assertSame('foo', $annotations['value']);
+
+        $annotations = $this->getParser('inline_docblock_implicit_boolean_fixture')->parse();
+        $this->assertSame(true, $annotations['alpha']);
+
+        $annotations = $this->getParser('inline_docblock_multiple_implicit_boolean_fixture')->parse();
+        $this->assertSame(true, $annotations['alpha']);
+        $this->assertSame(true, $annotations['beta']);
+        $this->assertSame(true, $annotations['gama']);
+    }
+
     /**
      * @test
      * @expectedException Minime\Annotations\ParserException