CharacterScroller uses TermSize object.

Author: jimdeekepler

scrolltext/utils.py

@@ -181,28 +181,30 @@ class CharacterScroller:  # pylint: disable=R0902  # disable (too-many-instance-
     Utility class  for all character based text-scrollers.
     """
 
-    def __init__(self, cfg, **argv):
+    def __init__(self, cfg, term_size, **argv):
         """Objects init method.
         :param cfg: Configuration dictionary
         :type: configparser.ConfigParser
+        :param term_size: Current terminal size, number of available columns and rows
+        :type: TermSize
         :param argv["section_index"]: Number of scrolltext.text section in use [1..3]
         :param argv["term_rows"]: Terminal height in number of rows
         :param argv["term_columns"]: Terminal width in number of columns
         :param argv["min_scroll_line"]: The minimum terminal row allowed
         :param argv["test"]: Only used in unittests
         """
-        self.visible_text_length = argv["term_columns"]
+        self.term_size = term_size
+        self.visible_text_length = self.term_size.get_cols()
+        log.debug("visibile_text_length: %d", self.visible_text_length)
+        self.min_scroll_line = argv["min_scroll_line"] if "min_scroll_line" in argv else 0
 
         section_index = str(argv["section_index"]) if "section_index" in argv else "1"
         str_section = "scrolltext.text " + section_index
         scroll_text = cfg[str_section]["text"]
-        scroll_line_str = cfg[str_section]["line"]
+        self.scroll_line_str = cfg[str_section]["line"]
         scroll_direction = cfg[str_section].getboolean("direction")
 
-        self.line = get_linenum(scroll_line_str, argv["min_scroll_line"], argv["term_rows"])
-        log.debug("screenline %d", self.line)
-        log.debug("scrolltext length: %d", len(scroll_text))
-        log.debug("scrolltext part: >> %s <<", scroll_text[20:100])
+        self._resized()
 
         num_blanks = argv["blanks"] if "blanks" in argv else self.visible_text_length
         self.blanks = num_blanks * " "
@@ -230,13 +232,23 @@ def __init__(self, cfg, **argv):
     def __iter__(self):
         return iter(self.next, None)
 
+    def _resized(self):
+        self.line = get_linenum(self.scroll_line_str,
+                                self.min_scroll_line, self.term_size.get_rows())
+        self.visible_text_length = self.term_size.get_cols()
+        log.debug("_resized  line: %d  columnns: %d  rows: %d  text-length %d",
+                  self.line, self.term_size.get_cols(),
+                  self.term_size.get_rows(), self.visible_text_length)
+
     def next(self):
         """
         Gives the next visible text to display by the client-program.
 
         :returns: A str object of visible text length
         :rtype: str
         """
+        if self.term_size.is_resized():
+            self._resized()
         if not self.right_to_left:
             return self._next_left_to_right()
         return self._next_right_to_left()

tests/utils_tests.py

@@ -29,45 +29,46 @@ def test_invalid_params1(self):
         """"Test creation of CharacterScroller with no parameters."""
         with self.assertRaises(Exception):
             argv = {}
-            CharacterScroller(self.cfg, **argv)
+            CharacterScroller(self.cfg, None, **argv)
 
     def test_dunno_visible_text_length_is_zero(self):
         """"Test with visibile window size set to 0."""
         cnt = 0
+        term_size = TermSize(0, 0)
         self.argv["term_columns"] = 0
         self.argv["blanks"] = 1
-        for text in CharacterScroller(self.cfg, **self.argv):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             self.assertEqual("", text)
             cnt += 1
         self.assertEqual(cnt, len(self.cfg["scrolltext.text 1"]["text"]) + 2)
 
     def test_scroll_character_for_character(self):
         """"Test with visibile window size set to 1, or character by
         character respectively."""
