Add Wiki

bin/test.sh

@@ -28,7 +28,9 @@ then
     echo "djlint --check ran successfully"
 else
     echo "There was an error running djlint --check"
-    uv run djlint --reformat "$target"
+    if uv run djlint --reformat "$target"; then
+        echo "djlint reformatted"
+    fi
     if ! uv run djlint --check "$target"; then
         echo "Couldn't fix with djlint --reformat"
         exit 1

docs/styleguide.md

@@ -307,6 +307,42 @@ def log_in_first(request: AuthenticatedHttpRequest) -> HttpResponse: ...
 - To style templates, Projectify uses [Tailwind version 3](https://v3.tailwindcss.com/). Refer to the tailwind
 configuration at `tailwind.config.js`.
 
+### Partial defs
+
+Use Django `partialdef` like so:
+
+```html
+{% partialdef button %}
+  <button>Hello {{ name }}</button>
+{% endpartialdef %}
+
+{% partial button %}
+```
+
+With `context={"name": "world"}`, this becomes the following:
+
+```html
+  <button>Hello world</button>
+```
+
+Pass arguments with `{% with %}`:
+
+```html
+{% partialdef button %}
+  <button>Hello {{ name }}</button>
+{% endpartialdef %}
+
+{% with name="foobar" %}
+{% partial button %}
+{% endwith
+```
+
+This becomes the following:
+
+```html
+  <button>Hello foobar</button>
+```
+
 ## Template includes
 
 ### Submit button

projectify/blog/templates/blog/blog_base.html

@@ -5,9 +5,7 @@
 {% extends "base.html" %}
 {% block body %}
     <div class="flex grow flex-col">
-        {% block storefront_header %}
-            {% include "common/navigation/header/landing.html" %}
-        {% endblock storefront_header %}
+        {% include "common/navigation/header/landing.html" %}
         <div class="mx-auto px-4 py-8 w-full container">
             {% block blog_content %}
             {% endblock blog_content %}

projectify/blog/tests/test_views.py

@@ -4,7 +4,7 @@
 """Test blog views."""
 
 from django.core.files.storage import default_storage
-from django.core.files.uploadedfile import SimpleUploadedFile, UploadedFile
+from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import Client
 from django.urls import reverse
 
@@ -55,8 +55,10 @@ def test_post_draft_others_cant_view(
     post.draft = True
     post.save()
     url = reverse("blog:post_draft_preview", args=[post.slug])
+    # Regular user
     response = user_client.get(url)
     assert response.status_code == 302
+    # Not logged-in user
     response = client.get(url)
     assert response.status_code == 302
 
@@ -70,7 +72,9 @@ def test_post_detail_redirect(client: Client, post: Post) -> None:
 
 
 def test_uploading_attachments(
-    superuser_client: Client, uploaded_file: UploadedFile, png_image: bytes
+    superuser_client: Client,
+    uploaded_file: SimpleUploadedFile,
+    png_image: bytes,
 ) -> None:
     """Test that superuser can upload files and view them, too."""
     url = reverse("blog:upload_attachment")
@@ -86,15 +90,15 @@ def test_uploading_attachments(
 
 
 def test_upload_attachment_regular_user_cannot_upload(
-    user_client: Client, uploaded_file: UploadedFile
+    user_client: Client, uploaded_file: SimpleUploadedFile
 ) -> None:
     """Test that regular users cannot upload files."""
     url = reverse("blog:upload_attachment")
     assert user_client.post(url, {"file": uploaded_file}).status_code == 403
 
 
 def test_upload_attachment_anonymous_user_cannot_upload(
-    client: Client, uploaded_file: UploadedFile
+    client: Client, uploaded_file: SimpleUploadedFile
 ) -> None:
     """Test that anonymous users cannot upload files."""
     url = reverse("blog:upload_attachment")
@@ -123,7 +127,7 @@ def test_post_feed_accessible(client: Client, post: Post) -> None:
 
 
 def test_serve_picture(
-    client: Client, uploaded_file: UploadedFile, png_image: bytes
+    client: Client, uploaded_file: SimpleUploadedFile, png_image: bytes
 ) -> None:
     """Test that serve_picture returns an uploaded file."""
     # Missing file

projectify/blog/views.py

@@ -23,7 +23,7 @@
 from django.shortcuts import render
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
-from django.views.decorators.http import require_http_methods
+from django.views.decorators.http import require_GET, require_http_methods
 
 from django_sendfile import sendfile
 
@@ -84,8 +84,11 @@ def sanitize_blog_picture_path(picture_name: str) -> Optional[str]:
     return str(Path("blog") / picture_name)
 
 
+@require_GET
 def serve_picture(request: HttpRequest, name: str) -> HttpResponse:
     """Serve a blog picture using sendfile."""
+    # XXX because the url pattern is serve-picture/<str:name>
+    # this can never contain slashes. We may not require the following:
     full_path = sanitize_blog_picture_path(name)
     if full_path is None or not default_storage.exists(str(full_path)):
         logger.warning("Picture with name %s not found at %s", name, full_path)

projectify/conftest.py

@@ -54,16 +54,19 @@
     user_invite_redeem,
 )
 from projectify.workspace.models import (
+    Attachment,
     Project,
     Task,
     TeamMember,
     TeamMemberInvite,
     TeamMemberRoles,
+    WikiPage,
     Workspace,
 )
 from projectify.workspace.selectors.team_member import (
     team_member_find_for_workspace,
 )
+from projectify.workspace.services.attachment import attachment_create
 from projectify.workspace.services.project import (
     project_archive,
     project_create,
@@ -72,6 +75,7 @@
 from projectify.workspace.services.team_member_invite import (
     team_member_invite_create,
 )
+from projectify.workspace.services.wiki import wiki_page_get_or_create_index
 from projectify.workspace.services.workspace import (
     workspace_add_user,
     workspace_create,
@@ -463,6 +467,14 @@ def unrelated_task(
     )
 
 
+@pytest.fixture
+def attachment(
+    team_member: TeamMember, uploaded_file: SimpleUploadedFile
+) -> Attachment:
+    """Return an attachment uploaded by the normal user."""
+    return attachment_create(who=team_member, file=uploaded_file)
+
+
 @pytest.fixture
 def unpaid_customer(workspace: Workspace) -> Customer:
     """Create customer."""
@@ -510,11 +522,23 @@ def post(faker: Faker, now: datetime, post_content: PostContent) -> Post:
     """Return a blog post."""
     title = faker.sentence()
     return Post.objects.create(
-        title=title, slug=faker.slug(), body=post_content, published=now.date()
+        title=title,
+        slug=faker.slug(),
+        body=post_content,
+        published=now.date(),
+        author=faker.name(),
     )
 
 
 @pytest.fixture
 def null_uuid() -> UUID:
     """Create an all-null UUID."""
     return UUID(int=0)
+
+
+@pytest.fixture
+def wiki_page(workspace: Workspace, team_member: TeamMember) -> WikiPage:
+    """Return a wiki index page."""
+    return wiki_page_get_or_create_index(
+        workspace=workspace, who=team_member.user
+    )

projectify/context_processors.py

@@ -3,22 +3,36 @@
 # SPDX-FileCopyrightText: 2021, 2023 JWP Consulting GK
 """Projectify context processors."""
 
+from dataclasses import asdict
 from typing import Mapping
 
-from django.conf import settings
 from django.http import HttpRequest
+from django.urls.resolvers import ResolverMatch
 
-
-def frontend_url(request: object) -> Mapping[str, str]:
-    """Add FRONTEND_URL to context."""
-    return {"FRONTEND_URL": settings.FRONTEND_URL}
+from projectify.lib.settings import get_settings
+from projectify.settings.types import FeatureFlags
 
 
 def show_go_to_dashboard(request: HttpRequest) -> Mapping[str, bool]:
     """Tell header nav that it can show "Go to dashboard"."""
-    match = request.resolver_match
-    if not match:
-        return {}
-    if not match.app_names:
-        return {}
-    return {"show_go_to_dashboard": match.app_names[0] != "dashboard"}
+    match request.resolver_match:
+        case None:
+            return {}
+        case ResolverMatch(app_names=[]):
+            return {}
+        case ResolverMatch(app_names=["dashboard", *_]):
+            result = False
+        case ResolverMatch(app_names=[*_]):
+            result = True
+    return {"show_go_to_dashboard": result}
+
+
+def feature_flags(request: HttpRequest) -> Mapping[str, Mapping[str, bool]]:
+    """Pass feature flags to frontend."""
+    del request
+    settings = get_settings()
+    # defensive programming so that this function doesn't return some other
+    # important or secret stuff from the settings
+    match settings.FEATURE_FLAGS:
+        case FeatureFlags() as flags:
+            return {"feature_flags": asdict(flags)}

projectify/corporate/test/views/test_stripe.py

@@ -133,7 +133,7 @@ def test_customer_subscription_deleted(
         event["data"]["object"].customer = paid_customer.stripe_customer_id
         stripe_client.return_value.construct_event.return_value = event
 
-        with django_assert_num_queries(2):
+        with django_assert_num_queries(5):
             response = client.post(resource_url, headers=headers)
         assert response.status_code == 200, response.content
         paid_customer.refresh_from_db()

projectify/help/markdown_en/quota.md

@@ -4,43 +4,47 @@ SPDX-FileCopyrightText: 2024 JWP Consulting GK
 SPDX-License-Identifier: AGPL-3.0-or-later
 -->
 
-# What are quotas
+# What are usage quotas
 
-Depending on whether you have a paid workspace or a trial workspace, different
-usage quotas will apply. Usage quotas determine how many items of a resouce you
+Different usage quotas apply depending on whether you have a paid or a
+[trial workspace](/help/trial).
+Usage quotas determine how many items of a resource you
 can create within your workspace. Resources within your workspace are:
 
 - Team members and invitations
+- Wiki pages
 - Projects
 - Tasks
+- Attachments
 
 # Quotas for paid workspaces
 
-The only quota that applies to a paid workspace is how many team members you
-can add and how many pending invites for new team members you have. These
-two values are added together and compared with the number of seats you have
-remaining in your workspace. For example, if you have a workspace with 10
-seats, then
+Paid workspaces have the following usage quotas:
 
-- if you have 8 team members and 1 pending invitation, you can invite or add
-  one more team member
-- if you have 8 team members and 2 pending invitations, you can not invite
-  or add any more team members
+- You can invite team members as long as your workspace has empty seats.
+  Pending invitations take up seats, too. Example: If your workspace has 10
+  seats, your workspace can host 8 team members and have 2 pending
+  invitiations.
+- You can upload up to 100 MiB in attachments in total. Example: If you
+have 2 x 40 MiB attachments your total is 80 MiB. You can then upload
+one 20 MiB attachment.
 
-If you would like to add more seats to your workspace, please review your
-workspace billing settings in the dashboard. For more information on how to
-change the billing settings, please refer to the [billing help](/help/billing).
+To add more seats to your workspace, update your
+workspace billing settings. To learn how to
+update your workspace biling settings, refer to the [billing help](/help/billing).
 
-# Quotas for trial workspaces
+# Usage quotas for trial workspaces
 
-In a trial workspace, the following quotas apply:
+Trial workspaces have the following usage quotas:
 
 - You can invite and add up to 1 additional team member, for a total of 2
   including yourself.
+- You can create up to 25 wiki pages
 - You can create up to 10 projects
 - You can create up to 1000 tasks
+- You can not upload any attachments
 
-If you would like to create more items, and invite more users to your
-workspace, you can upgrade to a paid workspace from the workspace billing
+To create more items, invite more users, or upload attachments to your
+workspace, upgrade to a paid workspace from the workspace billing
 settings. For more information on how to upgrade to paid workspace, please
 refer to the [billing help](/help/billing).

projectify/lib/forms.py

@@ -52,7 +52,7 @@ def get_image_format(file: UploadedFile) -> Optional[str]:
 class RichTextEditor(Textarea):
     """Rich text editor widget for prose's RichTextField."""
 
-    template_name = "common/trix-editor.html"
+    template_name = "projectify/widgets/trix-editor.html"
 
     def __init__(
         self,

projectify/lib/models.py

@@ -6,10 +6,17 @@
 import datetime
 from collections.abc import Iterable, Sequence
 from typing import Any, Callable, Optional
+from uuid import uuid4
 
 from django import forms
 from django.conf import settings
-from django.db.models import CharField, DateTimeField, Model, TextField
+from django.db.models import (
+    CharField,
+    DateTimeField,
+    Model,
+    TextField,
+    UUIDField,
+)
 from django.utils import safestring
 from django.utils.html import strip_tags
 from django.utils.translation import gettext_lazy as _
@@ -140,7 +147,12 @@ class BaseModel(Model):
 
     created = CreationDateTimeField(verbose_name=_("created"))
     modified = ModificationDateTimeField(verbose_name=_("modified"))
-    # TODO add full_clean() on save()
+
+    def save(self, *args: Any, **kwargs: Any) -> None:
+        """Run full_clean()."""
+        # At the time of writing, this applies to _all_ Projectify models
+        self.full_clean()
+        return super().save(*args, **kwargs)
 
     class Meta:
         """Make this model abstract."""
@@ -149,6 +161,17 @@ class Meta:
         get_latest_by = "modified"
 
 
+class BaseModelUUID(BaseModel):
+    """BaseModel with an additional hidden uuid field."""
+
+    uuid = UUIDField(unique=True, default=uuid4, editable=False)
+
+    class Meta:
+        """Make this model abstract."""
+
+        abstract = True
+
+
 # SPDX-SnippetBegin
 # SPDX-License-Identifier: MIT
 # SPDX-SnippetCopyrightText: 2022 LOGIC SMPC <paris@withlogic.co>