symfony's api references

Author: nikophil

_build/notes.md

@@ -4,3 +4,10 @@ Changes needed in symfony.com
 - For `caution`, `note` and `tip` : remove `class="last"` in favor to `:last-child`
 - idem about `.first`
 - idem for `sidebar` (the `.first` css class is not even used in css)
+
+
+Notes
+=====
+
+- warning about exceptions thrown and abortOnError conf
+- add some format check on references

_build/src/Reference/ClassReference.php

@@ -4,19 +4,24 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class ClassReference extends Reference
 {
+    private const BASE__URL = 'https://api.symfony.com';
+
     public function getName(): string
     {
         return 'class';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        $className = str_replace('\\\\', '\\', $data);
+
+        return new ResolvedReference(
+            $className,
+            sprintf('%s/%s/%s.html', self::BASE__URL, '4.1', str_replace('\\', '/', $className))
+        );
     }
-}
+}

_build/src/Reference/MethodReference.php

@@ -4,19 +4,27 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class MethodReference extends Reference
 {
+    private const BASE__URL = 'https://api.symfony.com';
+
     public function getName(): string
     {
         return 'method';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        $className = explode('::', $data)[0];
+        $className = str_replace('\\\\', '\\', $className);
+
+        $methodName = explode('::', $data)[1];
+
+        return new ResolvedReference(
+            $methodName.'()',
+            sprintf('%s/%s/%s.html#method_%s', self::BASE__URL, '4.1', str_replace('\\', '/', $className), $methodName)
+        );
     }
 }

_build/src/Reference/NamespaceReference.php

@@ -4,19 +4,24 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class NamespaceReference extends Reference
 {
+    private const BASE__URL = 'https://api.symfony.com';
+
     public function getName(): string
     {
         return 'namespace';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        $className = str_replace('\\\\', '\\', $data);
+
+        return new ResolvedReference(
+            $className,
+            sprintf('%s/%s/%s.html', self::BASE__URL, '4.1', str_replace('\\', '/', $className))
+        );
     }
 }

_build/tests/IntegrationTest.php

@@ -50,12 +50,8 @@ public function integrationProvider()
             'folder' => 'toctree',
         ];
 
-        yield 'refReference' => [
-            'folder' => 'refReference',
-        ];
-
-        yield 'refReferenceError' => [
-            'folder' => 'refReferenceError',
+        yield 'ref-reference' => [
+            'folder' => 'ref-reference',
         ];
     }
 
@@ -133,14 +129,26 @@ public function parserUnitBlockProvider()
         yield 'literal' => [
             'documentName' => 'literal',
         ];
+
+        yield 'class-reference' => [
+            'documentName' => 'class-reference',
+        ];
+
+        yield 'namespace-reference' => [
+            'documentName' => 'namespace-reference',
+        ];
+
+        yield 'method-reference' => [
+            'documentName' => 'method-reference',
+        ];
     }
 
     public function testRefReferenceError()
     {
         $this->expectException(\RuntimeException::class);
 
         $this->createBuilder()->build(
-            sprintf('%s/fixtures/source/refReferenceError', __DIR__),
+            sprintf('%s/fixtures/source/ref-reference-error', __DIR__),
             __DIR__.'/_output',
             true // verbose
         );

_build/tests/fixtures/expected/blocks/class-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://api.symfony.com/4.1/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.html" title="Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel">Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel</a></p>
+</body>
+</html>

_build/tests/fixtures/expected/blocks/method-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/RequestStack.html#method_getCurrentRequest" title="Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest()">getCurrentRequest()</a></p>
+</body>
+</html>

_build/tests/fixtures/expected/blocks/namespace-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://api.symfony.com/4.1/Symfony/Component/HttpFoundation.html" title="Symfony\Component\HttpFoundation">HttpFoundation</a></p>
+</body>
+</html>

_build/tests/fixtures/expected/refReference/index.html renamed to _build/tests/fixtures/expected/ref-reference/index.html

@@ -0,0 +1,2 @@
+
+:class:`Symfony\\Component\\HttpKernel\\DependencyInjection\\ContainerAwareHttpKernel`

_build/tests/fixtures/source/blocks/class-reference.rst

@@ -0,0 +1,2 @@
+
+:method:`Symfony\\Component\\HttpFoundation\\RequestStack::getCurrentRequest`

_build/tests/fixtures/source/blocks/method-reference.rst

@@ -0,0 +1,2 @@
+
+:namespace:`Symfony\\Component\\HttpFoundation`