model/boxes/buttons/views: Add stream_name_from_id method to model.

This commit introduces the stream_name_from_id method in
order to limit the direct accessing of stream_dict outside the
model. The commit also replaces the access of the name attribute
from stream_dict with the new method.

Tests added and updated.

Author: theViz343

tests/model/test_model.py

@@ -1913,6 +1913,29 @@ def test_get_all_stream_ids(
         model._never_subscribed_streams = never_subscribed_streams
         assert model.get_all_stream_ids() == all_stream_ids
 
+    @pytest.mark.parametrize(
+        "stream_id, expected_stream_name",
+        [
+            case(
+                1000,
+                "Some general stream",
+                id="Subscribed stream",
+            ),
+            case(
+                3,
+                "Stream 3",
+                id="Unsubscribed stream",
+            ),
+            case(
+                5,
+                "Stream 5",
+                id="Never subscribed stream",
+            ),
+        ],
+    )
+    def test_stream_name_from_id(self, model, stream_id, expected_stream_name):
+        assert model.stream_name_from_id(stream_id) == expected_stream_name
+
     @pytest.mark.parametrize("muted", powerset([99, 1000]))
     @pytest.mark.parametrize("visual_notification_enabled", powerset([99, 1000]))
     def test__subscribe_to_streams(

tests/ui/test_ui_tools.py

@@ -889,8 +889,8 @@ def test_keypress_NEXT_UNREAD_TOPIC_stream(
         mocker.patch(MIDCOLVIEW + ".focus_position")
         mocker.patch.object(self.view, "message_view")
 
-        mid_col_view.model.stream_dict = {1: {"name": "stream"}}
         mid_col_view.model.next_unread_topic_from_message_id.return_value = (1, "topic")
+        mid_col_view.model.stream_name_from_id.return_value = "stream"
 
         return_value = mid_col_view.keypress(size, key)
 

tests/ui_tools/test_boxes.py

@@ -153,11 +153,11 @@ def test_generic_autocomplete_stream_and_topic(
         is_valid_stream: bool,
         required_typeahead: Optional[str],
         topics: List[str],
-        stream_dict: Dict[int, Dict[str, Any]],
+        all_stream_ids: List[int],
     ) -> None:
         write_box.model.topics_in_stream.return_value = topics
         write_box.model.is_valid_stream.return_value = is_valid_stream
-        write_box.model.stream_dict = stream_dict
+        write_box.model.get_all_stream_ids.return_value = all_stream_ids
         write_box.model.muted_streams = set()
         typeahead_string = write_box.generic_autocomplete(text, state)
 
@@ -573,12 +573,12 @@ def test_generic_autocomplete_set_footer(
         state: Optional[int],
         footer_text: List[Any],
         text: str,
-        stream_dict: Dict[int, Dict[str, Any]],
+        all_stream_ids: List[int],
     ) -> None:
         write_box.view.set_typeahead_footer = mocker.patch(
             "zulipterminal.ui.View.set_typeahead_footer"
         )
-        write_box.model.stream_dict = stream_dict
+        write_box.model.get_all_stream_ids.return_value = all_stream_ids
         write_box.model.muted_streams = set()
         write_box.generic_autocomplete(text, state)
 
@@ -941,6 +941,7 @@ def test_generic_autocomplete_streams(
         state_and_required_typeahead: Dict[int, Optional[str]],
         stream_categories: Dict[str, Any],
         stream_dict: Dict[int, Dict[str, Any]],
+        all_stream_ids: List[int],
     ) -> None:
         streams_to_pin = (
             [{"name": stream_name} for stream_name in stream_categories["pinned"]]
@@ -951,12 +952,15 @@ def test_generic_autocomplete_streams(
             write_box.view.unpinned_streams.remove(stream)
         write_box.view.pinned_streams = streams_to_pin
         write_box.stream_id = stream_categories.get("current_stream", None)
-        write_box.model.stream_dict = stream_dict
         write_box.model.muted_streams = {
             stream["stream_id"]
             for stream in stream_dict.values()
             if stream["name"] in stream_categories.get("muted", set())
         }
+        write_box.model.get_all_stream_ids.return_value = all_stream_ids
+        write_box.model.stream_name_from_id.side_effect = lambda x: stream_dict[x][
+            "name"
+        ]
         states = state_and_required_typeahead.keys()
         required_typeaheads = list(state_and_required_typeahead.values())
         typeahead_strings = [

tests/ui_tools/test_buttons.py

@@ -444,6 +444,8 @@ def test_init_calls_top_button(
         top_button = mocker.patch(MODULE + ".TopButton.__init__")
         params = dict(controller=controller, count=count)
 
+        controller.model.stream_name_from_id.return_value = stream_name
+
         topic_button = TopicButton(
             stream_id=stream_id, topic=title, view=view, **params
         )
@@ -922,6 +924,7 @@ def test__validate_narrow_link(
             "is_user_subscribed_to_stream",
             "is_valid_stream",
             "stream_id_from_name_return_value",
+            "stream_name_from_id_return_value",
             "expected_parsed_link",
             "expected_error",
         ],
@@ -933,6 +936,7 @@ def test__validate_narrow_link(
                 True,
                 None,
                 None,
+                "Stream 1",
                 ParsedNarrowLink(
                     stream=DecodedStream(stream_id=1, stream_name="Stream 1")
                 ),
@@ -945,6 +949,7 @@ def test__validate_narrow_link(
                 False,
                 None,
                 None,
+                None,
                 ParsedNarrowLink(stream=DecodedStream(stream_id=462, stream_name=None)),
                 "The stream seems to be either unknown or unsubscribed",
             ),
@@ -955,6 +960,7 @@ def test__validate_narrow_link(
                 None,
                 True,
                 1,
+                None,
                 ParsedNarrowLink(
                     stream=DecodedStream(stream_id=1, stream_name="Stream 1")
                 ),
@@ -967,6 +973,7 @@ def test__validate_narrow_link(
                 None,
                 False,
                 None,
+                "foo",
                 ParsedNarrowLink(
                     stream=DecodedStream(stream_id=None, stream_name="foo")
                 ),
@@ -982,15 +989,14 @@ def test__validate_narrow_link(
     )
     def test__validate_and_patch_stream_data(
         self,
-        stream_dict: Dict[int, Any],
         parsed_link: ParsedNarrowLink,
         is_user_subscribed_to_stream: Optional[bool],
         is_valid_stream: Optional[bool],
         stream_id_from_name_return_value: Optional[int],
+        stream_name_from_id_return_value: Optional[str],
         expected_parsed_link: ParsedNarrowLink,
         expected_error: str,
     ) -> None:
-        self.controller.model.stream_dict = stream_dict
         self.controller.model.stream_id_from_name.return_value = (
             stream_id_from_name_return_value
         )
@@ -1000,6 +1006,10 @@ def test__validate_and_patch_stream_data(
         self.controller.model.is_valid_stream.return_value = is_valid_stream
         mocked_button = self.message_link_button()
 
+        mocked_button.model.stream_name_from_id.return_value = (
+            stream_name_from_id_return_value
+        )
+
         error = mocked_button._validate_and_patch_stream_data(parsed_link)
 
         assert parsed_link == expected_parsed_link

zulipterminal/model.py

@@ -890,7 +890,7 @@ def is_muted_topic(self, stream_id: int, topic: str) -> bool:
         """
         Returns True if topic is muted via muted_topics.
         """
-        stream_name = self.stream_dict[stream_id]["name"]
+        stream_name = self.stream_name_from_id(stream_id)
         topic_to_search = (stream_name, topic)
         return topic_to_search in self._muted_topics
 
@@ -1307,6 +1307,10 @@ def get_all_stream_ids(self) -> List[int]:
         id_list.extend(stream_id for stream_id in self._never_subscribed_streams)
         return id_list
 
+    def stream_name_from_id(self, stream_id: int) -> str:
+        stream = self._get_stream_from_id(stream_id)
+        return stream["name"]
+
     def _subscribe_to_streams(self, subscriptions: List[Subscription]) -> None:
         def make_reduced_stream_data(stream: Subscription) -> StreamData:
             # stream_id has been changed to id.

zulipterminal/ui_tools/boxes.py

@@ -618,7 +618,7 @@ def autocomplete_streams(
         )
 
         muted_streams = [
-            self.model.stream_dict[stream_id]["name"]
+            self.model.stream_name_from_id(stream_id)
             for stream_id in self.model.muted_streams
         ]
         matching_muted_streams = [
@@ -637,9 +637,8 @@ def autocomplete_streams(
             else:
                 matched_streams.append(matching_muted_stream)
 
-        current_stream = self.model.stream_dict.get(self.stream_id, None)
-        if current_stream is not None:
-            current_stream_name = current_stream["name"]
+        if self.stream_id in self.model.get_all_stream_ids():
+            current_stream_name = self.model.stream_name_from_id(self.stream_id)
             if current_stream_name in matched_streams:
                 matched_streams.remove(current_stream_name)
                 matched_streams.insert(0, current_stream_name)

zulipterminal/ui_tools/buttons.py

@@ -306,7 +306,7 @@ def __init__(
         view: Any,
         count: int,
     ) -> None:
-        self.stream_name = controller.model.stream_dict[stream_id]["name"]
+        self.stream_name = controller.model.stream_name_from_id(stream_id)
         self.topic_name = topic
         self.stream_id = stream_id
         self.model = controller.model
@@ -574,7 +574,7 @@ def _validate_and_patch_stream_data(self, parsed_link: ParsedNarrowLink) -> str:
             stream_id = cast(int, model.stream_id_from_name(stream_name))
             parsed_link["stream"]["stream_id"] = stream_id
         else:
-            stream_name = cast(str, model.stream_dict[stream_id]["name"])
+            stream_name = cast(str, model.stream_name_from_id(stream_id))
             parsed_link["stream"]["stream_name"] = stream_name
 
         return ""

zulipterminal/ui_tools/views.py

@@ -578,8 +578,8 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             # For new streams with no previous conversation.
             if self.footer.focus is None:
                 stream_id = self.model.stream_id
-                stream_dict = self.model.stream_dict
-                self.footer.stream_box_view(caption=stream_dict[stream_id]["name"])
+                stream_name = self.model.stream_name_from_id(stream_id)
+                self.footer.stream_box_view(caption=stream_name)
             self.set_focus("footer")
             self.footer.focus_position = 0
             return key
@@ -609,7 +609,7 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
 
             stream_id, topic = stream_topic
             self.controller.narrow_to_topic(
-                stream_name=self.model.stream_dict[stream_id]["name"],
+                stream_name=self.model.stream_name_from_id(stream_id),
                 topic_name=topic,
             )
             return key