Added asciidoctor preview sandbox (#1928) (#1934)

Author: daveoconnor

asciidoctor_sandbox/__init__.py

@@ -0,0 +1,33 @@
+from django.contrib import admin
+from django.contrib.auth import get_user_model
+
+from core.admin_filters import StaffUserCreatedByFilter
+from .models import SandboxDocument
+
+User = get_user_model()
+
+
+@admin.register(SandboxDocument)
+class SandboxDocumentAdmin(admin.ModelAdmin):
+    list_display = ("title", "created_by", "created_at", "updated_at")
+    list_filter = ("created_at", "updated_at", StaffUserCreatedByFilter)
+    search_fields = ("title", "asciidoc_content")
+    readonly_fields = ("created_at", "updated_at", "created_by")
+    ordering = ("-updated_at",)
+    change_form_template = "admin/asciidoctor_sandbox_doc_change_form.html"
+
+    fieldsets = (
+        (None, {"fields": ("title", "asciidoc_content")}),
+        (
+            "Metadata",
+            {
+                "fields": ("created_by", "created_at", "updated_at"),
+                "classes": ("collapse",),
+            },
+        ),
+    )
+
+    def save_model(self, request, obj, form, change):
+        if not change:
+            obj.created_by = request.user
+        super().save_model(request, obj, form, change)

asciidoctor_sandbox/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AsciidoctorSandboxConfig(AppConfig):
+    name = "asciidoctor_sandbox"
+    verbose_name = "Asciidoctor Sandbox"

asciidoctor_sandbox/apps.py

@@ -0,0 +1,4 @@
+# Asciidoctor Sandbox Configuration
+
+# Number of days after which sandbox documents are eligible for cleanup
+ASCIIDOCTOR_SANDBOX_DOCUMENT_RETENTION_DAYS = 365

asciidoctor_sandbox/constants.py

@@ -0,0 +1,16 @@
+import djclick as click
+
+from asciidoctor_sandbox.tasks import cleanup_old_sandbox_documents
+
+
+@click.command()
+def command():
+    """Clean up old sandbox documents based on the configured retention period."""
+    click.echo("Starting sandbox document cleanup...")
+
+    # Run the task synchronously
+    cleanup_old_sandbox_documents()
+
+    click.echo(
+        click.style("Sandbox document cleanup completed successfully.", fg="green")
+    )

asciidoctor_sandbox/management/__init__.py

@@ -0,0 +1,50 @@
+# Generated by Django 4.2.24 on 2025-09-22 22:54
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SandboxDocument",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(help_text="Document title", max_length=200)),
+                (
+                    "asciidoc_content",
+                    models.TextField(blank=True, help_text="Asciidoc source content"),
+                ),
+                ("created_at", models.DateTimeField(default=django.utils.timezone.now)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "created_by",
+                    models.ForeignKey(
+                        help_text="User who created this document",
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["-updated_at"],
+            },
+        ),
+    ]

asciidoctor_sandbox/management/commands/__init__.py

@@ -0,0 +1,26 @@
+from django.db import models
+from django.utils import timezone
+from django.conf import settings
+
+
+class SandboxDocument(models.Model):
+    """Model to store asciidoctor sandbox documents."""
+
+    title = models.CharField(max_length=200, help_text="Document title")
+    asciidoc_content = models.TextField(blank=True, help_text="Asciidoc source content")
+    created_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        on_delete=models.CASCADE,
+        help_text="User who created this document",
+    )
+    created_at = models.DateTimeField(default=timezone.now)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        ordering = ["-updated_at"]
+
+    def __str__(self):
+        return self.title
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} object ({self.pk}): {self}>"