Fix bug that prevented --format pretty and --format short from working

features/format.feature

@@ -1,5 +1,31 @@
 Feature: Custom formats
 
+    Scenario Outline: Short printing via --format flag
+        Given We use the config "<config>.yaml"
+        And we use the password "test" if prompted
+        When we run "jrnl --format short -3"
+        Then we should get no error 
+
+        Examples: configs
+        |   config          |
+        |   basic_onefile   |
+        |   basic_encrypted |
+        |   basic_folder    |
+        |   basic_dayone    |
+
+    Scenario Outline: Pretty Printing aka the Default 
+        Given We use the config "<config>.yaml"
+        And we use the password "test" if prompted
+        When we run "jrnl --format pretty -3"
+        Then we should get no error
+
+        Examples: configs
+        |   config          |
+        |   basic_onefile   |
+        |   basic_encrypted |
+        |   basic_folder    |
+        |   basic_dayone    |
+
     Scenario Outline: JSON format
         Given we use the config "<config>.yaml"
         And we use the password "test" if prompted

features/steps/core.py

@@ -16,6 +16,7 @@
 import toml
 import yaml
 
+
 import jrnl.time
 from jrnl import Journal
 from jrnl import __version__
@@ -394,6 +395,12 @@ def all_input_was_used(context):
 def run(context, command, text=""):
     text = text or context.text or ""
 
+    if "config_path" in context and context.config_path is not None:
+        with open(context.config_path) as f:
+            context.jrnl_config = yaml.load(f, Loader=yaml.FullLoader)
+    else:
+        context.jrnl_config = None
+
     if "cache_dir" in context and context.cache_dir is not None:
         cache_dir = os.path.join("features", "cache", context.cache_dir)
         command = command.format(cache_dir=cache_dir)

features/steps/export_steps.py

@@ -1,13 +1,13 @@
 # Copyright (C) 2012-2021 jrnl contributors
 # License: https://www.gnu.org/licenses/gpl-3.0.html
 
+
 import json
 import os
 import shutil
 import random
 import string
 from xml.etree import ElementTree
-
 from behave import given
 from behave import then
 

jrnl/jrnl.py

@@ -1,12 +1,13 @@
 # Copyright (C) 2012-2021 jrnl contributors
 # License: https://www.gnu.org/licenses/gpl-3.0.html
 
+from argparse import Namespace
 import logging
 import sys
 
 from . import install
 from . import plugins
-from .Journal import open_journal
+from .Journal import Journal, open_journal
 from .color import ERROR_COLOR
 from .color import RESET_COLOR
 from .config import get_journal_name
@@ -316,17 +317,36 @@ def _delete_search_results(journal, old_entries, **kwargs):
 
 
 def _display_search_results(args, journal, **kwargs):
-    if args.short:
+    if args.short or args.export == "short":
         print(journal.pprint(short=True))
 
+    elif args.export == "pretty":
+        print(journal.pprint())
+
     elif args.tags:
         print(plugins.get_exporter("tags").export(journal))
 
     elif args.export:
-        exporter = plugins.get_exporter(args.export)
-        print(exporter.export(journal, args.filename))
+        _export_journal(args, journal)
+
     elif kwargs["config"].get("display_format"):
         exporter = plugins.get_exporter(kwargs["config"]["display_format"])
         print(exporter.export(journal, args.filename))
     else:
         print(journal.pprint())
+
+
+def _export_journal(args: Namespace, journal: Journal):
+    """Export journal using supplied export format
+    Export formats "short" and "pretty" are shorthands for pre-configured
+    jrnl behavior, hence those export formats bypass the export plugins.
+
+    :param args: parsed arguments
+    :type args: Namespace
+    :param journal: journal under use
+    :type journal: Journal
+    """
+    # There are no exporter 'plugins' for pretty and short. We shouldn't expect this to be called for those two export formats.
+    assert args.export and args.export not in ("pretty", "short")
+    exporter = plugins.get_exporter(args.export)
+    print(exporter.export(journal, args.filename))

jrnl/plugins/__init__.py

@@ -27,6 +27,8 @@
 __importers = [JRNLImporter]
 
 __exporter_types = {name: plugin for plugin in __exporters for name in plugin.names}
+__exporter_types["pretty"] = None
+__exporter_types["short"] = None
 __importer_types = {name: plugin for plugin in __importers for name in plugin.names}
 
 EXPORT_FORMATS = sorted(__exporter_types.keys())

tests/test_color.py

@@ -0,0 +1,17 @@
+import pytest
+
+from jrnl.color import colorize
+from colorama import Fore, Style
+
+
+@pytest.fixture()
+def data_fixture():
+    string = "Zwei peanuts walked into a bar"
+    yield string
+
+
+def test_colorize(data_fixture):
+    string = data_fixture
+    colorized_string = colorize(string, "BLUE", True)
+
+    assert colorized_string == Style.BRIGHT + Fore.BLUE + string + Style.RESET_ALL

tests/test_display.py

@@ -0,0 +1,42 @@
+import argparse
+import jrnl
+import pytest
+from unittest import mock
+from jrnl.jrnl import _display_search_results, _export_journal
+
+
+# fmt: off
+# see: https://github.com/psf/black/issues/664
+@pytest.mark.parametrize("export_format", [ "pretty", "short",])
+#fmt: on
+@mock.patch.object(argparse, "Namespace", return_value={"export": "markdown", "filename": "irrele.vant"})
+def test_export_format(mock_args, export_format):
+
+    test_journal = jrnl.Journal.Journal
+    mock_args.export = export_format
+    #fmt: off
+    # see: https://github.com/psf/black/issues/664
+    with mock.patch("builtins.print") as mock_spy_print, \
+    mock.patch('jrnl.Journal.Journal.pprint') as mock_pprint:
+        _display_search_results(mock_args, test_journal)
+    mock_spy_print.assert_called_once_with(mock_pprint())
+    #fmt: on
+
+
+@mock.patch.object(argparse, "Namespace", return_value={"export": "markdown", "filename": "foo.jrnl"})
+def test_export_plugin(mock_args):
+    export_format =  mock_args.return_value["export"]
+
+    test_journal = jrnl.Journal.Journal
+    mock_args.export = export_format
+    mock_args.filename = mock_args.return_value['filename']
+
+    # fmt: off
+    # see: https://github.com/psf/black/issues/664
+    with mock.patch("builtins.print") as print_spy, \
+    mock.patch("jrnl.plugins.get_exporter") as mock_get_exporter, \
+    mock.patch("jrnl.Journal.Journal.pprint") :
+        _export_journal(mock_args, test_journal)
+    # fmt: on
+    mock_get_exporter.assert_called_once_with(export_format)
+    print_spy.assert_called_once_with(mock_get_exporter().export(test_journal,mock_args.filename))