WIP Development

commit_helper/__main__.py

@@ -1,16 +1,18 @@
-# dependencies imports
 from pathlib import Path
-# utils imports
+
 from .utils.utils import parser_cli
 from .utils.text_utils import debug
 from .utils.file_handler import handle_file_based_commit
 from .utils.file_handler import get_file_path
 from .utils.flag_commit_handler import convention_flag_handler
-# convention imports
+
 from .conventions.convention_help_handler import convention_help_handler
 
 
 def main():
+    """
+    Main function. Called by CLI.
+    """
     parser = parser_cli()
     args = parser.parse_args()
     debug_mode = args.debug
@@ -21,11 +23,11 @@ def main():
 
     debug('file_path', file_path, debug_mode)
 
-    if args.show_convention_tags is True:
+    if args.show_convention_tags == True:
         convention_help_handler(file_path, args, debug_mode)
         return
 
-    elif args.convention is not '':
+    elif args.convention != '':
         convention_flag_handler(args, debug_mode)
         return
 

commit_helper/conventions/atom.py

@@ -1,4 +1,10 @@
 def atom_convention(tag, msg):
+    """
+    Formats the commit following the atom convention format:
+    The atom convention:
+
+    :<tag as emoticon>: <Message>
+    """
     tag = tag.lower()
     msg = msg.capitalize()
     composed_message = ":%s: %s\n" % (tag, msg)

commit_helper/conventions/convention_help_handler.py

@@ -1,14 +1,12 @@
-# dependencies imports
 from yaml import safe_load
 from yaml import YAMLError
-# convention imports
+
 from .atom import atom_convention_help
 from .tagged import tagged_convention_help
 from .karma_angular import karma_convention_help
 from .karma_angular import angular_convention_help
 from .symphony_cmf import symphony_convention_help
-# utils imports
-from commit_helper.utils.colors import HELP
+
 from commit_helper.utils.colors import RESET
 from commit_helper.utils.colors import MIN_ERROR
 from commit_helper.utils.text_utils import debug
@@ -18,6 +16,9 @@
 
 # TODO: test
 def convention_help_handler(file_path, args, debug_mode):
+    """
+    Handles the user's help request.
+    """
     if file_path.is_file() and args.convention is '':
         debug('Found file for help', str(file_path), debug_mode)
         with open(str(file_path)) as target:
@@ -42,6 +43,9 @@ def convention_help_handler(file_path, args, debug_mode):
 
 # TODO: test
 def get_help_to_defined_convention(convention, debug_mode):
+    """
+    Prints the help menu to the base conventions.
+    """
     debug('recieved convention for help catch', convention, debug_mode)
     if convention == 'angular':
         print_help(angular_convention_help)

commit_helper/conventions/custom_convention.py

@@ -1,9 +1,12 @@
-# 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
 
 
+# custom commits are only acceptable when you have a config file
 def custom_convention(tag, message, config_file, debug_mode):
+    """
+    Formats the given arguments to make a custom commit message.
+    """
     debug('tag', tag, debug_mode)
     debug('message', message, debug_mode)
     debug('pattern from file', config_file['commit_pattern'], debug_mode)

commit_helper/conventions/karma_angular.py

@@ -1,4 +1,10 @@
 def karma_angular_convention(tag, msg, context):
+    """
+    Handles the formatting for both karma and angular conventions.
+
+    Convention structure:
+    <tag>(<scope>): <message>
+    """
     tag = tag.lower()
     if context == '':
         composed_message = "%s: %s\n" % (tag, msg)

commit_helper/conventions/no_convention.py

@@ -3,6 +3,9 @@
 
 
 def just_message(msg=''):
+    """
+    Formats the message to capitalize.
+    """
     if msg == '':
         message = str(input(INPUT_COLOR + "commit message: " + RESET))
     else:

commit_helper/conventions/symphony_cmf.py

@@ -1,4 +1,10 @@
 def symphony_convention(tag, msg):
