Merge branch 'master' into install-script

Author: andre-filho

README.md

@@ -32,7 +32,7 @@ Just follow the commands below:
   $ pip3 install -r ~/.commit-helper/requirements.txt
 
   # create a function in your .bashrc
-  $ echo "commit(){ python3 ~/.commit-helper/generator.py; }" >> ~/.bashrc
+  $ echo "alias commit='python3 ~/.commit-helper/generator.py'" >> ~/.bashrc
 
   # reload terminal
   $ source ~/.bashrc
@@ -108,4 +108,3 @@ Supported conventions available:
 | **Name** | **Username** |
 | :------: | :----------: |
 | Arthur José Benedito de Oliveira Assis | @arthur120496 |
-

generator.py

@@ -14,48 +14,58 @@
 # utils imports
 from utils import parser_cli
 from utils import create_file
+from utils import debug
 
 
+def main(debug_mode=False):
+    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 == 'angular' or convention == 'karma':
+                    print('You are using the %s convention' % convention)
+                    angular_convention(args.co_author)
+                elif convention == 'changelog':
+                    print('You are using the %s convention' % convention)
+                    changelog_convention(args.co_author)
+                elif convention == 'symphony':
+                    print('You are using the %s convention' % convention)
+                    symphony_convention(args.co_author)
+                elif convention == 'none':
+                    just_message(args.co_author)
+            except YAMLError as exc:
+                print(exc)
+
+    elif args.convention is not '':
+        convention = str(args.convention)
+        debug('convention flag', convention, debug_mode)
+        if convention == 'angular' or convention == 'karma':
+            angular_convention(args.co_author)
+            create_file(convention, args.no_file)
+        elif convention == 'changelog':
+            changelog_convention(args.co_author)
+            create_file(convention, args.no_file)
+        elif convention == 'symphony':
+            symphony_convention(args.co_author)
+            create_file(convention, args.no_file)
+        elif convention == 'message':
+            just_message(convention)
+            create_file('none', args.no_file)
+
+    else:
+        debug('parser full return', parser.parse_args(), debug_mode)
+        parser.print_help()
+
+
+debug_option = False
 parser = parser_cli()
 args = parser.parse_args()
-
-file_path = Path('commiter.yml')
-if file_path.is_file():
-    with open(str(file_path), 'r') as stream:
-        try:
-            config = safe_load(stream)
-            if config['convention'] is not None:
-                convention = str(config['convention']).lower()
-            else:
-                convention = 'none'
-            if convention == 'angular' or convention == 'karma':
-                print('You are using the %s convention' % convention)
-                angular_convention(args.co_author)
-            elif convention == 'changelog':
-                print('You are using the %s convention' % convention)
-                changelog_convention(args.co_author)
-            elif convention == 'symphony':
-                print('You are using the %s convention' % convention)
-                symphony_convention(args.co_author)
-            elif convention == 'none':
-                just_message(args.co_author)
-        except YAMLError as exc:
-            print(exc)
-
-elif args.convention is not '':
-    convention = str(args.convention)
-    if convention == 'angular' or convention == 'karma':
-        angular_convention(args.co_author)
-        create_file(convention, args.no_file)
-    elif convention == 'changelog':
-        changelog_convention(args.co_author)
-        create_file(convention, args.no_file)
-    elif convention == 'symphony':
-        symphony_convention(args.co_author)
-        create_file(convention, args.no_file)
-    elif convention == 'message':
-        just_message(convention)
-        create_file('none', args.no_file)
-
-else:
-    parser.print_help()
+debug('args variable', args, debug_option)
+main(debug_option)

utils.py

@@ -64,3 +64,10 @@ def change_if_none(string):
     if string is None:
         return ''
     return string
+
+
+def debug(message, value, show=False):
+    if show:
+        print("\n-------DEBUG--------")
+        print("%s: %s" % (message, value))
+        print("--------END---------\n")