Update tests.

Author: adamghill

coltrane/__init__.py

@@ -81,7 +81,7 @@ def _get_template_tag_module_name(base_dir: Path, file: Path) -> str:
     return module_name
 
 
-def _get_default_template_settings(base_dir: Path):
+def _get_default_template_settings(base_dir: Path) -> List:
     """
     Gets default template settings, including templates and built-in template tags.
     """

coltrane/management/commands/build.py

@@ -10,7 +10,7 @@
 
 from django.conf import settings
 from django.core import management
-from django.core.management.base import BaseCommand, CommandError
+from django.core.management.base import BaseCommand
 
 from halo import Halo
 from log_symbols.symbols import LogSymbols
@@ -168,6 +168,7 @@ def handle(self, *args, **options):
         self.output_result_counts.create_count = 0
         self.output_result_counts.update_count = 0
         self.output_result_counts.skip_count = 0
+        self.errors = []
 
         start_time = time.time()
 
@@ -216,7 +217,6 @@ def handle(self, *args, **options):
                 logger.exception(ex)
 
         spinner.start("Create HTML files")
-        errors = []
 
         with ThreadPoolExecutor(max_workers=self.threads_count) as executor:
             logger.debug(f"Multithread with {self.threads_count} threads")
@@ -243,7 +243,7 @@ def handle(self, *args, **options):
                         error_detail = f"'{error_detail}"
 
                     error_message = f"Rendering {path} failed. {error_detail}"
-                    errors.append(error_message)
+                    self.errors.append(error_message)
 
         result_msg = f"Create {self.output_result_counts.create_count} HTML files, {self.output_result_counts.skip_count} unmodified, {self.output_result_counts.update_count} updated"
 
@@ -256,12 +256,12 @@ def handle(self, *args, **options):
 
         elapsed_time = time.time() - start_time
 
-        for error_message in errors:
+        for error_message in self.errors:
             spinner.fail(error_message)
 
         self.stdout.write()
 
