chore(utils): rework 'multiple_line_breaker' into 'break_multiple_line'

Signed-off-by: Adrian DC <[email protected]>

Author: AdrianDC

commitizen/commands/commit.py

@@ -14,8 +14,8 @@
 from commitizen.config import BaseConfig
 from commitizen.cz.exceptions import CzException
 from commitizen.cz.utils import (
+    break_multiple_line,
     get_backup_file_path,
-    multiple_line_breaker,
     required_validator,
     required_validator_scope,
     required_validator_subject_strip,
@@ -80,8 +80,8 @@ def _prompt_commit_questions(self) -> str:
         for question in filter(
             lambda q: isinstance(q.get("filter", None), str), questions
         ):
-            if question["filter"] == "multiple_line_breaker":
-                question["filter"] = multiple_line_breaker
+            if question["filter"] == "break_multiple_line":
+                question["filter"] = break_multiple_line
             elif question["filter"] == "required_validator":
                 question["filter"] = required_validator
             elif question["filter"] == "required_validator_scope":

commitizen/cz/conventional_commits/conventional_commits.py

@@ -3,7 +3,7 @@
 
 from commitizen import defaults
 from commitizen.cz.base import BaseCommitizen
-from commitizen.cz.utils import multiple_line_breaker, required_validator
+from commitizen.cz.utils import break_multiple_line, required_validator
 from commitizen.question import CzQuestion
 
 __all__ = ["ConventionalCommitsCz"]
@@ -128,7 +128,7 @@ def questions(self) -> list[CzQuestion]:
                 "message": (
                     "Provide additional contextual information about the code changes: (press [enter] to skip)\n"
                 ),
-                "filter": multiple_line_breaker,
+                "filter": break_multiple_line,
             },
             {
                 "type": "confirm",

commitizen/cz/utils.py

@@ -35,7 +35,7 @@ def required_validator_title_strip(
     return required_validator(answer.strip(".").strip(), msg)
 
 
-def multiple_line_breaker(answer: str, sep: str = "|") -> str:
+def break_multiple_line(answer: str, sep: str = "|") -> str:
     return "\n".join(line.strip() for line in answer.split(sep) if line)
 
 

docs/customization.md

@@ -175,7 +175,7 @@ commitizen:
 | `message`           | `str`  | `None`  | Detail description for the question.                                                                                                                                                                               |
 | `choices`           | `list` | `None`  | (OPTIONAL) The choices when `type = list` or `type = select`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. |
 | `default`           | `Any`  | `None`  | (OPTIONAL) The default value for this question.                                                                                                                                                                    |
-| `filter`            | `str`  | `None`  | (OPTIONAL) Validator for user's answer. The string is the name of a `commitizen.cz.utils.NAME(answer...)` function like `multiple_line_breaker`                                                                    |
+| `filter`            | `str`  | `None`  | (OPTIONAL) Validator for user's answer. The string is the name of a `commitizen.cz.utils.NAME(answer...)` function like `break_multiple_line`                                                                      |
 | `multiline`         | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`.                                                                                                                                                           |
 | `multiline`         | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`.                                                                                                                                                           |
 | `use_search_filter` | `bool` | `False` | (OPTIONAL) Enable search/filter functionality for list/select type questions. This allows users to type and filter through the choices.                                                                            |

tests/test_cz_customize.py

@@ -5,7 +5,7 @@
 from commitizen.config import BaseConfig, JsonConfig, TomlConfig, YAMLConfig
 from commitizen.cz.customize import CustomizeCommitsCz
 from commitizen.cz.utils import (
-    multiple_line_breaker,
+    break_multiple_line,
     required_validator,
     required_validator_scope,
     required_validator_subject_strip,
@@ -55,7 +55,7 @@
     type = "input"
     name = "message"
     message = "Body."
-    filter = "multiple_line_breaker"
+    filter = "break_multiple_line"
 
     [[tool.commitizen.customize.questions]]
     type = "confirm"
@@ -115,7 +115,7 @@
                         "type": "input",
                         "name": "message",
                         "message": "Body.",
-                        "filter": "multiple_line_breaker"
+                        "filter": "break_multiple_line"
                     },
                     {
                         "type": "confirm",
@@ -169,7 +169,7 @@
     - type: input
       name: message
       message: Body.
-      filter: multiple_line_breaker
+      filter: break_multiple_line
     - type: confirm
       name: show_message
       message: Do you want to add body message in commit?
@@ -504,7 +504,7 @@ def test_questions_default(config):
             "type": "input",
             "name": "message",
             "message": "Body.",
-            "filter": "multiple_line_breaker",
+            "filter": "break_multiple_line",
         },
         {
             "type": "confirm",
@@ -542,7 +542,7 @@ def test_questions_filter_default(config, mocker: MockFixture):
     assert prompts_questions[1]["filter"] == required_validator_subject_strip
     assert prompts_questions[2]["type"] == "input"
     assert prompts_questions[2]["name"] == "message"
-    assert prompts_questions[2]["filter"] == multiple_line_breaker
+    assert prompts_questions[2]["filter"] == break_multiple_line
     assert prompts_questions[3]["type"] == "confirm"
     assert prompts_questions[3]["name"] == "show_message"
 
@@ -568,7 +568,7 @@ def test_questions_filter_values(config_filters, mocker: MockFixture):
     assert isinstance(commit_cmd.cz, CustomizeCommitsCz)
 
     for filter_desc in [
-        ("multiple_line_breaker", multiple_line_breaker),
+        ("break_multiple_line", break_multiple_line),
         ("required_validator", required_validator),
         ("required_validator_scope", required_validator_scope),
         ("required_validator_subject_strip", required_validator_subject_strip),

tests/test_cz_utils.py

@@ -11,12 +11,12 @@ def test_required_validator():
         utils.required_validator("")
 
 
-def test_multiple_line_breaker():
+def test_break_multiple_line():
     message = "this is the first line    | and this is the second line   "
-    result = utils.multiple_line_breaker(message)
+    result = utils.break_multiple_line(message)
     assert result == "this is the first line\nand this is the second line"
 
-    result = utils.multiple_line_breaker(message, "is")
+    result = utils.break_multiple_line(message, "is")
     assert result == "th\n\nthe first line    | and th\n\nthe second line"