rename _render_mjml to _to_mjml

Author: juleswg23

emailer_lib/ingress.py

@@ -64,7 +64,7 @@ def mjml_to_intermediate_email(
     # Handle MJMLTag objects by preprocessing images
     if isinstance(mjml_content, MJMLTag):
         processed_mjml, inline_attachments = _process_mjml_images(mjml_content)
-        mjml_markup = processed_mjml._render_mjml()
+        mjml_markup = processed_mjml._to_mjml()
     else:
         # String-based MJML, no preprocessing needed
         warnings.warn("MJMLTag not detected; treating input as plaintext MJML markup", UserWarning)

emailer_lib/mjml/_core.py

@@ -126,12 +126,12 @@ def __init__(
         # if self.content is not None:
         #     self.children = []
 
-    def _render_mjml(self, indent: int = 0, eol: str = "\n") -> str:
+    def _to_mjml(self, indent: int = 0, eol: str = "\n") -> str:
         """
         Render MJMLTag and its children to MJML markup.
         Ported from htmltools Tag rendering logic.
         
-        Note: BytesIO/bytes in image src attributes are not supported by _render_mjml().
+        Note: BytesIO/bytes in image src attributes are not supported by _to_mjml().
         Pass the MJMLTag directly to mjml_to_intermediate_email() instead.
         """
 
@@ -150,7 +150,7 @@ def _flatten(children):
             if isinstance(src_value, (bytes, BytesIO)):
                 raise ValueError(
                     "Cannot render MJML with BytesIO/bytes in image src attribute. "
-                    "Pass the MJMLTag object directly to mjml_to_intermediate_email() instead of calling _render_mjml() first. "
+                    "Pass the MJMLTag object directly to mjml_to_intermediate_email() instead of calling _to_mjml() first. "
                     "Example: i_email = mjml_to_intermediate_email(doc)"
                 )
 
@@ -167,7 +167,7 @@ def _flatten(children):
             child_strs = []
             for child in _flatten(self.children):
                 if isinstance(child, MJMLTag):
-                    child_strs.append(child._render_mjml(indent + 2, eol))
+                    child_strs.append(child._to_mjml(indent + 2, eol))
                 else:
                     child_strs.append(str(child))
             if child_strs:
@@ -202,7 +202,7 @@ def to_html(self, **mjml2html_kwargs) -> str:
         in <mjml><mj-body>...</mj-body></mjml> with a warning.
 
         Note: This method embeds all images as inline data URIs in the HTML.
-        For email sending with separate attachments, use mjml_to_intermediate_email() instead.
+        For email composition with inline attachments, use mjml_to_intermediate_email() instead.
 
         Parameters
         ----------
@@ -216,7 +216,7 @@ def to_html(self, **mjml2html_kwargs) -> str:
         """
         if self.tagName == "mjml":
             # Already a complete MJML document
-            mjml_markup = self._render_mjml()
+            mjml_markup = self._to_mjml()
         elif self.tagName == "mj-body":
             # Wrap only in mjml tag
             warnings.warn(
@@ -227,7 +227,7 @@ def to_html(self, **mjml2html_kwargs) -> str:
                 stacklevel=2,
             )
             wrapped = MJMLTag("mjml", self)
-            mjml_markup = wrapped._render_mjml()
+            mjml_markup = wrapped._to_mjml()
         else:
             # Warn and wrap in mjml/mj-body
             warnings.warn(
@@ -239,6 +239,6 @@ def to_html(self, **mjml2html_kwargs) -> str:
             )
             # Wrap in mjml and mj-body
             wrapped = MJMLTag("mjml", MJMLTag("mj-body", self))
-            mjml_markup = wrapped._render_mjml()
+            mjml_markup = wrapped._to_mjml()
 
         return mjml2html(mjml_markup, **mjml2html_kwargs)

emailer_lib/mjml/tests/test_core.py

@@ -38,41 +38,41 @@ def test_tag_with_dict_attributes():
 
 def test_tag_filters_none_children():
     tag = MJMLTag("mj-column", MJMLTag("mj-text", content="Text"), None)
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
 
     # None should not appear in output
     assert mjml_content.count("<mj-text>") == 1
 
 
 def test_render_empty_tag():
     tag = MJMLTag("mj-spacer")
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
     assert mjml_content == "<mj-spacer></mj-spacer>"
 
 
 def test_render_with_attributes():
     tag = MJMLTag("mj-spacer", attributes={"height": "20px"})
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
     assert mjml_content == '<mj-spacer height="20px"></mj-spacer>'
 
 
 def test_render_with_custom_indent():
     tag = MJMLTag("mj-text", content="Hello")
-    mjml_content = tag._render_mjml(indent=4)
+    mjml_content = tag._to_mjml(indent=4)
     assert mjml_content.startswith("    <mj-text>")
 
 
 def test_render_with_custom_eol():
     tag = MJMLTag("mj-text", content="Hello")
-    mjml_content = tag._render_mjml(eol="\r\n")
+    mjml_content = tag._to_mjml(eol="\r\n")
     assert "\r\n" in mjml_content
 
 
 def test_render_nested_tags():
     tag = MJMLTag(
         "mj-section", MJMLTag("mj-column", MJMLTag("mj-text", content="Nested"))
     )
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
 
     assert "<mj-section>" in mjml_content
     assert "<mj-column>" in mjml_content
@@ -83,7 +83,7 @@ def test_render_nested_tags():
 def test_render_with_string_and_tag_children():
     child_tag = MJMLTag("mj-text", content="Tagged")
     tag = MJMLTag("mj-column", "Plain text", child_tag, "More text")
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
 
     assert "Plain text" in mjml_content
     assert "<mj-text>" in mjml_content
@@ -169,34 +169,34 @@ def test_children_sequence_flattening():
     assert tag.children[1] == child2
     assert tag.children[2] == child3
 
-    mjml_content = tag._render_mjml()
+    mjml_content = tag._to_mjml()
 
     assert mjml_content.count("<mj-text>") == 3
     assert "Text 1" in mjml_content
     assert "Text 2" in mjml_content
     assert "Text 3" in mjml_content
 
 
-def test_render_mjml_raises_on_bytesio_in_image_src():
+def test_to_mjml_raises_on_bytesio_in_image_src():
     image_data = BytesIO(b"fake image data")
     image_tag = MJMLTag(
         "mj-image",
         attributes={"src": image_data, "alt": "Test"}
     )
 
     with pytest.raises(ValueError, match="Cannot render MJML with BytesIO/bytes"):
-        image_tag._render_mjml()
+        image_tag._to_mjml()
 
 
-def test_render_mjml_raises_on_bytes_in_image_src():
+def test_to_mjml_raises_on_bytes_in_image_src():
     image_data = b"fake image data"
     image_tag = MJMLTag(
         "mj-image",
         attributes={"src": image_data, "alt": "Test"}
     )
 
     with pytest.raises(ValueError, match="Cannot render MJML with BytesIO/bytes"):
-        image_tag._render_mjml()
+        image_tag._to_mjml()
 
 
 def test_tagattr_dict_stores_bytesio():

emailer_lib/mjml/tests/test_tags.py

@@ -39,7 +39,7 @@ def test_container_tag_accepts_children():
     assert len(sec.children) == 1
     assert sec.children[0].tagName == "mj-column"
 
-    mjml_content = sec._render_mjml()
+    mjml_content = sec._to_mjml()
     assert "<mj-section>" in mjml_content
     assert "<mj-column>" in mjml_content
     assert "<mj-text>" in mjml_content
@@ -53,7 +53,7 @@ def test_container_tag_accepts_attributes():
     assert sec.attrs["background-color"] == "#fff"
     assert sec.attrs["padding"] == "20px"
 
-    mjml_content = sec._render_mjml()
+    mjml_content = sec._to_mjml()
     assert '<mj-section background-color="#fff" padding="20px">' in mjml_content
 
 
@@ -66,7 +66,7 @@ def test_container_tag_accepts_children_and_attrs():
     assert len(sec.children) == 2
     assert sec.attrs["background-color"] == "#f0f0f0"
 
-    mjml_content = sec._render_mjml()
+    mjml_content = sec._to_mjml()
     assert 'background-color="#f0f0f0"' in mjml_content
     assert "Col 1" in mjml_content
     assert "Col 2" in mjml_content
@@ -79,7 +79,7 @@ def test_leaf_tag_accepts_content():
     assert txt.tagName == "mj-text"
     assert txt.content == "Hello World"
 
-    mjml_content = txt._render_mjml()
+    mjml_content = txt._to_mjml()
     assert mjml_content == "<mj-text>\nHello World\n</mj-text>"
 
 
@@ -89,7 +89,7 @@ def test_leaf_tag_accepts_attributes():
     assert txt.attrs["color"] == "red"
     assert txt.attrs["font-size"] == "16px"
 
-    mjml_content = txt._render_mjml()
+    mjml_content = txt._to_mjml()
     assert 'color="red"' in mjml_content
     assert 'font-size="16px"' in mjml_content
     assert "Hello" in mjml_content
@@ -108,7 +108,7 @@ def test_button_is_leaf_tag():
     assert btn.content == "Click Me"
     assert btn.attrs["href"] == "https://example.com"
 
-    mjml_content = btn._render_mjml()
+    mjml_content = btn._to_mjml()
     assert 'href="https://example.com"' in mjml_content
     assert "Click Me" in mjml_content
     assert "<mj-button" in mjml_content
@@ -158,7 +158,7 @@ def test_raw_tag():
     assert r.tagName == "mj-raw"
     assert r.content == "<div>Custom HTML</div>"
 
-    mjml_content = r._render_mjml()
+    mjml_content = r._to_mjml()
     assert mjml_content == "<mj-raw>\n<div>Custom HTML</div>\n</mj-raw>"
 
 
@@ -167,7 +167,7 @@ def test_table_tag():
     assert tbl.tagName == "mj-table"
     assert "<table>" in tbl.content
 
-    mjml_content = tbl._render_mjml()
+    mjml_content = tbl._to_mjml()
     assert "<mj-table>" in mjml_content
     assert "<table><tr><td>Cell</td></tr></table>" in mjml_content
 
@@ -195,7 +195,7 @@ def test_image_tag():
     assert img.attrs["src"] == "https://example.com/image.jpg"
     assert img.attrs["alt"] == "Test Image"
 
-    mjml_content = img._render_mjml()
+    mjml_content = img._to_mjml()
     assert 'src="https://example.com/image.jpg"' in mjml_content
     assert 'alt="Test Image"' in mjml_content
     assert "<mj-image" in mjml_content
@@ -214,7 +214,7 @@ def test_attributes_container_with_mj_all_and_classes():
     assert attrs.children[1].tagName == "mj-class"
     assert attrs.children[2].tagName == "mj-class"
 
-    mjml_content = attrs._render_mjml()
+    mjml_content = attrs._to_mjml()
     assert "<mj-attributes>" in mjml_content
     assert "<mj-all" in mjml_content
     assert 'font-family="Arial"' in mjml_content
@@ -226,7 +226,7 @@ def test_component_with_mj_class_attribute():
     txt = text(attributes={"mj-class": "blue big"}, content="Hello World!")
     assert txt.attrs["mj-class"] == "blue big"
 
-    mjml_content = txt._render_mjml()
+    mjml_content = txt._to_mjml()
     assert 'mj-class="blue big"' in mjml_content
     assert "Hello World!" in mjml_content
 
@@ -258,7 +258,7 @@ def test_full_document_with_attributes():
     assert attrs_tag.tagName == "mj-attributes"
     assert len(attrs_tag.children) == 4
 
-    mjml_content = doc._render_mjml()
+    mjml_content = doc._to_mjml()
     assert "<mj-attributes>" in mjml_content
     assert '<mj-text padding="0"' in mjml_content
     assert 'name="blue"' in mjml_content

emailer_lib/tests/test_ingress.py

@@ -186,7 +186,7 @@ def test_mjml_to_intermediate_email_with_bytesio():
     assert result.inline_attachments[cid_filename] != ""
 
 
-def test_mjml_render_mjml_with_bytesio_raises_error():
+def test_mjml_to_mjml_with_bytesio_raises_error():
     from io import BytesIO
     from emailer_lib.mjml import mjml, body, section, column, image
 
@@ -207,9 +207,9 @@ def test_mjml_render_mjml_with_bytesio_raises_error():
         )
     )
 
-    # Calling _render_mjml() should raise an error with a helpful message
+    # Calling _to_mjml() should raise an error with a helpful message
     with pytest.raises(ValueError, match="Cannot render MJML with BytesIO/bytes"):
-        mjml_tag._render_mjml()
+        mjml_tag._to_mjml()
 
     # But passing the tag directly to mjml_to_intermediate_email should work
     result = mjml_to_intermediate_email(mjml_tag)