Merge pull request #12 from vub-hpc/multiline-rules

Support multiline rules and improve wrapping
vub-hpc · Apr 24, 2024 · bcf0443 · bcf0443
2 parents f313b4e + 4112bbc
commit bcf0443
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 103 deletions.
diff --git a/src/term_rst_post/__init__.py b/src/term_rst_post/__init__.py
@@ -29,4 +29,4 @@
 @author: Alex Domingo (Vrije Universiteit Brussel)
 """
 
-__version__ = "1.2.3"
+__version__ = "1.3.0"
diff --git a/src/term_rst_post/ansimotd.py b/src/term_rst_post/ansimotd.py
@@ -80,7 +80,7 @@ def accomodate_motd(body_file, head_file=None, foot_file=None, foot_link=None, w
 
     # Inject extra link between body and footer
     if foot_link:
-        foot_link_text = f"\nMore information at\n{foot_link}\n"
+        foot_link_text = f"\nMore information in\n{foot_link}\n"
 
         if motd["foot"]["text"] is None:
             motd["foot"]["text"] = ""
@@ -113,12 +113,11 @@ def accomodate_motd(body_file, head_file=None, foot_file=None, foot_link=None, w
     return motd_file
 
 
-def wrap_ansicode(ansistr, column_width, match_width=5):
+def wrap_ansicode(ansistr, column_width):
     """
     Cuts long text in a single string to a fixed column width accounting for ANSI escape code characters
     - ansistr: (str) text with ANSI escape codes
     - column_width: (int) length of text column in legible characters
-    - match_width: (int) number of characters used to match between the text with/without ANSI escape codes
     """
     # Clear text without the ANSI escape codes
     clearstr = re.sub('\033\[[0-9;]*m', '', ansistr)
@@ -137,23 +136,24 @@ def wrap_ansicode(ansistr, column_width, match_width=5):
         ansistr_wrapped = list()
         for line in clearstr_wrapped:
             # Define search zone in ANSI text around column width boundary of non-ANSI text to find a match between them
-            # search zone = 3x `match_width` to the left and `ansicodes` to the right
-            cutleft = column_width - (match_width * 3)
             cutright = column_width + ansicodes
-            match_zone = ansistr[cutleft:cutright]
+            match_zone = ansistr[:cutright]
             # Find first matching substring between end of non-ANSI line and ANSI text
-            match_start = match_zone.find(line[(match_width * -1) :])
+            line_last_word = line.rstrip().split(' ')[-1]
+            match_start = match_zone.rfind(line_last_word)
             if match_start < 0:
-                # Hard wrap without a match (probably just an empty line)
-                cutpoint = column_width
-                log_msg = f"Hard wrap at {cutpoint} characters. No match found: '{line}' in '{match_zone}'"
+                # Hard wrap without a match (probably just an empty line, or escape codes in match zone)
+                # Find closest white space to text width
+                cutpoint = ansistr[:column_width+ansicodes].rfind(' ')
+                log_msg = f"Hard wrap at {cutpoint} characters. "
+                log_msg += f"No match found: '{line_last_word}' in '{repr(match_zone)}'"
                 logger.warning(log_msg) if match_zone else logger.debug(log_msg)
             else:
-                cutpoint = cutleft + match_start + match_width
+                cutpoint = match_start + len(line_last_word)
             # Split ANSI text in the same text position as non-ANSI text
-            leftstr = ansistr[:cutpoint].lstrip()
+            leftstr = ansistr[:cutpoint].rstrip()
             ansistr_wrapped.append(leftstr)  # save left part
-            ansistr = ansistr[cutpoint:]  # update ANSI text with right part
+            ansistr = ansistr[cutpoint:].lstrip()  # update ANSI text with right part
             ansicodes -= len(ansistr_wrapped[-1]) - len(line)  # update number of ANSI escape code charcaters
 
         logger.debug(

diff --git a/src/term_rst_post/newspost.py b/src/term_rst_post/newspost.py
@@ -384,7 +384,8 @@ def plain_ref_role(name, rawtext, text, lineno, inliner, options={}, content=[])
     Targets of :ref: are internal labels without meaning that should be hidden
     """
     text = utils.unescape(text)
-    regex = re.compile(r"(.*?)\s*\<(.*?)\>")
+    text = " ".join(text.splitlines())
+    regex = re.compile(r"([^<>]*)\s*(\<.*\>)?")
     try:
         match = regex.match(text)
         label = match.group(1)

