refactor: boxes/buttons/helper/model/ui: Hook semantic style helpers.

This commit replaces those instances of `set_footer_text` with new
helpers, that notify user of a success/error/warning response.

Tests amended.
Fixes #782.

Author: Ezio-Sarthak

tests/core/test_core.py

@@ -278,26 +278,26 @@ def test_narrow_to_all_mentions(self, mocker, controller, index_all_mentions):
     def test_open_in_browser_success(self, mocker, controller, url):
         # Set DISPLAY environ to be able to run test in CI
         os.environ["DISPLAY"] = ":0"
-        controller.view.set_footer_text = mocker.Mock()
+        controller.report_success = mocker.Mock()
         mock_get = mocker.patch(CORE + ".webbrowser.get")
         mock_open = mock_get.return_value.open
 
         controller.open_in_browser(url)
 
         mock_open.assert_called_once_with(url)
-        controller.view.set_footer_text.assert_called_once_with(
-            f"The link was successfully opened using {mock_get.return_value.name}", 3
+        controller.report_success.assert_called_once_with(
+            f"The link was successfully opened using {mock_get.return_value.name}"
         )
 
     def test_open_in_browser_fail__no_browser_controller(self, mocker, controller):
         os.environ["DISPLAY"] = ":0"
         error = "No runnable browser found"
-        controller.view.set_footer_text = mocker.Mock()
+        controller.report_error = mocker.Mock()
         mocker.patch(CORE + ".webbrowser.get").side_effect = webbrowser.Error(error)
 
         controller.open_in_browser("https://chat.zulip.org/#narrow/stream/test")
 
-        controller.view.set_footer_text.assert_called_once_with(f"ERROR: {error}", 3)
+        controller.report_error.assert_called_once_with(f"ERROR: {error}")
 
     def test_main(self, mocker, controller):
         controller.view.palette = {"default": "theme_properties"}

tests/helper/test_helper.py

@@ -343,14 +343,14 @@ def test_notify_quotes(monkeypatch, mocker, OS, cmd_length, title, text):
 )
 def test_display_error_if_present(mocker, response, footer_updated):
     controller = mocker.Mock()
-    set_footer_text = controller.view.set_footer_text
+    report_error = controller.report_error
 
     display_error_if_present(response, controller)
 
     if footer_updated:
-        set_footer_text.assert_called_once_with(response["msg"], 3)
+        report_error.assert_called_once_with(response["msg"])
     else:
-        set_footer_text.assert_not_called()
+        report_error.assert_not_called()
 
 
 @pytest.mark.parametrize(
@@ -424,17 +424,17 @@ def test_display_error_if_present(mocker, response, footer_updated):
 )
 def test_notify_if_message_sent_outside_narrow(mocker, req, narrow, footer_updated):
     controller = mocker.Mock()
-    set_footer_text = controller.view.set_footer_text
+    report_success = controller.report_success
     controller.model.narrow = narrow
 
     notify_if_message_sent_outside_narrow(req, controller)
 
     if footer_updated:
