Pretty print journal entries

docs/advanced.md

@@ -35,8 +35,9 @@ and can be edited with a 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). To disable colored output, set the value to `NONE`. If you set the value of any color subkey to an invalid color, no color will be used.
 
 !!! note
     Although it seems intuitive to use the `#`

features/core.feature

@@ -13,6 +13,19 @@ Feature: Basic reading and writing to a journal
             | But I'm better.
             """
 
+    Scenario: Printing a journal that has multiline entries
+        Given we use the config "multiline.yaml"
+        When we run "jrnl -n 1"
+        Then we should get no error
+        and the output should be
+            """
+            2013-06-09 15:39 Multiple line entry.
+            | This is the first line.
+            | This line doesn't have any ending punctuation
+            |
+            | There is a blank line above this.
+            """
+
     Scenario: Writing an entry from command line
         Given we use the config "basic.yaml"
         When we run "jrnl 23 july 2013: A cold and stormy day. I ate crisps on the sofa."
@@ -58,3 +71,11 @@ 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
+        """
+        2013-06-10 15:40 Life is good.
+        """
+        And we should get no error

features/data/configs/basic.yaml

@@ -10,3 +10,8 @@ tagsymbols: "@"
 template: false
 timeformat: "%Y-%m-%d %H:%M"
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/bug153.yaml

@@ -11,3 +11,8 @@ tagsymbols: '@'
 template: false
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/invalid_color.yaml

@@ -0,0 +1,17 @@
+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
+  body: still-no-color
+  tags: me-too

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

@@ -11,3 +11,8 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/multiline-tags.yaml

@@ -0,0 +1,17 @@
+default_hour: 9
+default_minute: 0
+editor: ""
+encrypt: false
+highlight: true
+journals:
+  default: features/journals/multiline-tags.journal
+linewrap: 80
+tagsymbols: "@"
+template: false
+timeformat: "%Y-%m-%d %H:%M"
+indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/multiline.yaml

@@ -0,0 +1,17 @@
+default_hour: 9
+default_minute: 0
+editor: ""
+encrypt: false
+highlight: true
+journals:
+  default: features/journals/multiline.journal
+linewrap: 80
+tagsymbols: "@"
+template: false
+timeformat: "%Y-%m-%d %H:%M"
+indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

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,8 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/tags-237.yaml

@@ -11,3 +11,8 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/tags.yaml

@@ -11,3 +11,8 @@ password: ''
 tagsymbols: '@'
 timeformat: '%Y-%m-%d %H:%M'
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/configs/unreadabledates.yaml

@@ -10,3 +10,8 @@ tagsymbols: "@"
 template: false
 timeformat: "%Y-%m-%d %H:%M"
 indent_character: "|"
+colors:
+  date: none
+  title: none
+  body: none
+  tags: none

features/data/journals/multiline-tags.journal

@@ -0,0 +1,7 @@
+[2013-06-09 15:39] Multiple @line entry with @tags.
+Tag with @punctuation. afterwards
+@TagOnLineAloneWithOutPunctuation
+@TagOnLineAloneWithPunctuation.
+Text before @tag. And After.
+@hi. Hello
+hi Hello

features/data/journals/multiline.journal

@@ -0,0 +1,5 @@
+[2013-06-09 15:39] Multiple line entry.
+This is the first line.
+This line doesn't have any ending punctuation
+
+There is a blank line above this.

features/steps/core.py

@@ -5,7 +5,9 @@
 from jrnl import __version__
 from dateutil import parser as date_parser
 from collections import defaultdict
+from codecs import encode, decode
 import os
+import ast
 import json
 import yaml
 import keyring
@@ -132,7 +134,7 @@ def has_error(context):
 
 @then('we should get no error')
 def no_error(context):
-    assert context.exit_status is 0, context.exit_status
+    assert context.exit_status == 0, context.exit_status
 
 
 @then('the output should be parsable as json')
@@ -181,20 +183,30 @@ def check_json_output_path(context, path, value):
             struct = struct[node]
     assert struct == value, struct
 
+def process_ANSI_escapes(text):
+    """Escapes and 'unescapes' a string with ANSI escapes so that behave stdout
+    comparisons work properly. This will render colors, and works with unicode
+    characters. https://stackoverflow.com/a/57192592
+    :param str text: The text to be escaped and unescaped
+    :return: Colorized / escaped text
+    :rtype: str
+    """
+    return decode(encode(text, 'latin-1', 'backslashreplace'), 'unicode-escape')
+
 
 @then('the output should be')
 @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 = process_ANSI_escapes(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 = process_ANSI_escapes(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")
@@ -205,7 +217,9 @@ 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 = process_ANSI_escapes(context.stdout_capture.getvalue())
+    if isinstance(out, bytes):
+        out = out.decode('utf-8')
     assert text in out, text
 
 
@@ -245,12 +259,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/tagging.feature

@@ -82,3 +82,19 @@ Feature: Tagging
             """
             @thought             : 2
             """
+
+
+    Scenario: Printing a journal that has multiline entries with tags
+        Given we use the config "multiline-tags.yaml"
+        When we run "jrnl -n 1"
+        Then we should get no error
+        and the output should be
+            """
+            2013-06-09 15:39 Multiple @line entry with @tags.
+            | Tag with @punctuation. afterwards
+            | @TagOnLineAloneWithOutPunctuation
+            | @TagOnLineAloneWithPunctuation.
+            | Text before @tag. And After.
+            | @hi. Hello
+            | hi Hello
+            """

features/upgrade.feature

@@ -22,6 +22,11 @@ Feature: Upgrading Journals from 1.x.x to 2.x.x
         Then the output should contain "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':'none', 'title':'none', 'body':'none', 'tags':'none'}"
+
     Scenario: Upgrade and parse journals with little endian date format
         Given we use the config "upgrade_from_195_little_endian_dates.json"
         When we run "jrnl -9" and enter "Y"
@@ -32,3 +37,4 @@ Feature: Upgrading Journals from 1.x.x to 2.x.x
             10.06.2013 15:40 He said "[this] is the best time to be alive".
             """
         Then the journal should have 2 entries
+