refactor: added commands folder, better integration with decli

woile · woile · commit e4840a059731 · 2019-03-31T11:02:44.000+02:00
diff --git a/commitizen/__init__.py b/commitizen/__init__.py
@@ -1,7 +1,12 @@
 import logging
 import logging.config
+from colorama import init
 from commitizen.cz.base import BaseCommitizen
 
+
+init()
+
+
 LOGGING = {
     "version": 1,
     "disable_existing_loggers": True,
diff --git a/commitizen/application.py b/commitizen/application.py
diff --git a/commitizen/cli.py b/commitizen/cli.py
@@ -3,11 +3,12 @@
 import sys
 import logging
 import argparse
+import warnings
 from decli import cli
 from pathlib import Path
 from configparser import RawConfigParser, NoSectionError
-from commitizen.application import Application
-from commitizen import deafults
+from commitizen import deafults, commands, out
+from commitizen.__version__ import __version__
 
 
 logger = logging.getLogger(__name__)
@@ -21,11 +22,7 @@
     "formatter_class": argparse.RawDescriptionHelpFormatter,
     "arguments": [
         {"name": "--debug", "action": "store_true", "help": "use debug mode"},
-        {
-            "name": ["-n", "--name"],
-            "default": deafults.NAME,
-            "help": "use the given commitizen",
-        },
+        {"name": ["-n", "--name"], "help": "use the given commitizen"},
         {
             "name": ["--version"],
             "action": "store_true",
@@ -38,28 +35,24 @@
             {
                 "name": "ls",
                 "help": "show available commitizens",
-                "func": lambda app: app.detected_cz,
+                "func": commands.ListCz,
             },
             {
                 "name": ["commit", "c"],
                 "help": "create new commit",
-                "func": lambda app: app.cz.run,
+                "func": commands.Commit,
             },
             {
                 "name": "example",
                 "help": "show commit example",
-                "func": lambda app: app.cz.show_example,
+                "func": commands.Example,
             },
             {
                 "name": "info",
                 "help": "show information about the cz",
-                "func": lambda app: app.cz.show_info,
-            },
-            {
-                "name": "schema",
-                "help": "show commit schema",
-                "func": lambda app: app.cz.show_schema,
+                "func": commands.Info,
             },
+            {"name": "schema", "help": "show commit schema", "func": commands.Schema},
         ],
     },
 }
@@ -106,16 +99,19 @@ def main():
         raise SystemExit(1)
 
     args = parser.parse_args()
-    app = Application(**config)
 
     if args.name:
-        app.name = args.name
+        config.update({"name": args.name})
 
     if args.debug:
+        warnings.warn(
+            "Debug will be deprecated in next major version. "
+            "Please remove it from your scripts"
+        )
         logging.getLogger("commitizen").setLevel(logging.DEBUG)
 
     if args.version:
-        logger.info(app.version)
-        sys.exit(0)
+        out.line(__version__)
+        raise SystemExit()
 
-    args.func(app)(args)
+    args.func(config)(args)
diff --git a/commitizen/commands/__init__.py b/commitizen/commands/__init__.py
@@ -0,0 +1,7 @@
+from .commit import Commit
+from .example import Example
+from .info import Info
+from .list_cz import ListCz
+from .schema import Schema
+
+__all__ = ("Commit", "Example", "Info", "ListCz", "Schema")
diff --git a/commitizen/commands/commit.py b/commitizen/commands/commit.py
@@ -0,0 +1,12 @@
+from commitizen import factory
+
+
+class Commit:
+    """Show prompt for the user to create a guided commit."""
+
+    def __init__(self, config: dict):
+        self.config: dict = config
+        self.cz = factory.commiter_factory(self.config)
+
+    def __call__(self, *args, **kwargs):
+        self.cz.run(*args, **kwargs)
diff --git a/commitizen/commands/example.py b/commitizen/commands/example.py
@@ -0,0 +1,12 @@
+from commitizen import factory
+
+
+class Example:
+    """Show an example so people understands the rules."""
+
+    def __init__(self, config: dict):
+        self.config: dict = config
+        self.cz = factory.commiter_factory(self.config)
+
+    def __call__(self, *args, **kwargs):
+        self.cz.show_example()
diff --git a/commitizen/commands/info.py b/commitizen/commands/info.py
@@ -0,0 +1,12 @@
+from commitizen import factory
+
+
+class Info:
+    """Show in depth explanation of your rules."""
+
+    def __init__(self, config: dict):
+        self.config: dict = config
+        self.cz = factory.commiter_factory(self.config)
+
+    def __call__(self, *args, **kwargs):
+        self.cz.show_info()
diff --git a/commitizen/commands/list_cz.py b/commitizen/commands/list_cz.py
@@ -0,0 +1,12 @@
+from commitizen import out
+from commitizen.cz import registry
+
+
+class ListCz:
+    """List currently installed rules."""
+
+    def __init__(self, config: dict):
+        self.config: dict = config
+
+    def __call__(self, *args, **kwargs):
+        out.write("\n".join(registry.keys()))
diff --git a/commitizen/commands/schema.py b/commitizen/commands/schema.py
@@ -0,0 +1,12 @@
+from commitizen import factory
+
+
+class Schema:
+    """Show structure of the rule."""
+
+    def __init__(self, config: dict):
+        self.config: dict = config
+        self.cz = factory.commiter_factory(self.config)
+
+    def __call__(self, *args, **kwargs):
+        self.cz.show_schema()
diff --git a/commitizen/cz/__init__.py b/commitizen/cz/__init__.py
@@ -3,13 +3,11 @@
 from commitizen.cz.conventional_commits import ConventionalCommitsCz
 from commitizen.cz.jira import JiraSmartCz
 
