model: refactor: Group _handle_* and associated methods at end of Model.

Underscore prefixes added to update_rendered_view and
update_topic_index, with updated docstrings to indicate their internal
usage in _handle_* methods.

Tests amended.

Author: neiljp

tests/model/test_model.py

@@ -648,7 +648,7 @@ def test__stream_info_from_subscriptions(self, initial_data, streams,
     def test__handle_message_event_with_Falsey_log(self, mocker,
                                                    model, message_fixture):
         model.found_newest = True
-        mocker.patch('zulipterminal.model.Model.update_topic_index')
+        mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
                                  return_value={})
         model.msg_list = mocker.Mock(log=[])
@@ -669,7 +669,7 @@ def test__handle_message_event_with_Falsey_log(self, mocker,
     def test__handle_message_event_with_valid_log(self, mocker,
                                                   model, message_fixture):
         model.found_newest = True
-        mocker.patch('zulipterminal.model.Model.update_topic_index')
+        mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
                                  return_value={})
         model.msg_list = mocker.Mock(log=[mocker.Mock()])
@@ -692,7 +692,7 @@ def test__handle_message_event_with_valid_log(self, mocker,
     def test__handle_message_event_with_flags(self, mocker,
                                               model, message_fixture):
         model.found_newest = True
-        mocker.patch('zulipterminal.model.Model.update_topic_index')
+        mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
                                  return_value={})
         model.msg_list = mocker.Mock()
@@ -757,7 +757,7 @@ def test__handle_message_event_with_flags(self, mocker,
     def test__handle_message_event(self, mocker, user_profile, response,
                                    narrow, recipients, model, log):
         model.found_newest = True
-        mocker.patch('zulipterminal.model.Model.update_topic_index')
+        mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
                                  return_value={})
         create_msg_box_list = mocker.patch('zulipterminal.model.'
@@ -794,14 +794,14 @@ def test__handle_message_event(self, mocker, user_profile, response,
         ('TOPIC1', [], ['TOPIC1'])
     ], ids=['reorder_topic3', 'topic1_discussion_continues', 'new_topic4',
             'first_topic_1'])
-    def test_update_topic_index(self, topic_name, topic_order_intial,
-                                topic_order_final, model):
+    def test__update_topic_index(self, topic_name, topic_order_intial,
+                                 topic_order_final, model):
         model.index = {
             'topics': {
                 86: topic_order_intial,
             }
         }
-        model.update_topic_index(86, topic_name)
+        model._update_topic_index(86, topic_name)
         assert model.index['topics'][86] == topic_order_final
 
     # TODO: Ideally message_fixture would use standardized ids?
@@ -972,12 +972,12 @@ def test__handle_update_message_event(self, mocker, model,
             },
             'edited_messages': set()
         }
-        mocker.patch('zulipterminal.model.Model.update_rendered_view')
+        mocker.patch('zulipterminal.model.Model._update_rendered_view')
 
         model._handle_update_message_event(response)
 
         assert model.index == new_index
