IntegrationTest::testIntegration : use data provider + test refReference

Author: nikophil

_build/src/HtmlKernel.php

@@ -2,14 +2,10 @@
 
 namespace SymfonyDocs;
 
+use Doctrine\RST\References\Doc;
 use Doctrine\RST\Directive;
 use Doctrine\RST\Factory;
 use Doctrine\RST\HTML\Kernel;
-use Highlight\Highlighter;
-use SymfonyDocs\CodeBlock\CodeBlockConsoleRenderer;
-use SymfonyDocs\CodeBlock\CodeBlockLanguageDetector;
-use SymfonyDocs\CodeBlock\CodeBlockRenderer;
-use SymfonyDocs\CodeBlock\CodeBlockWithLineNumbersRenderer;
 use SymfonyDocs\Directive\CautionDirective;
 use SymfonyDocs\Directive\ClassDirective;
 use SymfonyDocs\Directive\CodeBlockDirective;
@@ -26,6 +22,7 @@
 use SymfonyDocs\Reference\NamespaceReference;
 use SymfonyDocs\Reference\PhpFunctionReference;
 use SymfonyDocs\Reference\PhpMethodReference;
+use SymfonyDocs\Reference\RefReference;
 
 class HtmlKernel extends Kernel
 {
@@ -47,7 +44,7 @@ public function __construct(array $directives = [])
         $this->symfonyDocsFactory = new NodeFactory($this->getName());
     }
 
-    public function getFactory() :Factory
+    public function getFactory(): Factory
     {
         return $this->symfonyDocsFactory;
     }
@@ -56,31 +53,35 @@ public function getDirectives(): array
     {
         $directives = parent::getDirectives();
 
-        return array_merge($directives, [
-            new CautionDirective(),
-            new ClassDirective(),
-            new CodeBlockDirective(),
-            new ConfigurationBlockDirective(),
-            new IndexDirective(),
-            new NoteDirective(),
-            new RoleDirective(),
-            new SeeAlsoDirective(),
-            new SidebarDirective(),
-            new TipDirective(),
-            new VersionAddedDirective(),
-        ]);
+        return array_merge(
+            $directives,
+            [
+                new CautionDirective(),
+                new ClassDirective(),
+                new CodeBlockDirective(),
+                new ConfigurationBlockDirective(),
+                new IndexDirective(),
+                new NoteDirective(),
+                new RoleDirective(),
+                new SeeAlsoDirective(),
+                new SidebarDirective(),
+                new TipDirective(),
+                new VersionAddedDirective(),
+            ]
+        );
     }
 
     public function getReferences(): array
     {
-        $references = parent::getReferences();
-
-        return array_merge($references, [
+        return [
+            new Doc(),
+//            new Doc('ref'),
+            new RefReference(),
             new ClassReference(),
             new MethodReference(),
             new NamespaceReference(),
             new PhpFunctionReference(),
             new PhpMethodReference(),
-        ]);
+        ];
     }
 }

_build/src/Reference/RefReference.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace SymfonyDocs\Reference;
+
+use Doctrine\RST\Environment;
+use Doctrine\RST\Reference;
+use Doctrine\RST\References\Resolver;
+use Doctrine\RST\References\ResolvedReference;
+
+class RefReference extends Reference
+{
+    public function getName(): string
+    {
+        return 'ref';
+    }
+
+    public function resolve(Environment $environment, string $data): ResolvedReference
+    {
+        $resolver = new Resolver();
+        dump($resolver->resolve($environment, $data));
+        return $resolver->resolve($environment, $data);
+    }
+}

_build/tests/IntegrationTest.php

