merge(#61): add support to conventions helpers

andre-filho · web-flow · commit 7a2646a3083f · 2018-11-26T12:37:51.000-02:00
Convention helper
diff --git a/README.md b/README.md
@@ -30,15 +30,33 @@ Sometimes we, the developers, go _full-loco_ while programming and make mistakes
 
 ## Screenshots
 
-<div style="margin-right:auto;margin-left:auto;">
-	<img src="assets/commit.gif"/>
-    <img src="assets/--tudo.gif"/>
-    <img src="assets/--co-author.gif"/>
-    <img src="assets/--debug.gif"/>
-    <img src="assets/--no-file.gif"/>
-    <img src="assets/--convention.gif"/>
-</div>
+### Initial commit
 
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### Normal commit
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### Co-authored commit
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### Fast commit
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### Debugging and commiting
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### All-in-one commit
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
+
+### Getting help for writing in a convention
+
+<img src="" style="min-width:200px;margin-left:auto;margin-right:auto;"/>
 
 
 ## Installation
@@ -56,21 +74,27 @@ will show you the usage and options for your commit. All of them are optional
 for the sake of not losing your precious time.
 
 ```bash
-  $ commit -h
-  usage: generator.py [-h] [--co-author CO_AUTHOR] [--no-generate NO_FILE]
-                    [--convention {angular,changelog,symphony,message}]
-
-  A commit formatter tool to help you follow commit conventions.
-
-  optional arguments:
-    -h, --help            show this help message and exit
-    -ca, --co-author CO_AUTHOR
-                          make your friend an co-author to the commit
-    -nf, --no-file
-                          disables the creation of a commiter.yml file
-    -c, --convention {angular,changelog,symphony,message}
-                          Selects a convention to be used for the commit.
-                          Required if there is no commiter.yml file.
+ $ commit -h
+usage: commit [-h] [-t TAG] [-m MESSAGE] [-ct CONTEXT] [-ca CO_AUTHOR] [-nf]
+              [-c {angular,karma,tagged,symphony,message}] [-d]
+
+A commit formatter tool to help you follow commit conventions.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -t TAG, --tag TAG     Pass your commit tag directly
+  -m MESSAGE, --message MESSAGE
+                        Pass your commit message directly
+  -ct CONTEXT, --context CONTEXT
+                        Pass your commit context directly
+  -ca CO_AUTHOR, --co-author CO_AUTHOR
+                        Make your friend an co-author to the commit
+  -nf, --no-file        Disables the creation of a commiter.yml file
+  -c {angular,karma,tagged,symphony,message}, --convention {angular,karma,tagged,symphony,message}
+                        Selects a convention to be used for the commit.
+                        Required if there's no commiter.yml file.
+  -d, --debug           Toggles debug option
+
 ```
 
 So, if you want to write a co-authored commit, you should use:
@@ -82,7 +106,7 @@ $ commit --co-author "foo bar doritous <foobar@douritos.com>"
 Or if you are using this for the first time in your project:
 
 ```bash
-$ commit --convention changelog
+$ commit --convention tagged
 ```
 
 To work even more smoothly, have in your working directory a file named **commiter.yml**. In this file you must pass the commit convention that you want to use, following the example:
@@ -96,7 +120,7 @@ convention: karma   # tag(context): commit message
 
 # or
 
-convention: changelog # TAG: commit message
+convention: tagged # TAG: commit message
 
 # or
 
@@ -121,9 +145,9 @@ Supported conventions available:
 
  - angular
  - karma
- - changelog
+ - tagged
  - symphony
- - a custom one that you may invent ;)
+ - a custom one that you may create :)
 
  ## 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:
diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-3.3.4
+3.4.4
diff --git a/commit_helper/__main__.py b/commit_helper/__main__.py
@@ -5,6 +5,8 @@
 from .utils.text_utils import debug
 from .utils.file_handler import handle_file_based_commit
 from .utils.flag_commit_handler import convention_flag_handler
+# convention imports
+from .conventions.convention_help_handler import convention_help_handler
 
 
 def main():