-        self.argv["term_columns"] = 1
+        term_size = TermSize(1, 0)
         self.argv["blanks"] = 0
         scroll_text = "Hello, world"
         self.cfg["scrolltext.text 1"]["text"] = scroll_text
         self.cfg["scrolltext.text 1"]["direction"] = "0"
         expected = list(self.cfg["scrolltext.text 1"]["text"])
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             self.assertEqual(expected[cnt], text)
             cnt += 1
         self.assertEqual(cnt, len(self.cfg["scrolltext.text 1"]["text"]))
 
     def test_scroll_character_for_character_with_spaces(self):
         """"Test with visibile window size set to 1, and a leading
         and trailing blank character."""
-        self.argv["term_columns"] = 1
+        term_size = TermSize(1, 0)
         self.argv["blanks"] = 1
         scroll_text = "Hello, world"
         self.cfg["scrolltext.text 1"]["text"] = scroll_text
         self.cfg["scrolltext.text 1"]["direction"] = "0"
         scroll_text2 = " " + scroll_text + " "
         expected = list(scroll_text2)
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             self.assertEqual(expected[cnt], text)
             cnt += 1
         self.assertEqual(cnt, len(scroll_text) + 2)
@@ -77,12 +78,12 @@ def test_scroll_two_characters_with_spaces(self):
         scroll_text = "Hello, world"
         self.cfg["scrolltext.text 1"]["text"] = scroll_text
         self.cfg["scrolltext.text 1"]["direction"] = "0"
-        self.argv["term_columns"] = 2
+        term_size = TermSize(2, 0)
         self.argv["blanks"] = 1
         expected = [" H", "He", "el", "ll", "lo", "o,", ", ", " w", "wo", "or",
                     "rl", "ld", "d ", " "]
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             self.assertEqual(expected[cnt], text)
             cnt += 1
         self.assertEqual(cnt, len(scroll_text) + 2)
@@ -95,10 +96,10 @@ def test_scroll_in_broad_window_with_spaces(self):
         expected = [" Hello, world ", "Hello, world ", "ello, world ", "llo, world ",
                     "lo, world ", "o, world ", ", world ", " world ", "world ",
                     "orld ", "rld ", "ld ", "d ", " "]
-        self.argv["term_columns"] = 80
+        term_size = TermSize(80, 0)
         self.argv["blanks"] = 1
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             self.assertEqual(expected[cnt], text)
             cnt += 1
         self.assertEqual(cnt, len(scroll_text) + 2)
@@ -109,14 +110,14 @@ def test_scroll_character_for_character_right_to_left2(self):
         scroll_text = "Hello, world"
         self.cfg["scrolltext.text 1"]["text"] = scroll_text
         self.cfg["scrolltext.text 1"]["direction"] = "1"
-        self.argv["term_columns"] = 1
+        term_size = TermSize(1, 0)
         self.argv["blanks"] = 0
         scroll_text_list = list(self.cfg["scrolltext.text 1"]["text"])
         scroll_text_list.reverse()
         scroll_text = "".join(scroll_text_list)
         expected = list(scroll_text)
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):  # 1, 0, scroll_text, 1, 0):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             try:
                 self.assertEqual(expected[cnt], text)
             except IndexError:
@@ -128,14 +129,14 @@ def test_scroll_character_for_character_right_to_left(self):
         """"Right-to-Left text. Test with visibile window size set to 1, or character by
         character respectively."""
         self.cfg["scrolltext.text 1"]["direction"] = "1"
-        self.argv["term_columns"] = 1
+        term_size = TermSize(1, 0)
         self.argv["blanks"] = 0
         scroll_text = "مرحباً فيلت"
         self.cfg["scrolltext.text 1"]["text"] = scroll_text
         expected = list(scroll_text)
         expected.reverse()
         cnt = 0
-        for text in CharacterScroller(self.cfg, **self.argv):  # 1, 0, scroll_text, 1, 0):
+        for text in CharacterScroller(self.cfg, term_size, **self.argv):
             try:
                 self.assertEqual(expected[cnt], text)
             except IndexError: