feat(ConventionalCommitsCz): allow to override defaults from config

Before fixing tests and adding extra ones, I would like to received
partial feedback about my changes to see if this aligns with the desired
code changes by maintainers.

As addressed on commitizen-tools#535, when using customize commitizen, if we want to
customize a small attribute, we need to redefine all commitizens options
to make our custom class work.

For example:

```diff
diff --git a/cz.yaml b/cz.yaml
index 2e847b0..302e961 100644
--- a/cz.yaml
+++ b/cz.yaml
@@ -1,17 +1,18 @@
 commitizen:
   annotated_tag: true
   bump_message: 'bump: $current_version -> $new_version [skip ci]'
-  bump_pattern: '^(fix|feat|docs|style|refactor|test|build|ci)'
-  bump_map:
-    fix: PATCH
-    feat: PATCH
-    docs: PATCH
-    style: PATCH
-    refactor: PATCH
-    test: PATCH
-    build: PATCH
-    ci: PATCH
-
-  name: cz_conventional_commits
+  name: cz_customize
   update_changelog_on_bump: true
   version: 0.11.0
+
+  customize:
+    bump_pattern: '^(fix|feat|docs|style|refactor|test|build|ci)'
+    bump_map:
+      fix: PATCH
+      feat: PATCH
+      docs: PATCH
+      style: PATCH
+      refactor: PATCH
+      test: PATCH
+      build: PATCH
+      ci: PATCH
```

making the following change on a repo would cause an unexpected
behavior:

```python
+ bash -c cz commit

Traceback (most recent call last):
  File "/home/amit/.local/bin/cz", line 8, in <module>
    sys.exit(main())
  File "/home/amit/.local/lib/python3.10/site-packages/commitizen/cli.py", line 382, in main
    args.func(conf, vars(args))()
  File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 74, in __call__
    m = self.prompt_commit_questions()
  File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in prompt_commit_questions
    for question in filter(lambda q: q["type"] == "list", questions):
  File "/home/amit/.local/lib/python3.10/site-packages/commitizen/commands/commit.py", line 49, in <lambda>
    for question in filter(lambda q: q["type"] == "list", questions):
KeyError: 'type'
```

From my best understanding, this error happens because I didn't defined
question section in config, though I'm ok with using
ConventionalCommitsCz default ones.

This commit extends ConventionalCommitsCz to read from config and
fallbacks to defaults if some are not provided.

By adding this change, potentially customize commitizen can be
deprecated.

BREAKING CHANGES: CustomizeCommitsCz was removed.

Closes commitizen-tools#535.

commitizen/cz/__init__.py

@@ -5,7 +5,6 @@
 
 from commitizen.cz.base import BaseCommitizen
 from commitizen.cz.conventional_commits import ConventionalCommitsCz
-from commitizen.cz.customize import CustomizeCommitsCz
 from commitizen.cz.jira import JiraSmartCz
 
 