@@ -18,7 +20,11 @@ def main():
 
     debug('file_path', file_path, debug_mode)
 
-    if args.convention is not '':
+    if args.show_convention_tags is True:
+        convention_help_handler(file_path, args, debug_mode)
+        return
+
+    elif args.convention is not '':
         convention_flag_handler(args, debug_mode)
         return
 
diff --git a/commit_helper/conventions/atom.py b/commit_helper/conventions/atom.py
@@ -0,0 +1,39 @@
+def atom_convention(tag, msg):
+    tag = tag.lower()
+    msg = msg.capitalize()
+    composed_message = ":%s: %s\n" % (tag, msg)
+    return composed_message
+
+
+atom_convention_help = \
+    """
+    The atom convention:
+
+    :<tag>: <Message>
+    <BREAK>
+    <body>
+    <BREAK>
+
+    ---
+    Tags:
+    - art:               when improving the format/structure of the code
+    - racehorse:         when improving performance
+    - non-potable_water: when plugging memory leaks
+    - memo:              when writing docs
+    - penguin:           when fixing something on Linux
+    - apple:             when fixing something on macOS
+    - checkered_flag:    when fixing something on Windows
+    - bug:               when fixing a bug
+    - fire:              when removing code or files
+    - green_heart:       when fixing the CI build
+    - white_check_mark:  when adding tests
+    - lock:              when dealing with security
+    - arrow_up:          when upgrading dependencies
+    - arrow_down:        when downgrading dependencies
+    - shirt:             when removing linter warnings
+
+    ---
+    Message rules:
+    - Use the present tense ("Add feature" not "Added feature")
+    - Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+    """
diff --git a/commit_helper/conventions/changelog.py b/commit_helper/conventions/changelog.py
diff --git a/commit_helper/conventions/convention_help_handler.py b/commit_helper/conventions/convention_help_handler.py
@@ -0,0 +1,62 @@
+# 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
+from commit_helper.utils.text_utils import print_help
+from commit_helper.utils.utils import dump_convention
+
+
+# TODO: test
+def convention_help_handler(file_path, args, debug_mode):
+    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:
+            try:
+                config = safe_load(target)
+                convention = dump_convention(config)
+                debug('Convention captured', convention, debug_mode)
+            except YAMLError as err:
+                print(err)
+
+    elif args.convention is not '':
+        debug('Found convention in args', args, debug_mode)
+        convention = args.convention
+
+    else:
+        print(MIN_ERROR + 'No convention was specified!' + RESET)
+        return
+
+    debug('convention captured for helper', convention, debug_mode)
+    get_help_to_defined_convention(convention, debug_mode)
+
+
+# TODO: test
+def get_help_to_defined_convention(convention, debug_mode):
+    debug('recieved convention for help catch', convention, debug_mode)
+    if convention == 'angular':
+        print_help(angular_convention_help)
+
+    elif convention == 'tagged':
+        print_help(tagged_convention_help)
+
+    elif convention == 'karma':
+        print_help(karma_convention_help)
+
+    elif convention == 'symphony':
+        print_help(symphony_convention_help)
+
+    elif convention == 'atom':
+        print_help(atom_convention_help)
+
+    else:
+        print(MIN_ERROR + 'The chosen convention has no helper!' + RESET)
diff --git a/commit_helper/conventions/karma_angular.py b/commit_helper/conventions/karma_angular.py
@@ -1,7 +1,60 @@
-def angular_convention(tag, msg, context):
+def karma_angular_convention(tag, msg, context):
     tag = tag.lower()
     if context == '':
         composed_message = "%s: %s\n" % (tag, msg)
     else:
         composed_message = "%s(%s): %s\n" % (tag, context, msg)
     return composed_message
