merge(#51): Fast paced line commit

Fast paced line commit

Author: andre-filho

VERSION.txt

@@ -1 +1 @@
-3.2.2
+3.3.2

commit_helper/__main__.py

@@ -11,9 +11,13 @@ def main():
     parser = parser_cli()
     args = parser.parse_args()
     debug_mode = args.debug
+
     debug('args variable', args, debug_mode)
+
     file_path = Path('commiter.yml')
+
     debug('file_path', file_path, debug_mode)
+
     if file_path.is_file():
         handle_file_based_commit(file_path, debug_mode, args)
 

commit_helper/conventions/no_convention.py

@@ -2,7 +2,11 @@
 from commit_helper.utils.colors import RESET
 
 
-def just_message():
-    msg = str(input(INPUT_COLOR + "commit message: " + RESET))
-    composed = "%s\n" % msg.capitalize()
+def just_message(msg=''):
+    if msg is '':
+        message = str(input(INPUT_COLOR + "commit message: " + RESET))
+    else:
+        message = msg
+
+    composed = "%s\n" % message.capitalize()
     return composed

commit_helper/utils/file_handler.py

@@ -5,6 +5,7 @@
 from .utils import gen_co_author
 from .utils import dump_convention
 from .utils import validate_commiter_file
+from .utils import handle_conventioned_commit
 from .colors import RESET
 from .colors import NOTIFY_COLOR
 from .text_utils import debug
@@ -37,28 +38,12 @@ def handle_file_based_commit(file_path, debug_mode, args):
                 commit_msg = custom_convention(tag, msg, config, debug_mode)
 
             else:
-                commit_msg = handle_conventioned_commit(convention)
+                notify('You are using the %s convention' % convention)
+                commit_msg = handle_conventioned_commit(convention, args)
 
             commit_msg += gen_co_author(args.co_author)
             debug('commit message', commit_msg, debug_mode)
             system('git commit -m "%s"' % commit_msg)
 
         except YAMLError as err:
             print(err)
-
-
-def handle_conventioned_commit(convention):
-    notify('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)
-
-    return commit_message

commit_helper/utils/flag_commit_handler.py

@@ -2,6 +2,7 @@
 # utils imports
 from .utils import create_file
 from .utils import gen_co_author
+from .utils import handle_conventioned_commit
 from .text_utils import debug
 from .text_utils import get_text
 from .text_utils import get_context
@@ -17,22 +18,17 @@ def convention_flag_handler(args, debug_mode):
     debug('convention flag', convention, debug_mode)
 
     if convention == 'message':
-        commit_message = just_message()
+        if args.message is not '':
+            commit_message = just_message(msg=args.message)
+        else:
+            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 = handle_conventioned_commit(convention, args)
 
+    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)

commit_helper/utils/text_utils.py

@@ -1,7 +1,7 @@
-from commit_helper.utils.colors import RESET
-from commit_helper.utils.colors import DEBUG_COLOR
-from commit_helper.utils.colors import INPUT_COLOR
-from commit_helper.utils.colors import NOTIFY_COLOR
+from .colors import RESET
+from .colors import DEBUG_COLOR
+from .colors import INPUT_COLOR
+from .colors import NOTIFY_COLOR
 
 
 def get_text():
@@ -30,3 +30,15 @@ def debug(message, value, show=False):
     if show:
         mid = 'DEBUG: ' + str(message) + ' ~> ' + str(value)
         print(DEBUG_COLOR + mid + RESET)
+
+
+def handle_tag_message_args(tag='', message=''):
+    if tag + message is not '':
+        return tag, message
+    return get_text()
+
+
+def handle_context_arg(context=''):
+    if context is not '':
+        return context
+    return get_context()

commit_helper/utils/utils.py

@@ -1,6 +1,12 @@
 import sys
 import argparse
 from yaml import dump
+from .text_utils import handle_context_arg
+from .text_utils import handle_tag_message_args
+from commit_helper.conventions.karma_angular import angular_convention
+from commit_helper.conventions.changelog import changelog_convention
+from commit_helper.conventions.symphony_cmf import symphony_convention
+
 
 supported_conventions = [
     "angular",
@@ -24,7 +30,7 @@
 def gen_co_author(co_author):
     if co_author is '':
         return ''
-    return "\nCo-authored-by: %s" % co_author
+    return '\nCo-authored-by: %s' % co_author
 
 
 def create_file(convention_name, dont_create=False):    # pragma: no cover
@@ -38,23 +44,36 @@ def create_file(convention_name, dont_create=False):    # pragma: no cover
 
 
 def parser_cli():
-    desc = "A commit formatter tool to help you follow commit conventions."
+    desc = 'A commit formatter tool to help you follow commit conventions.'
     help_convention = \
         """
         Selects a convention to be used for the commit.
         Required if there's no commiter.yml file.
         """
     parser = argparse.ArgumentParser(description=desc)
-    parser.add_argument("-ca", "--co-author",
-                        help="Make your friend an co-author to the commit",
-                        dest="co_author", default='')
-    parser.add_argument("-nf", "--no-file", dest="no_file",
-                        help="Disables the creation of a commiter.yml file",
-                        action="store_true")
-    parser.add_argument("-c", "--convention", choices=supported_conventions,
-                        dest="convention", default='', help=help_convention)
-    parser.add_argument("-d", "--debug", action="store_true", dest="debug",
-                        help="Toggles debug option")
+    parser.add_argument('-t', '--tag', dest='tag', default='',
+                        help='Pass your commit tag directly')
+
+    parser.add_argument('-m', '--message', dest='message', default='',
+                        help='Pass your commit message directly')
+
+    parser.add_argument('-ct', '--context', dest='context', default='',
+                        help='Pass your commit context directly')
+
+    parser.add_argument('-ca', '--co-author',
+                        help='Make your friend an co-author to the commit',
+                        dest='co_author', default='')
+
+    parser.add_argument('-nf', '--no-file', dest='no_file',
+                        help='Disables the creation of a commiter.yml file',
+                        action='store_true')
+
+    parser.add_argument('-c', '--convention', choices=supported_conventions,
+                        dest='convention', default='', help=help_convention)
+
+    parser.add_argument('-d', '--debug', action='store_true', dest='debug',
+                        help='Toggles debug option')
+
     return parser
 
 
@@ -69,3 +88,19 @@ def validate_commiter_file(stream_file):    # pragma: no cover
     if stream_file['commit_pattern'] is None or stream_file['context'] is None:
         print("Error: Your commiter file lacks a commit_pattern or context!")
         sys.exit(0)
+
+
+def handle_conventioned_commit(convention, args):
+    tag, msg = handle_tag_message_args(args.tag, args.message)
+
+    if convention == 'angular' or convention == 'karma':
+        context = handle_context_arg(args.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)
+
+    return commit_message

release.sh

@@ -0,0 +1,11 @@
+#! /bin/bash
+
+python3 setup.py sdist bdist_wheel
+
+if "$1" == "test"; then
+  twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+fi
+
+if "$1" == "deploy"; then
+  twine upload dist/*
+fi

test/test_conventions.py

@@ -44,14 +44,21 @@ def test_custom_convention():
         raise AssertionError()
 
 
-def test_no_convention():
+def test_no_convention_without_args():
     inputs = [
         "message",
     ]
 
     def mock_input(s):
         return inputs.pop(0)
+
     no_convention.input = mock_input
     message = no_convention.just_message()
     if not message == 'Message\n':
         raise AssertionError()
+
+
+def test_no_convention_with_args():
+    message = no_convention.just_message('Message')
+    if not message == 'Message\n':
+        raise AssertionError()

test/test_utils.py

@@ -1,12 +1,10 @@
 import yaml
 import commit_helper.utils.utils as utils
 import commit_helper.utils.text_utils as text_utils
+
 from commit_helper.utils.colors import RESET
 from commit_helper.utils.colors import DEBUG_COLOR
 from commit_helper.utils.colors import NOTIFY_COLOR
-# from commit_helper.utils.utils import validate_commiter_file
-# import commit_helper.utils.file_handler as file_utils
-# import commit_helper.utils.flag_commit_handler as flag_utils
 
 
 def test_get_text():
@@ -91,3 +89,43 @@ def test_notify(capsys):
     captured = capsys.readouterr()
     if not captured.out == NOTIFY_COLOR + "msg" + RESET + "\n":
         raise AssertionError()
+
+
+def test_handle_tag_message_args_with_args():
+    tag, msg = text_utils.handle_tag_message_args('tag', 'msg')
+
+    if not (tag is 'tag' and msg is 'msg'):
+        raise AssertionError()
+
+
+def test_handle_tag_message_args_without_args():
+    inputs = ['tag', 'msg']
+
+    def mock_input(s):
+        return inputs.pop(0)
+
+    text_utils.input = mock_input
+    tag, msg = text_utils.handle_tag_message_args()
+
+    if not (tag == 'tag' and msg == 'msg'):
+        raise AssertionError()
+
+
+def test_handle_context_arg_with_args():
+    context = text_utils.handle_context_arg('context')
+
+    if not context is 'context':
+        raise AssertionError()
+
+
+def test_handle_context_arg_without_args():
+    inputs = ['context']
+
+    def mock_input(s):
+        return inputs.pop(0)
+
+    text_utils.input = mock_input
+    context = text_utils.handle_context_arg()
+
+    if not context == 'context':
+        raise AssertionError()