merge(#48): introducing custom conventions

Introducing custom conventions

Author: andre-filho

README.md

@@ -31,7 +31,7 @@ Sometimes we, the developers, go _full-loco_ while programming and make mistakes
 In order to install one of our older versions, check our [previous releases](PREVIOUS_VERSIONS). To install the latest (pip) version, just follow the commands below:
 
 ```bash
-$ pip3 install commit-helper  
+$ pip3 install commit-helper
 ```
 
 ## Usage and configuration
@@ -98,6 +98,11 @@ Supported conventions available:
  - changelog
  - symphony
 
+ ## Troubleshooting
+ If after you've installed commit-helper the `commit` or `commit-helper` commands are not usable at the command line, check if `$HOME/.local/bin` is on your PATH. If not, add it on your .bashrc file by running:
+ ``` bash
+$ echo "export PATH=$HOME/.local/bin:$PATH" >> .bashrc
+ ```
 
 ## Project's maintainers
 | **Name** | **Username** |

assets/--co-author.gif

@@ -1,22 +1,10 @@
 # dependencies imports
 from pathlib import Path
-from yaml import safe_load
-from yaml import YAMLError
-from os import system
-
-# conventions imports
-from .conventions.karma_angular import angular_convention
-from .conventions.changelog import changelog_convention
-from .conventions.symphony_cmf import symphony_convention
-from .conventions.no_convention import just_message
-
 # utils imports
 from .utils.utils import parser_cli
-from .utils.utils import create_file
-from .utils.utils import debug
-from .utils.utils import get_text
-from .utils.utils import get_context
-from .utils.utils import gen_co_author
+from .utils.text_utils import debug
+from .utils.file_handler import handle_file_based_commit
+from .utils.flag_commit_handler import convention_flag_handler
 
 
 def main():
@@ -27,67 +15,11 @@ def main():
     file_path = Path('commiter.yml')
     debug('file_path', file_path, debug_mode)
     if file_path.is_file():
-        with open(str(file_path), 'r') as stream:
-            try:
-                config = safe_load(stream)
-                debug('convention from file', config['convention'], debug_mode)
-                if config['convention'] is not None:
-                    convention = str(config['convention']).lower()
-                else:
-                    convention = 'none'
-
-                if convention == 'none':
-                    print('You are not using a convention')
-                    commit_message = just_message()
-
-                else:
-                    print('You are using the %s convention' % convention)
-                    tag, msg = get_text()
-                    if convention == 'angular' or convention == 'karma':
-                        context = get_context()
-                        commit_message = angular_convention(tag, msg, context)
-                    elif convention == 'changelog':
-                        commit_message = changelog_convention(tag, msg)
-                    elif convention == 'symphony':
-                        commit_message = symphony_convention(tag, msg)
-
-                commit_message += gen_co_author(args.co_author)
-                debug('commit message', commit_message, debug_mode)
-                system('git commit -m "%s"' % commit_message)
-
-            except YAMLError as exc:
-                print(exc)
+        handle_file_based_commit(file_path, debug_mode, args)
 
     elif args.convention is not '':
-        convention = str(args.convention)
-        debug('convention flag', convention, debug_mode)
-
-        if convention == 'message':
-            commit_message = just_message()
-            create_file('none', args.no_file)
-
-        else:
-            tag, msg = get_text()
-
-            if convention == 'angular' or convention == 'karma':
-                context = get_context()
-                commit_message = angular_convention(tag, msg, context)
-                create_file(convention, args.no_file)
-            elif convention == 'changelog':
-                commit_message = changelog_convention(tag, msg)
-                create_file(convention, args.no_file)
-            elif convention == 'symphony':
-                commit_message = symphony_convention(tag, msg)
-                create_file(convention, args.no_file)
-
-        commit_message += gen_co_author(args.co_author)
-        debug('commit message', commit_message, debug_mode)
-        system('git commit -m "%s"' % commit_message)
+        convention_flag_handler(args, debug_mode)
 
     else:
         debug('parser full return', parser.parse_args(), debug_mode)
         parser.print_help()
-
-
-#
-# main(args.debug)

assets/--convention.gif

@@ -0,0 +1,24 @@
+# custom commits are only acceptable when you have a config file
+from commit_helper.utils.text_utils import debug
+from commit_helper.utils.text_utils import get_context
+
+
+def custom_convention(tag, message, config_file, debug_mode):
+    debug('tag', tag, debug_mode)
+    debug('message', message, debug_mode)
+    debug('pattern from file', config_file['commit_pattern'], debug_mode)
+
+    pattern = str(config_file['commit_pattern'] or '')
+    debug('pattern acquired', pattern, debug_mode)
+
+    context = ''
+    pattern = pattern.replace('tag', str(tag))
+    pattern = pattern.replace('message', str(message))
+
+    if config_file['context']:
+        context = get_context()
+        pattern = pattern.replace('context', context)
+
+    debug('pattern post replace', pattern, debug_mode)
+    pattern += '\n'
+    return pattern