views: Add search logic and full emoji list to EmojiPickerView.

This commit completes the logic of searching for emojis from the
EmojiPickerView on pressing 'p' key. The search is kept kept dynamic
for faster reacting to messages.

The emoji list also displays the full list of emoji's present in the
model.active_emoji_data.

Tests amended.

Author: zee-bit

tests/ui_tools/test_popups.py

@@ -739,13 +739,42 @@ class TestEmojiPickerView:
     @pytest.fixture(autouse=True)
     def mock_external_classes(self, mocker, monkeypatch, message_fixture):
         self.controller = mocker.Mock()
+        self.view = self.controller.view
         mocker.patch.object(self.controller, 'maximum_popup_dimensions',
                             return_value=(64, 64))
         mocker.patch(VIEWS + '.urwid.SimpleFocusListWalker', return_value=[])
         self.emoji_picker_view = EmojiPickerView(self.controller, 'ADD EMOJI',
-                                                 list(), message_fixture)
+                                                 list(), message_fixture,
+                                                 self.view)
         self.emoji_picker_view.allow_update_emoji_list = True
 
+    @pytest.mark.parametrize('emoji_names', [
+        ('action', 'agent', 'angel', 'anger', 'angry', 'engineer',
+         'embarrassed', 'eye', 'ball', 'cat', 'hi', 'lightning',
+         'smile', 'smiley', 'smirk', 'smoking')
+    ])
+    @pytest.mark.parametrize(['search_string', 'assert_list',
+                              'match_return_value'], [
+        ('e', ['engineer', 'embarrassed', 'eye'], True),
+        ('sm', ['smile', 'smiley', 'smirk', 'smoking'], True),
+        ('ang', ['angel', 'anger', 'angry'], True),
+        ('abc', [], False),
+        ('q', [], False),
+    ])
+    def test_update_emoji_list(self, mocker, emoji_names, search_string,
+                               assert_list, match_return_value):
+        self.emoji_picker_view.emoji_buttons = (
+            self.emoji_picker_view.generate_emoji_buttons(emoji_names))
+        list_w = mocker.patch(VIEWS + ".urwid.SimpleFocusListWalker")
+
+        self.emoji_picker_view.update_emoji_list("SEARCH_EMOJIS",
+                                                 search_string)
+        self.emojis_display = self.emoji_picker_view.emojis_display
+        self.emojis_display = [
+            emoji.emoji_name for emoji in self.emojis_display]
+        assert self.emojis_display == assert_list
+        assert self.emoji_picker_view.get_focus() == 'header'
+
     @pytest.mark.parametrize('key', keys_for_command('SEARCH_EMOJIS'))
     def test_keypress_search_emoji(self, key, mocker, widget_size):
         size = widget_size(self.emoji_picker_view)
