Fix escaping issues in tables

Author: Saggre

src/Example/Pizza.php

@@ -6,7 +6,7 @@
 use PhpDocumentorMarkdown\Example\Pizza\Base;
 
 /**
- * A pizza | pie.
+ * A pizza | pie's.
  */
 class Pizza extends AbstractProduct implements ProductInterface, JsonSerializable
 {
@@ -42,7 +42,7 @@ class Pizza extends AbstractProduct implements ProductInterface, JsonSerializabl
      *
      * @param  string  $name  Product name.
      * @param  float  $price  Product price.
-     * @param  Base|null  $base  Pizza base.
+     * @param  Base|null  $base  Pizza's base.
      */
     public function __construct(string $name = '', float $price = 10.0, ?Base $base = null)
     {

tests/Functional/expected/Home.md

@@ -11,7 +11,7 @@ This is an automatically generated documentation for **Pizza Place (Example docu
 | Class                                                                        | Description                  |
 |------------------------------------------------------------------------------|------------------------------|
 | [`AbstractProduct`](./classes/PhpDocumentorMarkdown/Example/AbstractProduct) | Base class for all products. |
-| [`Pizza`](./classes/PhpDocumentorMarkdown/Example/Pizza)                     | A pizza \| pie.              |
+| [`Pizza`](./classes/PhpDocumentorMarkdown/Example/Pizza)                     | A pizza \| pie's.            |
 
 #### Traits
 

tests/Functional/expected/classes/PhpDocumentorMarkdown/Example/Pizza.md

@@ -1,6 +1,6 @@
 # Pizza
 
-A pizza \| pie.
+A pizza \| pie's.
 
 ***
 
@@ -67,7 +67,7 @@ Constructor description
 |-----------|-----------------------------------------------------|----------------|
 | `$name`   | **string**                                          | Product name.  |
 | `$price`  | **float**                                           | Product price. |
-| `$base`   | **\PhpDocumentorMarkdown\Example\Pizza\Base\|null** | Pizza base.    |
+| `$base`   | **\PhpDocumentorMarkdown\Example\Pizza\Base\|null** | Pizza's base.  |
 
 ***
 

themes/markdown/include/macros.twig

@@ -108,9 +108,9 @@
  # @param length int The target length of the string
  #}
 {% macro mdPadRight(str, length) %}
-    {%- set str = str|default('') -%}
-    {%- set delta = length - str|length -%}
-    {{- str ~ _self.mdRepeat(' ', delta > 0 ? delta : 0) -}}
+    {%- set str = str | default('') -%}
+    {%- set delta = length - str | length -%}
+    {{- (str ~ _self.mdRepeat(' ', delta > 0 ? delta : 0)) | raw -}}
 {% endmacro %}
 
 {#
@@ -129,7 +129,7 @@
     {%- for row in rows %}
         {%- for col in headers %}
             {%- set value = attribute(row, col.key) %}
-            {%- set value = _self.mdEsc(value) | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw %}
+            {%- set value = _self.mdEsc(value) %}
             {%- set length = value | length %}
             {%- if length > widths[loop.index0 ~ 'r'] %}
                 {%- set widths = widths | merge({ (loop.index0 ~ 'r'): length }) %}
@@ -150,8 +150,8 @@
     {%- for row in rows %}
         {%- for col in headers %}
             {%- set value = attribute(row, col.key) %}
-            {%- set value = _self.mdEsc(value) | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw %}
-            {{- '| ' ~ _self.mdPadRight(value, widths[loop.index0 ~ 'r']) ~ ' ' }}
+            {%- set value = _self.mdEsc(value) %}
+            {{- ('| ' ~ _self.mdPadRight(value, widths[loop.index0 ~ 'r']) ~ ' ') | raw }}
         {%- endfor -%}
         {{ '|' ~ "\n" }}
     {%- endfor %}

themes/markdown/index.md.twig

@@ -19,7 +19,7 @@ This is an automatically generated documentation for **{{project.name}}**.
 {% set parameters = parameters | merge([
     {
         link: macros.mdLink(class.FullyQualifiedStructuralElementName, null, null, 'class'),
-        description: class.summary | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw
+        description: class.summary | raw
     }
 ]) %}
 {% endfor -%}
@@ -37,7 +37,7 @@ This is an automatically generated documentation for **{{project.name}}**.
 {% set parameters = parameters | merge([
     {
         link: macros.mdLink(trait.FullyQualifiedStructuralElementName, null, null, 'class'),
-        description: trait.summary | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw
+        description: trait.summary | raw
     }
 ]) %}
 {% endfor -%}
@@ -55,7 +55,7 @@ This is an automatically generated documentation for **{{project.name}}**.
 {% set parameters = parameters | merge([
     {
         link: macros.mdLink(interface.FullyQualifiedStructuralElementName, null, null, 'class'),
-        description: interface.summary | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw
+        description: interface.summary | raw
     }
 ]) %}
 {% endfor -%}
@@ -73,7 +73,7 @@ This is an automatically generated documentation for **{{project.name}}**.
 {% set parameters = parameters | merge([
     {
         link: macros.mdLink(function.name, null, function.name ~ '()', 'function'),
-        description: function.summary | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw
+        description: function.summary | raw
     }
 ]) %}
 {% endfor -%}

themes/markdown/method.md.twig

@@ -34,7 +34,7 @@
     {
         name: '`$' ~ argument.name ~ '`',
         type: argument.type ? '**' ~ argument.type ~ '**' : '',
-        description: argument.description | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw
+        description: argument.description | raw
     }
 ]) %}
 {% endfor -%}