handle version number in external references

nikophil · nikophil · commit 4c0116349a08 · 2018-10-03T11:05:12.000+02:00
diff --git a/_build/composer.lock b/_build/composer.lock
diff --git a/_build/conf.json b/_build/conf.json
@@ -0,0 +1,3 @@
+{
+    "version": "4.0"
+}
diff --git a/_build/src/HtmlKernel.php b/_build/src/HtmlKernel.php
@@ -30,6 +30,27 @@ class HtmlKernel extends Kernel
     /** @var NodeFactory */
     private $symfonyDocsFactory;
 
+    /** @var array */
+    private static $configuration;
+
+    public static function getConfiguration(): array
+    {
+        if (null === self::$configuration) {
+            self::$configuration = json_decode(file_get_contents(__DIR__.'/../conf.json'), true);
+        }
+
+        return self::$configuration;
+    }
+
+    public static function getVersion(): string
+    {
+        if (!isset(self::getConfiguration()['version'])) {
+            throw new \RuntimeException('The version must be defined in "/_build/conf.json"');
+        }
+
+        return self::getConfiguration()['version'];
+    }
+
     public function getName(): string
     {
         return parent::getName();
diff --git a/_build/src/Reference/ClassReference.php b/_build/src/Reference/ClassReference.php
@@ -5,6 +5,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
 use Doctrine\RST\References\ResolvedReference;
+use SymfonyDocs\HtmlKernel;
 
 class ClassReference extends Reference
 {
@@ -21,7 +22,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
 
         return new ResolvedReference(
             $className,
-            sprintf('%s/%s/%s.html', self::BASE__URL, '4.1', str_replace('\\', '/', $className)),
+            sprintf('%s/%s/%s.html', self::BASE__URL, HtmlKernel::getVersion(), str_replace('\\', '/', $className)),
             [],
             [
                 'class' => 'reference external',
diff --git a/_build/src/Reference/MethodReference.php b/_build/src/Reference/MethodReference.php
@@ -5,6 +5,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
 use Doctrine\RST\References\ResolvedReference;
+use SymfonyDocs\HtmlKernel;
 
 class MethodReference extends Reference
 {
@@ -24,7 +25,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
 
         return new ResolvedReference(
             $methodName.'()',
-            sprintf('%s/%s/%s.html#method_%s', self::BASE__URL, '4.1', str_replace('\\', '/', $className), $methodName),
+            sprintf('%s/%s/%s.html#method_%s', self::BASE__URL, HtmlKernel::getVersion(), str_replace('\\', '/', $className), $methodName),
             [],
             [
                 'class' => 'reference external',
diff --git a/_build/src/Reference/NamespaceReference.php b/_build/src/Reference/NamespaceReference.php
@@ -5,6 +5,7 @@
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
 use Doctrine\RST\References\ResolvedReference;
+use SymfonyDocs\HtmlKernel;
 
 class NamespaceReference extends Reference
 {
@@ -21,7 +22,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
 
         return new ResolvedReference(
             substr(strrchr($className, '\\'), 1),
-            sprintf('%s/%s/%s.html', self::BASE__URL, '4.1', str_replace('\\', '/', $className)),
+            sprintf('%s/%s/%s.html', self::BASE__URL, HtmlKernel::getVersion(), str_replace('\\', '/', $className)),
             [],
             [
                 'class' => 'reference external',
diff --git a/_build/src/Reference/RefReference.php b/_build/src/Reference/RefReference.php
@@ -17,11 +17,11 @@ public function getName(): string
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
         $resolver = new Resolver();
-        $resolvedReference = $resolver->resolve($environment, $data);
+        $resolvedReference = $resolver->resolve($environment, $data, ['class' => 'reference internal']);
         if ($resolvedReference->getTitle() === '(unresolved)') {
             throw  new \RuntimeException(sprintf('Reference "%s" could not be resolved', $data));
         }
 
         return $resolvedReference;
     }
-}
+}
diff --git a/_build/tests/fixtures/expected/blocks/class-reference.html b/_build/tests/fixtures/expected/blocks/class-reference.html
@@ -4,6 +4,6 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<p><a href="https://api.symfony.com/4.1/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.html" class="reference external" title="Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel">Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel</a></p>
+<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.html" class="reference external" title="Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel">Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel</a></p>
 </body>
 </html>
diff --git a/_build/tests/fixtures/expected/blocks/method-reference.html b/_build/tests/fixtures/expected/blocks/method-reference.html
@@ -4,6 +4,6 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<p><a href="https://api.symfony.com/4.1/Symfony/Component/HttpFoundation/RequestStack.html#method_getCurrentRequest" class="reference external" title="Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest()">getCurrentRequest()</a></p>
+<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpFoundation/RequestStack.html#method_getCurrentRequest" class="reference external" title="Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest()">getCurrentRequest()</a></p>
 </body>
 </html>
diff --git a/_build/tests/fixtures/expected/blocks/namespace-reference.html b/_build/tests/fixtures/expected/blocks/namespace-reference.html
@@ -4,6 +4,6 @@
     <meta charset="utf-8" />
 </head>
 <body>
-<p><a href="https://api.symfony.com/4.1/Symfony/Component/HttpFoundation.html" class="reference external" title="Symfony\Component\HttpFoundation">HttpFoundation</a></p>
+<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpFoundation.html" class="reference external" title="Symfony\Component\HttpFoundation">HttpFoundation</a></p>
 </body>
 </html>
diff --git a/_build/tests/fixtures/expected/ref-reference/index.html b/_build/tests/fixtures/expected/ref-reference/index.html
@@ -4,6 +4,6 @@
     <meta charset="utf-8" />
 </head>
 <body>
-    <p><a href="file.html#ref-test">A ref test</a>.</p>
+    <p><a href="file.html#ref-test" class="reference internal">A ref test</a>.</p>
 </body>
 </html>

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`use Doctrine\RST\Environment;`
`6`	`6`	`use Doctrine\RST\Reference;`
`7`	`7`	`use Doctrine\RST\References\ResolvedReference;`
	`8`	`+use SymfonyDocs\HtmlKernel;`
`8`	`9`
`9`	`10`	`class ClassReference extends Reference`
`10`	`11`	`{`
`@@ -21,7 +22,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen`
`21`	`22`
`22`	`23`	`return new ResolvedReference(`
`23`	`24`	`$className,`
`24`		`- sprintf('%s/%s/%s.html', self::BASE__URL, '4.1', str_replace('\\', '/', $className)),`
	`25`	`+ sprintf('%s/%s/%s.html', self::BASE__URL, HtmlKernel::getVersion(), str_replace('\\', '/', $className)),`
`25`	`26`	`[],`
`26`	`27`	`[`
`27`	`28`	`'class' => 'reference external',`
Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,11 @@ public function getName(): string`
`17`	`17`	`public function resolve(Environment $environment, string $data): ResolvedReference`
`18`	`18`	`{`
`19`	`19`	`$resolver = new Resolver();`
`20`		`- $resolvedReference = $resolver->resolve($environment, $data);`
	`20`	`+ $resolvedReference = $resolver->resolve($environment, $data, ['class' => 'reference internal']);`
`21`	`21`	`if ($resolvedReference->getTitle() === '(unresolved)') {`
`22`	`22`	`throw new \RuntimeException(sprintf('Reference "%s" could not be resolved', $data));`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`return $resolvedReference;`
`26`	`26`	`}`
`27`		`-}`
	`27`	`+}`