Merge pull request #27 from NyanKiyoshi/feature/save_html

The html command now writes to a file instead of stdout

.gitignore

@@ -9,3 +9,4 @@ venv/
 dist/
 docs/_build/
 .DS*
+django-queries-results.html

README.md

@@ -102,9 +102,10 @@ You will get something like this to represent the results:
 ## Exporting the results (HTML)
 For a nicer presentation, use the `html` command, to export the results as HTML.
 ```shell
-django-queries html > results.html
+django-queries html
 ```
-<!-- todo: add example page link -->
+
+It will generate something [like this](docs/extra_html/html_export_results.html).
 
 ## Comparing results
 

docs/index.rst

@@ -54,7 +54,7 @@ Quick Start
         | module3 |                         |
         +---------+-------------------------+
 
-5. Or for a nicer presentation, use ``django-queries html > results.html`` to export the results as HTML. See `this example <./html_export_results.html>`_ for a demo!
+5. Or for a nicer presentation, use ``django-queries html`` to export the results as HTML. See `this example <./html_export_results.html>`_ for a demo!
 
     .. image:: _static/html_export_results.png
         :width: 500 px

docs/usage.rst

@@ -47,11 +47,14 @@ The HTML Command
 
 .. code-block:: text
 
-    Usage: django-queries html [OPTIONS] [INPUT_FILE]
+    Usage: django-queries html [OPTIONS] [INPUT_FILE] [-o OUTPUT FILE]
 
     Render the results as HTML instead of a raw table.
 
     Options:
+        -o                  The path to save the HTML file into
+                            django-queries.html by default.
+                            You can pass a dash (-) to write to stdout as well.
         --template INTEGER
         --help              Show this message and exit.
 

pytest_django_queries/cli.py

@@ -12,15 +12,21 @@
     DEFAULT_OLD_RESULT_FILENAME,
     DEFAULT_RESULT_FILENAME,
 )
-from pytest_django_queries.tables import print_entries, print_entries_as_html
+from pytest_django_queries.tables import entries_to_html, print_entries
 
 HERE = dirname(__file__)
 DEFAULT_TEMPLATE_PATH = abspath(pathjoin(HERE, "templates", "default_bootstrap.jinja2"))
+DEFAULT_HTML_SAVE_PATH = "django-queries-results.html"
 
 DIFF_TERM_COLOR = {"-": "red", "+": "green"}
 DEFAULT_TERM_DIFF_COLOR = None
 
 
+def _write_html_to_file(content, path):
+    with open(path, "w") as fp:
+        fp.write(content)
+
+
 class JsonFileParamType(click.File):
     name = "integer"
 
@@ -41,7 +47,7 @@ class Jinja2TemplateFile(click.File):
     def convert(self, value, param, ctx):
         fp = super(Jinja2TemplateFile, self).convert(value, param, ctx)
         try:
-            return Template(fp.read())
+            return Template(fp.read(), trim_blocks=True)
         except jinja_exceptions.TemplateError as e:
             self.fail(
                 "The file is not a valid jinja2 template: %s" % str(e), param, ctx
@@ -66,10 +72,20 @@ def show(input_file):
 @click.argument(
     "input_file", type=JsonFileParamType("r"), default=DEFAULT_RESULT_FILENAME
 )
+@click.option("-o", "--output", type=str, default=DEFAULT_HTML_SAVE_PATH)
 @click.option("--template", type=Jinja2TemplateFile("r"), default=DEFAULT_TEMPLATE_PATH)
-def html(input_file, template):
-    """Render the results as HTML instead of a raw table."""
-    return print_entries_as_html(input_file, template)
+def html(input_file, output, template):
+    """
+    Render the results as HTML instead of a raw table.
+
+    Note: you can pass a dash (-) as the path to print the HTML content to stdout."""
+    html_content = entries_to_html(input_file, template)
+
+    if output == "-":
+        click.echo(html_content, nl=False)
+        return
+
+    _write_html_to_file(html_content, output)
 
 
 @main.command()

pytest_django_queries/tables.py

@@ -17,8 +17,8 @@ def print_entries(data):
     click.echo(table)
 
 
-def print_entries_as_html(data, template):
+def entries_to_html(data, template):
     html_content = template.render(
         data=iter_entries(data), humanize=format_underscore_name_to_human
     )
-    click.echo(html_content, nl=False)
+    return html_content

tests/test_cli.py

@@ -1,6 +1,7 @@
 import json
 from textwrap import dedent
 
+import mock
 import pytest
 from bs4 import BeautifulSoup
 from click.testing import CliRunner
@@ -99,7 +100,7 @@ def test_load_valid_json_file_shows_correct_data(testdir):
 def test_load_valid_json_file_shows_correct_html_data(testdir):
     testdir.makefile(".json", test_file=json.dumps(VALID_DATA))
     runner = CliRunner()
-    result = runner.invoke(cli.main, ["html", "test_file.json"])
+    result = runner.invoke(cli.main, ["html", "test_file.json", "-o", "-"])
     assert result.exit_code == 0, result.stdout
     soup = BeautifulSoup(result.stdout, "lxml")
     sections = soup.select("section")
@@ -130,7 +131,7 @@ def test_load_valid_json_without_data_is_empty_result(testdir, test_data):
     testdir.makefile(".json", test_file=json.dumps(test_data))
 
     runner = CliRunner()
-    result = runner.invoke(cli.main, ["html", "test_file.json"])
+    result = runner.invoke(cli.main, ["html", "test_file.json", "-o", "-"])
     assert result.exit_code == 0, result.stdout
 
     soup = BeautifulSoup(result.stdout, "lxml")
@@ -156,18 +157,55 @@ def test_load_valid_json_without_data_is_empty_result(testdir, test_data):
     assert received_text.get_text(strip=True) == "No data."
 
 
+def test_export_to_html_using_custom_path(testdir):
+    testdir.makefile(".json", test_file="{}")
+    results_path = testdir.tmpdir.join("results.html")
+
+    runner = CliRunner()
+    result = runner.invoke(
+        cli.main, ["html", "test_file.json", "-o", str(results_path)]
+    )
+    assert result.exit_code == 0, result.stdout
+    assert not result.stdout
+    assert results_path.check()
+
+
 def test_export_to_html_using_custom_template(testdir):
     testdir.makefile(".json", test_file="{}")
     testdir.makefile(".html", test_template='{{ "hello world" }}')
 
     runner = CliRunner()
     result = runner.invoke(
-        cli.main, ["html", "test_file.json", "--template", "test_template.html"]
+        cli.main,
+        ["html", "test_file.json", "-o", "-", "--template", "test_template.html"],
     )
     assert result.exit_code == 0, result.stdout
     assert result.stdout == "hello world"
 
 
+@pytest.mark.parametrize(
+    "additional_args, expected_save_path",
+    ((["-o", "/somewhere/html"], "/somewhere/html"), ([], cli.DEFAULT_HTML_SAVE_PATH)),
+)
+@mock.patch.object(cli, "entries_to_html")
+@mock.patch.object(cli, "_write_html_to_file")
+def test_export_to_html_into_file(
+    mocked_write, mocked_entries_to_html, testdir, additional_args, expected_save_path
+):
+    testdir.makefile(".json", test_file="{}")
+    runner = CliRunner()
+
+    mocked_entries_to_html.return_value = "hi!"
+
+    args = ["html", "test_file.json"] + additional_args
+    result = runner.invoke(cli.main, args)
+
+    assert result.exit_code == 0, result.stdout
+    assert not result.stdout
+
+    mocked_write.assert_called_once_with("hi!", expected_save_path)
+
+
 def test_export_to_html_using_invalid_custom_template_should_fail(testdir):
     testdir.makefile(".json", test_file="{}")
     testdir.makefile(".html", test_template='{% "hello world" %}')