-        set_footer_text.assert_called_once_with(
-            "Message is sent outside of current narrow.", 3
+        report_success.assert_called_once_with(
+            "Message is sent outside of current narrow."
         )
     else:
-        set_footer_text.assert_not_called()
+        report_success.assert_not_called()
 
 
 @pytest.mark.parametrize(

tests/model/test_model.py

@@ -667,11 +667,11 @@ def test_update_stream_message(
         self.client.update_message.assert_called_once_with(req)
         assert result == return_value
         self.display_error_if_present.assert_called_once_with(response, self.controller)
-        set_footer_text = model.controller.view.set_footer_text
+        report_success = model.controller.report_success
         if result and footer_updated:
-            set_footer_text.assert_called_once_with("You changed a message's topic.", 3)
+            report_success.assert_called_once_with("You changed a message's topic.")
         else:
-            set_footer_text.assert_not_called()
+            report_success.assert_not_called()
 
     # NOTE: This tests only getting next-unread, not a fixed anchor
     def test_success_get_messages(

tests/ui/test_ui.py

@@ -356,7 +356,7 @@ def test_keypress_autohide_streams(self, view, mocker, autohide, key, widget_siz
     def test_keypress_OPEN_DRAFT(self, view, mocker, draft, key, widget_size):
         view.body = mocker.Mock()
         view.middle_column = mocker.Mock()
-        view.set_footer_text = mocker.Mock()
+        view.controller.report_error = mocker.Mock()
         view.controller.is_in_editor_mode = lambda: False
         view.model.stream_id_from_name.return_value = 10
         view.model.session_draft_message.return_value = draft
@@ -383,8 +383,8 @@ def test_keypress_OPEN_DRAFT(self, view, mocker, draft, key, widget_size):
             assert view.write_box.msg_write_box.edit_pos == len(draft["content"])
             view.middle_column.set_focus.assert_called_once_with("footer")
         else:
-            view.set_footer_text.assert_called_once_with(
-                "No draft message was saved in this session.", 3
+            view.controller.report_error.assert_called_once_with(
+                "No draft message was saved in this session."
             )
 
     @pytest.mark.parametrize("key", keys_for_command("SEARCH_PEOPLE"))

tests/ui_tools/test_buttons.py

@@ -853,7 +853,7 @@ def test__switch_narrow_to(
         assert mocked_button.controller.narrow_to_topic.called == narrow_to_topic_called
 
     @pytest.mark.parametrize(
-        "error, set_footer_text_called, _switch_narrow_to_called, exit_popup_called",
+        "error, report_error_called, _switch_narrow_to_called, exit_popup_called",
         [
             ("Some Validation Error", True, False, False),
             ("", False, True, True),
@@ -867,7 +867,7 @@ def test_handle_narrow_link(
         self,
         mocker,
         error,
-        set_footer_text_called,
+        report_error_called,
         _switch_narrow_to_called,
         exit_popup_called,
     ):
@@ -883,6 +883,6 @@ def test_handle_narrow_link(
 
         assert mocked_button._parse_narrow_link.called
         assert mocked_button._validate_narrow_link.called
-        assert mocked_button.view.set_footer_text.called == set_footer_text_called
+        assert mocked_button.controller.report_error.called == report_error_called
         assert mocked_button._switch_narrow_to.called == _switch_narrow_to_called
         assert mocked_button.controller.exit_popup.called == exit_popup_called

zulipterminal/core.py

@@ -313,10 +313,9 @@ def open_in_browser(self, url: str) -> None:
         # Don't try to open web browser if running without a GUI
         # TODO: Explore and eventually support opening links in text-browsers.
         if LINUX and not os.environ.get("DISPLAY") and os.environ.get("TERM"):
-            self.view.set_footer_text(
+            self.report_error(
                 "No DISPLAY environment variable specified. This could "
-                "likely mean the ZT host is running without a GUI.",
-                3,
+                "likely mean the ZT host is running without a GUI."
             )
             return
         try:
@@ -326,13 +325,12 @@ def open_in_browser(self, url: str) -> None:
             # Suppress stdout and stderr when opening browser
             with suppress_output():
                 browser_controller.open(url)
-                self.view.set_footer_text(
-                    f"The link was successfully opened using {browser_controller.name}",
-                    3,
+                self.report_success(
+                    f"The link was successfully opened using {browser_controller.name}"
                 )
         except webbrowser.Error as e:
             # Set a footer text if no runnable browser is located
-            self.view.set_footer_text(f"ERROR: {e}", 3)
+            self.report_error(f"ERROR: {e}")
 
     def report_error(self, text: str) -> None:
         """

zulipterminal/helper.py

@@ -661,7 +661,7 @@ def notify(title: str, html_text: str) -> str:
 
 def display_error_if_present(response: Dict[str, Any], controller: Any) -> None:
     if response["result"] == "error" and hasattr(controller, "view"):
-        controller.view.set_footer_text(response["msg"], 3)
+        controller.report_error(response["msg"])
 
 
 def check_narrow_and_notify(
@@ -674,7 +674,7 @@ def check_narrow_and_notify(
         and current_narrow != outer_narrow
         and current_narrow != inner_narrow
     ):
-        controller.view.set_footer_text("Message is sent outside of current narrow.", 3)
+        controller.report_success("Message is sent outside of current narrow.")
 
 
 def notify_if_message_sent_outside_narrow(

zulipterminal/model.py

@@ -376,7 +376,7 @@ def session_draft_message(self) -> Optional[Composition]:
 
     def save_draft(self, draft: Composition) -> None:
         self._draft = deepcopy(draft)
-        self.controller.view.set_footer_text("Saved message as draft", 3)
+        self.controller.report_success("Saved message as draft")
 
     @asynch
     def toggle_message_star_status(self, message: Message) -> None:
@@ -471,9 +471,8 @@ def update_stream_message(
         if response["result"] == "success":
             old_topic = self.index["messages"][message_id].get("subject", None)
             new_topic = request["topic"]
-            view = self.controller.view
             if old_topic != new_topic:
-                view.set_footer_text("You changed a message's topic.", 3)
+                self.controller.report_success("You changed a message's topic.")
 
         return response["result"] == "success"
 

zulipterminal/ui.py

@@ -269,7 +269,9 @@ def keypress(self, size: urwid_Box, key: str) -> Optional[str]:
                 self.body.focus_col = 1
                 self.middle_column.set_focus("footer")
             else:
-                self.set_footer_text("No draft message was saved in this session.", 3)
+                self.controller.report_error(
+                    "No draft message was saved in this session."
+                )
             return key
         elif is_command_key("ABOUT", key):
             self.controller.show_about()

zulipterminal/ui_tools/boxes.py

@@ -568,8 +568,8 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                             content=self.msg_write_box.edit_text,
                         )
                     else:
-                        self.view.set_footer_text(
-                            "Cannot send message without specifying recipients.", 3
+                        self.view.controller.report_error(
+                            "Cannot send message without specifying recipients."
                         )
                         success = None
             if success:
@@ -624,7 +624,7 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                                     primary_key_for_command("AUTOCOMPLETE_REVERSE"),
                                 )
                             )
-                            self.view.set_footer_text(invalid_stream_error, 3)
+                            self.view.controller.report_error(invalid_stream_error)
                             return key
                         user_ids = self.model.get_other_subscribers_in_stream(
                             stream_name=stream_name
@@ -658,7 +658,7 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                         invalid_emails_error = (
                             f"Invalid recipient(s) - {', '.join(invalid_emails)}"
                         )
-                        self.view.set_footer_text(invalid_emails_error, 3)
+                        self.view.controller.report_error(invalid_emails_error)
                         return key
                     users = self.model.user_dict
                     self.recipient_user_ids = [
@@ -1443,7 +1443,8 @@ def mouse_event(
                     "Try pressing ",
                     ("footer_contrast", f" {selection_key} "),
                     " and dragging to select text.",
-                ]
+                ],
+                "task:warning",
             )
             self.displaying_selection_hint = True
         elif event == "mouse release" and self.displaying_selection_hint:
@@ -1569,15 +1570,13 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             self.model.controller.view.middle_column.set_focus("footer")
         elif is_command_key("EDIT_MESSAGE", key):
             if self.message["sender_id"] != self.model.user_id:
-                self.model.controller.view.set_footer_text(
-                    " You can't edit messages sent by other users.", 3
+                self.model.controller.report_error(
+                    " You can't edit messages sent by other users."
                 )
                 return key
             # Check if editing is allowed in the realm
             elif not self.model.initial_data["realm_allow_message_editing"]:
-                self.model.controller.view.set_footer_text(
-                    " Editing sent message is disabled.", 3
-                )
+                self.model.controller.report_error(" Editing sent message is disabled.")
                 return key
             # Check if message is still editable, i.e. within
             # the time limit. A limit of 0 signifies no limit
@@ -1590,16 +1589,15 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                 ]
                 if time_since_msg_sent >= edit_time_limit:
                     if self.message["type"] == "private":
-                        self.model.controller.view.set_footer_text(
-                            " Time Limit for editing the message has been exceeded.", 3
+                        self.model.controller.report_error(
+                            " Time Limit for editing the message has been exceeded."
                         )
                         return key
                     elif self.message["type"] == "stream":
-                        self.model.controller.view.set_footer_text(
+                        self.model.controller.report_warning(
                             " Only topic editing allowed."
                             " Time Limit for editing the message body has"
                             " been exceeded.",
-                            3,
                         )
                         msg_body_edit_enabled = False