-
-registry = {
+registry = {"cz_conventional_commits": ConventionalCommitsCz, "cz_jira": JiraSmartCz}
+plugins = {
     name: importlib.import_module(name).discover_this
     for finder, name, ispkg in pkgutil.iter_modules()
     if name.startswith("cz_")
 }
 
-registry.update(
-    {"cz_conventional_commits": ConventionalCommitsCz, "cz_jira": JiraSmartCz}
-)
+registry.update(plugins)
diff --git a/commitizen/cz/base.py b/commitizen/cz/base.py
@@ -1,7 +1,7 @@
 import os
 import sys
 import logging
-from commitizen import cmd
+from commitizen import cmd, out
 from abc import ABCMeta, abstractmethod
 from tempfile import NamedTemporaryFile
 from questionary import prompt
@@ -10,6 +10,9 @@
 
 
 class BaseCommitizen(metaclass=ABCMeta):
+    def __init__(self, config: dict):
+        self.config = config
+
     @abstractmethod
     def questions(self):
         """Questions regarding the commit message.
@@ -36,7 +39,7 @@ def commit(self, message: str):
         f.close()
 
         c = cmd.run(f"git commit -a -F {f.name}")
-        print(c.out or c.err)
+        out.write(c.out or c.err)
 
         os.unlink(f.name)
         return c
@@ -63,13 +66,13 @@ def info(self):
         raise NotImplementedError("Not Implemented yet")
 
     def show_example(self, *args, **kwargs):
-        logger.info(self.example())
+        out.write(self.example())
 
     def show_schema(self, *args, **kwargs):
-        logger.info(self.schema())
+        out.write(self.schema())
 
     def show_info(self, *args, **kwargs):
-        logger.info(self.info())
+        out.write(self.info())
 
     def run(self, *args, **kwargs):
         questions = self.questions()
diff --git a/commitizen/factory.py b/commitizen/factory.py
@@ -0,0 +1,21 @@
+from commitizen import BaseCommitizen, out
+from commitizen.cz import registry
+
+
+NO_COMMITIZEN_FOUND = 2
+
+
+def commiter_factory(config: dict) -> BaseCommitizen:
+    """Return the correct commitizen existing in the registry."""
+    name: str = config["name"]
+    try:
+        _cz = registry[name](config)
+    except KeyError:
+        msg_error = (
+            "The commiter has not been found in the system.\n\n"
+            f"Try running 'pip install {name}'\n"
+        )
+        out.error(msg_error)
+        raise SystemExit(NO_COMMITIZEN_FOUND)
+    else:
+        return _cz
diff --git a/commitizen/out.py b/commitizen/out.py
@@ -0,0 +1,27 @@
+from termcolor import colored
+
+
+def write(value: str, *args):
+    """Intended to be used when value is multiline."""
+    print(value, *args)
+
+
+def line(value: str, *args):
+    """Wrapper in case I want to do something different later."""
+    print(value, *args)
+
+
+def error(value: str):
+    """TODO: This should go to stderr."""
+    message = colored(value, "red")
+    line(message)
+
+
+def success(value: str):
+    message = colored(value, "green")
+    line(message)
+
+
+def info(value: str):
+    message = colored(value, "blue")
+    line(message)
diff --git a/pyproject.toml b/pyproject.toml
@@ -39,6 +39,8 @@ classifiers = [
 python = ">3.6"
 questionary = "^1.0"
 decli = "^0.5.0"
+colorama = "^0.4.1"
+termcolor = "^1.1"
 
 [tool.poetry.dev-dependencies]
 ipython = "^7.2"
diff --git a/tests/test_application.py b/tests/test_application.py
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -9,10 +9,17 @@ def test_sysexit_no_argv():
 
 
 def test_ls(mocker, capsys):
-    testargs = ["cz", "ls"]
+    testargs = ["cz", "-n", "cz_jira", "ls"]
     mocker.patch.object(sys, 'argv', testargs)
     cli.main()
     out, err = capsys.readouterr()
 
     assert "cz_conventional_commits" in out
     assert isinstance(out, str)
+
+
+def test_version(mocker):
+    testargs = ["cz", "--version"]
+    with pytest.raises(SystemExit):
+        mocker.patch.object(sys, 'argv', testargs)
+        cli.main()
diff --git a/tests/test_commands.py b/tests/test_commands.py
diff --git a/tests/test_cz_base.py b/tests/test_cz_base.py
diff --git a/tests/test_cz_conventional_commits.py b/tests/test_cz_conventional_commits.py
diff --git a/tests/test_cz_jira.py b/tests/test_cz_jira.py
diff --git a/tests/test_factory.py b/tests/test_factory.py
