buildmimetree.py: unified item dscription setting

[etc/neomutt.git] / .config / neomutt / buildmimetree.py

diff --git a/.config/neomutt/buildmimetree.py b/.config/neomutt/buildmimetree.py
index d0493b362978a4af878e7429c3bd59a318f6d4d1..57fc21a3ced7e6f72c99d6e569caf7dcd7238536 100755 (executable)
--- a/.config/neomutt/buildmimetree.py
+++ b/.config/neomutt/buildmimetree.py
@@ -72,6 +72,12 @@ def parse_cli_args(*args, **kwargs):
         help="Markdown extension to add to the list of extensions use",
     )
 
         help="Markdown extension to add to the list of extensions use",
     )
 

+    parser_setup.add_argument(
+        "--send-message",
+        action="store_true",
+        help="Generate command(s) to send the message after processing",
+    )
+

     parser_massage.add_argument(
         "--debug-commands",
         action="store_true",
     parser_massage.add_argument(
         "--debug-commands",
         action="store_true",


@@ -136,23 +142,25 @@ class Multipart(
 
 def convert_markdown_to_html(maildraft, *, extensions=None):
     draftpath = pathlib.Path(maildraft)
 
 def convert_markdown_to_html(maildraft, *, extensions=None):
     draftpath = pathlib.Path(maildraft)

-    textpart = Part(
-        "text", "plain", draftpath, "Plain-text version", orig=True
-    )
-

     with open(draftpath, "r", encoding="utf-8") as textmarkdown:
         text = textmarkdown.read()
 
     mdwn = markdown.Markdown(extensions=extensions)
     with open(draftpath, "r", encoding="utf-8") as textmarkdown:
         text = textmarkdown.read()
 
     mdwn = markdown.Markdown(extensions=extensions)

-    html = mdwn.convert(text)

 
 

-    htmlpath = draftpath.with_suffix(".html")
-    htmlpart = Part("text", "html", htmlpath, "HTML version")

 
 

+    with open(draftpath, "w", encoding="utf-8") as textplain:
+        textplain.write(text)
+    textpart = Part(
+        "text", "plain", draftpath, "Plain-text version", orig=True
+    )
+
+    html = mdwn.convert(text)
+    htmlpath = draftpath.with_suffix(".html")

     with open(
         htmlpath, "w", encoding="utf-8", errors="xmlcharrefreplace"
     ) as texthtml:
         texthtml.write(html)
     with open(
         htmlpath, "w", encoding="utf-8", errors="xmlcharrefreplace"
     ) as texthtml:
         texthtml.write(html)

+    htmlpart = Part("text", "html", htmlpath, "HTML version")

 
     logopart = Part(
         "image",
 
     logopart = Part(
         "image",


@@ -305,7 +313,7 @@ def do_setup(
 
 def do_massage(
     maildraft,
 
 def do_massage(
     maildraft,

-    cmdpath,
+    cmd_f,

     *,
     extensions=None,
     converter=convert_markdown_to_html,
     *,
     extensions=None,
     converter=convert_markdown_to_html,


@@ -316,95 +324,95 @@ def do_massage(
     # draft, and whatever commands we write to the file given as cmdpath will
     # be run by the second source command in the macro definition.
 
     # draft, and whatever commands we write to the file given as cmdpath will
     # be run by the second source command in the macro definition.
 

-    with open(cmdpath, "w") as cmd_f:
-        # Let's start by cleaning up what the setup did (see above), i.e. we
-        # restore the $editor and $edit_headers variables, and also unset the
-        # variable used to identify the command file we're currently writing
-        # to.
-        cmds = MuttCommands(cmd_f, debug=debug_commands)
-        cmds.cmd('set editor="$my_editor"')
-        cmds.cmd('set edit_headers="$my_edit_headers"')
-        cmds.cmd("unset my_editor")
-        cmds.cmd("unset my_edit_headers")
-
-        # let's flush those commands, as there'll be a lot of pushes from now
-        # on, which need to be run in reverse order
-        cmds.flush()
-
-        extensions = extensions.split(",") if extensions else []
-        tree = converter(maildraft, extensions=extensions)
-
-        mimetree = MIMETreeDFWalker(debug=args.debug_walk)
-
-        def visitor_fn(item, stack, *, debugprint=None):
-            """
-            Visitor function called for every node (part) of the MIME tree,
-            depth-first, and responsible for telling NeoMutt how to assemble
-            the tree.
-            """
-            if isinstance(item, Part):
-                # We've hit a leaf-node, i.e. an alternative or a related part
-                # with actual content.
-
-                # If the part is not an original part, i.e. doesn't already
-                # exist, we must first add it.
-                if not item.orig:
-                    cmds.push(f"<attach-file>{item.path}<enter>")
-                    cmds.push("<toggle-unlink><toggle-disposition>")
-                    if item.cid:
-                        cmds.push(
-                            f"<edit-content-id>\\Ca\\Ck{item.cid}<enter>"
-                        )
-
-                # If the item (including the original) comes with a
-                # description, then we might just as well update the NeoMutt
-                # tree now:
-                if item.desc:
-                    cmds.push(f"<edit-description>\\Ca\\Ck{item.desc}<enter>")
-
-                # Finally, tag the entry that we just processed, so that when
-                # we're done at this level, as we walk up the stack, the items
-                # to be grouped will already be tagged and ready.
-                cmds.push("<tag-entry>")
-
-            elif isinstance(item, Multipart):
-                # This node has children, but we already visited them (see
-                # above), and so they have been tagged in NeoMutt's compose
-                # window. Now it's just a matter of telling NeoMutt to do the
-                # appropriate grouping:
-                if item.subtype == "alternative":
-                    cmds.push("<group-alternatives>")
-                elif item.subtype == "relative":
-                    cmds.push("<group-related>")
-                elif item.subtype == "multilingual":
-                    cmds.push("<group-multilingual>")
-
-                # Again, if there is a description, we might just as well:
-                if item.desc:
-                    cmds.push(f"<edit-description>\\Ca\\Ck{item.desc}<enter>")
-
-                # Finally, if we're at non-root level, tag the new container,
-                # as it might itself be part of a container, to be processed
-                # one level up:
-                if stack:
-                    cmds.push("<tag-entry>")
+    # Let's start by cleaning up what the setup did (see above), i.e. we
+    # restore the $editor and $edit_headers variables, and also unset the
+    # variable used to identify the command file we're currently writing
+    # to.
+    cmds = MuttCommands(cmd_f, debug=debug_commands)
+    cmds.cmd('set editor="$my_editor"')
+    cmds.cmd('set edit_headers="$my_edit_headers"')
+    cmds.cmd("unset my_editor")
+    cmds.cmd("unset my_edit_headers")
+
+    # let's flush those commands, as there'll be a lot of pushes from now
+    # on, which need to be run in reverse order
+    cmds.flush()

 
 

-            else:
-                # We should never get here
-                assert not "is valid part"
+    extensions = extensions.split(",") if extensions else []
+    tree = converter(maildraft, extensions=extensions)

 
 

-        # -----------------
-        # End of visitor_fn
+    mimetree = MIMETreeDFWalker(debug=debug_walk)

 
 

-        # Let's walk the tree and visit every node with our fancy visitor
-        # function
-        mimetree.walk(tree, visitor_fn=visitor_fn)
+    def visitor_fn(item, stack, *, debugprint=None):
+        """
+        Visitor function called for every node (part) of the MIME tree,
+        depth-first, and responsible for telling NeoMutt how to assemble
+        the tree.
+        """
+        if isinstance(item, Part):
+            # We've hit a leaf-node, i.e. an alternative or a related part
+            # with actual content.
+
+            # Let's add the part
+            if item.orig:
+                # The original source already exists in the NeoMutt tree, but
+                # the underlying file may have been modified, so we need to
+                # update the encoding, but that's it:
+                cmds.push("<update-encoding>")
+            else:
+                # … whereas all other parts need to be added, and they're all
+                # considered to be temporary and inline:
+                cmds.push(f"<attach-file>{item.path}<enter>")
+                cmds.push("<toggle-unlink><toggle-disposition>")
+
+            # If the item (including the original) comes with additional
+            # information, then we might just as well update the NeoMutt
+            # tree now:
+            if item.cid:
+                cmds.push(f"<edit-content-id>\\Ca\\Ck{item.cid}<enter>")
+
+        elif isinstance(item, Multipart):
+            # This node has children, but we already visited them (see
+            # above), and so they have been tagged in NeoMutt's compose
+            # window. Now it's just a matter of telling NeoMutt to do the
+            # appropriate grouping:
+            if item.subtype == "alternative":
+                cmds.push("<group-alternatives>")
+            elif item.subtype == "relative":
+                cmds.push("<group-related>")
+            elif item.subtype == "multilingual":
+                cmds.push("<group-multilingual>")

 
 

-        # Finally, cleanup. Since we're responsible for removing the temporary
-        # file, how's this for a little hack?
-        cmds.cmd(f"source 'rm -f {args.cmdpath}|'")
-        cmds.cmd("unset my_mdwn_postprocess_cmd_file")
-        cmds.flush()
+        else:
+            # We should never get here
+            assert not "is valid part"
+
+        # If the item has a description, we might just as well add it
+        if item.desc:
+            cmds.push(f"<edit-description>\\Ca\\Ck{item.desc}<enter>")
+
+        # Finally, if we're at non-root level, tag the new container,
+        # as it might itself be part of a container, to be processed
+        # one level up:
+        if stack:
+            cmds.push("<tag-entry>")
+
+    # -----------------
+    # End of visitor_fn
+
+    # Let's walk the tree and visit every node with our fancy visitor
+    # function
+    mimetree.walk(tree, visitor_fn=visitor_fn)
+
+    # Finally, cleanup. Since we're responsible for removing the temporary
+    # file, how's this for a little hack?
+    try:
+        filename = cmd_f.name
+    except AttributeError:
+        filename = "pytest_internal_file"
+    cmds.cmd(f"source 'rm -f {filename}|'")
+    cmds.cmd("unset my_mdwn_postprocess_cmd_file")
+    cmds.flush()

 
 
 # [ CLI ENTRY ] ###############################################################
 
 
 # [ CLI ENTRY ] ###############################################################


@@ -413,16 +421,20 @@ if __name__ == "__main__":
     args = parse_cli_args()
 
     if args.mode == "setup":
     args = parse_cli_args()
 
     if args.mode == "setup":

+        if args.send_message:
+            raise NotImplementedError()
+

         do_setup(args.extensions, debug_commands=args.debug_commands)
 
     elif args.mode == "massage":
         do_setup(args.extensions, debug_commands=args.debug_commands)
 
     elif args.mode == "massage":

-        do_massage(
-            args.MAILDRAFT,
-            args.cmdpath,
-            extensions=args.extensions,
-            debug_commands=args.debug_commands,
-            debug_walk=args.debug_walk,
-        )
+        with open(args.cmdpath, "w") as cmd_f:
+            do_massage(
+                args.MAILDRAFT,
+                cmd_f,
+                extensions=args.extensions,
+                debug_commands=args.debug_commands,
+                debug_walk=args.debug_walk,
+            )

 
 
 # [ TESTS ] ###################################################################
 
 
 # [ TESTS ] ###################################################################


@@ -488,12 +500,18 @@ try:
         @pytest.fixture
         def basic_mime_tree(self):
             return Multipart(
         @pytest.fixture
         def basic_mime_tree(self):
             return Multipart(

-                "related",
+                "relative",

                 children=[
                     Multipart(
                         "alternative",
                         children=[
                 children=[
                     Multipart(
                         "alternative",
                         children=[

-                            Part("text", "plain", "part.txt", desc="Plain"),
+                            Part(
+                                "text",
+                                "plain",
+                                "part.txt",
+                                desc="Plain",
+                                orig=True,
+                            ),

                             Part("text", "html", "part.html", desc="HTML"),
                         ],
                         desc="Alternative",
                             Part("text", "html", "part.html", desc="HTML"),
                         ],
                         desc="Alternative",


@@ -523,12 +541,11 @@ try:
             assert items[2][1] == 1
             assert items[3][0].subtype == "png"
             assert items[3][1] == 1
             assert items[2][1] == 1
             assert items[3][0].subtype == "png"
             assert items[3][1] == 1

-            assert items[4][0].subtype == "related"
+            assert items[4][0].subtype == "relative"

             assert items[4][1] == 0
 
         def test_MIMETreeDFWalker_list_to_mixed(self, basic_mime_tree):
             mimetree = MIMETreeDFWalker()
             assert items[4][1] == 0
 
         def test_MIMETreeDFWalker_list_to_mixed(self, basic_mime_tree):
             mimetree = MIMETreeDFWalker()

-

             items = []
 
             def visitor_fn(item, stack, debugprint):
             items = []
 
             def visitor_fn(item, stack, debugprint):


@@ -570,5 +587,49 @@ try:
             assert lines[2].endswith(f'{const2},{const1}"')
             assert lines[4].endswith(const1)
 
             assert lines[2].endswith(f'{const2},{const1}"')
             assert lines[4].endswith(const1)
 

+        def test_do_massage_basic(self, const1, capsys):
+            def converter(maildraft, extensions):
+                return Part("text", "plain", "/dev/null", orig=True)
+
+            do_massage(maildraft=const1, cmd_f=sys.stdout, converter=converter)
+            captured = capsys.readouterr()
+            assert (
+                captured.out.strip()
+                == """\
+            set editor="$my_editor"
+            set edit_headers="$my_edit_headers"
+            unset my_editor
+            unset my_edit_headers
+            source 'rm -f pytest_internal_file|'
+            unset my_mdwn_postprocess_cmd_file
+            """.replace(
+                    "            ", ""
+                ).strip()
+            )
+
+        def test_do_massage_fulltree(self, const1, basic_mime_tree, capsys):
+            def converter(maildraft, extensions):
+                return basic_mime_tree
+
+            do_massage(maildraft=const1, cmd_f=sys.stdout, converter=converter)
+            captured = capsys.readouterr()
+            lines = captured.out.splitlines()[4:][::-1]
+            assert "Related" in lines.pop()
+            assert "group-related" in lines.pop()
+            assert "tag-entry" in lines.pop()
+            assert "Logo" in lines.pop()
+            assert "content-id" in lines.pop()
+            assert "toggle-unlink" in lines.pop()
+            assert "logo.png" in lines.pop()
+            assert "tag-entry" in lines.pop()
+            assert "Alternative" in lines.pop()
+            assert "group-alternatives" in lines.pop()
+            assert "tag-entry" in lines.pop()
+            assert "HTML" in lines.pop()
+            assert "toggle-unlink" in lines.pop()
+            assert "part.html" in lines.pop()
+            assert "tag-entry" in lines.pop()
+            assert "Plain" in lines.pop()
+

 except ImportError:
     pass
 except ImportError:
     pass