[FEATURE] Make csv-table directive work with content

linawolf · jaapio · commit c2e3457d1436 · 2023-09-06T21:14:38.000+02:00
diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/CsvTableDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/CsvTableDirective.php
@@ -18,6 +18,7 @@
 
 use function array_filter;
 use function count;
+use function implode;
 use function trim;
 
 /**
@@ -46,24 +47,37 @@ public function processNode(
         BlockContext $blockContext,
         Directive $directive,
     ): Node {
-        $csvStream = $blockContext->getDocumentParserContext()
-            ->getContext()
-            ->getOrigin()
-            ->readStream((string) $directive->getOption('file')->getValue());
+        if ($directive->hasOption('file')) {
+            $csvStream = $blockContext->getDocumentParserContext()
+                ->getContext()
+                ->getOrigin()
+                ->readStream((string) $directive->getOption('file')->getValue());
 
-        if ($csvStream === false) {
-            $this->logger->error('Unable to read CSV file {file}', ['file' => $directive->getOption('file')->getValue()]);
+            if ($csvStream === false) {
+                $this->logger->error('Unable to read CSV file {file}', ['file' => $directive->getOption('file')->getValue()]);
 
-            return new GenericNode('csv-table');
+                return new GenericNode('csv-table');
+            }
+
+            $csv = Reader::createFromStream($csvStream);
+        } else {
+            $lines = $blockContext->getDocumentIterator()->toArray();
+            $csv = Reader::createFromString(implode("\n", $lines));
         }
 
-        $csv = Reader::createFromStream($csvStream);
         if ($directive->getOption('header-rows')->getValue() !== null) {
             $csv->setHeaderOffset((int) ($directive->getOption('header-rows')->getValue()) - 1);
         }
 
         $header = null;
-        if (empty($csv->getHeader()) === false) {
+        if ($directive->hasOption('header')) {
+            $headerCsv = Reader::createFromString($directive->getOption('header')->toString());
+            $header = new TableRow();
+            foreach ($headerCsv->first() as $column) {
+                $columnNode = new TableColumn($column, 1, []);
+                $header->addColumn($this->buildColumn($columnNode, $blockContext, $this->productions));
+            }
+        } elseif (empty($csv->getHeader()) === false) {
             $header = new TableRow();
             foreach ($csv->getHeader() as $column) {
                 $columnNode = new TableColumn($column, 1, []);
diff --git a/packages/guides-restructured-text/src/RestructuredText/Parser/DirectiveOption.php b/packages/guides-restructured-text/src/RestructuredText/Parser/DirectiveOption.php
@@ -4,6 +4,8 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Parser;
 
+use function strval;
+
 class DirectiveOption
 {
     public function __construct(private readonly string $name, private string|int|float|bool|null $value = null)
@@ -20,6 +22,11 @@ public function getValue(): string|int|float|bool|null
         return $this->value;
     }
 
+    public function toString(): string
+    {
+        return strval($this->value);
+    }
+
     public function appendValue(string $append): void
     {
         $this->value = ((string) $this->value) . $append;
diff --git a/tests/Integration/tests/table-csv-table-with-content/expected/index.html b/tests/Integration/tests/table-csv-table-with-content/expected/index.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Csv table with content</title>
+
+</head>
+<body>
+    <div class="section" id="csv-table-with-content">
+    <h1>Csv table with content</h1>
+
+            <table>
+            <thead>
+                            <tr>
+                                            <th>Header 1</th>
+                                            <th>Header 2</th>
+                                    </tr>
+                    </thead>
+    
+    <tbody>
+                    <tr>
+                                <td>1</td>
+                                <td>one</td>
+                            </tr>
+                    <tr>
+                                <td>2</td>
+                                <td>two</td>
+                            </tr>
+            </tbody>
+</table>
+
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/table-csv-table-with-content/input/index.rst b/tests/Integration/tests/table-csv-table-with-content/input/index.rst
@@ -0,0 +1,11 @@
+
+Csv table with content
+======================
+
+..  csv-table:: Numbers
+    :header: "Header 1", "Header 2"
+    :widths: 15, 15
+
+    1, "one"
+    2, "two"
+

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace phpDocumentor\Guides\RestructuredText\Parser;`
`6`	`6`
	`7`	`+use function strval;`
	`8`	`+`
`7`	`9`	`class DirectiveOption`
`8`	`10`	`{`
`9`	`11`	`public function __construct(private readonly string $name, private string\|int\|float\|bool\|null $value = null)`
`@@ -20,6 +22,11 @@ public function getValue(): string\|int\|float\|bool\|null`
`20`	`22`	`return $this->value;`
`21`	`23`	`}`
`22`	`24`
	`25`	`+ public function toString(): string`
	`26`	`+ {`
	`27`	`+ return strval($this->value);`
	`28`	`+ }`
	`29`	`+`
`23`	`30`	`public function appendValue(string $append): void`
`24`	`31`	`{`
`25`	`32`	`$this->value = ((string) $this->value) . $append;`