handle-legacy-doc

Author: nikophil

src/Directive/GlossaryDirective.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace SymfonyDocsBuilder\Directive;
+
+use Doctrine\RST\Directives\SubDirective;
+
+class GlossaryDirective extends SubDirective
+{
+    public function getName() : string
+    {
+        return 'glossary';
+    }
+}

src/KernelFactory.php

@@ -60,6 +60,7 @@ private static function getDirectives(): array
             new SymfonyDirectives\WarningDirective(),
             new SymfonyDirectives\VersionAddedDirective(),
             new SymfonyDirectives\BestPracticeDirective(),
+            new SymfonyDirectives\GlossaryDirective(),
         ];
     }
 
@@ -72,6 +73,10 @@ private static function getReferences(BuildContext $buildContext): array
             new SymfonyReferences\PhpFunctionReference($buildContext->getPhpDocUrl()),
             new SymfonyReferences\PhpMethodReference($buildContext->getPhpDocUrl()),
             new SymfonyReferences\PhpClassReference($buildContext->getPhpDocUrl()),
+            new SymfonyReferences\TermReference(),
+            new SymfonyReferences\LeaderReference(),
+            new SymfonyReferences\MergerReference(),
+            new SymfonyReferences\DeciderReference(),
         ];
     }
 }

src/Reference/DeciderReference.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SymfonyDocsBuilder\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\References\Reference;
+use Doctrine\RST\References\ResolvedReference;
+
+class DeciderReference extends Reference
+{
+    public function getName(): string
+    {
+        return 'decider';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        return new ResolvedReference(
+            $environment->getCurrentFileName(),
+            $data,
+            '#'
+        );
+    }
+}

src/Reference/LeaderReference.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SymfonyDocsBuilder\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\References\Reference;
+use Doctrine\RST\References\ResolvedReference;
+
+class LeaderReference extends Reference
+{
+    public function getName(): string
+    {
+        return 'leader';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        return new ResolvedReference(
+            $environment->getCurrentFileName(),
+            $data,
+            '#'
+        );
+    }
+}

src/Reference/MergerReference.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SymfonyDocsBuilder\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\References\Reference;
+use Doctrine\RST\References\ResolvedReference;
+
+class MergerReference extends Reference
+{
+    public function getName(): string
+    {
+        return 'merger';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        return new ResolvedReference(
+            $environment->getCurrentFileName(),
+            $data,
+            '#'
+        );
+    }
+}

src/Reference/MethodReference.php

@@ -25,6 +25,10 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
         $className = explode('::', $data)[0];
         $className = str_replace('\\\\', '\\', $className);
 
+        if (false === strpos($data, '::')) {
+            throw new \RuntimeException(sprintf('Malformed method reference  "%s" in file "%s"', $data, $environment->getCurrentFileName()));
+        }
+
         $methodName = explode('::', $data)[1];
 
         return new ResolvedReference(

src/Reference/TermReference.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace SymfonyDocsBuilder\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\References\Reference;
+use Doctrine\RST\References\ResolvedReference;
+
+class TermReference extends Reference
+{
+    public function getName(): string
+    {
+        return 'term';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        return new ResolvedReference(
+            $environment->getCurrentFileName(),
+            $data,
+            '#'
+        );
+    }
+}