core/views: Pass spoiler data to MsgInfoView popup helpers.

Author: rsashank

tests/ui_tools/test_popups.py

@@ -469,6 +469,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
             title="Full Rendered Message",
         )
 
@@ -479,6 +480,7 @@ def test_init(self, msg_box: MessageBox) -> None:
         assert self.full_rendered_message.topic_links == OrderedDict()
         assert self.full_rendered_message.message_links == OrderedDict()
         assert self.full_rendered_message.time_mentions == list()
+        assert self.full_rendered_message.spoilers == list()
         assert self.full_rendered_message.header.widget_list == msg_box.header
         assert self.full_rendered_message.footer.widget_list == msg_box.footer
 
@@ -521,6 +523,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
 
 
@@ -545,6 +548,7 @@ def mock_external_classes(self, mocker: MockerFixture, msg_box: MessageBox) -> N
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
             title="Full Raw Message",
         )
 
@@ -555,6 +559,7 @@ def test_init(self, msg_box: MessageBox) -> None:
         assert self.full_raw_message.topic_links == OrderedDict()
         assert self.full_raw_message.message_links == OrderedDict()
         assert self.full_raw_message.time_mentions == list()
+        assert self.full_raw_message.spoilers == list()
         assert self.full_raw_message.header.widget_list == msg_box.header
         assert self.full_raw_message.footer.widget_list == msg_box.footer
 
@@ -597,6 +602,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
 
 
@@ -620,6 +626,7 @@ def mock_external_classes(self, mocker: MockerFixture) -> None:
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
             title="Edit History",
         )
 
@@ -629,6 +636,7 @@ def test_init(self) -> None:
         assert self.edit_history_view.topic_links == OrderedDict()
         assert self.edit_history_view.message_links == OrderedDict()
         assert self.edit_history_view.time_mentions == list()
+        assert self.edit_history_view.spoilers == list()
         self.controller.model.fetch_message_history.assert_called_once_with(
             message_id=self.message["id"],
         )