@@ -9,35 +9,33 @@
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 use SymfonyDocs\HtmlKernel;
-use Symfony\Component\DomCrawler\Crawler;
 
 class IntegrationTest extends TestCase
 {
-    public function testIntegration()
+    /**
+     * @dataProvider integrationProvider
+     */
+    public function testIntegration(string $folder)
     {
         $kernel  = new HtmlKernel();
         $builder = new Builder($kernel);
         $fs      = new Filesystem();
         $fs->remove(__DIR__.'/_output');
 
         $builder->build(
-            __DIR__.'/fixtures/source',
+            sprintf('%s/fixtures/source/%s', __DIR__, $folder),
             __DIR__.'/_output',
             true // verbose
         );
 
         $finder = new Finder();
-        $finder->in(__DIR__.'/fixtures/expected/')
+        $finder->in(sprintf('%s/fixtures/expected/%s', __DIR__, $folder))
             ->files()
             ->depth('>=0');
 
         $indenter = new Indenter();
         foreach ($finder as $expectedFile) {
             $relativePath = $expectedFile->getRelativePathname();
-            if ($relativePath !== 'tables.html') {
-                continue;
-            }
-
             $actualFilename = __DIR__.'/_output/'.$relativePath;
             $this->assertFileExists($actualFilename);
 
@@ -47,6 +45,21 @@ public function testIntegration()
         }
     }
 
+    public function integrationProvider()
+    {
+//        yield 'main' => [
+//            'folder' => 'main'
+//        ];
+
+        yield 'toctree' => [
+            'folder' => 'toctree'
+        ];
+
+        yield 'refReference' => [
+            'folder' => 'refReference'
+        ];
+    }
+
     /**
      * @dataProvider parserUnitBlockProvider
      */
@@ -71,78 +84,55 @@ public function testParseUnitBlock(string $blockName)
     public function parserUnitBlockProvider()
     {
         yield 'tables' => [
-            'documentName' => 'tables'
+            'documentName' => 'tables',
         ];
 
         yield 'caution' => [
-            'documentName' => 'caution'
+            'documentName' => 'caution',
         ];
 
         yield 'note' => [
-            'documentName' => 'note'
+            'documentName' => 'note',
         ];
 
         yield 'seealso' => [
-            'documentName' => 'seealso'
+            'documentName' => 'seealso',
         ];
 
         yield 'tip' => [
-            'documentName' => 'tip'
+            'documentName' => 'tip',
         ];
 
         yield 'versionadded' => [
-            'documentName' => 'versionadded'
+            'documentName' => 'versionadded',
         ];
 
         yield 'class' => [
-            'documentName' => 'class'
+            'documentName' => 'class',
         ];
 
         yield 'configuration-block' => [
-            'documentName' => 'configuration-block'
+            'documentName' => 'configuration-block',
         ];
 
         yield 'code-block' => [
-            'documentName' => 'code-block'
+            'documentName' => 'code-block',
         ];
 
         yield 'sidebar' => [
-            'documentName' => 'sidebar'
+            'documentName' => 'sidebar',
         ];
 
         yield 'note-code-block-nested' => [
-            'documentName' => 'note-code-block-nested'
+            'documentName' => 'note-code-block-nested',
         ];
 
         yield 'sidebar-code-block-nested' => [
-            'documentName' => 'sidebar-code-block-nested'
+            'documentName' => 'sidebar-code-block-nested',
         ];
 
         yield 'literal' => [
-            'documentName' => 'literal'
+            'documentName' => 'literal',
         ];
     }
-
-    public function testTocTree()
-    {
-        $kernel  = new HtmlKernel();
-        $builder = new Builder($kernel);
-        $fs      = new Filesystem();
-        $fs->remove(__DIR__.'/_output/toctree');
-
-        $builder->build(
-            __DIR__.'/fixtures/source/toctree',
-            __DIR__.'/_output/toctree',
-            true // verbose
-        );
-
-        $indenter = new Indenter();
-
-        $expectedFile = sprintf('%s/fixtures/expected/toctree/index.html', __DIR__);
-        $outputFile = sprintf('%s/_output/toctree/index.html', __DIR__);
-        $this->assertSame(
-            $indenter->indent(file_get_contents($expectedFile)),
-            $indenter->indent(file_get_contents($outputFile))
-        );
-    }
 }

_build/tests/fixtures/expected/datetime.html renamed to _build/tests/fixtures/expected/main/datetime.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+    <p><a href="file.html#ref-test">A ref test</a>.</p>
+</body>
+</html>

_build/tests/fixtures/expected/form/form_type.html renamed to _build/tests/fixtures/expected/main/form/form_type.html

@@ -0,0 +1,4 @@
+File
+====
+
+.. _ref-test:

_build/tests/fixtures/expected/index.html renamed to _build/tests/fixtures/expected/main/index.html

@@ -0,0 +1,7 @@
+
+:ref:`A ref test <ref-test>`.
+
+.. toctree::
+    :hidden:
+
+    file