Customize base template (carltongibson#6)

kasun · Jun 20, 2023 · 64de4c5 · 64de4c5
1 parent 01ed67e
commit 64de4c5
Show file tree

Hide file tree

Showing 11 changed files with 70 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ docs/build
 neapolitan.code-workspace
 .coverage
 dist
+.DS_Store
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -100,8 +100,9 @@ Finally, start the runserver and in the admin, add a few ``Project`` objects to
 Wire up Neapolitan views
 ------------------------
 
-Neapolitan expects to extend a base template (its own templates use
-``{% extends "base.html" %}`` so you'll have to provide one at ``dashboard/templates/base.html``::
+Neapolitan expects to extend a base template called ``base.html``.
+So you'll have to provide one at ``dashboard/templates/base.html`` or override the base template by defining a class attribute called ``base_template`` in your view classes.
+The base template needs to have a block called ``content``::
 
     {% block content %}{% endblock %}
 

diff --git a/src/neapolitan/templates/neapolitan/object_confirm_delete.html b/src/neapolitan/templates/neapolitan/object_confirm_delete.html
@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends base_template %}
 
 {% block content %}
 

diff --git a/src/neapolitan/templates/neapolitan/object_detail.html b/src/neapolitan/templates/neapolitan/object_detail.html
@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends base_template %}
 {% load neapolitan %}
 
 {% block content %}

diff --git a/src/neapolitan/templates/neapolitan/object_form.html b/src/neapolitan/templates/neapolitan/object_form.html
@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends base_template %}
 
 {% block content %}
 

diff --git a/src/neapolitan/templates/neapolitan/object_list.html b/src/neapolitan/templates/neapolitan/object_list.html
@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends base_template %}
 {% load neapolitan %}
 
 {% block content %}

diff --git a/src/neapolitan/views.py b/src/neapolitan/views.py
@@ -64,6 +64,10 @@ class CRUDView(View):
     CRUDView is Neapolitan's core. It provides the standard list, detail,
     create, edit, and delete views for a model, as well as the hooks you need to
     be able to customise any part of that.
+
+    Following attributes can be overridden by defining in extending view classes or by passing to as_view():
+
+    * base_template: Base template that Neapolitan extends from. If not defined defaults to ``base.html``.
     """
 
     role: Role
@@ -95,6 +99,8 @@ class CRUDView(View):
     # Suffix that should be appended to automatically generated template names.
     template_name_suffix = None
 
+    base_template = "base.html"
+
     # Filtering.
 
     def get_filterset(self, queryset=None):
@@ -248,6 +254,7 @@ def get_context_data(self, **kwargs):
         kwargs["object_verbose_name"] = self.model._meta.verbose_name
         kwargs["object_verbose_name_plural"] = self.model._meta.verbose_name_plural
         kwargs["create_view_url"] = reverse(f"{self.model._meta.model_name}-create")
+        kwargs["base_template"] = self.base_template
 
         if getattr(self, "object", None) is not None:
             kwargs["object"] = self.object

diff --git a/tests/migrations/0002_project.py b/tests/migrations/0002_project.py
@@ -0,0 +1,28 @@
+# Generated by Django 4.2.2 on 2023-06-20 11:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Project",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=25)),
+            ],
+        ),
+    ]
diff --git a/tests/models.py b/tests/models.py
@@ -6,3 +6,7 @@ class Bookmark(models.Model):
     title = models.CharField(max_length=255)
     note = models.TextField(blank=True)
     favourite = models.BooleanField(default=False)
+
+
+class Project(models.Model):
+    name = models.CharField(max_length=25)
diff --git a/tests/templates/custom_base.html b/tests/templates/custom_base.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <title>Custom Base Template</title>
+    </head>
+    <body>
+        {% block content %}{% endblock %}
+    </body>
+</html>
diff --git a/tests/tests.py b/tests/tests.py
@@ -4,7 +4,7 @@
 
 from neapolitan.views import CRUDView
 
-from .models import Bookmark
+from .models import Bookmark, Project
 
 
 class BookmarkView(CRUDView):
@@ -15,7 +15,13 @@ class BookmarkView(CRUDView):
     ]
 
 
-urlpatterns = [] + BookmarkView.get_urls()
+class ProjectView(CRUDView):
+    model = Project
+    fields = ["name"]
+    base_template = "custom_base.html"
+
+
+urlpatterns = [] + BookmarkView.get_urls() + ProjectView.get_urls()
 
 
 class BasicTests(TestCase):
@@ -122,3 +128,9 @@ def test_filter(self):
         self.assertContains(response, self.homepage.title)
         self.assertNotContains(response, self.github.title)
         self.assertNotContains(response, self.fosstodon.title)
+
+    def test_custom_base_template(self):
+        """Test that base template can be customized per view"""
+        response = self.client.get("/project/")
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "<title>Custom Base Template</title>")