Bypass composite decorators in most common br scenario

Author: thibaudcolas

.gitignore

@@ -93,3 +93,4 @@ lib64
 example.html
 .mypy_cache
 pip-wheel-metadata
+__pycache__

draftjs_exporter/composite_decorators.py

@@ -1,3 +1,4 @@
+import re
 from operator import itemgetter
 from typing import Any, Dict, Generator, List, Sequence, Tuple
 
@@ -9,6 +10,9 @@
     Element,
 )
 
+br = "\n"
+br_strategy = re.compile(r"\n")
+
 
 def get_decorations(
     decorators: CompositeDecorators, text: str
@@ -69,3 +73,20 @@ def render_decorators(
             DOM.append_child(decorated_node, decorated_child)
 
     return decorated_node
+
+
+def should_render_decorators(
+    decorators: CompositeDecorators, text: str,
+) -> bool:
+    nb_decorators = len(decorators)
+
+    if nb_decorators == 0:
+        return False
+
+    is_skippable_br = (
+        nb_decorators == 1
+        and decorators[0]["strategy"] == br_strategy
+        and not (br in text)
+    )
+
+    return not is_skippable_br

draftjs_exporter/dom.py

@@ -35,7 +35,12 @@ def use(cls, engine: str) -> None:
         cls.dom = import_string(engine)
 
     @classmethod
-    def create_element(cls, type_: RenderableType = None, props: Optional[Props] = None, *elt_children: Optional[Element]) -> Element:
+    def create_element(
+        cls,
+        type_: RenderableType = None,
+        props: Optional[Props] = None,
+        *elt_children: Optional[Element]
+    ) -> Element:
         """
         Signature inspired by React.createElement.
         createElement(

draftjs_exporter/html.py

@@ -3,7 +3,10 @@
 from typing import List, Optional, Tuple
 
 from draftjs_exporter.command import Command
-from draftjs_exporter.composite_decorators import render_decorators
+from draftjs_exporter.composite_decorators import (
+    render_decorators,
+    should_render_decorators,
+)
 from draftjs_exporter.defaults import BLOCK_MAP, STYLE_MAP
 from draftjs_exporter.dom import DOM
 from draftjs_exporter.entity_state import EntityState
@@ -27,7 +30,6 @@ class HTML(object):
 
     __slots__ = (
         "composite_decorators",
-        "has_decorators",
         "entity_options",
         "block_options",
         "style_options",
@@ -38,7 +40,6 @@ def __init__(self, config: Optional[Config] = None) -> None:
             config = {}
 
         self.composite_decorators = config.get("composite_decorators", [])
-        self.has_decorators = len(self.composite_decorators) > 0
 
         self.entity_options = Options.map_entities(
             config.get("entity_decorators", {})
@@ -86,6 +87,10 @@ def render(self, content_state: Optional[ContentState] = None) -> str:
     def render_block(
         self, block: Block, entity_map: EntityMap, wrapper_state: WrapperState
     ) -> Element:
+        has_decorators = should_render_decorators(
+            self.composite_decorators, block["text"]
+        )
+
         if (
             "inlineStyleRanges" in block
             and block["inlineStyleRanges"]
@@ -102,7 +107,7 @@ def render_block(
                     style_state.apply(command)
 
                 # Decorators are not rendered inside entities.
-                if entity_state.has_no_entity() and self.has_decorators:
+                if entity_state.has_no_entity() and has_decorators:
                     decorated_node = render_decorators(
                         self.composite_decorators,
                         text,
@@ -129,7 +134,7 @@ def render_block(
                     ):
                         DOM.append_child(content, styled_node)
         # Fast track for blocks which do not contain styles nor entities, which is very common.
-        elif self.has_decorators:
+        elif has_decorators:
             content = render_decorators(
                 self.composite_decorators,
                 block["text"],

draftjs_exporter/wrapper_state.py

@@ -161,9 +161,7 @@ def update_stack(self, options: Options, depth: int) -> None:
                     DOM.append_child(self.stack.head().elt, wrapper_parent)
                 else:
                     # Otherwise we can append at the end of the last child.
-                    wrapper_parent = (
-                        self.stack.head().last_child
-                    )
+                    wrapper_parent = self.stack.head().last_child
 
                 DOM.append_child(wrapper_parent, new_wrapper.elt)
 

tests/test_composite_decorators.py

@@ -1,7 +1,10 @@
 import re
 import unittest
 
-from draftjs_exporter.composite_decorators import render_decorators
+from draftjs_exporter.composite_decorators import (
+    render_decorators,
+    should_render_decorators,
+)
 from draftjs_exporter.constants import BLOCK_TYPES
 from draftjs_exporter.dom import DOM
 from example import LINKIFY_RE, br, hashtag, linkify
@@ -87,6 +90,17 @@ def test_render(self):
             ),
             "<br/>",
         )
+        self.assertEqual(
+            DOM.render(
+                render_decorators(
+                    [BR_DECORATOR],
+                    "test \n test",
+                    {"type": BLOCK_TYPES.UNSTYLED, "depth": 0},
+                    [],
+                )
+            ),
+            "test <br/> test",
+        )
 
     def test_render_code_block(self):
         self.assertEqual(
@@ -169,3 +183,31 @@ def component(props):
             blocks[0],
             blocks,
         )
+
+    def test_should_render_decorators_empty(self):
+        self.assertEqual(
+            should_render_decorators([], "test"), False,
+        )
+
+    def test_should_render_decorators_more_than_one(self):
+        self.assertEqual(
+            should_render_decorators(
+                [HASHTAG_DECORATOR, LINKIFY_DECORATOR], "test",
+            ),
+            True,
+        )
+
+    def test_should_render_decorators_single_not_br(self):
+        self.assertEqual(
+            should_render_decorators([HASHTAG_DECORATOR], "test"), True,
+        )
+
+    def test_should_render_decorators_single_br_absent(self):
+        self.assertEqual(
+            should_render_decorators([BR_DECORATOR], "test"), False,
+        )
+
+    def test_should_render_decorators_single_br_present(self):
+        self.assertEqual(
+            should_render_decorators([BR_DECORATOR], "test \n test"), True,
+        )