boxes/views: Generalize footlinks_view() for StreamInfoView.

This modifies footlinks_view() to accept a range of configurable
parameters, return footlinks_width and makes the method static to
facilitate its reusability.

While the commit only has changes for StreamInfoView, this will also be
useful for rendering spoiler content later.

Tests amended.

Author: preetmishra

tests/core/test_core.py

@@ -15,7 +15,7 @@
 class TestController:
     @pytest.fixture(autouse=True)
     def mock_external_classes(self, mocker: Any) -> None:
-        mocker.patch('zulipterminal.ui_tools.boxes.MessageBox.footlinks_view')
+        mocker.patch('zulipterminal.ui_tools.boxes.MessageBox.main_view')
         self.client = mocker.patch('zulip.Client')
         # Patch init only, in general, allowing specific patching elsewhere
         self.model = mocker.patch(CORE + '.Model.__init__', return_value=None)

tests/ui/test_ui_tools.py

@@ -2319,41 +2319,46 @@ def test_reactions_view(self, message_fixture, to_vary_in_each_message):
         ]
 
     @pytest.mark.parametrize(['message_links', 'expected_text',
-                              'expected_attrib'], [
+                              'expected_attrib', 'expected_footlinks_width'], [
             (OrderedDict([
                 ('https://github.com/zulip/zulip-terminal/pull/1', ('#T1', 1,
                                                                     True)),
              ]),
              '1: https://github.com/zulip/zulip-terminal/pull/1',
-             [('msg_link_index', 2), (None, 1), ('msg_link', 46)]),
+             [('msg_link_index', 2), (None, 1), ('msg_link', 46)],
+             49),
             (OrderedDict([
                 ('https://foo.com', ('Foo!', 1, True)),
                 ('https://bar.com', ('Bar!', 2, True)),
              ]),
              '1: https://foo.com\n2: https://bar.com',
              [('msg_link_index', 2), (None, 1), ('msg_link', 15), (None, 1),
-              ('msg_link_index', 2), (None, 1), ('msg_link', 15)]),
+              ('msg_link_index', 2), (None, 1), ('msg_link', 15)],
+             18),
             (OrderedDict([
                 ('https://example.com', ('https://example.com', 1, False)),
                 ('http://example.com', ('http://example.com', 2, False)),
              ]),
              None,
-             None),
+             None,
+             0),
             (OrderedDict([
                 ('https://foo.com', ('https://foo.com, Text', 1, True)),
                 ('https://bar.com', ('Text, https://bar.com', 2, True)),
              ]),
              '1: https://foo.com\n2: https://bar.com',
              [('msg_link_index', 2), (None, 1), ('msg_link', 15), (None, 1),
-              ('msg_link_index', 2), (None, 1), ('msg_link', 15)]),
+              ('msg_link_index', 2), (None, 1), ('msg_link', 15)],
+             18),
             (OrderedDict([
                 ('https://foo.com', ('Foo!', 1, True)),
                 ('http://example.com', ('example.com', 2, False)),
                 ('https://bar.com', ('Bar!', 3, True)),
              ]),
              '1: https://foo.com\n3: https://bar.com',
              [('msg_link_index', 2), (None, 1), ('msg_link', 15), (None, 1),
-              ('msg_link_index', 2), (None, 1), ('msg_link', 15)]),
+              ('msg_link_index', 2), (None, 1), ('msg_link', 15)],
+             18),
         ],
         ids=[
             'one_footlink',
@@ -2363,16 +2368,19 @@ def test_reactions_view(self, message_fixture, to_vary_in_each_message):
             'http_default_scheme',
         ]
     )
-    def test_footlinks_view(self, message_fixture, message_links,
-                            expected_text, expected_attrib):
-        self.model.controller.footlinks_enabled = True
-        msg_box = MessageBox(message_fixture, self.model, None)
-
-        footlinks = msg_box.footlinks_view(message_links)
+    def test_footlinks_view(self, message_links, expected_text,
+                            expected_attrib, expected_footlinks_width):
+        footlinks, footlinks_width = MessageBox.footlinks_view(
+            message_links,
+            footlinks_enabled=True,
+            padded=True,
+            wrap='ellipsis',
+        )
 
         if expected_text:
             assert footlinks.original_widget.text == expected_text
             assert footlinks.original_widget.attrib == expected_attrib
+            assert footlinks_width == expected_footlinks_width
         else:
             assert footlinks is None
             assert not hasattr(footlinks, 'original_widget')
@@ -2381,15 +2389,17 @@ def test_footlinks_view(self, message_fixture, message_links,
         (False, type(None)),
         (True, Padding),
     ])
