core/views: Add support for copying code blocks.

Introduces support for copying code blocks in the message information
popup. Makes use of the CodeBlockButton class and its methods.
Tests added.

Co-authored-by: kingjuno <[email protected]>
Co-authored-by: yuktasarode <[email protected]>

Fixes #1123.

Author: rsashank

docs/hotkeys.md

@@ -66,6 +66,7 @@
 |View current message in browser (from message information)|<kbd>v</kbd>|
 |Show/hide full rendered message (from message information)|<kbd>f</kbd>|
 |Show/hide full raw message (from message information)|<kbd>r</kbd>|
+|Copy code block to clipboard (from message information)|<kbd>c</kbd>|
 
 ## Stream list actions
 |Command|Key Combination|

tests/ui_tools/test_popups.py

@@ -503,6 +503,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
             title="Full Rendered Message",
         )
 
@@ -555,6 +556,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
 
 
@@ -579,6 +581,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
             title="Full Raw Message",
         )
 
@@ -631,6 +634,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
 
 
@@ -654,6 +658,7 @@ def mock_external_classes(self, mocker: MockerFixture) -> None:
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
             title="Edit History",
         )
 
@@ -702,6 +707,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
 
     @pytest.mark.parametrize(
@@ -979,6 +985,7 @@ def mock_external_classes(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
 
     def test_init(self, message_fixture: Message) -> None:
@@ -997,6 +1004,7 @@ def test_pop_up_info_order(self, message_fixture: Message) -> None:
             topic_links=topic_links,
             message_links=message_links,
             time_mentions=list(),
+            code_blocks=list(),
         )
         msg_links = msg_info_view.button_widgets
         assert msg_links == [message_links, topic_links]
@@ -1045,6 +1053,7 @@ def test_keypress_edit_history(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1056,6 +1065,7 @@ def test_keypress_edit_history(
                 topic_links=OrderedDict(),
                 message_links=OrderedDict(),
                 time_mentions=list(),
+                code_blocks=list(),
             )
         else:
             self.controller.show_edit_history.assert_not_called()
@@ -1074,6 +1084,7 @@ def test_keypress_full_rendered_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1084,6 +1095,7 @@ def test_keypress_full_rendered_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
 
     @pytest.mark.parametrize("key", keys_for_command("FULL_RAW_MESSAGE"))
@@ -1100,6 +1112,7 @@ def test_keypress_full_raw_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1110,6 +1123,7 @@ def test_keypress_full_raw_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            code_blocks=list(),
         )
 
     @pytest.mark.parametrize(
@@ -1138,13 +1152,14 @@ def test_keypress_view_in_browser(
         assert self.controller.open_in_browser.called
 
     def test_height_noreactions(self) -> None:
-        expected_height = 8
-        # 6 = 1 (date & time) +1 (sender's name) +1 (sender's email)
+        expected_height = 9
+        # 3 = 1 (date & time) +1 (sender's name) +1 (sender's email)
         # +1 (display group header)
         # +1 (whitespace column)
         # +1 (view message in browser)
         # +1 (full rendered message)
         # +1 (full raw message)
+        # +1 (copy code block)
         assert self.msg_info_view.height == expected_height
 
     # FIXME This is the same parametrize as MessageBox:test_reactions_view
@@ -1211,10 +1226,11 @@ def test_height_reactions(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
-        # 12 = 7 labels + 2 blank lines + 1 'Reactions' (category)
+        # 11 = 8 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(
@@ -1264,6 +1280,118 @@ 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_block",
+            "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"},
+            ),
+            (
+                [
+                    (
+                        "JavaScript",
+                        [
+                            ("pygments:nx", "console"),
+                            ("pygments:p", "."),
+                            ("pygments:nx", "log"),
+                            ("pygments:p", "("),
+                            ("pygments:s2", '"Hello, world!"'),
+                            ("pygments:p", ");"),
+                            ("pygments:w", "\n"),
+                        ],
+                    )
+                ],
+                '1: JavaScript\nconsole.log("Hello, world!");',
+                {None: "popup_contrast"},
+                {None: "selected"},
+            ),
+            (
+                [
+                    (
+                        "C++",
+                        [
+                            ("pygments:cp", "#include"),
+                            ("pygments:w", " "),
+                            ("pygments:cpf", "<iostream>"),
+                            ("pygments:w", "\n\n"),
+                            ("pygments:kt", "int"),
+                            ("pygments:w", " "),
+                            ("pygments:nf", "main"),
+                            ("pygments:p", "()"),
+                            ("pygments:w", " "),
+                            ("pygments:p", "{"),
+                            ("pygments:w", "\n"),
+                            ("pygments:w", "    "),
+                            ("pygments:n", "std"),
+                            ("pygments:o", "::"),
+                            ("pygments:n", "cout"),
+                            ("pygments:w", " "),
+                            ("pygments:o", "<<"),
+                            ("pygments:w", " "),
+                            ("pygments:s", '"Hello World!"'),
+                            ("pygments:p", ";"),
+                            ("pygments:w", "\n"),
+                            ("pygments:w", "    "),
+                            ("pygments:k", "return"),
+                            ("pygments:w", " "),
+                            ("pygments:mi", "0"),
+                            ("pygments:p", ";"),
+                            ("pygments:w", "\n"),
+                            ("pygments:p", "}"),
+                            ("pygments:w", "\n"),
+                        ],
+                    )
+                ],
+                "1: C++\n#include <iostream>\n\nint main() {...",
+                {None: "popup_contrast"},
+                {None: "selected"},
+            ),
+        ],
+        ids=[
+            "with_python_code_block_two_lines",
+            "with_javascript_code_block_one_line",
+            "with_cpp_code_block_more_than_two_lines",
+        ],
+    )
+    def test_create_code_block_buttons(
+        self,
+        initial_code_block: 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_block_buttons(
+            self.controller, initial_code_block
+        )
+
+        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)

