Adding rst-support

Author: mamazu

.travis.yml

@@ -19,3 +19,4 @@ script:
   - vendor/bin/phpstan analyse
   - vendor/bin/phpspec run --format dot -vvv --no-interaction
   - bin/doc-parser tests/test.md
+  - bin/doc-parser tests/test.rst

bin/doc-parser

@@ -14,11 +14,13 @@ if(file_exists($autoloadPath)) {
     include __DIR__.'/../../../autoload.php';
 }
 
+use Gregwar\RST\Parser;
 use Mamazu\DocumentationParser\Application;
 use Mamazu\DocumentationParser\CLI;
 use Mamazu\DocumentationParser\FileList;
 use Mamazu\DocumentationParser\Output\TextFormatter;
 use Mamazu\DocumentationParser\Parser\Parser\MarkdownParser;
+use Mamazu\DocumentationParser\Parser\Parser\RstParser;
 use Mamazu\DocumentationParser\Validator\CompositeValidator;
 use Mamazu\DocumentationParser\Validator\Php\PhpClassExistsValidator;
 use Mamazu\DocumentationParser\Validator\XML\XMLValidValidator;
@@ -34,6 +36,7 @@ $formatter = new TextFormatter();
 $application = new Application(
     [
         new MarkdownParser(),
+        new RstParser(new Parser()),
     ],
     [
         'php' =>

composer.json

@@ -17,7 +17,8 @@
 
         "thecodingmachine/safe": "^0.1.16",
         "nikic/php-parser": "^4.2",
-        "symfony/yaml": "^4"
+        "symfony/yaml": "^4",
+        "gregwar/rst": "dev-line-numbers"
     },
     "require-dev": {
         "phpspec/phpspec": "^5.1|^6.0",
@@ -43,5 +44,11 @@
             "vendor/bin/phpstan analyse"
         ]
     },
-    "bin": [ "bin/doc-parser" ]
+    "bin": [ "bin/doc-parser" ],
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/mamazu/RST/"
+        }
+    ]
 }

spec/Mamazu/DocumentationParser/Parser/Parser/RstParserSpec.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace spec\Mamazu\DocumentationParser\Parser\Parser;
+
+use Gregwar\RST\Document;
+use Gregwar\RST\Environment;
+use Gregwar\RST\ErrorManager;
+use Gregwar\RST\HTML\Nodes\CodeNode;
+use Gregwar\RST\Parser;
+use Mamazu\DocumentationParser\Parser\Parser\ParserInterface;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class RstParserSpec extends ObjectBehavior
+{
+    public function let(Parser $parser): void
+    {
+        $this->beConstructedWith($parser);
+    }
+
+    public function it_is_a_parser(): void
+    {
+        $this->shouldImplement(ParserInterface::class);
+    }
+
+    public function it_only_allows_rst_files(): void
+    {
+        $this->canParse('docs.rst')->shouldReturn(true);
+        $this->canParse('hello.py')->shouldReturn(false);
+        $this->canParse('hello.RsT')->shouldReturn(true);
+    }
+
+    public function it_parses_code_blocks(
+        Parser $parser,
+        Document $document,
+        Environment $environment,
+        ErrorManager $errorManager,
+        CodeNode $codeNode
+    ): void
+    {
+        $parser->getEnvironment()->willReturn($environment);
+        $environment->getErrorManager()->willReturn($errorManager);
+
+        $errorManager->abortOnError(false)->shouldBeCalled();
+
+        $parser->parseFile('documentation.rst')->shouldBeCalled()->willReturn($document);
+        $document->getNodes(Argument::type(\Closure::class))->willReturn([ $codeNode ]);
+        $codeNode->getValue()->willReturn('echo "PHP";');
+        $codeNode->getStartingLineNumber()->willReturn(12);
+        $codeNode->getLanguage()->willReturn('php');
+
+        $result = $this->parse('documentation.rst');
+        $result->shouldHaveCount(1);
+        $result[0]->getFileName()->shouldBe('documentation.rst');
+        $result[0]->getContent()->shouldBe('echo "PHP";');
+        $result[0]->getRelativeLineNumber()->shouldBe(12);
+        $result[0]->getType()->shouldBe('php');
+    }
+}

src/Parser/Parser/RstParser.php

@@ -0,0 +1,52 @@
+<?php
+
+
+namespace Mamazu\DocumentationParser\Parser\Parser;
+
+use Gregwar\RST\Nodes\CodeNode;
+use Gregwar\RST\Nodes\Node;
+use Gregwar\RST\Parser;
+use Mamazu\DocumentationParser\Parser\Block;
+
+class RstParser implements ParserInterface
+{
+    /** @var Parser */
+    private $rstParser;
+
+    public function __construct(Parser $parser)
+    {
+        $this->rstParser = $parser;
+    }
+
+    public function canParse(string $fileName): bool
+    {
+        return strtolower(substr($fileName, -3)) === 'rst';
+    }
+
+    public function parse(string $fileName): array
+    {
+        $this->rstParser->getEnvironment()->getErrorManager()->abortOnError(false);
+        $parsedOutput = $this->rstParser->parseFile($fileName);
+
+        /** @var CodeNode[] $codeNodes */
+        $codeNodes = $parsedOutput->getNodes(
+            static function (Node $node) { return $node instanceof CodeNode; }
+        );
+
+        $blocks = [];
+        foreach($codeNodes as $codeNode) {
+            if($codeNode->getLanguage() === null) {
+                continue;
+            }
+
+            $blocks[] = new Block(
+                $fileName,
+                $codeNode->getValue(),
+                $codeNode->getStartingLineNumber(),
+                $codeNode->getLanguage()
+            );
+        }
+
+        return $blocks;
+    }
+}

tests/test.rst

@@ -0,0 +1,20 @@
+Hello world
+===========
+
+What is it?
+----------
+This is a **RST** document!
+
+Where can I get it?
+-------------------
+You can get it on the `GitHub page <https://github.com/Gregwar/RST>`_
+
+
+.. code-block:: php
+   :linenos:
+   :encoding: utf-8
+
+   <?php
+    echo "Hello world";
+
+I was just about to get angry