-    def test_footlinks_enabled(self, message_fixture, footlinks_enabled,
-                               expected_instance):
+    def test_footlinks_enabled(self, footlinks_enabled, expected_instance):
         message_links = OrderedDict([
             ('https://github.com/zulip/zulip-terminal', ('ZT', 1, True)),
         ])
-        self.model.controller.footlinks_enabled = footlinks_enabled
-        msg_box = MessageBox(message_fixture, self.model, None)
 
-        footlinks = msg_box.footlinks_view(message_links)
+        footlinks, _ = MessageBox.footlinks_view(
+            message_links,
+            footlinks_enabled,
+            padded=True,
+            wrap='ellipsis',
+        )
 
         assert isinstance(footlinks, expected_instance)
 

zulipterminal/ui_tools/boxes.py

@@ -596,18 +596,23 @@ def reactions_view(self, reactions: List[Dict[str, Any]]) -> Any:
 
     # Use quotes as a workaround for OrderedDict typing issue.
     # See https://github.com/python/mypy/issues/6904.
+    @staticmethod
     def footlinks_view(
-        self, message_links: 'OrderedDict[str, Tuple[str, int, bool]]',
-    ) -> Any:
+        message_links: 'OrderedDict[str, Tuple[str, int, bool]]',
+        footlinks_enabled: bool, padded: bool, wrap: str,
+    ) -> Tuple[Any, int]:
         # Return if footlinks are disabled by the user.
-        if not self.model.controller.footlinks_enabled:
-            return None
+        if not footlinks_enabled:
+            return None, 0
 
         footlinks = []
+        footlinks_width = 0
         for link, (text, index, show_footlink) in message_links.items():
             if not show_footlink:
                 continue
 
+            footlinks_width = max(footlinks_width,
+                                  len('{}: {}'.format(index, link)))
             footlinks.extend([
                 ('msg_link_index', '{}:'.format(index)),
                 ' ',
@@ -616,12 +621,17 @@ def footlinks_view(
             ])
 
         if not footlinks:
-            return None
+            return None, 0
 
         footlinks[-1] = footlinks[-1][:-1]  # Remove the last newline.
-        return urwid.Padding(urwid.Text(footlinks, wrap='ellipsis'),
-                             align='left', left=8, width=('relative', 100),
-                             min_width=10, right=2)
+
+        text_widget = urwid.Text(footlinks, wrap=wrap)
+        if padded:
+            return urwid.Padding(text_widget, align='left', left=8,
+                                 width=('relative', 100), min_width=10,
+                                 right=2), footlinks_width
+        else:
+            return text_widget, footlinks_width
 
     @classmethod
     def soup2markup(cls, soup: Any, server_url: str, metadata: Dict[str, Any],
@@ -974,7 +984,12 @@ def main_view(self) -> List[Any]:
         reactions = self.reactions_view(self.message['reactions'])
 
         # Footlinks.
-        footlinks = self.footlinks_view(self.message_links)
+        footlinks, _ = self.footlinks_view(
+            self.message_links,
+            self.model.controller.footlinks_enabled,
+            padded=True,
+            wrap='ellipsis',
+        )
 
         # Build parts together and return
         parts = [

zulipterminal/ui_tools/views.py

@@ -1065,22 +1065,33 @@ def __init__(self, controller: Any, stream_id: int) -> None:
         urwid.connect_signal(pinned_setting, 'change',
                              self.toggle_pinned_status)
 
-        markup_desc, *_ = MessageBox.transform_content(
+        markup_desc, message_links, _ = MessageBox.transform_content(
             rendered_desc,
             self.controller.model.server_url,
         )
         desc = urwid.Text(markup_desc)
+        footlinks, footlinks_width = MessageBox.footlinks_view(
+            message_links=message_links,
+            footlinks_enabled=True,
+            padded=False,
+            wrap='space',
+        )
 
         # Manual because calculate_table_widths does not support checkboxes.
         # Add 4 to checkbox label to accomodate the checkbox itself.
         popup_width = max(popup_width, len(muted_setting.label) + 4,
-                          len(pinned_setting.label) + 4, desc.pack()[0])
+                          len(pinned_setting.label) + 4, desc.pack()[0],
+                          footlinks_width)
         self.widgets = self.make_table_with_categories(stream_info_content,
                                                        column_widths)
 
         # Stream description.
         self.widgets.insert(0, desc)
-        self.widgets.insert(1, urwid.Text(''))  # Add a newline.
+        desc_newline = 1
+        if footlinks:
+            self.widgets.insert(1, footlinks)
+            desc_newline = 2
+        self.widgets.insert(desc_newline, urwid.Text(''))  # Add a newline.
 
         self.widgets.append(muted_setting)
         self.widgets.append(pinned_setting)