@@ -33,7 +32,6 @@ def discover_plugins(path: Iterable[str] = None) -> Dict[str, Type[BaseCommitize
 registry: Dict[str, Type[BaseCommitizen]] = {
     "cz_conventional_commits": ConventionalCommitsCz,
     "cz_jira": JiraSmartCz,
-    "cz_customize": CustomizeCommitsCz,
 }
 
 registry.update(discover_plugins())

commitizen/cz/base.py

@@ -1,37 +1,14 @@
 from abc import ABCMeta, abstractmethod
-from typing import Callable, Dict, List, Optional, Tuple
+from typing import Callable, Dict, List, Optional
 
 from prompt_toolkit.styles import Style, merge_styles
 
-from commitizen import git
+from commitizen import defaults, git
 from commitizen.config.base_config import BaseConfig
 from commitizen.defaults import Questions
 
 
 class BaseCommitizen(metaclass=ABCMeta):
-    bump_pattern: Optional[str] = None
-    bump_map: Optional[Dict[str, str]] = None
-    default_style_config: List[Tuple[str, str]] = [
-        ("qmark", "fg:#ff9d00 bold"),
-        ("question", "bold"),
-        ("answer", "fg:#ff9d00 bold"),
-        ("pointer", "fg:#ff9d00 bold"),
-        ("highlighted", "fg:#ff9d00 bold"),
-        ("selected", "fg:#cc5454"),
-        ("separator", "fg:#cc5454"),
-        ("instruction", ""),
-        ("text", ""),
-        ("disabled", "fg:#858585 italic"),
-    ]
-
-    # The whole subject will be parsed as message by default
-    # This allows supporting changelog for any rule system.
-    # It can be modified per rule
-    commit_parser: Optional[str] = r"(?P<message>.*)"
-    changelog_pattern: Optional[str] = r".*"
-    change_type_map: Optional[Dict[str, str]] = None
-    change_type_order: Optional[List[str]] = None
-
     # Executed per message parsed by the commitizen
     changelog_message_builder_hook: Optional[
         Callable[[Dict, git.GitCommit], Dict]
@@ -42,8 +19,30 @@ class BaseCommitizen(metaclass=ABCMeta):
 
     def __init__(self, config: BaseConfig):
         self.config = config
-        if not self.config.settings.get("style"):
-            self.config.settings.update({"style": BaseCommitizen.default_style_config})
+        self.default_style_config: Optional[Dict[str, str]] = self.config.settings.get(
+            "default_style_config", defaults.default_style_config
+        )
+        self.bump_pattern: Optional[str] = self.config.settings.get(
+            "bump_pattern", defaults.bump_pattern
+        )
+        self.bump_map: Optional[Dict[str, str]] = self.config.settings.get(
+            "bump_map", defaults.bump_map
+        )
+        self.change_type_order: Optional[List[str]] = self.config.settings.get(
+            "change_type_order", defaults.change_type_order
+        )
+        self.change_type_map: Optional[Dict[str, str]] = self.config.settings.get(
+            "change_type_map", defaults.change_type_map
+        )
+        self.commit_parser: Optional[str] = self.config.settings.get(
+            "commit_parser", defaults.commit_parser
+        )
+        self.changelog_pattern: Optional[str] = self.config.settings.get(
+            "changelog_pattern", defaults.changelog_pattern
+        )
+        self.version_parser = self.config.settings.get(
+            "version_parser", defaults.version_parser
+        )
 
     @abstractmethod
     def questions(self) -> Questions:
@@ -58,7 +57,7 @@ def style(self):
         return merge_styles(
             [
                 Style(BaseCommitizen.default_style_config),
-                Style(self.config.settings["style"]),
+                Style(self.default_style_config),
             ]
         )
 

commitizen/cz/conventional_commits/conventional_commits.py

@@ -1,7 +1,11 @@
 import os
 import re
 
-from commitizen import defaults
+try:
+    from jinja2 import Template
+except ImportError:
+    from string import Template  # type: ignore
+
 from commitizen.cz.base import BaseCommitizen
 from commitizen.cz.utils import multiple_line_breaker, required_validator
 from commitizen.defaults import Questions
@@ -28,18 +32,6 @@ def parse_subject(text):
 
 
 class ConventionalCommitsCz(BaseCommitizen):
-    bump_pattern = defaults.bump_pattern
-    bump_map = defaults.bump_map
-    commit_parser = defaults.commit_parser
-    version_parser = defaults.version_parser
-    change_type_map = {
-        "feat": "Feat",
-        "fix": "Fix",
-        "refactor": "Refactor",
-        "perf": "Perf",
-    }
-    changelog_pattern = defaults.bump_pattern
-
     def questions(self) -> Questions:
         questions: Questions = [
             {
@@ -148,9 +140,21 @@ def questions(self) -> Questions:
                 ),
             },
         ]
-        return questions
+
+        # TODO: How would filter functions would be handled from config?
+        return self.config.settings.get("questions", questions)
 
     def message(self, answers: dict) -> str:
+        custom_message = self.self.config.settings.get("message_template")
+        if custom_message:
+            message_template = Template(
+                self.self.config.settings.get("message_template", "")
+            )
+            if getattr(Template, "substitute", None):
+                return message_template.substitute(**answers)  # type: ignore
+            else:
+                return message_template.render(**answers)
+
         prefix = answers["prefix"]
         scope = answers["scope"]
         subject = answers["subject"]
@@ -172,39 +176,47 @@ def message(self, answers: dict) -> str:
         return message
 
     def example(self) -> str:
-        return (
+        return self.config.settings.get(
+            "example",
             "fix: correct minor typos in code\n"
             "\n"
             "see the issue for details on the typos fixed\n"
             "\n"
-            "closes issue #12"
+            "closes issue #12",
         )
 
     def schema(self) -> str:
-        return (
+        return self.config.settings.get(
+            "schema",
             "<type>(<scope>): <subject>\n"
             "<BLANK LINE>\n"
             "<body>\n"
             "<BLANK LINE>\n"
-            "(BREAKING CHANGE: )<footer>"
+            "(BREAKING CHANGE: )<footer>",
         )
 
     def schema_pattern(self) -> str:
         PATTERN = (
-            r"(?s)"  # To explictly make . match new line
+            r"(?s)"  # To explicitly make . match new line
             r"(build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)"  # type
             r"(\(\S+\))?!?:"  # scope
             r"( [^\n\r]+)"  # subject
             r"((\n\n.*)|(\s*))?$"
         )
-        return PATTERN
+        return self.config.settings.get("schema_pattern", PATTERN)
 
     def info(self) -> str:
         dir_path = os.path.dirname(os.path.realpath(__file__))
         filepath = os.path.join(dir_path, "conventional_commits_info.txt")
-        with open(filepath, "r") as f:
-            content = f.read()
-        return content
+        info_path = self.custom_settings.get("info_path", filepath)
+        info = self.custom_settings.get("info")
+        if info_path:
+            with open(info_path, "r") as f:
+                content = f.read()
+            return content
+        elif info:
+            return info
+        return None
 
     def process_commit(self, commit: str) -> str:
         pat = re.compile(self.schema_pattern())

commitizen/defaults.py

@@ -87,3 +87,25 @@ class Settings(TypedDict, total=False):
 
 commit_parser = r"^(?P<change_type>feat|fix|refactor|perf|BREAKING CHANGE)(?:\((?P<scope>[^()\r\n]*)\)|\()?(?P<breaking>!)?:\s(?P<message>.*)?"  # noqa
 version_parser = r"(?P<version>([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?(\w+)?)"
+
+change_type_map = {
+    "feat": "Feat",
+    "fix": "Fix",
+    "refactor": "Refactor",
+    "perf": "Perf",
+}
+
+changelog_pattern = r".*"
+
+default_style_config: List[Tuple[str, str]] = [
+    ("qmark", "fg:#ff9d00 bold"),
+    ("question", "bold"),
+    ("answer", "fg:#ff9d00 bold"),
+    ("pointer", "fg:#ff9d00 bold"),
+    ("highlighted", "fg:#ff9d00 bold"),
+    ("selected", "fg:#cc5454"),
+    ("separator", "fg:#cc5454"),
+    ("instruction", ""),
+    ("text", ""),
+    ("disabled", "fg:#858585 italic"),
+]

commitizen/exceptions.py

@@ -19,7 +19,6 @@ class ExitCode(enum.IntEnum):
     CUSTOM_ERROR = 12
     NO_COMMAND_FOUND = 13
     INVALID_COMMIT_MSG = 14
-    MISSING_CZ_CUSTOMIZE_CONFIG = 15
     NO_REVISION = 16
     CURRENT_VERSION_NOT_FOUND = 17
     INVALID_COMMAND_ARGUMENT = 18
@@ -69,11 +68,6 @@ class NotAGitProjectError(CommitizenException):
     message = "fatal: not a git repository (or any of the parent directories): .git"
 
 
-class MissingCzCustomizeConfigError(CommitizenException):
-    exit_code = ExitCode.MISSING_CZ_CUSTOMIZE_CONFIG
-    message = "fatal: customize is not set in configuration file."
-
-
 class NoCommitsFoundError(CommitizenException):
     exit_code = ExitCode.NO_COMMITS_FOUND