drop esoteric exts, more test cases

fastily · fastily · commit ea7fa571c2da · 2022-10-11T00:59:18.000-07:00
diff --git a/jinja2html/build_context.py b/jinja2html/build_context.py
@@ -19,7 +19,7 @@
 class Context:
     """Collects shared configuration and simple methods for determining which files/directories to watch.  There should only be one instance of this during the program's lifeycle."""
 
-    _FILE_PATTERN = re.compile(r"[^.].*?\.(html|htm|css|js)$", re.IGNORECASE)
+    _FILE_PATTERN = re.compile(r"[^.].*?\.(html|css|js)$", re.IGNORECASE)
 
     def __init__(self, input_dir: Path = Path("."), output_dir: Path = Path("out"), template_dir: str = "templates", ignore_list: set[Path] = set(), dev_mode: bool = False) -> None:
         """Initializer, creates a new `Context`.  For best results, all `Path` type arguments should be absolute (this is automatically done in the initializer, but if you want to change the properties after initializing, make sure you do this).
@@ -102,7 +102,6 @@ def is_content_dir(self, p: Union[Path, str]) -> bool:
         Returns:
             bool: `True` if `p` is a content directory.
         """
-
         return (p := _abs_path_of(p)).is_dir() and \
             p != self.template_dir and self.template_dir not in p.parents and \
             p.name not in DefaultFilter.ignore_dirs and p not in self.ignored_dirs
diff --git a/jinja2html/utils.py b/jinja2html/utils.py
@@ -3,17 +3,16 @@
 from pathlib import Path
 
 
-def _is_ext(f: Path, ext: tuple[str]) -> bool:
-    """Determines whether a file has one of the specified extension(s).
+def _normalized_ext(f: Path) -> str:
+    """Convenience method, gets the file extension of `f` in lowercase
 
     Args:
-        f (Path): The file to check.
-        ext (tuple[str]): The extension(s) to check for.  These should be lower case.
+        f (Path): The file to get the lowercased extension of.
 
     Returns:
-        bool: `True` if `f` has an extension in `ext`.
+        str: The lowercased extension of `f`, if possible
     """
-    return f.suffix.lower() in ext
+    return f.suffix.lower()
 
 
 def is_css_js(f: Path) -> bool:
@@ -25,7 +24,7 @@ def is_css_js(f: Path) -> bool:
     Returns:
         bool: `True` if `f` is a css/js file.
     """
-    return _is_ext(f, (".css", ".js"))
+    return _normalized_ext(f) in (".css", ".js")
 
 
 def is_html(f: Path) -> bool:
