feat(cz/filters): add required_validator and multiple_line_breaker

Lee-W · Lee-W · commit d968daf1271e · 2019-11-19T13:38:03.000-05:00
diff --git a/commitizen/commands/bump.py b/commitizen/commands/bump.py
@@ -122,7 +122,7 @@ def __call__(self):
         bump.update_version_in_files(current_version, new_version.public, files)
         c = git.commit(message, args="-a")
         if c.err:
-            out.error("git.commit errror: \"{}\"".format(c.err.strip()))
+            out.error('git.commit errror: "{}"'.format(c.err.strip()))
             raise SystemExit(COMMIT_FAILED)
         c = git.tag(new_tag_version)
         if c.err:
diff --git a/commitizen/cz/conventional_commits/conventional_commits.py b/commitizen/cz/conventional_commits/conventional_commits.py
@@ -2,15 +2,11 @@
 
 from commitizen import defaults
 from commitizen.cz.base import BaseCommitizen
-from commitizen.cz.exceptions import CzException
+from commitizen.cz.filters import multiple_line_breaker, required_validator
 
 __all__ = ["ConventionalCommitsCz"]
 
 
-class NoSubjectException(CzException):
-    ...
-
-
 def parse_scope(text):
     if not text:
         return ""
@@ -26,10 +22,7 @@ def parse_subject(text):
     if isinstance(text, str):
         text = text.strip(".").strip()
 
-    if not text:
-        raise NoSubjectException("Subject is required.")
-
-    return text
+    return required_validator(text, msg="Subject is required.")
 
 
 class ConventionalCommitsCz(BaseCommitizen):
@@ -124,6 +117,7 @@ def questions(self) -> list:
                     "Body. Motivation for the change and contrast this "
                     "with previous behavior:\n"
                 ),
+                "filter": multiple_line_breaker,
             },
             {
                 "type": "input",
diff --git a/commitizen/cz/exceptions.py b/commitizen/cz/exceptions.py
@@ -1,2 +1,6 @@
 class CzException(Exception):
     ...
+
+
+class AnswerRequiredError(Exception):
+    ...
diff --git a/commitizen/cz/filters.py b/commitizen/cz/filters.py
@@ -0,0 +1,11 @@
+from commitizen.cz import exceptions
+
+
+def required_validator(ans, msg=None):
+    if not ans:
+        raise exceptions.AnswerRequiredError(msg)
+    return ans
+
+
+def multiple_line_breaker(ans, sep="|"):
+    return "\n".join(line.strip() for line in ans.split(sep) if line)
diff --git a/tests/test_cz_conventional_commits.py b/tests/test_cz_conventional_commits.py
@@ -3,10 +3,10 @@
 from commitizen import defaults
 from commitizen.cz.conventional_commits.conventional_commits import (
     ConventionalCommitsCz,
-    NoSubjectException,
     parse_scope,
     parse_subject,
 )
+from commitizen.cz.exceptions import AnswerRequiredError
 
 config = {"name": defaults.name}
 
@@ -39,7 +39,7 @@ def test_parse_subject_valid_values():
 
 def test_parse_subject_invalid_values():
     for valid_subject in invalid_subjects:
-        with pytest.raises(NoSubjectException):
+        with pytest.raises(AnswerRequiredError):
             parse_subject(valid_subject)
 
 

-Original file line number
+Diff line change
@@ @@ -1,2 +1,6 @@ @@
 class CzException(Exception):
     ...
++
++
 +class AnswerRequiredError(Exception):
 +    ...