tools/lint-hotkeys

@@ -23,7 +23,7 @@ SCRIPT_NAME = PurePath(__file__).name
 HELP_TEXT_STYLE = re.compile(r"^[a-zA-Z /()',&@#:_-]*$")
 
 # Exclude keys from duplicate keys checking
-KEYS_TO_EXCLUDE = ["q", "e", "m", "r", "Esc"]
+KEYS_TO_EXCLUDE = ["q", "e", "m", "r", "Esc", "c"]
 
 
 def main(fix: bool) -> None:

zulipterminal/config/keys.py

@@ -438,6 +438,13 @@ class KeyBinding(TypedDict):
         'help_text': 'Show/hide full raw message (from message information)',
         'key_category': 'msg_actions',
     },
+    'COPY_CODE_BLOCK': {
+        'keys': ['c'],
+        'help_text':
+            'Copy code block to clipboard (from message information)',
+        'excluded_from_random_tips': True,
+        'key_category': 'msg_actions'
+    },
     'NEW_HINT': {
         'keys': ['tab'],
         'help_text': 'New footer hotkey hint',

zulipterminal/core.py

@@ -264,6 +264,7 @@ def show_msg_info(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        code_blocks: List[Tuple[str, List[Tuple[str, str]]]],
     ) -> None:
         msg_info_view = MsgInfoView(
             self,
@@ -272,6 +273,7 @@ def show_msg_info(
             topic_links,
             message_links,
             time_mentions,
+            code_blocks,
         )
         self.show_pop_up(msg_info_view, "area:msg")
 
@@ -342,6 +344,7 @@ def show_full_rendered_message(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        code_blocks: List[Tuple[str, List[Tuple[str, str]]]],
     ) -> None:
         self.show_pop_up(
             FullRenderedMsgView(
@@ -350,6 +353,7 @@ def show_full_rendered_message(
                 topic_links,
                 message_links,
                 time_mentions,
+                code_blocks,
                 f"Full rendered message {SCROLL_PROMPT}",
             ),
             "area:msg",
@@ -361,6 +365,7 @@ def show_full_raw_message(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        code_blocks: List[Tuple[str, List[Tuple[str, str]]]],
     ) -> None:
         self.show_pop_up(
             FullRawMsgView(
@@ -369,6 +374,7 @@ def show_full_raw_message(
                 topic_links,
                 message_links,
                 time_mentions,
+                code_blocks,
                 f"Full raw message {SCROLL_PROMPT}",
             ),
             "area:msg",
@@ -380,6 +386,7 @@ def show_edit_history(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        code_blocks: List[Tuple[str, List[Tuple[str, str]]]],
     ) -> None:
         self.show_pop_up(
             EditHistoryView(
@@ -388,6 +395,7 @@ def show_edit_history(
                 topic_links,
                 message_links,
                 time_mentions,
+                code_blocks,
                 f"Edit History {SCROLL_PROMPT}",
             ),
             "area:msg",

zulipterminal/ui_tools/buttons.py

@@ -742,6 +742,13 @@ def extract_display_code(self, code_block_list: List[Tuple[str, str]]) -> None:
             )
         self.display_code = [("pygments:w", self.caption)] + self.display_code
 
+    def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
+        if is_command_key("COPY_CODE_BLOCK", key):
+            urwid.emit_signal(
+                self, "click", lambda button: self.copy_to_clipboard(self.block_list)
+            )
+        return super().keypress(size, key)
+
 
 class EditModeButton(urwid.Button):
     def __init__(self, *, controller: Any, width: int) -> None: