Add file reference

Author: alamirault

src/KernelFactory.php

@@ -103,6 +103,7 @@ private static function getReferences(BuildConfig $buildConfig): array
     {
         return [
             new SymfonyReferences\ClassReference($buildConfig->getSymfonyRepositoryUrl()),
+            new SymfonyReferences\FileReference($buildConfig->getSymfonyRepositoryUrl()),
             new SymfonyReferences\MethodReference($buildConfig->getSymfonyRepositoryUrl()),
             new SymfonyReferences\NamespaceReference($buildConfig->getSymfonyRepositoryUrl()),
             new SymfonyReferences\PhpFunctionReference($buildConfig->getPhpDocUrl()),

src/Reference/FileReference.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Docs Builder package.
+ * (c) Ryan Weaver <ryan@symfonycasts.com>
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SymfonyDocsBuilder\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\References\Reference;
+use Doctrine\RST\References\ResolvedReference;
+use function Symfony\Component\String\u;
+
+class FileReference extends Reference
+{
+    private $symfonyRepositoryUrl;
+
+    public function __construct(string $symfonyRepositoryUrl)
+    {
+        $this->symfonyRepositoryUrl = $symfonyRepositoryUrl;
+    }
+
+    public function getName(): string
+    {
+        return 'file';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        $className = u($data);
+
+        $linkTarget = $className->afterLast('::');
+        $linkName = $className->beforeLast('::');
+
+        return new ResolvedReference(
+            $environment->getCurrentFileName(),
+            $linkName,
+            sprintf('%s/%s', $this->symfonyRepositoryUrl, $linkTarget),
+            [],
+            [
+                'title' => $linkTarget,
+            ]
+        );
+    }
+}

tests/IntegrationTest.php

@@ -211,6 +211,10 @@ public function parserUnitBlockProvider()
             'blockName' => 'references/class',
         ];
 
+        yield 'file-reference' => [
+            'blockName' => 'references/file',
+        ];
+
         yield 'namespace-reference' => [
             'blockName' => 'references/namespace',
         ];

tests/fixtures/expected/blocks/references/file.html

@@ -0,0 +1 @@
+<p><a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/Notifier/Bridge/AmazonSns/README.md" class="reference external" title="Symfony/Component/Notifier/Bridge/AmazonSns/README.md" rel="external noopener noreferrer" target="_blank">Link name</a></p>

tests/fixtures/source/blocks/references/file.rst

@@ -0,0 +1,2 @@
+
+:file:`Link name::Symfony/Component/Notifier/Bridge/AmazonSns/README.md`