Skip to content

Commit 1d70a09

Browse files
committed
feat(commit): implement questions 'filter' support with handlers
Details: The 'filter' key of 'cz_customize' questions is resolved from its string value to the matching 'commitizen.cz.utils' handler before prompting, and unknown values raise 'NotAllowed' --- Supported handlers: - multiple_line_breaker - required_validator - required_validator_scope - required_validator_subject_strip - required_validator_title_strip Example YAML configuration: --- commitizen: name: cz_customize customize: questions: - ... - type: input name: scope message: 'Scope of the change :' filter: 'required_validator_scope' default: '' - type: input name: subject message: 'Title of the commit (starting in lower case and without period) :' filter: 'required_validator_subject_strip' default: '' - type: input name: body message: 'Additional contextual message (Empty to skip) :' default: 'Issue: #...' filter: 'multiple_line_breaker' --- Signed-off-by: Adrian DC <radian.dc@gmail.com>
1 parent a7dccee commit 1d70a09

4 files changed

Lines changed: 183 additions & 6 deletions

File tree

‎commitizen/commands/commit.py‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,14 @@
1414

1515
from commitizen import factory, git, out
1616
from commitizen.cz.exceptions import CzException
17-
from commitizen.cz.utils import get_backup_file_path
17+
from commitizen.cz.utils import (
18+
get_backup_file_path,
19+
multiple_line_breaker,
20+
required_validator,
21+
required_validator_scope,
22+
required_validator_subject_strip,
23+
required_validator_title_strip,
24+
)
1825
from commitizen.exceptions import (
1926
CommitError,
2027
CommitMessageLengthExceededError,
@@ -73,6 +80,23 @@ def _get_message_by_prompt_commit_questions(self) -> str:
7380

7481
for question in (q for q in questions if q["type"] == "list"):
7582
question["use_shortcuts"] = self.config.settings["use_shortcuts"]
83+
84+
for question in filter(
85+
lambda q: isinstance(q.get("filter", None), str), questions
86+
):
87+
if question["filter"] == "multiple_line_breaker":
88+
question["filter"] = multiple_line_breaker
89+
elif question["filter"] == "required_validator":
90+
question["filter"] = required_validator
91+
elif question["filter"] == "required_validator_scope":
92+
question["filter"] = required_validator_scope
93+
elif question["filter"] == "required_validator_subject_strip":
94+
question["filter"] = required_validator_subject_strip
95+
elif question["filter"] == "required_validator_title_strip":
96+
question["filter"] = required_validator_title_strip
97+
else:
98+
raise NotAllowed(f"Unknown value filter: {question['filter']}")
99+
76100
try:
77101
answers = questionary.prompt(questions, style=self.cz.style)
78102
except ValueError as err:

‎commitizen/cz/utils.py‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,27 @@ def required_validator(answer: str, msg: object = None) -> str:
1515
return answer
1616

1717

18+
def required_validator_scope(
19+
answer: str,
20+
msg: str = "! Error: Scope is required",
21+
) -> str:
22+
return required_validator(answer, msg)
23+
24+
25+
def required_validator_subject_strip(
26+
answer: str,
27+
msg: str = "! Error: Subject is required",
28+
) -> str:
29+
return required_validator(answer.strip(".").strip(), msg)
30+
31+
32+
def required_validator_title_strip(
33+
answer: str,
34+
msg: str = "! Error: Title is required",
35+
) -> str:
36+
return required_validator(answer.strip(".").strip(), msg)
37+
38+
1839
def multiple_line_breaker(answer: str, sep: str = "|") -> str:
1940
return "\n".join(line.strip() for line in answer.split(sep) if line)
2041

‎docs/customization/config_file.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ Example:
179179
| `message` | `str` | `None` | Detail description for the question. |
180180
| `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. |
181181
| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. |
182-
| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. **(Work in Progress)** |
182+
| `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` |
183183
| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. |
184184
| `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. |
185185
| `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only. |

‎tests/test_cz_customize.py‎

Lines changed: 136 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,22 @@
22
from pathlib import Path
33

44
import pytest
5+
from pytest_mock import MockFixture
56

7+
from commitizen import cmd, commands
68
from commitizen.config import BaseConfig
79
from commitizen.config.json_config import JsonConfig
810
from commitizen.config.toml_config import TomlConfig
911
from commitizen.config.yaml_config import YAMLConfig
1012
from commitizen.cz.customize import CustomizeCommitsCz
11-
from commitizen.exceptions import MissingCzCustomizeConfigError
13+
from commitizen.cz.utils import (
14+
multiple_line_breaker,
15+
required_validator,
16+
required_validator_scope,
17+
required_validator_subject_strip,
18+
required_validator_title_strip,
19+
)
20+
from commitizen.exceptions import MissingCzCustomizeConfigError, NotAllowed
1221

1322
TOML_STR = r"""
1423
[tool.commitizen]
@@ -42,10 +51,17 @@
4251
]
4352
message = "Select the type of change you are committing"
4453
54+
[[tool.commitizen.customize.questions]]
55+
type = "input"
56+
name = "subject"
57+
message = "Subject."
58+
filter = "required_validator_subject_strip"
59+
4560
[[tool.commitizen.customize.questions]]
4661
type = "input"
4762
name = "message"
4863
message = "Body."
64+
filter = "multiple_line_breaker"
4965
5066
[[tool.commitizen.customize.questions]]
5167
type = "confirm"
@@ -95,10 +111,17 @@
95111
],
96112
"message": "Select the type of change you are committing"
97113
},
114+
{
115+
"type": "input",
116+
"name": "subject",
117+
"message": "Subject.",
118+
"filter": "required_validator_subject_strip"
119+
},
98120
{
99121
"type": "input",
100122
"name": "message",
101-
"message": "Body."
123+
"message": "Body.",
124+
"filter": "multiple_line_breaker"
102125
},
103126
{
104127
"type": "confirm",
@@ -145,9 +168,14 @@
145168
- value: bug fix
146169
name: 'bug fix: A bug fix.'
147170
message: Select the type of change you are committing
171+
- type: input
172+
name: subject
173+
message: Subject.
174+
filter: required_validator_subject_strip
148175
- type: input
149176
name: message
150177
message: Body.
178+
filter: multiple_line_breaker
151179
- type: confirm
152180
name: show_message
153181
message: Do you want to add body message in commit?
@@ -336,6 +364,13 @@
336364
"""
337365

338366

367+
@pytest.fixture
368+
def staging_is_clean(mocker: MockFixture, tmp_git_project):
369+
is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean")
370+
is_staging_clean_mock.return_value = False
371+
return tmp_git_project
372+
373+
339374
@pytest.fixture(
340375
params=[
341376
TomlConfig(data=TOML_STR, path=Path("not_exist.toml")),
@@ -352,6 +387,15 @@ def config(request):
352387
return request.param
353388

354389

390+
@pytest.fixture(
391+
params=[
392+
YAMLConfig(data=YAML_STR, path=Path("not_exist.yaml")),
393+
]
394+
)
395+
def config_filters(request):
396+
return request.param
397+
398+
355399
@pytest.fixture(
356400
params=[
357401
TomlConfig(data=TOML_STR_INFO_PATH, path=Path("not_exist.toml")),
@@ -524,7 +568,7 @@ def test_change_type_order_unicode(config_with_unicode):
524568
]
525569

526570

527-
def test_questions(config):
571+
def test_questions_default(config):
528572
cz = CustomizeCommitsCz(config)
529573
questions = cz.questions()
530574
expected_questions = [
@@ -537,7 +581,18 @@ def test_questions(config):
537581
],
538582
"message": "Select the type of change you are committing",
539583
},
540-
{"type": "input", "name": "message", "message": "Body."},
584+
{
585+
"type": "input",
586+
"name": "subject",
587+
"message": "Subject.",
588+
"filter": "required_validator_subject_strip",
589+
},
590+
{
591+
"type": "input",
592+
"name": "message",
593+
"message": "Body.",
594+
"filter": "multiple_line_breaker",
595+
},
541596
{
542597
"type": "confirm",
543598
"name": "show_message",
@@ -547,6 +602,83 @@ def test_questions(config):
547602
assert list(questions) == expected_questions
548603

549604

605+
@pytest.mark.usefixtures("staging_is_clean")
606+
def test_questions_filter_default(config, mocker: MockFixture):
607+
is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean")
608+
is_staging_clean_mock.return_value = False
609+
610+
prompt_mock = mocker.patch("questionary.prompt")
611+
prompt_mock.return_value = {
612+
"change_type": "feature",
613+
"subject": "user created",
614+
"message": "body of the commit",
615+
"show_message": True,
616+
}
617+
618+
commit_mock = mocker.patch("commitizen.git.commit")
619+
commit_mock.return_value = cmd.Command("success", "", b"", b"", 0)
620+
621+
commands.Commit(config, {})()
622+
623+
prompts_questions = prompt_mock.call_args[0][0]
624+
assert prompts_questions[0]["type"] == "list"
625+
assert prompts_questions[0]["name"] == "change_type"
626+
assert prompts_questions[0]["use_shortcuts"] is False
627+
assert prompts_questions[1]["type"] == "input"
628+
assert prompts_questions[1]["name"] == "subject"
629+
assert prompts_questions[1]["filter"] == required_validator_subject_strip
630+
assert prompts_questions[2]["type"] == "input"
631+
assert prompts_questions[2]["name"] == "message"
632+
assert prompts_questions[2]["filter"] == multiple_line_breaker
633+
assert prompts_questions[3]["type"] == "confirm"
634+
assert prompts_questions[3]["name"] == "show_message"
635+
636+
637+
@pytest.mark.usefixtures("staging_is_clean")
638+
def test_questions_filter_values(config_filters, mocker: MockFixture):
639+
is_staging_clean_mock = mocker.patch("commitizen.git.is_staging_clean")
640+
is_staging_clean_mock.return_value = False
641+
642+
prompt_mock = mocker.patch("questionary.prompt")
643+
prompt_mock.return_value = {
644+
"change_type": "feature",
645+
"subject": "user created",
646+
"message": "body of the commit",
647+
"show_message": True,
648+
}
649+
650+
commit_mock = mocker.patch("commitizen.git.commit")
651+
commit_mock.return_value = cmd.Command("success", "", b"", b"", 0)
652+
653+
commit_cmd = commands.Commit(config_filters, {})
654+
655+
assert isinstance(commit_cmd.cz, CustomizeCommitsCz)
656+
657+
for filter_desc in [
658+
("multiple_line_breaker", multiple_line_breaker),
659+
("required_validator", required_validator),
660+
("required_validator_scope", required_validator_scope),
661+
("required_validator_subject_strip", required_validator_subject_strip),
662+
("required_validator_title_strip", required_validator_title_strip),
663+
]:
664+
commit_cmd.cz.custom_settings["questions"][1]["filter"] = filter_desc[0] # type: ignore[index]
665+
commit_cmd()
666+
667+
assert filter_desc[1]("input")
668+
669+
prompts_questions = prompt_mock.call_args[0][0]
670+
assert prompts_questions[1]["filter"] == filter_desc[1]
671+
672+
for filter_name in [
673+
"",
674+
"faulty_value",
675+
]:
676+
commit_cmd.cz.custom_settings["questions"][1]["filter"] = filter_name # type: ignore[index]
677+
678+
with pytest.raises(NotAllowed):
679+
commit_cmd()
680+
681+
550682
def test_questions_unicode(config_with_unicode):
551683
cz = CustomizeCommitsCz(config_with_unicode)
552684
questions = cz.questions()

0 commit comments

Comments
 (0)