Pretty print journal entries

docs/advanced.md

@@ -31,8 +31,9 @@ and can be edited with any plain text editor.
   - `highlight`
     if `true`, tags will be highlighted in cyan.
   - `linewrap`
-    controls the width of the output. Set to `false` if you don't
-    want to wrap long lines.
+    controls the width of the output. Set to `false` if you don't want to wrap long lines.
+  - `colors`
+    dictionary that controls the colors used to display journal entries. It has two subkeys, which are: `date` and `title`. Current valid values are: `BLACK`, `RED`, `GREEN`, `YELLOW`, `BLUE`, `MAGENTA`, `CYAN`, and `WHITE`. `colorama.Fore` is used for colorization, and you can find the [docs here](https://github.com/tartley/colorama#colored-output).
 
 !!! note
     Although it seems intuitive to use the `#`

features/core.feature

@@ -58,3 +58,12 @@ Feature: Basic reading and writing to a journal
         When we run "jrnl -on 2013-06-10 -s"
         Then the output should be "2013-06-10 15:40 Life is good."
 
+    Scenario: Invalid color configuration
+        Given we use the config "invalid_color.yaml"
+        When we run "jrnl -on 2013-06-10 -s"
+        Then the output should be
+        """
+        [ERROR: date set to invalid color: not-a-color]
+        [ERROR: title set to invalid color: also-not-a-color]
+        2013-06-10 15:40 Life is good.
+        """

features/data/configs/basic.yaml

@@ -10,3 +10,6 @@ tagsymbols: "@"
 template: false
 timeformat: "%Y-%m-%d %H:%M"
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/data/configs/bug153.yaml

@@ -11,3 +11,6 @@ tagsymbols: '@'
 template: false
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/data/configs/invalid_color.yaml

@@ -0,0 +1,15 @@
+default_hour: 9
+default_minute: 0
+editor: ""
+encrypt: false
+highlight: true
+journals:
+  default: features/journals/simple.journal
+linewrap: 80
+tagsymbols: "@"
+template: false
+timeformat: "%Y-%m-%d %H:%M"
+indent_character: "|"
+colors:
+  date: not-a-color
+  title: also-not-a-color

features/data/configs/markdown-headings-335.yaml

@@ -11,3 +11,6 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/data/configs/no_colors.yaml

@@ -0,0 +1,12 @@
+default_hour: 9
+default_minute: 0
+editor: ""
+encrypt: false
+highlight: true
+journals:
+  default: features/journals/simple.journal
+linewrap: 80
+tagsymbols: "@"
+template: false
+timeformat: "%Y-%m-%d %H:%M"
+indent_character: "|"

features/data/configs/tags-216.yaml

@@ -11,3 +11,6 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/data/configs/tags-237.yaml

@@ -11,3 +11,6 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/data/configs/tags.yaml

@@ -11,3 +11,6 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: red
+  title: green

features/steps/core.py

@@ -5,8 +5,10 @@
 from jrnl import cli, install, Journal, util, plugins
 from jrnl import __version__
 from dateutil import parser as date_parser
+from ansiwrap import strip_color
 from collections import defaultdict
 import os
+import ast
 import json
 import yaml
 import keyring
@@ -170,15 +172,15 @@ def check_json_output_path(context, path, value):
 @then('the output should be "{text}"')
 def check_output(context, text=None):
     text = (text or context.text).strip().splitlines()
-    out = context.stdout_capture.getvalue().strip().splitlines()
+    out = strip_color(context.stdout_capture.getvalue().strip()).splitlines()
     assert len(text) == len(out), "Output has {} lines (expected: {})".format(len(out), len(text))
     for line_text, line_out in zip(text, out):
         assert line_text.strip() == line_out.strip(), [line_text.strip(), line_out.strip()]
 
 
 @then('the output should contain "{text}" in the local time')
 def check_output_time_inline(context, text):
-    out = context.stdout_capture.getvalue()
+    out = strip_color(context.stdout_capture.getvalue())
     local_tz = tzlocal.get_localzone()
     utc_time = date_parser.parse(text)
     local_date = utc_time.astimezone(local_tz).strftime("%Y-%m-%d %H:%M")
@@ -189,7 +191,7 @@ def check_output_time_inline(context, text):
 @then('the output should contain "{text}"')
 def check_output_inline(context, text=None):
     text = text or context.text
-    out = context.stdout_capture.getvalue()
+    out = strip_color(context.stdout_capture.getvalue())
     if isinstance(out, bytes):
         out = out.decode('utf-8')
     assert text in out, text
@@ -233,12 +235,17 @@ def journal_doesnt_exist(context, journal_name="default"):
 @then('the config should have "{key}" set to "{value}"')
 @then('the config for journal "{journal}" should have "{key}" set to "{value}"')
 def config_var(context, key, value, journal=None):
-    t, value = value.split(":")
-    value = {
-        "bool": lambda v: v.lower() == "true",
-        "int": int,
-        "str": str
-    }[t](value)
+    if not value[0] == "{":
+        t, value = value.split(":")
+        value = {
+            "bool": lambda v: v.lower() == "true",
+            "int": int,
+            "str": str
+        }[t](value)
+    else:
+        # Handle value being a dictionary
+        value = ast.literal_eval(value)
+
     config = util.load_config(install.CONFIG_FILE_PATH)
     if journal:
         config = config["journals"][journal]

features/upgrade.feature

@@ -13,11 +13,16 @@ Feature: Upgrading Journals from 1.x.x to 2.x.x
 
     Scenario: Upgrading a journal encrypted with jrnl 1.x
         Given we use the config "encrypted_old.json"
-        When we run "jrnl -n 1" and enter 
+        When we run "jrnl -n 1" and enter
             """
             Y
             bad doggie no biscuit
             bad doggie no biscuit
             """
         Then we should see the message "Password"
         and the output should contain "2013-06-10 15:40 Life is good"
+
+    Scenario: Upgrading a config without colors to colors
+        Given we use the config "no_colors.yaml"
+        When we run "jrnl -n 1"
+        Then the config should have "colors" set to "{'date':'red', 'title':'blue'}"

jrnl/Entry.py

@@ -3,9 +3,9 @@
 
 from __future__ import unicode_literals
 import re
-import textwrap
+import ansiwrap
 from datetime import datetime
-from .util import split_title
+from .util import split_title, colorize
 
 
 class Entry:
@@ -79,9 +79,12 @@ def pprint(self, short=False):
         else:
             indent = ""
         if not short and self.journal.config['linewrap']:
-            title = textwrap.fill(date_str + " " + self.title, self.journal.config['linewrap'])
+            # Color date and color / bold title and make sure first line of title is bolded
+            title = ansiwrap.fill(colorize(date_str, self.journal.config['colors']['date']) + " " +
+                                  colorize(self.title, self.journal.config['colors']['title'], bold=True),
+                                  self.journal.config['linewrap'])
             body = "\n".join([
-                textwrap.fill(
+                ansiwrap.fill(
                     line,
                     self.journal.config['linewrap'],
                     initial_indent=indent,
@@ -90,7 +93,8 @@ def pprint(self, short=False):
                 for line in self.body.rstrip(" \n").splitlines()
             ])
         else:
-            title = date_str + " " + self.title.rstrip("\n ")
+            title = colorize(date_str, self.journal.config['colors']['date']) + " " +\
+                    colorize(self.title.rstrip("\n"), self.journal.config['colors']['title'], bold=True)
             body = self.body.rstrip("\n ")
 
         # Suppress bodies that are just blanks and new lines.

jrnl/Journal.py

@@ -152,12 +152,12 @@ def pprint(self, short=False):
                 for tag in self.search_tags:
                     tagre = re.compile(re.escape(tag), re.IGNORECASE)
                     pp = re.sub(tagre,
-                                lambda match: util.colorize(match.group(0)),
+                                lambda match: util.colorize(match.group(0), "CYAN"),
                                 pp, re.UNICODE)
             else:
                 pp = re.sub(
                     Entry.Entry.tag_regex(self.config['tagsymbols']),
-                    lambda match: util.colorize(match.group(0)),
+                    lambda match: util.colorize(match.group(0), "CYAN"),
                     pp
                 )
         return pp

jrnl/install.py

@@ -12,7 +12,7 @@
 from . import __version__
 from .Journal import PlainJournal
 from .EncryptedJournal import EncryptedJournal
-from .util import UserAbort
+from .util import UserAbort, verify_config
 import yaml
 import logging
 import sys
@@ -42,6 +42,7 @@ def module_exists(module_name):
     else:
         return True
 
+
 default_config = {
     'version': __version__,
     'journals': {
@@ -57,6 +58,10 @@ def module_exists(module_name):
     'highlight': True,
     'linewrap': 79,
     'indent_character': '|',
+    'colors': {
+        'date': 'red',
+        'title': 'blue',
+    },
 }
 
 
@@ -98,6 +103,7 @@ def load_or_install_jrnl():
             sys.exit(1)
 
         upgrade_config(config)
+        verify_config(config)
 
         return config
     else:

jrnl/util.py

@@ -8,8 +8,8 @@
 import os
 import getpass as gp
 import yaml
+import colorama
 if "win32" in sys.platform:
-    import colorama
     colorama.init()
 import re
 import tempfile
@@ -30,9 +30,9 @@
 TEST = False
 __cached_tz = None
 
-WARNING_COLOR = "\033[33m"
-ERROR_COLOR = "\033[31m"
-RESET_COLOR = "\033[0m"
+WARNING_COLOR = colorama.Fore.YELLOW
+ERROR_COLOR = colorama.Fore.RED
+RESET_COLOR = colorama.Fore.RESET
 
 # Based on Segtok by Florian Leitner
 # https://github.com/fnl/segtok
@@ -162,6 +162,21 @@ def scope_config(config, journal_name):
     return config
 
 
+def verify_config(config):
+    """
+    Ensures the keys set for colors are valid colorama.Fore attributes.
+    :return: True if all keys are set correctly, False otherwise
+    """
+    all_valid_colors = True
+    for key, color in config["colors"].items():
+        if not getattr(colorama.Fore, color.upper(), None):
+            # TODO: Not sure whether both of these should stay or not.
+            print("[{2}ERROR{3}: {0} set to invalid color: {1}]".format(key, color, ERROR_COLOR, RESET_COLOR))
+            log.error("Invalid color configuration value for '{0}'.".format(key))
+            all_valid_colors = False
+    return all_valid_colors
+
+
 def get_text_from_editor(config, template=""):
     filehandle, tmpfile = tempfile.mkstemp(prefix="jrnl", text=True, suffix=".txt")
     with codecs.open(tmpfile, 'w', "utf-8") as f:
@@ -180,9 +195,15 @@ def get_text_from_editor(config, template=""):
     return raw
 
 
-def colorize(string):
-    """Returns the string wrapped in cyan ANSI escape"""
-    return u"\033[36m{}\033[39m".format(string)
+def colorize(string, color, bold=False):
+    """Returns the string colored with colorama.Fore.color. If the color set
+    by the user doesn't exist in the colorama.Fore attributes, the colorization
+    is done with WHITE."""
+    color_escape = getattr(colorama.Fore, color.upper(), colorama.Fore.WHITE)
+    if not bold:
+        return color_escape + string + colorama.Fore.RESET
+    else:
+        return colorama.Style.BRIGHT + color_escape + string + colorama.Style.RESET_ALL
 
 
 def slugify(string):

pyproject.toml

@@ -22,9 +22,10 @@ keyring = "^19.0"
 pytz = "^2019.1"
 tzlocal = "^1.5"
 asteval = "^0.9.14"
-colorama = {version = "^0.4.1",platform = "win32"}
+colorama = "^0.4.1"
 python-dateutil = "^2.8"
 pyyaml = "^5.1"
+ansiwrap = "^0.8.4"
 
 [tool.poetry.dev-dependencies]
 behave = "^1.2"