core/views: Add support for copying code snippets.

Fixes #1123.
Introduces support for copying code snippets in the message information popup.
Makes use of the CodeSnippetButton class and its methods.
Tests added.

Author: rsashank

tests/ui_tools/test_popups.py

@@ -467,6 +467,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             message=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
             title="Full Rendered Message",
         )
@@ -519,6 +520,7 @@ def test_keypress_show_msg_info(
             msg=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
 
@@ -543,6 +545,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             message=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
             title="Full Raw Message",
         )
@@ -595,6 +598,7 @@ def test_keypress_show_msg_info(
             msg=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
 
@@ -618,6 +622,7 @@ def mock_external_classes(self, mocker: MockerFixture) -> None:
             message=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
             title="Edit History",
         )
@@ -666,6 +671,7 @@ def test_keypress_show_msg_info(
             msg=self.message,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
 
@@ -944,6 +950,7 @@ def mock_external_classes(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
 
     def test_init(self, message_fixture: Message) -> None:
@@ -961,6 +968,7 @@ def test_pop_up_info_order(self, message_fixture: Message) -> None:
             title="Message Information",
             topic_links=topic_links,
             message_links=message_links,
+            code_snippets=list(),
             time_mentions=list(),
         )
         msg_links = msg_info_view.button_widgets
@@ -1009,6 +1017,7 @@ def test_keypress_edit_history(
             title="Message Information",
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
         size = widget_size(msg_info_view)
@@ -1020,6 +1029,7 @@ def test_keypress_edit_history(
                 message=message_fixture,
                 topic_links=OrderedDict(),
                 message_links=OrderedDict(),
+                code_snippets=list(),
                 time_mentions=list(),
             )
         else:
@@ -1038,6 +1048,7 @@ def test_keypress_full_rendered_message(
             title="Message Information",
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
         size = widget_size(msg_info_view)
@@ -1048,6 +1059,7 @@ def test_keypress_full_rendered_message(
             message=message_fixture,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
 
@@ -1064,6 +1076,7 @@ def test_keypress_full_raw_message(
             title="Message Information",
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
         size = widget_size(msg_info_view)
@@ -1074,6 +1087,7 @@ def test_keypress_full_raw_message(
             message=message_fixture,
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
+            code_snippets=list(),
             time_mentions=list(),
         )
 
@@ -1103,7 +1117,7 @@ def test_keypress_view_in_browser(
         assert self.controller.open_in_browser.called
 
     def test_height_noreactions(self) -> None:
-        expected_height = 8
+        expected_height = 9
         # 6 = 1 (date & time) +1 (sender's name) +1 (sender's email)
         # +1 (display group header)
         # +1 (whitespace column)
@@ -1176,10 +1190,11 @@ def test_height_reactions(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
         # 12 = 7 labels + 2 blank lines + 1 'Reactions' (category)
         # + 4 reactions (excluding 'Message Links').
-        expected_height = 14
+        expected_height = 15
         assert self.msg_info_view.height == expected_height
 
     @pytest.mark.parametrize(
@@ -1229,6 +1244,54 @@ def test_create_link_buttons(
         assert link_w._wrapped_widget.attr_map == expected_attr_map
         assert link_width == expected_link_width
 
+    @pytest.mark.parametrize(
+        [
+            "initial_code_snippet",
+            "expected_code",
+            "expected_attr_map",
+            "expected_focus_map",
+        ],
+        [
+            (
+                [
+                    (
+                        "Python",
+                        [
+                            ("pygments:k", "def"),
+                            ("pygments:w", " "),
+                            ("pygments:nf", "main"),
+                            ("pygments:p", "()"),
+                            ("pygments:w", "\n  "),
+                            ("pygments:nb", "print"),
+                            ("pygments:p", "("),
+                            ("pygments:s2", '"Hello"'),
+                            ("pygments:p", ")"),
+                            ("pygments:w", "\n"),
+                        ],
+                    )
+                ],
+                '1: Python\ndef main()\n  print("Hello")...',
+                {None: "popup_contrast"},
+                {None: "selected"},
+            )
+        ],
+        ids=["with_code_snippet"],
+    )
+    def test_create_code_snippet_buttons(
+        self,
+        initial_code_snippet: List[Tuple[str, List[Tuple[str, str]]]],
+        expected_code: str,
+        expected_attr_map: Dict[None, str],
+        expected_focus_map: Dict[None, str],
+    ) -> None:
+        [code_w], _ = self.msg_info_view.create_code_snippet_buttons(
+            self.controller, initial_code_snippet
+        )
+
+        assert code_w._wrapped_widget.original_widget.text == expected_code
+        assert code_w._wrapped_widget.focus_map == expected_focus_map
+        assert code_w._wrapped_widget.attr_map == expected_attr_map
+
 
 class TestStreamInfoView:
     @pytest.fixture(autouse=True)

zulipterminal/core.py

@@ -261,6 +261,7 @@ def show_msg_info(
         msg: Message,
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
+        code_snippets: List[Tuple[str, List[Tuple[str, str]]]],
         time_mentions: List[Tuple[str, str]],
     ) -> None:
         msg_info_view = MsgInfoView(
@@ -269,6 +270,7 @@ def show_msg_info(
             "Message Information (up/down scrolls)",
             topic_links,
             message_links,
+            code_snippets,
             time_mentions,
         )
         self.show_pop_up(msg_info_view, "area:msg")
@@ -336,6 +338,7 @@ def show_full_rendered_message(
         message: Message,
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
+        code_snippets: List[Tuple[str, List[Tuple[str, str]]]],
         time_mentions: List[Tuple[str, str]],
     ) -> None:
         self.show_pop_up(
@@ -344,6 +347,7 @@ def show_full_rendered_message(
                 message,
                 topic_links,
                 message_links,
+                code_snippets,
                 time_mentions,
                 "Full rendered message (up/down scrolls)",
             ),
@@ -355,6 +359,7 @@ def show_full_raw_message(
         message: Message,
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
+        code_snippets: List[Tuple[str, List[Tuple[str, str]]]],
         time_mentions: List[Tuple[str, str]],
     ) -> None:
         self.show_pop_up(
@@ -363,6 +368,7 @@ def show_full_raw_message(
                 message,
                 topic_links,
                 message_links,
+                code_snippets,
                 time_mentions,
                 "Full raw message (up/down scrolls)",
             ),
@@ -374,6 +380,7 @@ def show_edit_history(
         message: Message,
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
+        code_snippets: List[Tuple[str, List[Tuple[str, str]]]],
         time_mentions: List[Tuple[str, str]],
     ) -> None:
         self.show_pop_up(
@@ -382,6 +389,7 @@ def show_edit_history(
                 message,
                 topic_links,
                 message_links,
+                code_snippets,
                 time_mentions,
                 "Edit History (up/down scrolls)",
             ),