diff --git a/tests/references/ablog_motd_wrapped.ansi b/tests/references/ablog_motd_wrapped.ansi
@@ -1,27 +1,27 @@
 
 [1m# Test news post with a simple paragraph[22m
 
-[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. 
-[4mSome text with emphasis.[24m Nulla sed orci nec orci elementum facilisis 
-vitae at mauris. Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer 
-vitae purus vel quam laoreet fringilla vitae nec diam. Donec non 
-aliquet nisi. Vivamus quis aliquam purus. Ut non ipsum sit amet eros 
+[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+[4mSome text with emphasis.[24m Nulla sed orci nec orci elementum facilisis
+vitae at mauris. Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer
+vitae purus vel quam laoreet fringilla vitae nec diam. Donec non
+aliquet nisi. Vivamus quis aliquam purus. Ut non ipsum sit amet eros
 imperdiet gravida at a tellus. [7m`Some literal text.`[27m Curabitur at ipsum
-bibendum nunc tincidunt bibendum nec sed sapien. Donec ultrices nunc 
-ligula, aliquet elementum diam tempus at. Morbi condimentum, ligula 
-vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur 
+bibendum nunc tincidunt bibendum nec sed sapien. Donec ultrices nunc
+ligula, aliquet elementum diam tempus at. Morbi condimentum, ligula
+vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur
 odio magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu,
-facilisis vitae justo. Curabitur a ipsum placerat libero aliquam 
+facilisis vitae justo. Curabitur a ipsum placerat libero aliquam
 volutpat. Proin interdum porta consequat.
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed 
-orci nec orci elementum facilisis vitae at mauris. Nulla eu ultrices 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed
+orci nec orci elementum facilisis vitae at mauris. Nulla eu ultrices
 lectus. Integer vitae purus vel quam laoreet fringilla vitae nec diam.
-Donec non aliquet nisi. Vivamus quis aliquam purus. Ut non ipsum sit 
-amet eros imperdiet gravida at a tellus. Curabitur at ipsum bibendum 
-nunc tincidunt bibendum nec sed sapien. Donec ultrices nunc ligula, 
-aliquet elementum diam tempus at. Morbi condimentum, ligula vitae 
-venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio 
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, 
-facilisis vitae justo. Curabitur a ipsum placerat libero aliquam 
+Donec non aliquet nisi. Vivamus quis aliquam purus. Ut non ipsum sit
+amet eros imperdiet gravida at a tellus. Curabitur at ipsum bibendum
+nunc tincidunt bibendum nec sed sapien. Donec ultrices nunc ligula,
+aliquet elementum diam tempus at. Morbi condimentum, ligula vitae
+venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu,
+facilisis vitae justo. Curabitur a ipsum placerat libero aliquam
 volutpat. Proin interdum porta consequat.
diff --git a/tests/references/ablog_motd_wrapped_headfoot.ansi b/tests/references/ablog_motd_wrapped_headfoot.ansi
@@ -3,28 +3,27 @@ HEADER
 
 [1m# Test news post with a simple paragraph[22m
 
-[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text 
-with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris. 
-Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam 
-laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam 
-purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal 
+[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text
+with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris.
+Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam
+laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam
+purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal
 text.`[27m Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
 porta consequat.
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci
-nec orci elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer 
-vitae 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci nec orci
+elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer vitae
 purus vel quam laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus
-quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. 
-Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec 
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus.
+Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
-porta consequat. 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
+porta consequat.
 ------
 FOOTER
diff --git a/tests/references/ablog_motd_wrapped_headfoot_url.ansi b/tests/references/ablog_motd_wrapped_headfoot_url.ansi
@@ -3,31 +3,30 @@ HEADER
 
 [1m# Test news post with a simple paragraph[22m
 
-[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text 
-with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris. 
-Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam 
-laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam 
-purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal 
+[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text
+with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris.
+Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam
+laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam
+purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal
 text.`[27m Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
 porta consequat.
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci
-nec orci elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer 
-vitae 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci nec orci
+elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer vitae
 purus vel quam laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus
-quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. 
-Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec 
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus.
+Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
-porta consequat. 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
+porta consequat.
 
-More information at
+More information in
 https://example.com/posts/year/test
 ------
 FOOTER
diff --git a/tests/references/ablog_motd_wrapped_indented.ansi b/tests/references/ablog_motd_wrapped_indented.ansi
@@ -1,26 +1,25 @@
 
 [1m# Test news post with a simple paragraph[22m
 
-[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text 
-with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris. 
-Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam 
-laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam 
-purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal 
+[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text
+with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris.
+Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam
+laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam
+purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal
 text.`[27m Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
 porta consequat.
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci
-nec orci elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer 
-vitae 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci nec orci
+elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer vitae
 purus vel quam laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus
-quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. 
-Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec 
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus.
+Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
-porta consequat. 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
+porta consequat.
diff --git a/tests/references/ablog_motd_wrapped_indented_url.ansi b/tests/references/ablog_motd_wrapped_indented_url.ansi
@@ -1,29 +1,28 @@
 
 [1m# Test news post with a simple paragraph[22m
 
-[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text 
-with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris. 
-Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam 
-laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam 
-purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal 
+[1;31;7m Warning [0;27m Lorem ipsum dolor sit amet, consectetur adipiscing elit. [4mSome text
+with emphasis.[24m Nulla sed orci nec orci elementum facilisis vitae at mauris.
+Nulla eu ultrices lectus. [1mSome text in bold.[22m Integer vitae purus vel quam
+laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus quis aliquam
+purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. [7m`Some literal
 text.`[27m Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
 porta consequat.
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci
-nec orci elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer 
-vitae 
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla sed orci nec orci
+elementum facilisis vitae at mauris. Nulla eu ultrices lectus. Integer vitae
 purus vel quam laoreet fringilla vitae nec diam. Donec non aliquet nisi. Vivamus
-quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus. 
-Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec 
-ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum, 
+quis aliquam purus. Ut non ipsum sit amet eros imperdiet gravida at a tellus.
+Curabitur at ipsum bibendum nunc tincidunt bibendum nec sed sapien. Donec
+ultrices nunc ligula, aliquet elementum diam tempus at. Morbi condimentum,
 ligula vitae venenatis aliquam, tellus lectus pulvinar est, vitae efficitur odio
-magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis 
-vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum 
-porta consequat. 
+magna vitae lorem. Nam quam risus, pellentesque nec facilisis eu, facilisis
+vitae justo. Curabitur a ipsum placerat libero aliquam volutpat. Proin interdum
+porta consequat.
 
-More information at
+More information in
 https://example.com/posts/year/test