♻ Refactor document_issue_md_to_pdf function

environment.yml

@@ -18,6 +18,7 @@ dependencies:
   - pip:
       - polyfactory
       - -e packages/document-issue 
-      - -e packages/document-issue-io[quarto]
+      - -e packages/document-issue-io
+      - -e packages/document-issue-io[dev]
       - -e packages/document-issue-api
       - -e packages/document-issue-ui

packages/document-issue-io/src/document_issue_io/__init__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2023-present J Gunstone <[email protected]>
 #
 # SPDX-License-Identifier: MIT
-from document_issue_io.markdown_document_issue import document_issue_md_to_pdf
+from document_issue_io.markdown_document_issue import generate_document_issue_pdf

packages/document-issue-io/src/document_issue_io/markdown_document_issue.py

@@ -100,14 +100,6 @@ def to_file(self, fpth: pathlib.Path):
         f.close()
 
 
-def check_markdown_file_paths(fpth_md: pathlib.Path, fpth_md_output: pathlib.Path):
-    """Check if input and output markdown files are the same."""
-    if fpth_md == fpth_md_output:
-        raise ValueError(
-            f"Input and output markdown file paths must be different. Please change file name of input markdown."
-        )
-
-
 def check_quarto_version() -> ty.Union[None, str]:
     """Check if quarto version is at least 0.5.0."""
     completed_process = subprocess.run(["quarto", "--version"], capture_output=True)
