Add support for multi-color badges (dbrgn#3)

* 🚀 add color ranges for badge
* 🔁 color in template
* 🔁 gitignore virtualenv
* ✅ update test for color ranges
* 📝 upd readme
* 📝 abs path to badge
* 🔁 force overwrite filepath
* 📝 upd readme
* 🔁 add missing flag in helptext
* 🔁 default color const use
* 🔁 add plain color mode flag
* 📝 upd helptext
* ✅ upd test to check correct color outputs
* 🔁 upd example images with xml prefix row

Author: samael500

.gitignore

@@ -6,3 +6,4 @@ dist/
 *.egg-info/
 .cache/
 .coverage
+venv/

README.rst

@@ -36,21 +36,42 @@ either return the badge SVG to stdout::
 It's important that you run ``coverage-badge`` from the directory where the
 ``.coverage`` data file is located.
 
+Different colors for cover ranges:
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/15.svg
+    :alt: 15%
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/45.svg
+    :alt: 45%
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/65.svg
+    :alt: 65%
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/80.svg
+    :alt: 80%
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/93.svg
+    :alt: 93%
+
+.. image:: https://cdn.rawgit.com/samael500/coverage-badge/master/media/97.svg
+    :alt: 97%
+
 ---
 
 The full usage text::
 
-    usage: __main__.py [-h] [-o FILEPATH] [-q] [-v]
+    usage: __main__.py [-h] [-o FILEPATH] [-p] [-f] [-q] [-v]
 
     Generate coverage badges for Coverage.py.
 
     optional arguments:
       -h, --help   show this help message and exit
       -o FILEPATH  Save the file to the specified path.
+      -p           Plain color mode. Standard green badge.
+      -f           Force overwrite image, use with -o key.
       -q           Don't output any non-error messages.
       -v           Show version.
 
-
 License
 -------
 

coverage_badge/__main__.py

@@ -17,6 +17,27 @@
 __version__ = '0.1.2'
 
 
+DEFAULT_COLOR = '#a4a61d'
+COLORS = {
+    'brightgreen': '#4c1',
+    'green': '#97CA00',
+    'yellowgreen': '#a4a61d',
+    'yellow': '#dfb317',
+    'orange': '#fe7d37',
+    'red': '#e05d44',
+    'lightgrey': '#9f9f9f',
+}
+
+COLOR_RANGES = [
+    (95, 'brightgreen'),
+    (90, 'green'),
+    (75, 'yellowgreen'),
+    (60, 'yellow'),
+    (40, 'orange'),
+    (0, 'red'),
+]
+
+
 class Devnull(object):
     """
     A file like object that does nothing.
@@ -35,14 +56,27 @@ def get_total():
     return '{0:.0f}'.format(total)
 
 
-def get_badge(total):
+def get_color(total):
+    """
+    Return color for current coverage precent
+    """
+    try:
+        xtotal = int(total)
+    except ValueError:
+        return COLORS['lightgrey']
+    for range_, color in COLOR_RANGES:
+        if xtotal >= range_:
+            return COLORS[color]
+
+
+def get_badge(total, color=DEFAULT_COLOR):
     """
     Read the SVG template from the package, update total, return SVG as a
     string.
     """
     template_path = os.path.join('templates', 'flat.svg')
     template = pkg_resources.resource_string(__name__, template_path).decode('utf8')
-    return template.replace('{{ total }}', total)
+    return template.replace('{{ total }}', total).replace('{{ color }}', color)
 
 
 def parse_args(argv=None):
@@ -52,6 +86,10 @@ def parse_args(argv=None):
     parser = argparse.ArgumentParser(description=__doc__)
     parser.add_argument('-o', dest='filepath',
             help='Save the file to the specified path.')
+    parser.add_argument('-p', dest='plain_color', action='store_true',
+            help='Plain color mode. Standard green badge.')
+    parser.add_argument('-f', dest='force', action='store_true',
+            help='Force overwrite image, use with -o key.')
     parser.add_argument('-q', dest='quiet', action='store_true',
             help='Don\'t output any non-error messages.')
     parser.add_argument('-v', dest='print_version', action='store_true',
@@ -66,7 +104,7 @@ def parse_args(argv=None):
         return parser.parse_args()
 
 
-def save_badge(badge, filepath):
+def save_badge(badge, filepath, force=False):
     """
     Save badge to the specified path.
     """
@@ -81,7 +119,7 @@ def save_badge(badge, filepath):
         path += '.svg'
 
     # Validate path (part 2)
-    if os.path.exists(path):
+    if not force and os.path.exists(path):
         print('Error: "{}" already exists.'.format(path))
         sys.exit(1)
 
@@ -114,11 +152,13 @@ def main(argv=None):
     except coverage.misc.CoverageException as e:
         print('Error: {} Did you run coverage first?'.format(e))
         sys.exit(1)
-    badge = get_badge(total)
+
+    color = DEFAULT_COLOR if args.plain_color else get_color(total)
+    badge = get_badge(total, color)
 
     # Show or save output
     if args.filepath:
-        path = save_badge(badge, args.filepath)
+        path = save_badge(badge, args.filepath, args.force)
         if not args.quiet:
             print('Saved badge to {}'.format(path))
     else:

coverage_badge/templates/flat.svg

@@ -2,6 +2,7 @@
 from __future__ import print_function, division, absolute_import, unicode_literals
 
 import sys
+from textwrap import dedent
 
 import pytest
 
@@ -39,3 +40,37 @@ def test_svg_output(cb, capsys):
     assert '<svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">' in out
     assert '<text x="80" y="14">79%</text>' in out
     assert out.endswith('</svg>\n')
+
+
+def test_color_ranges(cb, capsys):
+    """
+    Test color total value
+    """
+    for total, color in (('97', '#4c1'), ('93', '#97CA00'), ('80', '#a4a61d'), ('65', '#dfb317'),
+            ('45', '#fe7d37'), ('15', '#e05d44'), ('n/a', '#9f9f9f')):
+        __main__.get_total = lambda: total
+        cb.main([])
+        out, _ = capsys.readouterr()
+        row = '<path fill="%s" d="M63 0h36v20H63z"/>' % color
+        assert out.startswith(dedent('''\
+            <?xml version="1.0" encoding="UTF-8"?>
+            <svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">'''))
+        assert row in out
+        assert out.endswith('</svg>\n')
+
+
+def test_plain_color_mode(cb, capsys):
+    """
+    Should get always one color in badge
+    """
+    assert __main__.DEFAULT_COLOR == '#a4a61d'
+    for total in ('97', '93', '80', '65', '45', '15', 'n/a'):
+        __main__.get_total = lambda: total
+        cb.main(['-p'])
+        out, _ = capsys.readouterr()
+        row = '<path fill="#a4a61d" d="M63 0h36v20H63z"/>'
+        assert out.startswith(dedent('''\
+            <?xml version="1.0" encoding="UTF-8"?>
+            <svg xmlns="http://www.w3.org/2000/svg" width="99" height="20">'''))
+        assert row in out
+        assert out.endswith('</svg>\n')