Merge pull request #1065 from phpDocumentor/fix/955-table-content

[BUGFIX] do not trim per line
phpDocumentor · Sep 6, 2024 · 5b95517 · 5b95517
2 parents 28819a4 + 5e6d683
commit 5b95517
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 10 deletions.
diff --git a/...ides-restructured-text/src/RestructuredText/Parser/Productions/Table/GridTableBuilder.php b/...ides-restructured-text/src/RestructuredText/Parser/Productions/Table/GridTableBuilder.php
@@ -24,6 +24,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\RuleContainer;
 use Psr\Log\LoggerInterface;
 
+use function array_map;
 use function array_reverse;
 use function count;
 use function mb_strlen;
@@ -45,6 +46,7 @@ protected function compile(ParserContext $context): TableNode
     {
         $rows = $this->extractTableRows($context);
         $rows = $this->concatenateTableRows($rows, $context);
+        $rows = $this->trimTableCellContents($rows);
         $headers = $this->extractHeaderRows($rows, $context);
 
         return new TableNode($rows, $headers);
@@ -407,4 +409,27 @@ private function hasRowSpan(string $line): bool
     {
         return preg_match('/\+[-]+\+/', $line) === 1;
     }
+
+    /**
+     * @param array<int, TableRow> $rows
+     *
+     * @return array<int, TableRow>
+     */
+    private function trimTableCellContents(array $rows): array
+    {
+        return array_map(
+            static fn (TableRow $row) => new TableRow(
+                array_map(
+                    static fn (TableColumn $column) => new TableColumn(
+                        trim($column->getContent()),
+                        $column->getColSpan(),
+                        [],
+                        $column->getRowSpan(),
+                    ),
+                    $row->getColumns(),
+                ),
+            ),
+            $rows,
+        );
+    }
 }
diff --git a/packages/guides-restructured-text/tests/unit/Parser/Productions/GridTableRuleTest.php b/packages/guides-restructured-text/tests/unit/Parser/Productions/GridTableRuleTest.php
@@ -205,7 +205,7 @@ public static function gridTableWithRowSpanProvider(): Generator
 +===================================+===============+
 | description                       | string        |
 +-----------------------------------+               |
-| author                            |               |
+| author                            | test          |
 +-----------------------------------+---------------+
 | keywords                          | string        |
 +-----------------------------------+---------------+
@@ -217,7 +217,7 @@ public static function gridTableWithRowSpanProvider(): Generator
 
         $row1 = new TableRow();
         $row1->addColumn(self::createColumnNode('description'));
-        $rowSpan = self::createColumnNode('string');
+        $rowSpan = self::createColumnNode("string\n\ntest");
         $rowSpan->incrementRowSpan();
         $row1->addColumn($rowSpan);
 

diff --git a/packages/guides/src/Nodes/Table/TableColumn.php b/packages/guides/src/Nodes/Table/TableColumn.php
@@ -54,7 +54,7 @@ public function getRowSpan(): int
 
     public function addContent(string $content): void
     {
-        $this->content = trim($this->content . $content);
+        $this->content .= $content;
     }
 
     public function incrementRowSpan(): void

diff --git a/packages/guides/src/Nodes/Table/TableRow.php b/packages/guides/src/Nodes/Table/TableRow.php
@@ -23,8 +23,10 @@
 
 final class TableRow
 {
-    /** @var TableColumn[] */
-    private array $columns = [];
+    /** @param TableColumn[] $columns */
+    public function __construct(private array $columns = [])
+    {
+    }
 
     public function addColumn(TableColumn $tableColumn): void
     {

diff --git a/tests/Integration/tests/tables/grid-table-with-list/expected/index.html b/tests/Integration/tests/tables/grid-table-with-list/expected/index.html
@@ -6,19 +6,23 @@ <h1>table</h1>
                 <tbody>
     <tr>
             <td><strong>Paragraphs</strong></td>
-        <td><p>Paragraph 1</p>
-<p>Paragraph 2</p></td>
+        <td>
+            <p>Paragraph 1</p>
+            <p>Paragraph 2</p>
+        </td>
     </tr>
     <tr>
             <td><strong>Lists</strong></td>
-            <td><p>See the list</p>
+            <td>
+                <p>See the list</p>
                 <ul>
                     <li>Item 1</li>
                     <li>Item 2</li>
                 </ul>
-<p>A paragraph</p></td>
+<p>A paragraph</p>
+            </td>
     </tr>
 </tbody>
 </table>
     </div>
-<!-- content end -->
+<!-- content end -->
diff --git a/tests/Integration/tests/tables/grid-table-with-list/input/skip b/tests/Integration/tests/tables/grid-table-with-list/input/skip