+    """
+    Formats the commit following the symphony convention.
+
+    The symphony CMF convention:
+    [<Tag>] <message>
+    """
     tag = tag.capitalize()
     composed = "[%s] %s\n" % (tag, msg)
     return composed

commit_helper/conventions/tagged.py

@@ -1,4 +1,10 @@
 def tagged_convention(tag, msg):
+    """
+    Formats the convention following the tag convention.
+
+    The tagged convention:
+    <TAG>: <message>
+    """
     tag = tag.upper()
     composed_message = "%s: %s\n" % (tag, msg)
     return composed_message

commit_helper/utils/file_handler.py

@@ -2,20 +2,24 @@
 from pathlib import Path
 from yaml import safe_load
 from yaml import YAMLError
-# utils imports
+
 from .text_utils import debug
 from .text_utils import notify
 from .text_utils import get_text
 from .utils import gen_co_author
 from .utils import dump_convention
 from .utils import validate_commiter_file
 from .utils import handle_conventioned_commit
-# conventions imports
+
 from commit_helper.conventions.no_convention import just_message
 from commit_helper.conventions.custom_convention import custom_convention
 
 
 def handle_file_based_commit(file_path, debug_mode, args):
+    """
+    Function that handles all the logic involved in commits with previous
+    configuration file.
+    """
     with open(str(file_path), 'r') as stream:
         try:
             config = safe_load(stream)
@@ -48,6 +52,10 @@ def handle_file_based_commit(file_path, debug_mode, args):
 
 
 def get_file_path():     # pragma: no cover
+    """
+    Searchs on the folder the program was called if there is a commiter.yml
+    or a commit-helper.yml file and returns it's path if exists.
+    """
     commiter = Path('commiter.yml')
     commit_h = Path('commit-helper.yml')
 

commit_helper/utils/flag_commit_handler.py

@@ -1,15 +1,17 @@
-# dependencies imports
 from os import system
-# utils imports
+
 from .text_utils import debug
 from .utils import create_file
 from .utils import gen_co_author
 from .utils import handle_conventioned_commit
-# conventions imports
+
 from commit_helper.conventions.no_convention import just_message
 
 
 def convention_flag_handler(args, debug_mode):
+    """
+    Handles the commit configuration and creation through flags.
+    """
     convention = str(args.convention)
     debug('convention flag', convention, debug_mode)
     commit_message = ''

commit_helper/utils/text_utils.py

@@ -6,44 +6,69 @@
 
 
 def get_text():
+    """
+    Gets the input for both tag and message.
+    """
     tag = str(input(INPUT_COLOR + 'type the tag: ' + RESET))
     msg = str(input(INPUT_COLOR + 'type the commit message: ' + RESET)).lower()
     return tag, msg
 
 
 def get_context():
+    """
+    Gets the input for the commit context and formats it to lowercase.
+    """
     context = str(input(INPUT_COLOR + 'type the context: ' + RESET) or '')
     context.lower()
     return context
 
 
 def sanitize_as_empty_string(string):
+    """
+    Checks if arg is None and returns it as an empty string.
+    """
     if string is None:
         return ''
     return string
 
 
 def notify(message):
+    """
+    Colored formatted print for notifications.
+    """
     print(NOTIFY_COLOR + str(message) + RESET)
 
 
 def debug(message, value, show=False):
+    """
+    Colored formatted print for debugging.
+    """
     if show:
         mid = 'DEBUG: ' + str(message) + ' ~> ' + str(value)
         print(DEBUG_COLOR + mid + RESET)
 
 
 def print_help(message):
+    """
+    Colored formatted print for help menus.
+    """
     print(HELP + str(message) + RESET)
 
 
 def handle_tag_message_args(tag='', message=''):
+    """
+    Checks if args are empty strings, if so it calls the get_text function.
+    """
     if tag + message is not '':
         return tag, message
     return get_text()
 
 
 def handle_context_arg(context=''):
+    """
+    Checks if context is empty and if it is calls a input function to get the
+    context.
+    """
     if context is not '':
         return context
     return get_context()