messages/views: Add markup to code snippets.

Tests updated.

Author: rsashank

tests/ui_tools/test_messages.py

@@ -679,6 +679,7 @@ def test_soup2markup(self, content, expected_markup, mocker):
         metadata = dict(
             server_url=SERVER_URL,
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
             bq_len=0,
         )

zulipterminal/ui_tools/messages.py

@@ -62,6 +62,7 @@ def __init__(self, message: Message, model: "Model", last_message: Any) -> None:
         self.user_id: Optional[int] = None
         self.message_links: Dict[str, Tuple[str, int, bool]] = dict()
         self.topic_links: Dict[str, Tuple[str, int, bool]] = dict()
+        self.code_snippets: List[Tuple[str, List[Tuple[str, str]]]] = list()
         self.time_mentions: List[Tuple[str, str]] = list()
         self.last_message = last_message
         # if this is the first message
@@ -371,12 +372,22 @@ def footlinks_view(
     @classmethod
     def soup2markup(
         cls, soup: Any, metadata: Dict[str, Any], **state: Any
-    ) -> Tuple[List[Any], Dict[str, Tuple[str, int, bool]], List[Tuple[str, str]]]:
+    ) -> Tuple[
+        List[Any],
+        Dict[str, Tuple[str, int, bool]],
+        List[Tuple[str, List[Tuple[str, str]]]],
+        List[Tuple[str, str]],
+    ]:
         # Ensure a string is provided, in case the soup finds none
         # This could occur if eg. an image is removed or not shown
         markup: List[Union[str, Tuple[Optional[str], Any]]] = [""]
         if soup is None:  # This is not iterable, so return promptly
-            return markup, metadata["message_links"], metadata["time_mentions"]
+            return (
+                markup,
+                metadata["message_links"],
+                metadata["code_snippets"],
+                metadata["time_mentions"],
+            )
         unrendered_tags = {  # In pairs of 'tag_name': 'text'
             # TODO: Some of these could be implemented
             "br": "",  # No indicator of absence
@@ -551,7 +562,7 @@ def soup2markup(
                 # Ref: https://github.com/Python-Markdown/markdown/pull/862
                 if code_soup is None:
                     code_soup = element.pre
-
+                code_snippet = []
                 for code_element in code_soup.contents:
                     code_text = (
                         code_element.text
@@ -564,8 +575,15 @@ def soup2markup(
                             continue
                         css_style = code_element.attrs.get("class", ["w"])
                         markup.append((f"pygments:{css_style[0]}", code_text))
+                        code_snippet.append((f"pygments:{css_style[0]}", code_text))
                     else:
                         markup.append(("pygments:w", code_text))
+                        code_snippet.append(("pygments:w", code_text))
+
+                code_language = element.attrs.get("data-code-language")
+
+                if code_language != "Text only":
+                    metadata["code_snippets"].append((code_language, code_snippet))
             elif tag in ("strong", "em"):
                 # BOLD & ITALIC
                 markup.append(("msg_bold", tag_text))
@@ -634,7 +652,12 @@ def soup2markup(
                 metadata["time_mentions"].append((time_string, source_text))
             else:
                 markup.extend(cls.soup2markup(element, metadata)[0])
-        return markup, metadata["message_links"], metadata["time_mentions"]
+        return (
+            markup,
+            metadata["message_links"],
+            metadata["code_snippets"],
+            metadata["time_mentions"],
+        )
 
     def main_view(self) -> List[Any]:
         # Recipient Header
@@ -730,11 +753,13 @@ def main_view(self) -> List[Any]:
             )
 
         # Transform raw message content into markup (As needed by urwid.Text)
-        content, self.message_links, self.time_mentions = self.transform_content(
-            self.message["content"], self.model.server_url
-        )
+        (
+            content,
+            self.message_links,
+            self.code_snippets,
+            self.time_mentions,
+        ) = self.transform_content(self.message["content"], self.model.server_url)
         self.content.set_text(content)
-
         if self.message["id"] in self.model.index["edited_messages"]:
             edited_label_size = 7
             left_padding = 1
@@ -818,6 +843,7 @@ def transform_content(
     ) -> Tuple[
         Tuple[None, Any],
         Dict[str, Tuple[str, int, bool]],
+        List[Tuple[str, List[Tuple[str, str]]]],
         List[Tuple[str, str]],
     ]:
         soup = BeautifulSoup(content, "lxml")
@@ -826,14 +852,17 @@ def transform_content(
         metadata = dict(
             server_url=server_url,
             message_links=dict(),
+            code_snippets=list(),
             time_mentions=list(),
         )  # type: Dict[str, Any]
 
         if isinstance(body, Tag) and body.find(name="blockquote"):
             metadata["bq_len"] = cls.indent_quoted_content(soup, QUOTED_TEXT_MARKER)
 
-        markup, message_links, time_mentions = cls.soup2markup(body, metadata)
-        return (None, markup), message_links, time_mentions
+        markup, message_links, code_snippets, time_mentions = cls.soup2markup(
+            body, metadata
+        )
+        return (None, markup), message_links, code_snippets, time_mentions
 
     @staticmethod
     def indent_quoted_content(soup: Any, padding_char: str) -> int:
@@ -1121,7 +1150,11 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             self.model.controller.view.middle_column.set_focus("footer")
         elif is_command_key("MSG_INFO", key):
             self.model.controller.show_msg_info(
-                self.message, self.topic_links, self.message_links, self.time_mentions
+                self.message,
+                self.topic_links,
+                self.message_links,
+                self.code_snippets,
+                self.time_mentions,
             )
         elif is_command_key("ADD_REACTION", key):
             self.model.controller.show_emoji_picker(self.message)

zulipterminal/ui_tools/views.py

@@ -1397,7 +1397,7 @@ def __init__(self, controller: Any, stream_id: int) -> None:
 
         title = f"{stream_marker} {stream['name']}"
         rendered_desc = stream["rendered_description"]
-        self.markup_desc, message_links, _ = MessageBox.transform_content(
+        self.markup_desc, message_links, _, _ = MessageBox.transform_content(
             rendered_desc,
             self.controller.model.server_url,
         )