@@ -761,10 +790,11 @@ def test_keypress_exit_called(self, key, mocker, widget_size,
         if allow_update:
             assert self.controller.exit_popup.called
         else:
-            assert self.emoji_picker_view.get_focus() == 'body'
+            assert self.emoji_picker_view.get_focus() == 'header'
 
     def test_keypress_navigation(self, mocker, widget_size,
                                  navigation_key_expected_key_pair):
+        self.emoji_picker_view.set_focus('body')
         key, expected_key = navigation_key_expected_key_pair
         size = widget_size(self.emoji_picker_view)
         super_keypress = mocker.patch(VIEWS + '.urwid.ListBox.keypress')

zulipterminal/core.py

@@ -216,7 +216,9 @@ def show_msg_info(self, msg: Message,
 
     def show_emoji_picker(self, message: Message) -> None:
         emoji_picker_view = EmojiPickerView(self, "Add/Remove reactions",
-                                            ['thumbs_up'], message)
+                                            list(self.model.active_emoji_data.
+                                                 keys()),
+                                            message, self.view)
         self.show_pop_up(emoji_picker_view, 'area:msg')
 
     def show_stream_info(self, stream_id: int) -> None:

zulipterminal/model.py

@@ -323,8 +323,6 @@ def _start_presence_updates(self) -> None:
     def react_to_message(self,
                          message: Message,
                          reaction_to_toggle: str) -> None:
-        # FIXME Only support thumbs_up for now
-        assert reaction_to_toggle == 'thumbs_up'
         assert reaction_to_toggle in self.active_emoji_data
 
         reaction_to_toggle_spec = dict(

zulipterminal/ui_tools/boxes.py

@@ -1564,14 +1564,18 @@ class PanelSearchBox(urwid.Edit):
     """
 
     def __init__(self, panel_view: Any, search_command: str,
-                 update_function: Callable[..., None]) -> None:
+                 update_function: Callable[..., None],
+                 fixed_search_caption: bool=False) -> None:
         self.panel_view = panel_view
         self.search_command = search_command
         self.search_text = (
             f"Search [{', '.join(keys_for_command(search_command))}]: "
         )
         urwid.connect_signal(self, 'change', update_function)
-        super().__init__(caption='', edit_text=self.search_text)
+        if not fixed_search_caption:
+            super().__init__(caption='', edit_text=self.search_text)
+        else:
+            super().__init__(caption=self.search_text, edit_text='')
 
     def reset_search_text(self) -> None:
         self.set_caption('')
@@ -1602,6 +1606,10 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             self.panel_view.view.controller.exit_editor_mode()
             self.set_caption([('filter_results', 'Search Results'), ' '])
             self.panel_view.set_focus("body")
-            if hasattr(self.panel_view, 'log') and len(self.panel_view.log):
+            if hasattr(self.panel_view, 'log') and (
+                (isinstance(self.panel_view.log, list)
+                 and len(self.panel_view.log)) or (
+                     isinstance(self.panel_view.log, urwid.ListBox)
+                     and self.panel_view.body.get_focus()[0])):
                 self.panel_view.body.set_focus(0)
         return super().keypress(size, key)

zulipterminal/ui_tools/buttons.py

@@ -67,7 +67,7 @@ def update_count(self, count: int, text_color: Optional[str]=None) -> None:
             count_text = str(count)
         self.update_widget(('unread_count', count_text), new_color)
 
-    def update_widget(self, count_text: Tuple[str, str],
+    def update_widget(self, count_text: Tuple[Optional[str], str],
                       text_color: Optional[str]) -> Any:
         # Note that we don't modify self._caption
         max_caption_length = (self.width_for_text_and_count
@@ -284,15 +284,15 @@ def __init__(self, controller: Any, width: int, emoji_name: str,
             show_function=controller.model.toggle_message_reaction,
             width=width)
         if self.user_has_reacted_to_msg():
-            self.update_widget(('bar', f' {CHECK_MARK} '), 'bar')
+            self.update_widget((None, f' {CHECK_MARK} '), None)
 
     def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if is_command_key('ENTER', key):
             # Note that this is called before toggle_message_reaction.
             if self.user_has_reacted_to_msg():
-                self.update_widget(('bar', ''), 'bar')
+                self.update_widget((None, ''), None)
             else:
-                self.update_widget(('bar', f' {CHECK_MARK} '), 'bar')
+                self.update_widget((None, f' {CHECK_MARK} '), None)
         return super().keypress(size, key)
 
     def user_has_reacted_to_msg(self) -> bool:

zulipterminal/ui_tools/views.py

@@ -26,6 +26,7 @@
     Message,
     asynch,
     edit_mode_captions,
+    match_emoji,
     match_stream,
     match_user,
 )
@@ -1464,47 +1465,78 @@ class EmojiPickerView(PopUpView):
     Displays Emoji Picker view for messages.
     """
     def __init__(self, controller: Any, title: str, emoji_names: List[str],
-                 message: Message) -> None:
+                 message: Message, view: Any) -> None:
         self.width = 40
+        self.view = view
         self.message = message
         self.controller = controller
-        emoji_buttons = self.generate_emoji_buttons(emoji_names)
+        self.emoji_buttons = self.generate_emoji_buttons(emoji_names)
         self.emoji_search = PanelSearchBox(self,
                                            'SEARCH_EMOJIS',
-                                           self.update_emoji_list)
+                                           self.update_emoji_list,
+                                           fixed_search_caption=True)
+        self.view.emoji_search = self.emoji_search
         search_box = urwid.LineBox(
             self.emoji_search, tlcorner='─', tline='', lline='',
             trcorner='─', blcorner='─', rline='',
             bline='─', brcorner='─'
             )
-        self.allow_update_emoji_list = True
-        self.search_lock = threading.Lock()
-        super().__init__(controller, emoji_buttons, 'ADD_REACTION',
+        super().__init__(controller, self.emoji_buttons, 'ADD_REACTION',
                          self.width, title, header=[search_box])
+        self.set_focus('header')
+        self.allow_update_emoji_list = False
 
     @asynch
     def update_emoji_list(self, search_box: Any=None,
                           new_text: Optional[str]=None,
                           emoji_list: Any=None) -> None:
-        pass
+        """
+        Updates emoji list via PanelSearchBox.
+        """
+        assert (
+            (emoji_list is None and search_box is not None)
+            or (emoji_list is not None and search_box is None
+                and new_text is None)
+        )
+
+        if new_text:
+            self.emojis_display = [
+                searched_emoji for searched_emoji in self.emoji_buttons
+                if match_emoji(searched_emoji.emoji_name, new_text)
+            ]
+        else:
+            self.emojis_display = self.emoji_buttons
+
+        self.contents['body'] = (urwid.ListBox(
+                                 urwid.SimpleFocusListWalker(
+                                     self.emojis_display)), None)
+        self.controller.update_screen()
 
     def generate_emoji_buttons(self, emoji_names: List[str]
                                ) -> List[EmojiButton]:
-        return [EmojiButton(self.controller, self.width, emoji_name,
-                            self.message)
-                for emoji_name in emoji_names]
+        emoji_buttons = []
+        for index, emoji_name in enumerate(emoji_names):
+            emoji_buttons.append(urwid.AttrWrap(EmojiButton(
+                self.controller, self.width, emoji_name, self.message
+            ), None if index % 2 else 'popup_contrast'))
+        return emoji_buttons
 
     def keypress(self, size: urwid_Size, key: str) -> str:
         if (is_command_key('SEARCH_EMOJIS', key)
                 and self.allow_update_emoji_list):
             self.allow_update_emoji_list = False
             self.emoji_search.set_edit_text('')
+            self.emoji_search.set_caption(
+                f"Search [{', '.join(keys_for_command('SEARCH_EMOJIS'))}]: ")
             self.set_focus('header')
             return key
         elif (is_command_key('GO_BACK', key)
               and not self.allow_update_emoji_list):
             self.emoji_search.reset_search_text()
             self.allow_update_emoji_list = True
+            self.contents['body'] = (
+                urwid.ListBox(urwid.SimpleFocusListWalker(
+                    self.emoji_buttons)), None)
             self.set_focus('body')
             self.controller.update_screen()
             return key