@@ -37,4 +36,4 @@ def is_html(f: Path) -> bool:
     Returns:
         bool: `True` if `f` is a jinja file.
     """
-    return _is_ext(f, (".html", ".htm", ".jinja"))
+    return _normalized_ext(f) == ".html"
diff --git a/jinja2html/web_ui.py b/jinja2html/web_ui.py
@@ -135,11 +135,11 @@ async def changed_files_handler(wm: WebsiteManager) -> None:
                     target.unlink()
                 elif wm.context.is_content_dir(p):
                     rmtree(target)
-                else: # rebuild all if user deleted template or config
+                else:  # rebuild all if user deleted template or config
                     # l = wm.find_acceptable_files()
                     build_all = True
                     break
-            
+
             # handle changed/added content files
             elif wm.context.is_content_file(p):
                 l.add(p)
diff --git a/tests/base.py b/tests/base.py
@@ -0,0 +1,12 @@
+"""Shared template `TestCase` classes and methods for use in jinja2html tests"""
+
+from pathlib import Path
+from unittest.case import TestCase
+
+
+class J2hTestCase(TestCase):
+    """Basic template for testing jinja2html"""
+
+    RES_DIR: Path = Path("tests/resources").resolve()  # script is run from the root repo dir
+    SAMPLE_PROJECT: Path = RES_DIR / "sample_project"
+    SAMPLE_TEMPLATES: Path = SAMPLE_PROJECT / "templates"
diff --git a/tests/resources/expected_output/index.html b/tests/resources/expected_output/index.html
@@ -41,6 +41,7 @@ <h1>Hello, World! This is the index page.</h1>
     <ul>
         <li><a href="content1.html">content 1</a></li>
         <li><a href="content2.html">content 2</a></li>
+        <li><a href="sub/index.html">example subpage</a></li>
     </ul>
 </div>
 
diff --git a/tests/resources/expected_output/sub/index.html b/tests/resources/expected_output/sub/index.html
@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
+    
+
+    <title>jinja2html test - subpage 1</title>
+</head>
+
+<body>
+    <header>
+        <nav class="navbar navbar-expand-lg navbar-light bg-light">
+            <div class="container-fluid">
+                <a class="navbar-brand" href="index.html">jinja2html</a>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+                <div class="collapse navbar-collapse" id="navbarNavAltMarkup">
+                    <div class="navbar-nav">
+                        <a class="nav-link active" aria-current="page" href="#">Home</a>
+                        <a class="nav-link" href="#">Features</a>
+                        <a class="nav-link" href="#">Pricing</a>
+                        <a class="nav-link disabled">Disabled</a>
+                    </div>
+                </div>
+            </div>
+        </nav>
+    </header>
+
+    
+
+<div class="container">
+    <h1>this is a subpage!!!!!</h1>
+    <p>:D</p>
+    <p>Click here to go <a href="../index.html">home</a></p>
+</div>
+
+
+
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-ka7Sk0Gln4gmtz2MlQnikT1wXgYsOg+OMhuP+IlRH9sENBO0LRn5q+8nbTov4+1p" crossorigin="anonymous"></script>
+    
+</body>
+
+</html>
diff --git a/tests/resources/sample_project/index.html b/tests/resources/sample_project/index.html
@@ -11,6 +11,7 @@ <h1>Hello, World! This is the index page.</h1>
     <ul>
         <li><a href="content1.html">content 1</a></li>
         <li><a href="content2.html">content 2</a></li>
+        <li><a href="sub/index.html">example subpage</a></li>
     </ul>
 </div>
 {% endraw %}
diff --git a/tests/resources/sample_project/sub/index.html b/tests/resources/sample_project/sub/index.html
@@ -0,0 +1,13 @@
+{% extends 'templates/base.html' %}
+
+{% set title = "subpage 1" %}
+
+{% block content %}
+{% raw %}
+<div class="container">
+    <h1>this is a subpage!!!!!</h1>
+    <p>:D</p>
+    <p>Click here to go <a href="../index.html">home</a></p>
+</div>
+{% endraw %}
+{% endblock %}
diff --git a/tests/test_build_context.py b/tests/test_build_context.py
@@ -0,0 +1,62 @@
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from jinja2html.build_context import Context
+
+from .base import J2hTestCase
+
+
+class TestContext(J2hTestCase):
+    """Test methods supporting the build context"""
+
+    def test_is_stub_of(self):
+        with TemporaryDirectory() as tempdir:
+            c = Context(self.SAMPLE_PROJECT, Path(tempdir))
+
+            self.assertEqual(Path("index.html"), c.stub_of(self.SAMPLE_PROJECT / "index.html"))
+            self.assertEqual(Path("sub/index.html"), c.stub_of(self.SAMPLE_PROJECT / "sub/index.html"))
+            self.assertEqual(Path("shared.js"), c.stub_of(self.SAMPLE_PROJECT / "shared.js"))
+
+    def test_is_some_content(self):
+        with TemporaryDirectory() as tempdir:
+            c = Context(self.SAMPLE_PROJECT, Path(tempdir))
+
+            self.assertTrue(c.is_template(self.SAMPLE_TEMPLATES / "base.html"))
+            self.assertFalse(c.is_template(self.SAMPLE_TEMPLATES / "does-not-exist.html"))
+            self.assertFalse(c.is_template(self.SAMPLE_TEMPLATES / "lol.js"))
+            self.assertFalse(c.is_template(self.SAMPLE_PROJECT / "base.html"))
+            self.assertFalse(c.is_template(self.SAMPLE_PROJECT / "index.html"))
+
+            self.assertTrue(c.is_config_json(self.SAMPLE_PROJECT / "config.json"))
+            self.assertFalse(c.is_config_json(self.SAMPLE_PROJECT / "config.js"))
+            self.assertFalse(c.is_config_json(self.SAMPLE_PROJECT / "sus.json"))
+            self.assertFalse(c.is_config_json(self.SAMPLE_TEMPLATES / "config.json"))
+            self.assertFalse(c.is_config_json(self.SAMPLE_PROJECT / "ok.html"))
+
+            self.assertTrue(c.is_content_file(self.SAMPLE_PROJECT / "index.html"))
+            self.assertTrue(c.is_content_file(self.SAMPLE_PROJECT / "content2.html"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "does-not-exist.js"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "a.css"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "config.js"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "sub"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_TEMPLATES / "base.html"))
+
+            self.assertTrue(c.is_content_dir(self.SAMPLE_PROJECT / "sub"))
+            self.assertFalse(c.is_content_dir(self.SAMPLE_PROJECT / "config.json"))
+            self.assertFalse(c.is_content_dir(self.SAMPLE_PROJECT / "foobar"))
+
+    def test_ignore(self):
+        with TemporaryDirectory() as tempdir:
+            c = Context(self.SAMPLE_PROJECT, Path(tempdir), ignore_list={self.SAMPLE_PROJECT / "sub"})
+
+            self.assertTrue(c.is_content_file(self.SAMPLE_PROJECT / "index.html"))
+            self.assertTrue(c.is_content_file(self.SAMPLE_PROJECT / "content2.html"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "does-not-exist.js"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "a.css"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "config.js"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_PROJECT / "sub"))
+            self.assertFalse(c.is_content_file(self.SAMPLE_TEMPLATES / "base.html"))
+
+            self.assertFalse(c.is_content_dir(self.SAMPLE_PROJECT / "sub"))
+            self.assertFalse(c.is_content_dir(self.SAMPLE_PROJECT / "config.json"))
+            self.assertFalse(c.is_content_dir(self.SAMPLE_PROJECT / "foobar"))
diff --git a/tests/test_core.py b/tests/test_core.py
diff --git a/tests/test_website_manager.py b/tests/test_website_manager.py
@@ -0,0 +1,25 @@
+"""Tests for core modules of jinja2html"""
+
+from filecmp import dircmp
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+from jinja2html.build_context import Context
+from jinja2html.website_manager import WebsiteManager
+
+from .base import J2hTestCase
+
+
+class TestWebsiteManager(J2hTestCase):
+    """Test global methods and classes in core"""
+
+    def test_find_acceptable_files(self):
+        with TemporaryDirectory() as tempdir:
+            self.assertSetEqual({self.SAMPLE_PROJECT / s for s in ("content1.html", "content2.html", "index.html", "sub/index.html", "shared.css", "shared.js")},
+                                WebsiteManager(Context(self.SAMPLE_PROJECT, Path(tempdir))).find_acceptable_files())
+
+    def test_process_files(self):
+        with TemporaryDirectory() as tempdir:
+            WebsiteManager(Context(self.SAMPLE_PROJECT, Path(tempdir))).build_files(auto_find=True)
+
+            self.assertFalse(dircmp(self.RES_DIR / "expected_output", tempdir).diff_files)