-        assert model.update_rendered_view.call_count == update_call_count
+        assert model._update_rendered_view.call_count == update_call_count
 
     @pytest.mark.parametrize('subject, narrow, new_log_len', [
         ('foo', [['stream', 'boo'], ['topic', 'foo']], 2),
@@ -988,8 +988,8 @@ def test__handle_update_message_event(self, mocker, model,
         'msgbox_removed_due_to_topic_narrow_mismatch',
         'msgbox_updated_in_all_messages_narrow',
     ])
-    def test_update_rendered_view(self, mocker, model, subject, narrow,
-                                  new_log_len, msg_id=1):
+    def test__update_rendered_view(self, mocker, model, subject, narrow,
+                                   new_log_len, msg_id=1):
         msg_w = mocker.Mock()
         other_msg_w = mocker.Mock()
         msg_w.original_widget.message = {'id': msg_id, 'subject': subject}
@@ -1001,7 +1001,7 @@ def test_update_rendered_view(self, mocker, model, subject, narrow,
         cmbl = mocker.patch('zulipterminal.model.create_msg_box_list',
                             return_value=[new_msg_w])
 
-        model.update_rendered_view(msg_id)
+        model._update_rendered_view(msg_id)
 
         # If there are 2 msgs and first one is updated, next one is updated too
         if new_log_len == 2:
@@ -1018,9 +1018,9 @@ def test_update_rendered_view(self, mocker, model, subject, narrow,
         'previous_topic_narrow_empty_so_change_narrow',
         'same_all_messages_narrow',
     ])
-    def test_update_rendered_view_change_narrow(self, mocker, model, subject,
-                                                narrow, narrow_changed,
-                                                msg_id=1):
+    def test__update_rendered_view_change_narrow(self, mocker, model, subject,
+                                                 narrow, narrow_changed,
+                                                 msg_id=1):
         msg_w = mocker.Mock()
         other_msg_w = mocker.Mock()
         msg_w.original_widget.message = {'id': msg_id, 'subject': subject}
@@ -1031,7 +1031,7 @@ def test_update_rendered_view_change_narrow(self, mocker, model, subject,
         cmbl = mocker.patch('zulipterminal.model.create_msg_box_list',
                             return_value=[new_msg_w])
 
-        model.update_rendered_view(msg_id)
+        model._update_rendered_view(msg_id)
 
         assert model.controller.narrow_to_topic.called == narrow_changed
         assert model.controller.update_screen.called
@@ -1152,13 +1152,13 @@ def test__handle_reaction_event_remove_reaction(self, mocker, model,
     def test_update_star_status_no_index(self, mocker, model):
         model.index = dict(messages={})  # Not indexed
         event = dict(messages=[1], flag='starred', all=False, operation='add')
-        mocker.patch('zulipterminal.model.Model.update_rendered_view')
+        mocker.patch('zulipterminal.model.Model._update_rendered_view')
         set_count = mocker.patch('zulipterminal.model.set_count')
 
         model._handle_update_message_flags_event(event)
 
         assert model.index == dict(messages={})
-        model.update_rendered_view.assert_not_called()
+        model._update_rendered_view.assert_not_called()
         set_count.assert_not_called()
 
     def test_update_star_status_invalid_operation(self, mocker, model):
@@ -1170,11 +1170,11 @@ def test_update_star_status_invalid_operation(self, mocker, model):
             'operation': 'OTHER',  # not 'add' or 'remove'
             'all': False,
         }
-        mocker.patch('zulipterminal.model.Model.update_rendered_view')
+        mocker.patch('zulipterminal.model.Model._update_rendered_view')
         set_count = mocker.patch('zulipterminal.model.set_count')
         with pytest.raises(RuntimeError):
             model._handle_update_message_flags_event(event)
-        model.update_rendered_view.assert_not_called()
+        model._update_rendered_view.assert_not_called()
         set_count.assert_not_called()
 
     @pytest.mark.parametrize('event_message_ids, indexed_ids', [
@@ -1208,15 +1208,15 @@ def test_update_star_status(self, mocker, model, event_op,
             'operation': event_op,
             'all': False,
         }
-        mocker.patch('zulipterminal.model.Model.update_rendered_view')
+        mocker.patch('zulipterminal.model.Model._update_rendered_view')
         set_count = mocker.patch('zulipterminal.model.set_count')
 
         model._handle_update_message_flags_event(event)
 
         changed_ids = set(indexed_ids) & set(event_message_ids)
         for changed_id in changed_ids:
             assert model.index['messages'][changed_id]['flags'] == flags_after
-        (model.update_rendered_view.
+        (model._update_rendered_view.
          assert_has_calls([mocker.call(changed_id)
                           for changed_id in changed_ids]))
 
@@ -1258,7 +1258,7 @@ def test_update_read_status(self, mocker, model, event_op,
             'all': False,
         }
 
-        mocker.patch('zulipterminal.model.Model.update_rendered_view')
+        mocker.patch('zulipterminal.model.Model._update_rendered_view')
         set_count = mocker.patch('zulipterminal.model.set_count')
 
         model._handle_update_message_flags_event(event)
@@ -1268,10 +1268,10 @@ def test_update_read_status(self, mocker, model, event_op,
             assert model.index['messages'][changed_id]['flags'] == flags_after
 
             if event_op == 'add':
-                model.update_rendered_view.assert_has_calls(
+                model._update_rendered_view.assert_has_calls(
                         [mocker.call(changed_id)])
             elif event_op == 'remove':
-                model.update_rendered_view.assert_not_called()
+                model._update_rendered_view.assert_not_called()
 
         for unchanged_id in (set(indexed_ids) - set(event_message_ids)):
             assert (model.index['messages'][unchanged_id]['flags'] ==

zulipterminal/model.py

@@ -602,6 +602,16 @@ def _group_info_from_realm_user_groups(self,
         user_group_names.sort(key=str.lower)
         return user_group_names
 
+    def toggle_stream_muted_status(self, stream_id: int) -> bool:
+        request = [{
+            'stream_id': stream_id,
+            'property': 'is_muted',
+            'value': not self.is_muted_stream(stream_id)
+            # True for muting and False for unmuting.
+        }]
+        response = self.client.update_subscription_settings(request)
+        return response['result'] == 'success'
+
     def _handle_subscription_event(self, event: Event) -> None:
         """
         Handle changes in subscription (eg. muting/unmuting streams)
@@ -624,16 +634,6 @@ def _handle_subscription_event(self, event: Event) -> None:
 
                 self.controller.update_screen()
 
-    def toggle_stream_muted_status(self, stream_id: int) -> bool:
-        request = [{
-            'stream_id': stream_id,
-            'property': 'is_muted',
-            'value': not self.is_muted_stream(stream_id)
-            # True for muting and False for unmuting.
-        }]
-        response = self.client.update_subscription_settings(request)
-        return response['result'] == 'success'
-
     def _handle_typing_event(self, event: Event) -> None:
         """
         Handle typing notifications (in private messages)
@@ -693,7 +693,8 @@ def _handle_message_event(self, event: Event) -> None:
         response['flags'] = event.get('flags', [])
         # We need to update the topic order in index, unconditionally.
         if response['type'] == 'stream':
-            self.update_topic_index(response['stream_id'], response['subject'])
+            self._update_topic_index(response['stream_id'],
+                                     response['subject'])
             # If the topic view is toggled for incoming message's
             # recipient stream, then we re-arrange topic buttons
             # with most recent at the top.
@@ -755,9 +756,10 @@ def _handle_message_event(self, event: Event) -> None:
                 set_count([response['id']], self.controller, 1)
             self.controller.update_screen()
 
-    def update_topic_index(self, stream_id: int, topic_name: str) -> None:
+    def _update_topic_index(self, stream_id: int, topic_name: str) -> None:
         """
         Update topic order in index based on incoming message.
+        Helper method called by _handle_message_event
         """
         topic_index = self.index['topics'][stream_id]
         for topic_iterator, topic in enumerate(topic_index):
@@ -781,15 +783,15 @@ def _handle_update_message_event(self, response: Event) -> None:
             if 'rendered_content' in response:
                 message['content'] = response['rendered_content']
                 self.index['messages'][message_id] = message
-                self.update_rendered_view(message_id)
+                self._update_rendered_view(message_id)
 
             # 'subject' is not present in update event if
             # the response didn't have a 'subject' update.
             if 'subject' in response:
                 for msg_id in response['message_ids']:
                     self.index['messages'][msg_id]['subject']\
                         = response['subject']
-                    self.update_rendered_view(msg_id)
+                    self._update_rendered_view(msg_id)
 
     def _handle_reaction_event(self, response: Event) -> None:
         """
@@ -818,7 +820,7 @@ def _handle_reaction_event(self, response: Event) -> None:
                         message['reactions'].remove(reaction)
 
             self.index['messages'][message_id] = message
-            self.update_rendered_view(message_id)
+            self._update_rendered_view(message_id)
 
     def _handle_update_message_flags_event(self, event: Event) -> None:
         """
@@ -849,13 +851,16 @@ def _handle_update_message_flags_event(self, event: Event) -> None:
                 raise RuntimeError(event, msg['flags'])
 
             self.index['messages'][message_id] = msg
-            self.update_rendered_view(message_id)
+            self._update_rendered_view(message_id)
 
         if event['operation'] == 'add' and flag_to_change == 'read':
             set_count(list(message_ids_to_mark & indexed_message_ids),
                       self.controller, -1)
 
-    def update_rendered_view(self, msg_id: int) -> None:
+    def _update_rendered_view(self, msg_id: int) -> None:
+        """
+        Helper method called by various _handle_* methods
+        """
         # Update new content in the rendered view
         for msg_w in self.msg_list.log:
             msg_box = msg_w.original_widget