Pretty print journal entries (#692)

* Pretty print journal entry titles and dates.

Changes appearance of all jrnl viewing commands, such as $ jrnl --short and
$ jrnl -n {NUM}.

Fix #508

* Removed extra newline at end of title

* Use ansiwrap to properly wrap strings with ANSI escapes

* Add ansiwrap to pyproject.toml

* Allow configuration of colors

- Replaced raw escapes with colorama
- Added colors key to config
- Add checks for validity of color values

* Add color configuration documentation

* Fix broken tests due to config change

* Add tests for colors in configs

- Identifying invalid color configs
- Upgrading config from no colors -> colors

* Add colorama dependency for all platforms

* Allow users to disable colorization of output

* Update poetry.lock

* Add tag and body color customization options

* Fix colorization of tags in title and body

* Updated tests to use no color by default

* Change pass to continue in verify_config()

* Better style in Entry.py

* Reduce code duplication for tag highlighting

- Breaks "unreadable date" regression test for unknown reason

* Properly colorize tags and print body

* Reformatting and clean up

* Replace list comprehension with generator

* Handle invalid colors by not using a color

* Process ANSI escapes properly with behave

* Fixed the 'spaces after tags directly next to punctuation' bug

Broke processing of tags next to any punctuation at all

* Closer to working tag colorization but not perfect

* Add tests printing for multiline journals

Fix #717

* Correctly indent first line of multiline entry

* Add test for multiline entries with tags

* Remove redundant UNICODE flag

* Progress towards proper tag colorization and body formatting

* Fix newline colorization bug

Debug code left intact since there are more bugs to fix :/

* And now the space just ends up before the tag instead of after it

* Fix assertion syntax warning

* Moved tag test to tagging.feature file

* Strip out debug code and clean up

* Bold datetimes in title

* Bold all titles

Fix #720

* Remove PY2 and PY3 constants

* Fix regression in features/steps/core.py

* Fix tag_regex

* Remove redundant re.UNICODE flag

* Remove extraneous code

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."
@@ -72,3 +85,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

@@ -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/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

@@ -10,3 +10,8 @@ linewrap: 80
 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

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

features/data/configs/tags-237.yaml

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

features/data/configs/tags.yaml

@@ -10,3 +10,8 @@ linewrap: 80
 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

@@ -10,7 +10,9 @@ try:
 except ImportError:
     import parsedatetime as pdt
 import time
+from codecs import encode, decode
 import os
+import ast
 import json
 import yaml
 import keyring
@@ -184,11 +186,69 @@ def no_error(context):
     assert context.exit_status == 0, context.exit_status
 
 
+@then("the output should be parsable as json")
+def check_output_json(context):
+    out = context.stdout_capture.getvalue()
+    assert json.loads(out), out
+
+
+@then('"{field}" in the json output should have {number:d} elements')
+@then('"{field}" in the json output should have 1 element')
+def check_output_field(context, field, number=1):
+    out = context.stdout_capture.getvalue()
+    out_json = json.loads(out)
+    assert field in out_json, [field, out_json]
+    assert len(out_json[field]) == number, len(out_json[field])
+
+
+@then('"{field}" in the json output should not contain "{key}"')
+def check_output_field_not_key(context, field, key):
+    out = context.stdout_capture.getvalue()
+    out_json = json.loads(out)
+    assert field in out_json
+    assert key not in out_json[field]
+
+
+@then('"{field}" in the json output should contain "{key}"')
+def check_output_field_key(context, field, key):
+    out = context.stdout_capture.getvalue()
+    out_json = json.loads(out)
+    assert field in out_json
+    assert key in out_json[field]
+
+
+@then('the json output should contain {path} = "{value}"')
+def check_json_output_path(context, path, value):
+    """ E.g.
+    the json output should contain entries.0.title = "hello"
+    """
+    out = context.stdout_capture.getvalue()
+    struct = json.loads(out)
+
+    for node in path.split("."):
+        try:
+            struct = struct[int(node)]
+        except ValueError:
+            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)
     )
@@ -201,7 +261,7 @@ def check_output(context, text=None):
 
 @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()
     date, flag = CALENDAR.parse(text)
     output_date = time.strftime("%Y-%m-%d %H:%M", date)
@@ -213,7 +273,7 @@ def check_output_time_inline(context, text):
 @then('the output should contain "{text}" or "{text2}"')
 def check_output_inline(context, text=None, text2=None):
     text = text or context.text
-    out = context.stdout_capture.getvalue()
+    out = process_ANSI_escapes(context.stdout_capture.getvalue())
     assert text in out or text2 in out, text or text2
 
 
@@ -253,8 +313,15 @@ 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
+