@@ -668,6 +676,7 @@ def test_keypress_show_msg_info(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
 
     @pytest.mark.parametrize(
@@ -986,13 +995,15 @@ def mock_external_classes(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
 
     def test_init(self, message_fixture: Message) -> None:
         assert self.msg_info_view.msg == message_fixture
         assert self.msg_info_view.topic_links == OrderedDict()
         assert self.msg_info_view.message_links == OrderedDict()
         assert self.msg_info_view.time_mentions == list()
+        assert self.msg_info_view.spoilers == list()
 
     def test_pop_up_info_order(self, message_fixture: Message) -> None:
         topic_links = OrderedDict([("https://bar.com", ("topic", 1, True))])
@@ -1004,6 +1015,7 @@ def test_pop_up_info_order(self, message_fixture: Message) -> None:
             topic_links=topic_links,
             message_links=message_links,
             time_mentions=list(),
+            spoilers=list(),
         )
         msg_links = msg_info_view.button_widgets
         assert msg_links == [message_links, topic_links]
@@ -1052,6 +1064,7 @@ def test_keypress_edit_history(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1063,6 +1076,7 @@ def test_keypress_edit_history(
                 topic_links=OrderedDict(),
                 message_links=OrderedDict(),
                 time_mentions=list(),
+                spoilers=list(),
             )
         else:
             self.controller.show_edit_history.assert_not_called()
@@ -1081,6 +1095,7 @@ def test_keypress_full_rendered_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1091,6 +1106,7 @@ def test_keypress_full_rendered_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
 
     @pytest.mark.parametrize("key", keys_for_command("FULL_RAW_MESSAGE"))
@@ -1107,6 +1123,7 @@ def test_keypress_full_raw_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
         size = widget_size(msg_info_view)
 
@@ -1117,6 +1134,7 @@ def test_keypress_full_raw_message(
             topic_links=OrderedDict(),
             message_links=OrderedDict(),
             time_mentions=list(),
+            spoilers=list(),
         )
 
     @pytest.mark.parametrize(
@@ -1218,6 +1236,7 @@ def test_height_reactions(
             OrderedDict(),
             OrderedDict(),
             list(),
+            list(),
         )
         # 12 = 7 labels + 2 blank lines + 1 'Reactions' (category)
         # + 4 reactions (excluding 'Message Links').

zulipterminal/core.py

@@ -265,6 +265,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]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
     ) -> None:
         msg_info_view = MsgInfoView(
             self,
@@ -273,6 +274,7 @@ def show_msg_info(
             topic_links,
             message_links,
             time_mentions,
+            spoilers,
         )
         self.show_pop_up(msg_info_view, "area:msg")
 
@@ -343,6 +345,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]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
     ) -> None:
         self.show_pop_up(
             FullRenderedMsgView(
@@ -351,6 +354,7 @@ def show_full_rendered_message(
                 topic_links,
                 message_links,
                 time_mentions,
+                spoilers,
                 f"Full rendered message {SCROLL_PROMPT}",
             ),
             "area:msg",
@@ -362,6 +366,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]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
     ) -> None:
         self.show_pop_up(
             FullRawMsgView(
@@ -370,6 +375,7 @@ def show_full_raw_message(
                 topic_links,
                 message_links,
                 time_mentions,
+                spoilers,
                 f"Full raw message {SCROLL_PROMPT}",
             ),
             "area:msg",
@@ -381,6 +387,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]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
     ) -> None:
         self.show_pop_up(
             EditHistoryView(
@@ -389,6 +396,7 @@ def show_edit_history(
                 topic_links,
                 message_links,
                 time_mentions,
+                spoilers,
                 f"Edit History {SCROLL_PROMPT}",
             ),
             "area:msg",

zulipterminal/ui_tools/messages.py

@@ -1204,7 +1204,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.time_mentions,
+                self.spoilers,
             )
         elif is_command_key("ADD_REACTION", key):
             self.model.controller.show_emoji_picker(self.message)

zulipterminal/ui_tools/views.py

@@ -1568,11 +1568,13 @@ def __init__(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
     ) -> None:
         self.msg = msg
         self.topic_links = topic_links
         self.message_links = message_links
         self.time_mentions = time_mentions
+        self.spoilers = spoilers
         self.server_url = controller.model.server_url
         date_and_time = controller.model.formatted_local_time(
             msg["timestamp"], show_seconds=True, show_year=True
@@ -1717,6 +1719,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
         elif is_command_key("VIEW_IN_BROWSER", key):
             url = near_message_url(self.server_url[:-1], self.msg)
@@ -1727,6 +1730,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
             return key
         elif is_command_key("FULL_RAW_MESSAGE", key):
@@ -1735,6 +1739,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
             return key
         return super().keypress(size, key)
@@ -1784,13 +1789,15 @@ def __init__(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
         title: str,
     ) -> None:
         self.controller = controller
         self.message = message
         self.topic_links = topic_links
         self.message_links = message_links
         self.time_mentions = time_mentions
+        self.spoilers = spoilers
         width = 64
         widgets: List[Any] = []
 
@@ -1889,6 +1896,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
             return key
         return super().keypress(size, key)
@@ -1902,13 +1910,15 @@ def __init__(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
         title: str,
     ) -> None:
         self.controller = controller
         self.message = message
         self.topic_links = topic_links
         self.message_links = message_links
         self.time_mentions = time_mentions
+        self.spoilers = spoilers
         max_cols, max_rows = controller.maximum_popup_dimensions()
 
         # Get rendered message
@@ -1933,6 +1943,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
             return key
         return super().keypress(size, key)
@@ -1946,13 +1957,15 @@ def __init__(
         topic_links: Dict[str, Tuple[str, int, bool]],
         message_links: Dict[str, Tuple[str, int, bool]],
         time_mentions: List[Tuple[str, str]],
+        spoilers: List[Tuple[int, List[Any], List[Any]]],
         title: str,
     ) -> None:
         self.controller = controller
         self.message = message
         self.topic_links = topic_links
         self.message_links = message_links
         self.time_mentions = time_mentions
+        self.spoilers = spoilers
         max_cols, max_rows = controller.maximum_popup_dimensions()
 
         # Get rendered message header and footer
@@ -1983,6 +1996,7 @@ def keypress(self, size: urwid_Size, key: str) -> str:
                 topic_links=self.topic_links,
                 message_links=self.message_links,
                 time_mentions=self.time_mentions,
+                spoilers=self.spoilers,
             )
             return key
         return super().keypress(size, key)