-        if errors:
+        if self.errors:
             self.stderr.write(
                 self.style.ERROR(
                     f"Static site output completed with errors in {elapsed_time:.4f}s\n"

coltrane/manifest.py

@@ -109,10 +109,11 @@ def render_html(self):
         """
 
         # Mock an HttpRequest when generating the HTML for static sites
-        request = StaticRequest(path=self.directory)
+        request = StaticRequest(path=self.directory, META={})
 
         (template, context) = render_markdown(self.slug, request)
         rendered_html = render_to_string(template, context)
+        print("rendered_htmlrendered_htmlrendered_html", rendered_html)
 
         return rendered_html
 

coltrane/renderer.py

@@ -29,6 +29,7 @@ class StaticRequest:
     """
 
     path: str
+    META: Dict
 
 
 def render_markdown_path(path) -> Dict[str, Optional[Dict]]:

coltrane/retriever.py

@@ -41,7 +41,7 @@ def get_data() -> Dict:
     data_directory = get_data_directory()
 
     for path in data_directory.rglob("*.json"):
-        if path.is_file:
+        if path.is_file():
             directory_without_base_and_file_name = (
                 (str(path)).replace(str(data_directory), "").replace(path.name, "")
             )
@@ -81,5 +81,5 @@ def get_content_paths(slug: str = None) -> Iterable[Path]:
     paths = directory.rglob("*.md")
 
     for path in paths:
-        if path.is_file:
+        if path.is_file():
             yield path

coltrane/sitemaps.py

@@ -1,3 +1,5 @@
+from pathlib import Path
+
 from django.contrib.sitemaps import Sitemap
 
 from coltrane.retriever import get_content_paths
@@ -8,10 +10,11 @@ class ContentSitemap(Sitemap):
     priority = 0.5
 
     def items(self):
+        # TODO: This could get cached so it isn't re-generated every time
         return list(get_content_paths())
 
-    def location(self, obj):
-        relative_url = str(obj)[7:-3]
+    def location(self, path: Path):
+        relative_url = str(path)[7:-3]
 
         if relative_url.endswith("/index"):
             relative_url = relative_url[:-6]

coltrane/templates/coltrane/base.html

@@ -1,10 +1,10 @@
 <!DOCTYPE html>
-<html lang="{{ lang|default:"en" }}">
+<html lang="{% if lang %}{{ lang }}{% else %}en{% endif %}">
 
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>{{ title|default:"" }}</title>
+    <title>{% if title %}{{ title }}{% endif %}</title>
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css">
 </head>
 

coltrane/templatetags/coltrane_tags.py

@@ -1,6 +1,7 @@
-from typing import Dict
+from typing import Dict, Union
 
 from django import template
+from django.core.handlers.wsgi import WSGIRequest
 from django.template.base import Node
 from django.template.exceptions import TemplateSyntaxError
 from django.template.loader_tags import construct_relative_path
@@ -17,18 +18,24 @@
 register = template.Library()
 
 
+class NoParentError(Exception):
+    pass
+
+
 @register.simple_tag(takes_context=True)
-def directory_contents(context, directory: str = None) -> Dict[str, str]:
+def directory_contents(
+    context, directory: str = None, exclude: str = None
+) -> Dict[str, str]:
     if not directory:
         request = context["request"]
         directory = request.path
-
-        if directory.startswith("/"):
-            directory = directory[1:]
     elif isinstance(directory, SafeString):
         # Force SafeString to be a normal string so it can be used with `Path` later
         directory = directory + ""
 
+    if directory.startswith("/"):
+        directory = directory[1:]
+
     content_paths = get_content_paths(directory)
     contents = []
 
@@ -42,10 +49,12 @@ def directory_contents(context, directory: str = None) -> Dict[str, str]:
                 content_slug = f"{directory}/{path_slug}"
                 content_directory = content_directory / directory
 
-            directory_without_name = str(path).replace(path.name, "")[:-1]
+            if exclude:
+                if exclude.startswith("/"):
+                    exclude = exclude[1:]
 
-            if str(content_directory) != directory_without_name:
-                continue
+                if exclude == content_slug:
+                    continue
 
             (_, metadata) = get_html_and_markdown(content_slug)
 
@@ -54,6 +63,26 @@ def directory_contents(context, directory: str = None) -> Dict[str, str]:
     return contents
 
 
+@register.filter()
+def parent(path: Union[str, WSGIRequest] = "") -> str:
+    if hasattr(path, "path"):
+        # Handle if a `request` is passed in
+        path = path.path
+
+    path = path.strip()
+
+    if path.endswith("/"):
+        path = path[:-1]
+
+    if path == "":
+        raise NoParentError()
+
+    last_slash_index = path.rindex("/")
+    path = path[:last_slash_index]
+
+    return path
+
+
 class IncludeMarkdownNode(Node):
     """
     Based on: `django.template.loader_tags.IncludeNode`.

coltrane/urls.py

@@ -9,15 +9,15 @@
 
 app_name = "coltrane"
 
+sitemaps = {"content": ContentSitemap}
+
 urlpatterns = []
 
 if settings.DEBUG:
     urlpatterns += [
         path("__reload__/", include("django_browser_reload.urls")),
     ]
 
-sitemaps = {"content": ContentSitemap}
-
 urlpatterns += [
     path(
         "sitemap.xml",

coltrane/utils.py

@@ -44,7 +44,7 @@ def dict_merge(
     return source
 
 
-def threadpool(f, executor=None):
+def threadpool(func):
     """
     A decorator to convert a regular function so that it gets run in another thread.
 
@@ -59,8 +59,8 @@ def threadpool(f, executor=None):
     More details: https://stackoverflow.com/a/14331755
     """
 
-    @wraps(f)
+    @wraps(func)
     def wrap(*args, **kwargs):
-        return (executor or ThreadPoolExecutor()).submit(f, *args, **kwargs)
+        return ThreadPoolExecutor().submit(func, *args, **kwargs)
 
     return wrap