core/ui/views/keys/README: Show new AboutView on ABOUT keypress.

This introduces a minimal AboutView to show metadata about the app.

For now, the popup shows ZT_VERSION (the running version of Zulip
Terminal) under an 'Application' category.

Tests added.

Author: preetmishra

README.md

@@ -114,6 +114,7 @@ source ~/.zshenv
 | Command                                               | Key Combination                               |
 | ----------------------------------------------------- | --------------------------------------------- |
 | Show/hide help menu                                   | <kbd>?</kbd>                                  |
+| Show/hide about menu                                  | <kbd>Meta</kbd> + <kbd>?</kbd>                |
 | Go back                                               | <kbd>esc</kbd>                                |
 | Redraw screen                                         | <kbd>Ctrl</kbd> + <kbd>l</kbd>                |
 | Quit                                                  | <kbd>Ctrl</kbd> + <kbd>C</kbd>                |

tests/ui/test_ui_tools.py

@@ -13,9 +13,9 @@
     StreamButton, TopButton, TopicButton, UserButton,
 )
 from zulipterminal.ui_tools.views import (
-    HelpView, LeftColumnView, MessageView, MiddleColumnView, ModListWalker,
-    MsgInfoView, PopUpConfirmationView, PopUpView, RightColumnView,
-    StreamInfoView, StreamsView, TopicsView, UsersView,
+    AboutView, HelpView, LeftColumnView, MessageView, MiddleColumnView,
+    ModListWalker, MsgInfoView, PopUpConfirmationView, PopUpView,
+    RightColumnView, StreamInfoView, StreamsView, TopicsView, UsersView,
 )
 
 
@@ -1239,6 +1239,38 @@ def test_keypress_navigation(self, mocker,
         super_keypress.assert_called_once_with(size, expected_key)
 
 
+class TestAboutView:
+    @pytest.fixture(autouse=True)
+    def mock_external_classes(self, mocker):
+        self.controller = mocker.Mock()
+        mocker.patch.object(self.controller, 'maximum_popup_dimensions',
+                            return_value=(64, 64))
+        mocker.patch(VIEWS + '.urwid.SimpleFocusListWalker', return_value=[])
+        self.about_view = AboutView(self.controller, 'About',
+                                    zt_version='0.5.1+git')
+
+    @pytest.mark.parametrize('key', {*keys_for_command('GO_BACK'),
+                                     *keys_for_command('ABOUT')})
+    def test_keypress_exit_popup(self, key):
+        size = (200, 20)
+        self.about_view.keypress(size, key)
+        assert self.controller.exit_popup.called
+
+    def test_keypress_exit_popup_invalid_key(self):
+        key = 'a'
+        size = (200, 20)
+        self.about_view.keypress(size, key)
+        assert not self.controller.exit_popup.called
+
+    def test_keypress_navigation(self, mocker,
+                                 navigation_key_expected_key_pair):
+        key, expected_key = navigation_key_expected_key_pair
+        size = (200, 20)
+        super_keypress = mocker.patch(VIEWS + '.urwid.ListBox.keypress')
+        self.about_view.keypress(size, key)
+        super_keypress.assert_called_once_with(size, expected_key)
+
+
 class TestPopUpConfirmationView:
     @pytest.fixture
     def popup_view(self, mocker, stream_button):

zulipterminal/config/keys.py

@@ -18,6 +18,11 @@
         'excluded_from_random_tips': True,
         'key_category': 'general',
     }),
+    ('ABOUT', {
+        'keys': {'meta ?'},
+        'help_text': 'Show/hide about menu',
+        'key_category': 'general',
+    }),
     ('GO_BACK', {
         'keys': {'esc'},
         'help_text': 'Go Back',

zulipterminal/core.py

@@ -15,7 +15,8 @@
 from zulipterminal.ui import Screen, View
 from zulipterminal.ui_tools.utils import create_msg_box_list
 from zulipterminal.ui_tools.views import (
-    HelpView, MsgInfoView, NoticeView, PopUpConfirmationView, StreamInfoView,
+    AboutView, HelpView, MsgInfoView, NoticeView, PopUpConfirmationView,
+    StreamInfoView,
 )
 from zulipterminal.version import ZT_VERSION
 
@@ -146,6 +147,9 @@ def show_stream_info(self, color: str, name: str, desc: str) -> None:
     def popup_with_message(self, text: str, width: int) -> None:
         self.show_pop_up(NoticeView(self, text, width, "NOTICE"))
 
+    def show_about(self) -> None:
+        self.show_pop_up(AboutView(self, 'About', zt_version=ZT_VERSION))
+
     def search_messages(self, text: str) -> None:
         # Search for a text in messages
         self.model.index['search'].clear()

zulipterminal/ui.py

@@ -188,6 +188,9 @@ def keypress(self, size: Tuple[int, int], key: str) -> Optional[str]:
             search_box.set_edit_text("")
             self.controller.enter_editor_mode_with(search_box)
             return key
+        elif is_command_key('ABOUT', key):
+            self.controller.show_about()
+            return key
         elif is_command_key('HELP', key):
             # Show help menu
             self.controller.show_help()

zulipterminal/ui_tools/views.py

@@ -878,6 +878,20 @@ def __init__(self, controller: Any,
         super().__init__(controller, widgets, 'GO_BACK', width, title)
 
 
+class AboutView(PopUpView):
+    def __init__(self, controller: Any, title: str, *,
+                 zt_version: str) -> None:
+        contents = [
+            ('Application', [('Zulip Terminal', zt_version)]),
+        ]
+
+        popup_width, column_widths = self.calculate_table_widths(contents,
+                                                                 len(title))
+        widgets = self.make_table_with_categories(contents, column_widths)
+
+        super().__init__(controller, widgets, 'ABOUT', popup_width, title)
+
+
 class HelpView(PopUpView):
     def __init__(self, controller: Any, title: str) -> None:
         help_menu_content = []