refactor: new config system where each config type has its own class

* refactor(config): Make config a class and each type of config (e.g., toml, ini) a child class

* Use new config structure to fix the previously fixed Issue #97
* Rename the config inside a config as settings
* Use config class as argument for cz and commands instead of dict config
* Remove settings from default

* fix(config/ini_config): replase outdated _parse_ini_settings with _parse_settings

* fix(config): fix load global_conf even if it doesn't exist

* refactor(config): move default settings back to defaults

* test(all): fix test break due to refactoring

note that empty config file is not yet handled. should be fix in next commit

* fix(config): handle empty config file

* refactor(cz/customize): remove unnecessary statement "raise NotImplementedError("Not Implemented yet")"

* refactor(all): replace all the _settings invoke with settings.update

* refactor(config): use add_path instead of directly assigning _path

Author: woile

commitizen/cli.py

@@ -155,7 +155,7 @@ def main():
         out.error("Command is required")
         raise SystemExit()
 
-    if args.name and not conf["name"]:
+    if args.name:
         conf.update({"name": args.name})
 
     if args.version:

commitizen/commands/bump.py

@@ -3,7 +3,8 @@
 import questionary
 from packaging.version import Version
 
-from commitizen import bump, config, factory, git, out
+from commitizen import bump, factory, git, out
+from commitizen.config import BaseConfig
 
 NO_COMMITS_FOUND = 3
 NO_VERSION_SPECIFIED = 4
@@ -15,11 +16,11 @@
 class Bump:
     """Show prompt for the user to create a guided commit."""
 
-    def __init__(self, config: dict, arguments: dict):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, arguments: dict):
+        self.config: BaseConfig = config
         self.arguments: dict = arguments
         self.parameters: dict = {
-            **config,
+            **config.settings,
             **{
                 key: arguments[key]
                 for key in [
@@ -56,7 +57,7 @@ def find_increment(self, commits: list) -> Optional[str]:
         bump_pattern = self.cz.bump_pattern
         bump_map = self.cz.bump_map
         if not bump_map or not bump_pattern:
-            out.error(f"'{self.config['name']}' rule does not support bump")
+            out.error(f"'{self.config.settings['name']}' rule does not support bump")
             raise SystemExit(NO_PATTERN_MAP)
         increment = bump.find_increment(
             commits, regex=bump_pattern, increments_map=bump_map
@@ -74,7 +75,7 @@ def __call__(self):
             raise SystemExit(NO_VERSION_SPECIFIED)
 
         # Initialize values from sources (conf)
-        current_version: str = self.config["version"]
+        current_version: str = self.config.settings["version"]
         tag_format: str = self.parameters["tag_format"]
         bump_commit_message: str = self.parameters["bump_message"]
         current_tag_version: str = bump.create_tag(
@@ -127,7 +128,7 @@ def __call__(self):
         if is_files_only:
             raise SystemExit()
 
-        config.set_key("version", new_version.public)
+        self.config.set_key("version", new_version.public)
         c = git.commit(message, args="-a")
         if c.err:
             out.error('git.commit errror: "{}"'.format(c.err.strip()))

commitizen/commands/check.py

@@ -2,6 +2,7 @@
 import re
 
 from commitizen import factory, out
+from commitizen.config import BaseConfig
 
 
 NO_COMMIT_MSG = 3
@@ -11,19 +12,19 @@
 class Check:
     """Check if the current commit msg matches the commitizen format."""
 
-    def __init__(self, config: dict, arguments: dict, cwd=os.getcwd()):
+    def __init__(self, config: BaseConfig, arguments: dict, cwd=os.getcwd()):
         """Init method.
 
         Parameters
         ----------
-        config : dict
+        config : BaseConfig
             the config object required for the command to perform its action
         arguments : dict
             the arguments object that contains all
             the flags provided by the user
 
         """
-        self.config: dict = config
+        self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
         self.arguments: dict = arguments
 

commitizen/commands/commit.py

@@ -6,6 +6,8 @@
 
 from commitizen import factory, git, out
 from commitizen.cz.exceptions import CzException
+from commitizen.config import BaseConfig
+
 
 NO_ANSWERS = 5
 COMMIT_ERROR = 6
@@ -17,8 +19,8 @@
 class Commit:
     """Show prompt for the user to create a guided commit."""
 
-    def __init__(self, config: dict, arguments: dict):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, arguments: dict):
+        self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
         self.arguments = arguments
         self.temp_file: str = os.path.join(tempfile.gettempdir(), "cz.commit.backup")

commitizen/commands/example.py

@@ -1,11 +1,12 @@
 from commitizen import factory, out
+from commitizen.config import BaseConfig
 
 
 class Example:
     """Show an example so people understands the rules."""
 
-    def __init__(self, config: dict, *args):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, *args):
+        self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
 
     def __call__(self):

commitizen/commands/info.py

@@ -1,11 +1,12 @@
 from commitizen import factory, out
+from commitizen.config import BaseConfig
 
 
 class Info:
     """Show in depth explanation of your rules."""
 
-    def __init__(self, config: dict, *args):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, *args):
+        self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
 
     def __call__(self):

commitizen/commands/list_cz.py

@@ -1,12 +1,13 @@
 from commitizen import out
 from commitizen.cz import registry
+from commitizen.config import BaseConfig
 
 
 class ListCz:
     """List currently installed rules."""
 
-    def __init__(self, config: dict, *args):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, *args):
+        self.config: BaseConfig = config
 
     def __call__(self):
         out.write("\n".join(registry.keys()))

commitizen/commands/schema.py

@@ -1,11 +1,12 @@
 from commitizen import factory, out
+from commitizen.config import BaseConfig
 
 
 class Schema:
     """Show structure of the rule."""
 
-    def __init__(self, config: dict, *args):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, *args):
+        self.config: BaseConfig = config
         self.cz = factory.commiter_factory(self.config)
 
     def __call__(self):

commitizen/commands/version.py

@@ -1,12 +1,13 @@
 from commitizen import out
+from commitizen.config import BaseConfig
 from commitizen.__version__ import __version__
 
 
 class Version:
     """Get the version of the installed commitizen."""
 
-    def __init__(self, config: dict, *args):
-        self.config: dict = config
+    def __init__(self, config: BaseConfig, *args):
+        self.config: BaseConfig = config
 
     def __call__(self):
         out.write(__version__)