+
+
+angular_convention_help = \
+    """
+    The angular convention:
+
+    <tag>(<scope>): <message>
+    <BLANK>
+    <body>
+    <BLANK>
+    <footer>
+
+    ----
+    Tags:
+    build:      Changes that affect the build system or external dependencies
+    ci:         Changes to our CI configuration files and scripts
+    docs:       Documentation only changes
+    feat:       A new feature
+    fix:        A bug fix
+    perf:       A code change that improves performance
+    refactor:   A code change that neither fixes a bug nor adds a feature
+    style:      Changes that do not affect the meaning of the code
+    test:       Adding missing tests or correcting existing tests
+
+    ---
+    Optional fields:
+    <scope> or <context>, <body> and <footer>
+    """
+
+karma_convention_help = \
+    """
+    The karma convention:
+
+    <tag>(<scope>): <message>
+    <BLANK>
+    <body>
+    <BLANK>
+    <footer>
+
+    ---
+    Tags:
+    feat:       New feature for the user, not a new feature for build script
+    fix:        Bug fix for the user, not a fix to a build script
+    docs:       Changes to the documentation
+    style:      Formatting, missing semi colons, etc; no production code change
+    refactor:   Refactoring production code, eg. renaming a variable
+    test:       Adding missing tests, refactoring tests; no product code change
+    chore:      Updating grunt tasks etc; no production code change
+
+    ---
+    Optional fields:
+    <scope> or <context>, <body> and <footer>
+    """
diff --git a/commit_helper/conventions/symphony_cmf.py b/commit_helper/conventions/symphony_cmf.py
@@ -2,3 +2,26 @@ def symphony_convention(tag, msg):
     tag = tag.capitalize()
     composed = "[%s] %s\n" % (tag, msg)
     return composed
+
+
+symphony_convention_help = \
+    """
+    The symphony CMF convention:
+
+    [<Tag>] <message>
+    <BLANK>
+    <body>
+    <BLANK>
+    <changes>
+    <BLANK>
+    <footer>
+
+    ---
+    Obs.:
+    Tag is not a tag similar to other commit conventions, it is actually a
+    context to what was changed.
+
+    ---
+    Optionals:
+    <body>, <changes>, <footer>
+    """
diff --git a/commit_helper/conventions/tagged.py b/commit_helper/conventions/tagged.py
@@ -0,0 +1,31 @@
+def tagged_convention(tag, msg):
+    tag = tag.upper()
+    composed_message = "%s: %s\n" % (tag, msg)
+    return composed_message
+
+
+tagged_convention_help = \
+    """
+    The tagged convention:
+
+    TAG: message
+    <BLANK>
+    <body>
+    <BLANK>
+    <footer>
+
+    ---
+    Tag usage:
+
+    ADD     -> use for new files or methods
+    FEAT    -> for when adding a new feature
+    DEL     -> use for excluded files or methods
+    CHR     -> use for normal dev work and maintainance
+    MERGE   -> use for signal merges
+    DOCS    -> for documentation changes
+    FIX     -> use for solving bugs or failures in file
+    REF     -> use for when you rename a file
+    STYLE   -> use for fixing stylesheet errors
+    TEST    -> use for test files
+    CI      -> for that commit that aims for fix a build
+    """
diff --git a/commit_helper/utils/colors.py b/commit_helper/utils/colors.py
@@ -1,7 +1,10 @@
 from colored import fg
 from colored import attr
 
-INPUT_COLOR = fg(14)
-NOTIFY_COLOR = fg(15)
-DEBUG_COLOR = fg(244)
+# color wheel: https://pypi.org/project/colored/
+HELP = fg(227)
 RESET = attr(0)
+MIN_ERROR = fg(160)
+INPUT_COLOR = fg(6)
+DEBUG_COLOR = fg(239)
+NOTIFY_COLOR = fg(14)
diff --git a/commit_helper/utils/flag_commit_handler.py b/commit_helper/utils/flag_commit_handler.py
@@ -1,3 +1,4 @@
+# dependencies imports
 from os import system
 # utils imports
 from .text_utils import debug
diff --git a/commit_helper/utils/text_utils.py b/commit_helper/utils/text_utils.py
diff --git a/commit_helper/utils/utils.py b/commit_helper/utils/utils.py
diff --git a/test/test_conventions.py b/test/test_conventions.py
diff --git a/test/test_utils.py b/test/test_utils.py
