docassemble.AssemblyLine 3.1.0__tar.gz → 3.2.0__tar.gz

{docassemble_assemblyline-3.1.0/docassemble.AssemblyLine.egg-info → docassemble_assemblyline-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docassemble.AssemblyLine
-Version: 3.1.0
+Version: 3.2.0
 Home-page: https://courtformsonline.org
 Author: Suffolk Legal Innovation and Technology Lab
 Author-email: qsteenhuis@suffolk.edu

docassemble_assemblyline-3.2.0/docassemble/AssemblyLine/__init__.py

@@ -0,0 +1 @@
+__version__ = '3.2.0'

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/al_document.py

@@ -35,6 +35,7 @@ from math import floor
 import subprocess
 from collections import ChainMap
 import pikepdf
+from typing import Tuple
 
 __all__ = [
     "ALAddendumField",
@@ -1822,6 +1823,107 @@ class ALDocumentBundle(DAList):
                 editable.append(doc)
         return editable
 
+    def get_cacheable_documents(
+        self,
+        key: str = "final",
+        pdf: bool = True,
+        docx: bool = False,
+        original: bool = False,
+        refresh: bool = True,
+        pdfa: bool = False,
+        include_zip: bool = True,
+        include_full_pdf: bool = False,
+        append_matching_suffix: bool = True,
+    ) -> Tuple[List[Dict[str, DAFile]], Optional[DAFile], Optional[DAFile]]:
+        """
+        Generates a cache of all enabled documents in the bundle, and returns it in a structure that can be cached
+        and returned for use in a background process.
+
+        The result looks like this:
+
+        [
+            {"title": "Document 1", "pdf": DAFile, "docx": DAFile, download_filename: str},
+        ],
+        DAFile, # Zip of whole bundle
+        DAFile # PDF of whole bundle
+
+        Args:
+            key (str): Identifier for the document version, default is "final".
+            pdf (bool): Flag to include a PDF version of each file, default is True.
+            docx (bool): Flag to include a DOCX version of each file, default is False.
+            original (bool): Flag to include the original version of each file, default is False.
+            refresh (bool): Flag to reconsider the 'enabled' attribute, default is True.
+            pdfa (bool): Flag to return documents in PDF/A format, default is False.
+            include_zip (bool): Flag to include a zip option, default is True.
+            include_full_pdf (bool): Flag to include a PDF version of the whole bundle, default is False.
+            append_matching_suffix (bool): Flag to determine if matching suffix should be appended to file name, default is True.
+
+        Returns:
+            Tuple[List[Dict[str, DAFile]], Optional[DAFile], Optional[DAFile]]: A list of dictionaries containing the enabled documents, a zip file of the whole bundle, and a PDF of the whole
+        """
+        # reduce idempotency delays
+        enabled_docs = self.enabled_documents(refresh=refresh)
+        for doc in enabled_docs:
+            doc.title
+
+        results = []
+
+        for doc in enabled_docs:
+            result = {"title": doc.title}
+            filename_root = os.path.splitext(str(doc.filename))[0]
+            if pdf:
+                result["pdf"] = doc.as_pdf(
+                    key=key,
+                    refresh=refresh,
+                    pdfa=pdfa,
+                    append_matching_suffix=append_matching_suffix,
+                )
+                result["download_filename"] = filename_root + ".pdf"
+            if docx and doc._is_docx(key=key):
+                result["docx"] = doc.as_docx(
+                    key=key,
+                    refresh=refresh,
+                    append_matching_suffix=append_matching_suffix,
+                )
+                result["download_filename"] = filename_root + ".docx"
+            if original:
+                result["original"] = doc[key]
+                result["download_filename"] = doc.filename
+
+            try:
+                # If it's possible, set the file extension to the actual filetype
+                # This is mostly necessary if people omit the file extension in attachment block
+                # for filetype="original"
+                if original:
+                    download_doc = result["original"]
+                else:
+                    download_doc = result["docx"]
+                ext = next(
+                    iter(
+                        mimetypes.guess_all_extensions(
+                            download_doc.mimetype, strict=True
+                        )
+                    )
+                )
+                result["download_filename"] = filename_root + ext
+            except:
+                pass
+            results.append(result)
+
+        if len(enabled_docs) > 1 and include_zip:
+            bundled_zip = self.as_zip(
+                key=key, format="original" if original else "docx" if docx else "pdf"
+            )
+        else:
+            bundled_zip = None
+
+        if len(enabled_docs) > 1 and include_full_pdf:
+            bundled_pdf = self.as_pdf(key=key, pdfa=pdfa)
+        else:
+            bundled_pdf = None
+
+        return results, bundled_zip, bundled_pdf
+
     def download_list_html(
         self,
         key: str = "final",
@@ -1838,6 +1940,9 @@ class ALDocumentBundle(DAList):
         zip_icon: str = "file-archive",
         append_matching_suffix: bool = True,
         include_email: bool = False,
+        use_previously_cached_files: bool = False,
+        include_full_pdf: bool = False,
+        full_pdf_label: Optional[str] = None,
     ) -> str:
         """
         Constructs an HTML table displaying a list of documents with 'view' and 'download' buttons.
@@ -1857,6 +1962,9 @@ class ALDocumentBundle(DAList):
             zip_icon (str): Icon for the zip option, default is "file-archive".
             append_matching_suffix (bool): Flag to determine if matching suffix should be appended to file name, default is True.
             include_email (bool): Flag to include an email option, default is False.
+            use_previously_cached_files (bool): Flag to use previously cached files (e.g., made in background) if defined. default is False.
+            include_full_pdf (bool): Flag to include a full PDF option, default is False.
+            full_pdf_label (Optional[str]): Label for the full PDF option. If not provided, uses the generic template for `self.full_pdf_label` ("Download all").
 
         Returns:
             str: HTML representation of a table with documents and their associated actions.
@@ -1864,52 +1972,40 @@ class ALDocumentBundle(DAList):
         if not hasattr(self, "_cached_zip_label"):
             self._cached_zip_label = str(self.zip_label)
 
-        # Trigger some variables up top to avoid idempotency issues
-        enabled_docs = self.enabled_documents(refresh=refresh)
-        for doc in enabled_docs:
-            doc.title
-            if format == "pdf":
-                doc.as_pdf(
-                    key=key,
-                    refresh=refresh,
-                    pdfa=pdfa,
-                    append_matching_suffix=append_matching_suffix,
-                )  # Generate cached file for this session
+        if not hasattr(self, "_cached_full_pdf_label"):
+            self._cached_full_pdf_label = str(self.full_pdf_label)
+
+        if use_previously_cached_files and hasattr(self, "_downloadable_files"):
+            downloadable_files, bundled_zip, bundled_pdf = self._downloadable_files
+        else:
+            downloadable_files, bundled_zip, bundled_pdf = self.get_cacheable_documents(
+                key=key,
+                pdf=(format == "pdf" or view == True),
+                docx=format == "docx",
+                original=format == "original",
+                refresh=refresh,
+                pdfa=pdfa,
+                include_zip=include_zip,
+                include_full_pdf=include_full_pdf,
+                append_matching_suffix=append_matching_suffix,
+            )
 
         html = f'<div class="container al_table al_doc_table" id="{ html_safe_str(self.instanceName) }">'
 
-        for doc in enabled_docs:
-            filename_root = os.path.splitext(str(doc.filename))[0]
-            # Do our best to use the provided filename + the extension from requested filetype
-            if format == "original":
-                download_doc = doc[key]
-                download_filename = doc.filename
-            if format == "docx" and doc._is_docx(key=key):
-                download_doc = doc.as_docx(
-                    key=key, append_matching_suffix=append_matching_suffix
-                )
-                download_filename = filename_root + ".docx"
-            else:
-                download_doc = doc.as_pdf(
-                    key=key, append_matching_suffix=append_matching_suffix
-                )
-                download_filename = filename_root + ".pdf"
+        for result in downloadable_files:
+            title = result["title"]
+            download_filename = result.get("download_filename", "document")
 
-            try:
-                # If it's possible, set the file extension to the actual filetype
-                # This is mostly necessary if people omit the file extension in attachment block
-                # for filetype="original"
-                ext = next(
-                    iter(
-                        mimetypes.guess_all_extensions(
-                            download_doc.mimetype, strict=True
-                        )
-                    )
-                )
-                download_filename = filename_root + ext
-            except:
-                pass
+            if format == "original" and "original" in result:
+                download_doc = result["original"]
+            elif format == "docx" and "docx" in result:
+                download_doc = result["docx"]
+            elif "pdf" in result:
+                download_doc = result["pdf"]
+            else:
+                continue  # Skip if the desired format is not available
 
+            # Construct the download button
             doc_download_button = action_button_html(
                 download_doc.url_for(
                     attachment=True, display_filename=download_filename
@@ -1920,12 +2016,14 @@ class ALDocumentBundle(DAList):
                 size="md",
                 classname="al_download al_button",
             )
-            if view and doc.as_pdf().url_for().endswith(".pdf"):
+
+            # Construct the view button if needed
+            if view and "pdf" in result and result["pdf"].url_for().endswith(".pdf"):
+                # Use .pdf as the filename extension
+                view_filename = os.path.splitext(download_filename)[0] + ".pdf"
                 doc_view_button = action_button_html(
-                    doc.as_pdf(key=key).url_for(
-                        attachment=False,
-                        display_filename=filename_root + ".pdf",
-                        append_matching_suffix=append_matching_suffix,
+                    result["pdf"].url_for(
+                        attachment=False, display_filename=view_filename
                     ),
                     label=view_label,
                     icon=view_icon,
@@ -1936,31 +2034,47 @@ class ALDocumentBundle(DAList):
                 buttons = [doc_view_button, doc_download_button]
             else:
                 buttons = [doc_download_button]
-            html += table_row(doc.title, buttons)
 
-        # Add a zip file row if there's more than one doc
-        filename_root = os.path.splitext(str(self.filename))[0]
-        if len(enabled_docs) > 1 and include_zip:
+            html += table_row(title, buttons)
+
+        # Add a zip file row if included
+        if include_zip and bundled_zip:
             if not zip_label:
                 zip_label = self._cached_zip_label
-            # Zip file will match the format of the download table
-            zip = self.as_zip(key=key, format=format, include_pdf=view)
+            filename_root = os.path.splitext(str(self.filename))[0]
             zip_button = action_button_html(
-                zip.url_for(attachment=False, display_filename=filename_root + ".zip"),
+                bundled_zip.url_for(
+                    attachment=False, display_filename=filename_root + ".zip"
+                ),
                 label=zip_label,
                 icon=zip_icon,
                 color="primary",
                 size="md",
                 classname="al_zip al_button",
             )
-            html += table_row(zip.title, zip_button)
+            html += table_row(zip_label, zip_button)
+
+        if include_full_pdf and bundled_pdf:
+            if not full_pdf_label:
+                full_pdf_label = self._cached_full_pdf_label
+            filename_root = os.path.splitext(str(self.filename))[0]
+            full_pdf_button = action_button_html(
+                bundled_pdf.url_for(
+                    attachment=False, display_filename=filename_root + ".pdf"
+                ),
+                label=full_pdf_label,
+                icon="file-pdf",
+                color="primary",
+                size="md",
+                classname="al_full_pdf al_button",
+            )
+            html += table_row(full_pdf_label, full_pdf_button)
 
         if include_email:
             html += self.send_email_table_row(key=key)
 
         html += "\n</div>"
 
-        # Discuss: Do we want a table with the ability to have a merged pdf row?
         return html
 
     def download_html(

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/data/questions/al_document.yml

@@ -88,9 +88,85 @@ template: x.zip_label
 content: |
   Download all
 ---
+generic object: ALDocumentBundle
+template: x.full_pdf_label
+content: |
+  Download as one PDF
+---
 id: al exhibit ocr pages bg
 event: al_exhibit_ocr_pages
 code: |
   to_pdf = action_argument('to_pdf')
   from_file = action_argument('from_file')
-  background_response(ocrmypdf_task(from_file, to_pdf))
+  background_response(ocrmypdf_task(from_file, to_pdf))
+---
+############## Background document assembly #################
+---
+generic object: ALDocumentBundle
+code: |
+  x.generate_downloads_task = background_action(x.attr_name('create_downloads'))
+---
+generic object: ALDocumentBundle
+event: x.create_downloads
+code: |
+  download_response = x.get_cacheable_documents(key="final", pdf=True, include_full_pdf=True)
+  background_response_action(x.attr_name('save_downloads'), download_response=download_response)
+---
+generic object: ALDocumentBundle
+code: |
+  x.generate_downloads_with_docx_task = background_action(x.attr_name('create_downloads_with_docx'))
+---
+generic object: ALDocumentBundle
+event: x.create_downloads_with_docx
+code: |
+  download_response = x.get_cacheable_documents(key="final", pdf=True, docx=True, include_full_pdf=True)
+  background_response_action(x.attr_name('save_downloads'), download_response=download_response)
+---
+generic object: ALDocumentBundle
+event: x.save_downloads
+code: |
+  x._downloadable_files = action_argument('download_response')
+
+  background_response()
+---
+id: waiting screen
+question: |
+  Please wait while we make your documents
+subquestion: |
+  This can take a few minutes.
+
+  <div class="spinner-border text-primary d-flex justify-content-center" role="status">
+      <span class="sr-only">Making documents...</span>
+  </div>
+event: al_download_waiting_screen
+reload: True
+---
+########## Background preview assembly ################
+---
+generic object: ALDocumentBundle
+code: |
+  x.generate_preview_task = background_action(x.attr_name('generate_preview_event'))
+---
+generic object: ALDocumentBundle
+event: x.generate_preview_event
+code: |
+  preview_response = x.as_pdf(key="preview")
+  background_response_action(x.attr_name('save_preview'), preview_response=preview_response)
+---
+generic object: ALDocumentBundle
+event: x.save_preview
+code: |
+  x._preview_file = action_argument('preview_response')
+  background_response()
+---
+id: preview waiting screen
+question: |
+  Please wait while we generate a preview of your document
+subquestion: |
+  This can take a few minutes.
+
+  <div class="spinner-border text-primary d-flex justify-content-center" role="status">
+      <span class="sr-only">Generating preview...</span>
+  </div>
+event: al_preview_waiting_screen
+reload: True

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/data/questions/al_visual.yml

@@ -163,17 +163,34 @@ code: |
   package_name = str(user_info().package)
 ---
 code: |
+  # github_repo_name is used to direct issue feedback to the right repository
+  # Normally you will customize this in your package
   if package_name and not "playground" in package_name:
     github_repo_name = package_name.replace('.','-')
   else:    
     github_repo_name = "docassemble-AssemblyLine"
 ---
 code: |
-  # Username or organization name for Github repositories
-  # Used to direct feedback to the right place and to check for
-  # the last commit date.
+  # github_about_repo_name is used to lookup the last commit date on the default about page
+  # defaults to the same value as github_repo_name
+  github_about_repo_name = github_repo_name
+---
+code: |
+  # github_user is the `username` or `organization name` part of the URL
+  # on github where you want the feedback form to create issues. I.e., the owner of that repository.
+
+  # Example: if you want issues to appear on a repository at https://github.com/suffolklitlab/docassemble-AssemblyLine,
+  # then `github_user` should be `suffolklitlab`
+
+  # defaults to the "default repository owner" value in the global configuration, under the "github issues" section
+  
   github_user = get_config("github issues",{}).get("default repository owner","").strip() or "suffolklitlab"
 ---
+code: |
+  # github_about_user is used to lookup the last commit date on the default about page
+  # defaults to the same value as github_user
+  github_about_user = github_user
+---
 code: |
   feedback_form = "docassemble.AssemblyLine:feedback.yml"
 ---
@@ -347,7 +364,7 @@ code: |
   github_url = "https://github.com/" + github_user + "/" + github_repo_name
 ---
 code: |
-  res = github_modified_date(github_user, github_repo_name)
+  res = github_modified_date(github_about_user, github_about_repo_name)
   if res:
     package_updated_on = res.format('yyyy-MM-dd')
   else:

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/data/questions/demo_search_sessions.yml

@@ -25,9 +25,20 @@ subquestion: |
   Searching is not case sensitive.
 fields:
   - Keyword: search_keyword
+  - Limit metadata column: limit_column_name
+    required: False
+  - To value: limit_column_value
+    required: False  
 ---
 code: |
-  matching_results = find_matching_sessions(search_keyword, user_id="all")
+  if limit_column_name:
+    matching_results = find_matching_sessions(
+      search_keyword, user_id="all", metadata_filters = {
+        limit_column_name: (limit_column_value, "ILIKE")
+      }
+      )
+  else:
+    matching_results = find_matching_sessions(search_keyword, user_id="all")
 ---
 event: no_matches
 question: |

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/data/questions/interview_list.yml

@@ -132,6 +132,7 @@ code: |
 sections:
   - section_in_progress_forms: In progress forms
   - section_answer_sets: Answer sets
+  - section_search: Search
 progressive: False
 ---
 # A code block is the only way to show navigation with custom labels (mako isn't allowed in `sections`)
@@ -144,7 +145,10 @@ code: |
         },
         {
           "section_answer_sets": ANSWER_SETS_TITLE or word("Answer sets")
-        }
+        },
+        {
+          "section_search": word("Search")
+        },
         ]
   )
 ---
@@ -261,6 +265,10 @@ subquestion: |
   documents.
   % endif
 
+  % if showifdef("limit_filename") or showifdef("search_keyword"):
+  ${ session_list_html(answers = find_matching_sessions(filenames={limit_filename} if limit_filename else None, keyword=search_keyword), filename=None, limit=20, offset=session_page*20, exclude_filenames=al_sessions_to_exclude_from_interview_list, exclude_newly_started_sessions=True) }
+
+  % else:
   ${ session_list_html(filename=None, limit=20, offset=session_page*20, exclude_filenames=al_sessions_to_exclude_from_interview_list, exclude_newly_started_sessions=True) }
 
   <nav aria-label="Page navigation">
@@ -273,8 +281,12 @@ subquestion: |
   % endif
     </ul>
   </nav>  
-  % else:
-  You do not have any current forms in progress
+  % endif
+
+  % endif
+
+  % if showifdef("limit_filename") or showifdef("search_keyword"):
+  ${ action_button_html(url_action("delete_results_action"), label=word("Clear search results"), size="md", color="secondary", icon="times-circle", id_tag="al-clear-search-results") }
   % endif
 # TODO: might be able to save some DB queries here but performance is good
 section: section_in_progress_forms
@@ -304,6 +316,25 @@ script:
       });
   </script>
 ---
+continue button field: section_search
+section: section_search
+question: |
+  Search
+  % if PAGE_QUESTION:
+  ${ str(PAGE_QUESTION).lower() }
+  % else:
+  in progress forms 
+  % endif
+subquestion: |
+  Use a keyword to find results that match the title or description of the session.
+fields:
+  - Limit by form title (optional): limit_filename
+    required: False
+    code: |
+      get_combined_filename_list()
+  - Search term (optional): search_keyword
+    required: False
+---
 event: section_answer_sets
 id: answer set list
 question: |
@@ -441,3 +472,8 @@ code: |
           ),
       )
   )
+---
+event: delete_results_action
+code: |
+  undefine("limit_filename")
+  undefine("search_keyword")

docassemble_assemblyline-3.2.0/docassemble/AssemblyLine/data/questions/test_aldocument_background_assembly.yml

@@ -0,0 +1,65 @@
+---
+include:
+  - assembly_line.yml
+---
+metadata:
+  title: ALDocument Background Processing
+---
+mandatory: True
+code: |
+  intro_screen
+  if not al_user_bundle.generate_preview_task.ready():
+    al_preview_waiting_screen
+  preview_screen
+  # if not al_user_bundle.generate_downloads_task.ready(): # Without DOCX
+  if not al_user_bundle.generate_downloads_with_docx_task.ready(): # With DOCX
+    al_download_waiting_screen
+  download_screen
+---
+continue button field: intro_screen
+question: |
+  Intro screen
+---
+id: preview_screen
+continue button field: preview_screen
+question: |
+  Preview the documents
+subquestion: |
+  Your documents are ready for preview.
+
+  Click the thumbnail below to view the preview of your documents. It will open in a new tab.
+
+  ${ al_user_bundle._preview_file }
+---
+id: download
+event: download_screen
+question: |
+  Download the documents
+subquestion: |
+  Your documents are ready for download.
+
+  ${ al_user_bundle.download_list_html(use_previously_cached_files=True, include_full_pdf=True) }
+---
+objects:
+  - al_user_bundle: ALDocumentBundle.using(
+          elements = [pdf_1, docx_1],
+          title = "Background processed bundle",
+          enabled = True,
+          filename = "background_processed_bundle",
+        )
+---
+objects:
+  - pdf_1: ALDocument.using( title="PDF 1 with a lot of text for the title of this document", filename="pdf_doc_1", enabled=True, has_addendum=False )
+  - docx_1: ALDocument.using( title="Docx 1 also with a lot of text for the title of this document", filename="docx_doc_1", enabled=True, has_addendum=False )
+---
+attachment: 
+  variable name: pdf_1[i]
+  pdf template file: test_aldocument_pdf_1.pdf
+  filename: pdf_1
+  fields:
+    - "sample_field": "Sample input"
+---
+attachment: 
+  variable name: docx_1[i]
+  docx template file: test_aldocument_docx_1.docx
+  filename: docx_1

{docassemble_assemblyline-3.1.0 → docassemble_assemblyline-3.2.0}/docassemble/AssemblyLine/requirements.txt

@@ -5,4 +5,5 @@ pandas-stubs
 sqlalchemy[mypy]
 types-PyYAML
 PyGithub
-types-requests
+types-requests
+types-psycopg2