Release 0.0.4 and step into source directory before compiling a document. (#4)

Author: tobiasraabe

Diff for: .pre-commit-config.yaml

@@ -55,6 +55,7 @@ repos:
   rev: v1.17.1
   hooks:
     - id: codespell
+      args: [-L=als]
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

Diff for: CHANGES.rst

@@ -7,6 +7,13 @@ all releases are available on `Anaconda.org
 <https://anaconda.org/pytask/pytask-latex>`_.
 
 
+0.0.4 - 2020-08-21
+------------------
+
+- :gh:`4` changes the default options. latexmk will step into the source directory
+  before compiling the document. Releases 0.0.4.
+
+
 0.0.3 - 2020-08-12
 ------------------
 

Diff for: README.rst

@@ -78,7 +78,7 @@ via the ``@pytask.mark.latex`` marker. The default is the following.
 
 .. code-block:: python
 
-    @pytask.mark.latex(["--pdf", "--interaction=nonstopmode", "--synctex=1"])
+    @pytask.mark.latex(["--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd"])
     def task_compile_latex_document():
         pass
 
@@ -94,6 +94,9 @@ The options ``jobname``, ``output-directory`` and the ``.tex`` file which will b
 compiled are handled by the ``@pytask.mark.depends_on`` and ``@pytask.mark.produces``
 markers and cannot be changed.
 
+For more options and their explanations, visit the `manual for latexmk
+<https://man.cx/latexmk>`_.
+
 You can either pass a string or a list of strings to the ``@pytask.mark.latex``
 decorator.
 

Diff for: setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.3
+current_version = 0.0.4
 parse = (?P<major>\d+)\.(?P<minor>\d+)(\.(?P<patch>\d+))(\-?((dev)?(?P<dev>\d+))?)
 serialize = 
 	{major}.{minor}.{patch}dev{dev}

Diff for: setup.py

@@ -3,7 +3,7 @@
 
 setup(
     name="pytask-latex",
-    version="0.0.3",
+    version="0.0.4",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     entry_points={"pytask": ["pytask_latex = pytask_latex.plugin"]},

Diff for: src/pytask_latex/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"

Diff for: src/pytask_latex/collect.py

@@ -13,6 +13,9 @@
 from _pytask.shared import to_list
 
 
+DEFAULT_OPTIONS = ["--pdf", "--interaction=nonstopmode", "--synctex=1", "--cd"]
+
+
 def latex(options: Optional[Union[str, Iterable[str]]] = None):
     """Specify command line options for latexmk.
 
@@ -23,7 +26,7 @@ def latex(options: Optional[Union[str, Iterable[str]]] = None):
 
     """
     if options is None:
-        options = ["--pdf", "--interaction=nonstopmode", "--synctex=1"]
+        options = DEFAULT_OPTIONS.copy()
     elif isinstance(options, str):
         options = [options]
     return options

Diff for: tests/test_collect.py

@@ -1,6 +1,7 @@
 import pytest
 from _pytask.mark import Mark
 from pytask_latex.collect import _create_command_line_arguments
+from pytask_latex.collect import DEFAULT_OPTIONS
 
 
 class DummyTask:
@@ -9,11 +10,7 @@ class DummyTask:
 
 @pytest.mark.unit
 @pytest.mark.parametrize(
-    "args, expected",
-    [
-        ((), ["--pdf", "--interaction=nonstopmode", "--synctex=1"]),
-        (("--xelatex",), ["--xelatex"]),
-    ],
+    "args, expected", [((), DEFAULT_OPTIONS.copy()), (("--xelatex",), ["--xelatex"])],
 )
 def test_create_command_line_arguments(args, expected):
     task = DummyTask()

Diff for: tests/test_execute.py

@@ -292,3 +292,49 @@ def task_compile_document():
 
     assert session.exit_code == 2
     assert isinstance(session.collection_reports[0].exc_info[1], ValueError)
+
+
+@needs_latexmk
+@skip_on_github_actions_with_win
+@pytest.mark.end_to_end
+def test_compile_document_to_out_if_document_has_relative_resources(tmp_path):
+    """Test that motivates the ``"--cd"`` flag.
+
+    If you have a document which includes other resources via relative paths and you
+    compile the document to a different output folder, latexmk will not find the
+    relative resources. Thus, use the ``"--cd"`` flag to enter the source directory
+    before the compilation.
+
+    """
+    tmp_path.joinpath("sub", "resources").mkdir(parents=True)
+
+    task_source = """
+    import pytask
+
+    @pytask.mark.latex
+    @pytask.mark.depends_on(["document.tex", "resources/content.tex"])
+    @pytask.mark.produces("out/document.pdf")
+    def task_compile_document():
+        pass
+
+    """
+    tmp_path.joinpath("sub", "task_dummy.py").write_text(textwrap.dedent(task_source))
+
+    latex_source = r"""
+    \documentclass{report}
+    \begin{document}
+    \input{resources/content}
+    \end{document}
+    """
+    tmp_path.joinpath("sub", "document.tex").write_text(textwrap.dedent(latex_source))
+
+    resources = r"""
+    In Ottakring, in Ottakring, wo das Bitter so viel süßer schmeckt als irgendwo in
+    Wien.
+    """
+    tmp_path.joinpath("sub", "resources", "content.tex").write_text(resources)
+
+    session = main({"paths": tmp_path})
+
+    assert session.exit_code == 0
+    assert len(session.tasks) == 1