Merge pull request #89 from MarketSquare/83_prevent_trailing_underscores_in_keyword_method_names

Prevent training underscores in keyword method names

Author: robinmackaij

src/openapi_libgen/parsing_utils.py

@@ -1,11 +1,11 @@
 from typing import Generator
 
 
-def remove_unsafe_characters_from_string(string: str) -> str:
+def remove_unsafe_characters_from_string(unsafe_string: str) -> str:
     def _remove_unsafe_characters_from_string(
-        string: str,
+        string_: str,
     ) -> Generator[str, None, None]:
-        string_iterator = iter(string)
+        string_iterator = iter(string_)
         capitalize_next_character = False
 
         # The first character must be A-z or _
@@ -27,4 +27,7 @@ def _remove_unsafe_characters_from_string(
                 capitalize_next_character = True
                 yield "_"
 
-    return "".join(_remove_unsafe_characters_from_string(string=string))
+    unsafe_string = unsafe_string.strip()
+    safe_string = "".join(_remove_unsafe_characters_from_string(string_=unsafe_string))
+    without_trailing_underscore = safe_string.rstrip("_")
+    return without_trailing_underscore or "_"

tests/libgen/unittests/test_parsing_utils.py

@@ -38,6 +38,16 @@ def test_capitalize_next_alpha_after_removed_char(self) -> None:
         result = remove_unsafe_characters_from_string(path)
         self.assertEqual(result, "my_Path_Part_2a")
 
+    def test_whitespace_is_stripped(self) -> None:
+        description = "\tAdd a new user\n\r"
+        result = remove_unsafe_characters_from_string(description)
+        self.assertEqual(result, "Add_A_New_User")
+
+    def test_trailing_underscore_is_stripped(self) -> None:
+        description = "Add a new user."
+        result = remove_unsafe_characters_from_string(description)
+        self.assertEqual(result, "Add_A_New_User")
+
 
 if __name__ == "__main__":
     unittest.main()