feat: Add string_trimmed_before

Added to support stripping parents from account name.

Author: tim-rohrer

src/move2gnucash/utils.py

@@ -41,13 +41,22 @@ def custom_join(strings: Series) -> LiteralString | Literal[""]:
 def string_trimmed_after(string: str, delimiter: str, occurrences=0) -> str:
     """Function to trim a string after the nth occurrence of the specified delimiter.
 
-    If occurrence == 0, only the last word/segment is trimmed.
+    If occurrences == 0, only the last word/segment is trimmed.
     """
     groups: list[str] = string.split(delimiter)
     n_th: int = occurrences if occurrences >> 0 else len(groups) - 1
     return delimiter.join((string.split(delimiter))[:n_th])
 
 
+def string_trimmed_before(string: str, delimiter, occurrences=0) -> str:
+    """Function to trim a string before the nth occurrence of the specified delimiter.
+
+    If occurrences = 0, only the last word/segment is returned."""
+    groups: list[str] = string.split(delimiter)
+    n_th: int = occurrences if occurrences >> 0 else len(groups) - 1
+    return delimiter.join((groups)[n_th:])
+
+
 def hierarchy_from(delimited_words: str) -> list[str]:
     """
     Function to make list of all parents from a string delimited by a colon.

tests/unit/test_utils.py

@@ -10,6 +10,7 @@
     decimal_to,
     hierarchy_from,
     string_trimmed_after,
+    string_trimmed_before,
 )
 
 
@@ -50,6 +51,30 @@ def test_custom_join():
     assert custom_join(pd.Series([""])) == ""
 
 
+def test_string_trimmed_after():
+    """
+    GIVEN a string of words separated by a specified delimiter and a specified number of occurrences,
+    WHEN executed by string_trimmed_after,
+    THEN a literal string is returned comprised of the left hand part of the original string
+        before the nth occurrence of the delimiter.
+    """
+    test_string = "foo:bar:doo:day"
+    assert string_trimmed_after(test_string, ":") == "foo:bar:doo"
+    assert string_trimmed_after(test_string, ":", 1) == "foo"
+
+
+def test_string_trimmed_before():
+    """
+    GIVEN a string of words separated by a specified delimiter and a specified number of occurrences,
+    WHEN executed by string_trimmed_before,
+    THEN a literal string is returned comprised of the right hand part of the original string
+        after the nth occurrence of the delimiter.
+    """
+    test_string = "foo:bar:doo:day"
+    assert string_trimmed_before(test_string, ":") == "day"
+    assert string_trimmed_before(test_string, ":", 1) == "bar:doo:day"
+
+
 def test_hierarchy_from():
     """
     GIVEN a string of words delimited by colons