boxes/views: Generalize footlinks_view() for StreamInfoView.

This modifies footlinks_view() to accept a range of configurable
parameters and return footlinks_width.

Tests amended.

Author: preetmishra

tests/ui/test_ui_tools.py

@@ -2015,41 +2015,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',
@@ -2060,15 +2065,18 @@ def test_reactions_view(self, message_fixture, to_vary_in_each_message):
         ]
     )
     def test_footlinks_view(self, message_links, expected_text,
-                            expected_attrib):
-        footlinks = MessageBox.footlinks_view(
+                            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')
@@ -2082,9 +2090,11 @@ def test_footlinks_enabled(self, footlinks_enabled, expected_instance):
             ('https://github.com/zulip/zulip-terminal', ('ZT', 1, True)),
         ])
 
-        footlinks = MessageBox.footlinks_view(
+        footlinks, _ = MessageBox.footlinks_view(
             message_links,
             footlinks_enabled=footlinks_enabled,
+            padded=True,
+            wrap='ellipsis',
         )
 
         assert isinstance(footlinks, expected_instance)

tests/ui_tools/test_popups.py

@@ -4,6 +4,7 @@
 from urwid import Columns, Text
 
 from zulipterminal.config.keys import is_command_key, keys_for_command
+from zulipterminal.ui_tools.boxes import MessageBox
 from zulipterminal.ui_tools.views import (
     AboutView, EditHistoryView, EditModeView, HelpView, MsgInfoView,
     PopUpConfirmationView, PopUpView, StreamInfoView, StreamMembersView,
@@ -613,6 +614,31 @@ def test_markup_descrption(self, rendered_description, expected_markup,
 
         assert stream_info_view.markup_desc == expected_markup
 
+    @pytest.mark.parametrize(['message_links', 'expected_text',
+                              'expected_attrib', 'expected_footlinks_width'], [
+            (OrderedDict([
+                ('https://example.com', ('Example', 1, True)),
+                ('https://generic.com', ('Generic', 2, True)),
+             ]),
+             '1: https://example.com\n2: https://generic.com',
+             [('msg_link_index', 2), (None, 1), ('msg_link', 19), (None, 1),
+              ('msg_link_index', 2), (None, 1), ('msg_link', 19)],
+             22),
+        ],
+    )
+    def test_footlinks(self, message_links, expected_text, expected_attrib,
+                       expected_footlinks_width):
+        footlinks, footlinks_width = MessageBox.footlinks_view(
+            message_links,
+            footlinks_enabled=True,
+            padded=False,
+            wrap='space',
+        )
+
+        assert footlinks.text == expected_text
+        assert footlinks.attrib == expected_attrib
+        assert footlinks_width == expected_footlinks_width
+
     @pytest.mark.parametrize('key', {*keys_for_command('GO_BACK'),
                                      *keys_for_command('STREAM_DESC')})
     def test_keypress_exit_popup(self, key, widget_size):

zulipterminal/ui_tools/boxes.py

@@ -713,30 +713,46 @@ def footlinks_view(
         message_links: 'OrderedDict[str, Tuple[str, int, bool]]',
         *,
         footlinks_enabled: bool,
-    ) -> Any:
+        padded: bool,
+        wrap: str
+    ) -> Tuple[Any, int]:
+        """
+        Returns a Tuple that consists footlinks view (widget) and its required
+        width.
+        """
         # Return if footlinks are disabled by the user.
         if not footlinks_enabled:
-            return None
+            return None, 0
 
         footlinks = []
+        footlinks_width = 0
         for link, (text, index, show_footlink) in message_links.items():
             if not show_footlink:
                 continue
 
-            footlinks.extend([
+            styled_footlink = [
                 ('msg_link_index', '{}:'.format(index)),
-                ' ',
+                (None, ' '),
                 ('msg_link', link),
-                '\n',
-            ])
+            ]
+            footlinks_width = max(
+                footlinks_width,
+                sum([len(text) for style, text in styled_footlink])
+            )
+            footlinks.extend([*styled_footlink, '\n'])
 
         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, metadata: Dict[str, Any],
@@ -1080,9 +1096,11 @@ def main_view(self) -> List[Any]:
         reactions = self.reactions_view(self.message['reactions'])
 
         # Footlinks.
-        footlinks = self.footlinks_view(
+        footlinks, _ = self.footlinks_view(
             self.message_links,
             footlinks_enabled=self.model.controller.footlinks_enabled,
+            padded=True,
+            wrap='ellipsis',
         )
 
         # Build parts together and return

zulipterminal/ui_tools/views.py

@@ -1088,7 +1088,7 @@ def __init__(self, controller: Any, stream_id: int) -> None:
                          else STREAM_MARKER_PUBLIC)
         title = '{} {}'.format(stream_marker, stream['name'])
         rendered_desc = stream['rendered_description']
-        self.markup_desc, *_ = MessageBox.transform_content(
+        self.markup_desc, message_links, _ = MessageBox.transform_content(
             rendered_desc,
             self.controller.model.server_url,
         )
@@ -1118,16 +1118,28 @@ def __init__(self, controller: Any, stream_id: int) -> None:
         urwid.connect_signal(pinned_setting, 'change',
                              self.toggle_pinned_status)
 
+        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)