feat(cz/cz_customize): implement customizable cz

Lee-W · Lee-W · commit 746dd87314b4 · 2019-11-18T15:37:17.000-05:00
#54
diff --git a/commitizen/cz/__init__.py b/commitizen/cz/__init__.py
@@ -3,8 +3,13 @@
 
 from commitizen.cz.conventional_commits import ConventionalCommitsCz
 from commitizen.cz.jira import JiraSmartCz
+from commitizen.cz.customize import CustomizeCommitsCz
 
-registry = {"cz_conventional_commits": ConventionalCommitsCz, "cz_jira": JiraSmartCz}
+registry = {
+    "cz_conventional_commits": ConventionalCommitsCz,
+    "cz_jira": JiraSmartCz,
+    "cz_customize": CustomizeCommitsCz,
+}
 plugins = {
     name: importlib.import_module(name).discover_this
     for finder, name, ispkg in pkgutil.iter_modules()
diff --git a/commitizen/cz/customize/__init__.py b/commitizen/cz/customize/__init__.py
@@ -0,0 +1 @@
+from .customize import CustomizeCommitsCz  # noqa
diff --git a/commitizen/cz/customize/customize.py b/commitizen/cz/customize/customize.py
@@ -0,0 +1,30 @@
+from commitizen import defaults
+from commitizen.cz.base import BaseCommitizen
+
+__all__ = ["CustomizeCommitsCz"]
+
+
+class CustomizeCommitsCz(BaseCommitizen):
+    bump_pattern = defaults.bump_pattern
+    bump_map = defaults.bump_map
+
+    def __init__(self, config: dict):
+        super(CustomizeCommitsCz, self).__init__(config)
+        self.custom_config = self.config.get("customize")
+
+    def questions(self) -> list:
+        return self.custom_config.get("questions")
+
+    def message(self, answers: dict) -> str:
+        message_template = self.custom_config.get("message_template")
+        return message_template.format(**answers)
+
+    def example(self) -> str:
+        return self.custom_config.get("example")
+
+    def schema(self) -> str:
+        return self.custom_config.get("schema")
+
+    def info(self) -> str:
+        # TODO
+        raise NotImplementedError("Not Implemented yet")
diff --git a/commitizen/cz/customize/customize_info.txt b/commitizen/cz/customize/customize_info.txt
diff --git a/scripts/test b/scripts/test
@@ -1,4 +1,3 @@
-export PREFIX="poetry run python -m "
 if [ -d 'venv' ] ; then
     export PREFIX="venv/bin/"
 fi
diff --git a/tests/test_cz_customize.py b/tests/test_cz_customize.py
@@ -0,0 +1,65 @@
+import pytest
+from tomlkit import parse
+
+from commitizen.cz.customize import CustomizeCommitsCz
+from commitizen.config import Config
+
+
+@pytest.fixture(scope="module")
+def config():
+    _conf = Config()
+    toml_str = """
+    [tool.commitizen.customize]
+    # message_template should follow the python string formatting spec
+    message_template = "{change_type}: {message}"
+    example = "feature: this feature eanable customize through config file"
+    schema = "<type>: <body>"
+
+    [[tool.commitizen.customize.questions]]
+    type = "list"
+    name = "change_type"
+    choices = ["feature", "bug fix"]
+    message = "Select the type of change you are committing"
+
+    [[tool.commitizen.customize.questions]]
+    type = "input"
+    name = "message"
+    message = "Body."
+    """
+    _conf.update(parse(toml_str)["tool"]["commitizen"])
+    return _conf.config
+
+
+def test_questions(config):
+    cz = CustomizeCommitsCz(config)
+    questions = cz.questions()
+    expected_questions = [
+        {
+            "type": "list",
+            "name": "change_type",
+            "choices": ["feature", "bug fix"],
+            "message": "Select the type of change you are committing",
+        },
+        {"type": "input", "name": "message", "message": "Body."},
+    ]
+    assert list(questions) == expected_questions
+
+
+def test_answer(config):
+    cz = CustomizeCommitsCz(config)
+    answers = {
+        "change_type": "feature",
+        "message": "this feature eanable customize through config file",
+    }
+    message = cz.message(answers)
+    assert message == "feature: this feature eanable customize through config file"
+
+
+def test_example(config):
+    cz = CustomizeCommitsCz(config)
+    assert "feature: this feature eanable customize through config file" in cz.example()
+
+
+def test_schema(config):
+    cz = CustomizeCommitsCz(config)
+    assert "<type>: <body>" in cz.schema()

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+from .customize import CustomizeCommitsCz # noqa`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-export PREFIX="poetry run python -m "`
`2`	`1`	`if [ -d 'venv' ] ; then`
`3`	`2`	`export PREFIX="venv/bin/"`
`4`	`3`	`fi`