@@ -145,26 +137,25 @@ def run_quarto(
     return subprocess.run(cmd)
 
 
-def document_issue_md_to_pdf(
-    document_issue: DocumentIssue,
-    fpth_pdf: pathlib.Path,
-    fpth_md: ty.Union[pathlib.Path, None] = None,
-):
-    """Convert markdown document issue to pdf using quarto.
+# generate_document_issue_docx(document_issue, fpth_docx, *, md_content="")
+# generate_document_issue_md(document_issue, fpth_md, *, md_content="")
+# ^ TODO: add in future if this functionality is needed
+
+
+def generate_document_issue_pdf(
+    document_issue: DocumentIssue, fpth_pdf: pathlib.Path, *, md_content: str = ""
+) -> subprocess.CompletedProcess:
+    """Convert document issue to pdf using quarto.
+    Extra markdown content can be added to the document using `md_content`.
     The files will be built in the parent directory of fpth_pdf."""
     fpth_md_output = fpth_pdf.parent / (fpth_pdf.stem + ".md")
-    if fpth_md is not None:
-        check_markdown_file_paths(fpth_md, fpth_md_output)
-        md_content = fpth_md.read_text()
-    else:
-        md_content = ""
     with change_dir(fpth_pdf.parent):
         shutil.copy(
-            FPTH_FOOTER_LOGO, FPTH_FOOTER_LOGO.name
+            src=FPTH_FOOTER_LOGO, dst=FPTH_FOOTER_LOGO.name
         )  # Copy footer logo to markdown document issue directory
         build_schedule_title_page_template_pdf(document_issue=document_issue)
         install_or_update_document_issue_quarto_extension()
         markdown = MarkdownDocumentIssue(document_issue).md_docissue + md_content
         fpth_md_output.write_text(markdown)
         completed_process = run_quarto(fpth_md_output, fpth_pdf)
-    return fpth_pdf
+    return completed_process

packages/document-issue-io/tests/test_markdown_document_issue.py

@@ -1,4 +1,3 @@
-import pytest
 import shutil
 import datetime
 from polyfactory.factories.pydantic_factory import ModelFactory
@@ -7,7 +6,7 @@
 from document_issue.issue import StatusRevisionEnum
 from document_issue_io.markdown_document_issue import (
     MarkdownDocumentIssue,
-    document_issue_md_to_pdf,
+    generate_document_issue_pdf,
 )
 
 from tests.constants import FDIR_TEST_OUTPUT
@@ -69,7 +68,7 @@ def test_to_file(self):
 
 -   convert this notebook to markdown
 -   read `docissue.json`
--   convert using `document_issue_md_to_pdf`
+-   convert using `generate_document_issue_pdf`
 
 ## My Project
 
@@ -82,7 +81,7 @@ def test_to_file(self):
 
 
 class TestDocumentIssueMdToPdf:
-    """Test the function `document_issue_md_to_pdf`."""
+    """Test the function `generate_document_issue_pdf`."""
 
     def test_to_pdf(self):
         FDIR_RENDER = FDIR_TEST_OUTPUT / "test_to_pdf"
@@ -92,7 +91,7 @@ def test_to_pdf(self):
         document_issue.format_configuration.output_author = False
         document_issue.format_configuration.output_checked_by = False
         fpth_pdf = FDIR_RENDER / f"{document_issue.document_code}.pdf"
-        document_issue_md_to_pdf(
+        generate_document_issue_pdf(
             document_issue=document_issue,
             fpth_pdf=fpth_pdf,
         )
@@ -106,14 +105,12 @@ def test_to_pdf_with_markdown_content(self):
         FDIR_RENDER = FDIR_TEST_OUTPUT / "test_to_pdf_with_markdown_content"
         shutil.rmtree(FDIR_RENDER, ignore_errors=True)
         FDIR_RENDER.mkdir(parents=True, exist_ok=True)
-        fpth_md = FDIR_RENDER / "test.md"
-        fpth_md.write_text(MD)
         document_issue = create_test_document_issue()
         document_issue.format_configuration.output_author = False
         document_issue.format_configuration.output_checked_by = False
         fpth_pdf = FDIR_RENDER / f"{document_issue.document_code}.pdf"
-        document_issue_md_to_pdf(
-            document_issue=document_issue, fpth_md=fpth_md, fpth_pdf=fpth_pdf
+        generate_document_issue_pdf(
+            document_issue=document_issue, fpth_pdf=fpth_pdf, md_content=MD
         )
         assert fpth_pdf.is_file()
         # Check that the markdown file created contains the correct content
@@ -127,7 +124,7 @@ def test_to_pdf_with_author(self):
         document_issue.format_configuration.output_author = True
         document_issue.format_configuration.output_checked_by = False
         fpth_pdf = FDIR_RENDER / f"{document_issue.document_code}.pdf"
-        document_issue_md_to_pdf(
+        generate_document_issue_pdf(
             document_issue=document_issue,
             fpth_pdf=fpth_pdf,
         )
@@ -145,7 +142,7 @@ def test_to_pdf_with_author_and_checked_by(self):
         document_issue.format_configuration.output_author = True
         document_issue.format_configuration.output_checked_by = True
         fpth_pdf = FDIR_RENDER / f"{document_issue.document_code}.pdf"
-        document_issue_md_to_pdf(
+        generate_document_issue_pdf(
             document_issue=document_issue,
             fpth_pdf=fpth_pdf,
         )
@@ -220,7 +217,7 @@ def test_to_pdf_loads_of_notes_and_issues(self):
         document_issue.format_configuration.output_author = True
         document_issue.format_configuration.output_checked_by = True
         fpth_pdf = FDIR_RENDER / f"{document_issue.document_code}.pdf"
-        document_issue_md_to_pdf(
+        generate_document_issue_pdf(
             document_issue=document_issue,
             fpth_pdf=fpth_pdf,
         )
@@ -230,15 +227,3 @@ def test_to_pdf_loads_of_notes_and_issues(self):
             fpth_pdf.with_suffix(".log")
         ).is_file()  # log file should be deleted if Quarto PDF compilation is successful
 
-    def test_to_pdf_error(self):
-        """If the markdown file has the same file path as the output markdown file, raise an error."""
-        FDIR_RENDER = FDIR_TEST_OUTPUT / "test_to_pdf_with_markdown_content"
-        fpth_md = FDIR_RENDER / "test.md"
-        fpth_pdf = FDIR_RENDER / "test.pdf"
-        document_issue = create_test_document_issue()
-        document_issue.format_configuration.output_author = False
-        document_issue.format_configuration.output_checked_by = False
-        with pytest.raises(ValueError):
-            document_issue_md_to_pdf(
-                document_issue=document_issue, fpth_md=fpth_md, fpth_pdf=fpth_pdf
-            )

packages/document-issue-io/tests/testoutput/test_to_file.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project
@@ -48,11 +48,11 @@ Fordham LLP\
 
 ### Contributions
 
-+----------------+-------------------+
-| **Initials**   | **Role**          |
-+================+===================+
-| OH             | RoleEnum.director |
-+----------------+-------------------+
++----------------+--------------------+
+| **Initials**   | **Role**           |
++================+====================+
+| OH             | Director in Charge |
++----------------+--------------------+
 
 : {tbl-colwidths="[30,70]"}
 

packages/document-issue-io/tests/testoutput/test_to_pdf/06667-MXF-XX-XX-SH-M-20003.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project

packages/document-issue-io/tests/testoutput/test_to_pdf_loads_of_notes_and_issues/06667-MXF-XX-XX-SH-M-20003.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project

packages/document-issue-io/tests/testoutput/test_to_pdf_with_author/06667-MXF-XX-XX-SH-M-20003.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project

packages/document-issue-io/tests/testoutput/test_to_pdf_with_author_and_checked_by/06667-MXF-XX-XX-SH-M-20003.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project

packages/document-issue-io/tests/testoutput/test_to_pdf_with_markdown_content/06667-MXF-XX-XX-SH-M-20003.md

@@ -1,5 +1,5 @@
 ---
-project_name: A Max Fordham Project
+project_name: A Max Fordham Project \\& Co
 project_number : 4321
 director_in_charge: OH
 document_description: A description of a Max Fordham Project
@@ -96,7 +96,7 @@ Fordham LLP\
 
 -   convert this notebook to markdown
 -   read `docissue.json`
--   convert using `document_issue_md_to_pdf`
+-   convert using `generate_document_issue_pdf`
 
 ## My Project