Merge pull request #53 from toggle-corp/feature/daily-standup

Feature/daily standup

Author: thenav56

apps/common/factories.py

@@ -0,0 +1,13 @@
+# pyright: reportPrivateImportUsage=false
+# pyright: reportIncompatibleVariableOverride=false
+import factory
+from factory.django import DjangoModelFactory
+
+from .models import Event
+
+
+class EventFactory(DjangoModelFactory):
+    name = factory.Sequence(lambda n: f"Event-{n}")
+
+    class Meta:
+        model = Event

apps/common/models.py

@@ -82,7 +82,7 @@ class GoogleCalendarSyncStatus(models.IntegerChoices):
 
     @typing.override
     def __str__(self):
-        return self.name
+        return f"{self.name} - {self.get_type_display()}"
 
     @typing.override
     def save(self, *args, **kwargs):
@@ -181,6 +181,28 @@ def aget_last_working_date(
     ) -> datetime.date:  # type: ignore[reportReturnType]
         return cls.get_last_working_date(now_date, skip_dates=skip_dates, offset_count=offset_count)
 
+    @classmethod
+    def get_next_working_date(
+        cls,
+        now_date: datetime.date,
+        skip_dates: list[datetime.date] | None = None,
+        offset_count: int | None = None,
+    ) -> datetime.date:  # type: ignore[reportReturnType]
+        # TODO: Add test
+        dates_to_skip = set(cls.get_relative_event_dates())
+        if skip_dates:
+            dates_to_skip.update(skip_dates)
+        found_count = 0
+        for x in range(30):  # Create a 1 month window, Should be enough
+            date = now_date + datetime.timedelta(days=x)
+            if cls.is_weekend(date) or date in dates_to_skip:
+                continue
+            if offset_count is not None and found_count < offset_count:
+                found_count += 1
+                continue
+            return date
+        return timezone.now()  # XXX: Fallback to now
+
     @classmethod
     def get_relative_non_working_events(cls) -> models.QuerySet["Event"]:
         """

apps/project/admin.py

@@ -43,6 +43,7 @@ class DeadlineAdmin(VersionAdmin, UserResourceAdmin):
         AutocompleteFilterFactory("Project", "project"),
         AutocompleteFilterFactory("Contract", "contract"),
     )
+    autocomplete_fields = ("contract", "project")
     actions = [sync_with_google_calendar]
 
     @typing.override

apps/standup/admin.py

@@ -2,10 +2,21 @@
 
 from apps.common.admin import UserResourceAdmin, VersionAdmin
 
-from .models import Quote
+from .models import DailyUserStandup, Quote
 
 
 @admin.register(Quote)
 class QuoteAdmin(VersionAdmin, UserResourceAdmin):
-    search_fields = ("author",)
+    search_fields = ("author", "text")
     list_display = ("author", "last_viewed")
+
+
+@admin.register(DailyUserStandup)
+class DailyUserStandupAdmin(VersionAdmin):
+    list_filter = ("date",)
+    list_display = ("date", "conductor", "fallback_conductor")
+    autocomplete_fields = (
+        "quote",
+        "conductor",
+        "fallback_conductor",
+    )

apps/standup/factories.py

@@ -0,0 +1,19 @@
+# pyright: reportPrivateImportUsage=false
+# pyright: reportIncompatibleVariableOverride=false
+import factory
+from factory.django import DjangoModelFactory
+
+from .models import DailyUserStandup, Quote
+
+
+class DailyUserStandupFactory(DjangoModelFactory):
+    class Meta:
+        model = DailyUserStandup
+
+
+class QuoteFactory(DjangoModelFactory):
+    author = factory.Faker("name")
+    text = factory.Faker("sentence")
+
+    class Meta:
+        model = Quote

apps/standup/management/__init__.py

@@ -0,0 +1,47 @@
+import logging
+import typing
+
+from django.core.management.base import BaseCommand
+
+from apps.standup.tasks import (
+    before_standup_reminder,
+    morning_reminder,
+    read_doc_reminder,
+    setup_next_standup,
+)
+
+CommandActionType = typing.Literal[
+    "morning-reminder",
+    "before-standup-reminder",
+    "setup-next-standup",
+    "read-doc-reminder",
+]
+
+logger = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    help = "Daily Standup cli"
+
+    @typing.override
+    def add_arguments(self, parser):
+        subparsers = parser.add_subparsers(dest="action", help="Actions", required=True)
+
+        subparsers.add_parser("morning-reminder", help="Send morning reminder for conductors")
+        subparsers.add_parser("before-standup-reminder", help="Send before standup reminder for the team")
+        subparsers.add_parser("setup-next-standup", help="Setup next standup and assign conductors")
+        subparsers.add_parser("read-doc-reminder", help="Send read doc reminder for conductors")
+
+    @typing.override
+    def handle(self, action: CommandActionType, **_):
+        match action:
+            case "morning-reminder":
+                return morning_reminder()
+            case "before-standup-reminder":
+                return before_standup_reminder()
+            case "setup-next-standup":
+                return setup_next_standup()
+            case "read-doc-reminder":
+                return read_doc_reminder()
+            case _:
+                typing.assert_never(action)

apps/standup/management/commands/__init__.py

@@ -0,0 +1,27 @@
+# Generated by Django 4.2.20 on 2025-04-29 13:50
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('standup', '0002_quote_last_viewed'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='DailyUserStandup',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('date', models.DateField(unique=True)),
+                ('slack_thread_ts', models.CharField(blank=True, max_length=20, null=True)),
+                ('conductor', models.ForeignKey(blank=True, help_text='User responsible for conducting the stand-up', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('fallback_conductor', models.ForeignKey(blank=True, help_text='Fallback user when conductor is not available', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('quote', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, to='standup.quote')),
+            ],
+        ),
+    ]

apps/standup/management/commands/standup.py

@@ -1,19 +1,64 @@
+import textwrap
+import typing
+
 from django.db import models
+from django.db.models.functions import Now
+from django.utils.translation import gettext_lazy as _
 
 from apps.common.models import UserResource
-
-# from apps.user.models import User
-
-
-# class DailyUserStandup(models.Model):
-#     user = models.ForeignKey(User, on_delete=models.CASCADE)
-#     date = models.DateField()
-
-#     slack_thread_id = models.CharField(max_length=200)  # TODO: Check length
-#     text = models.TextField()  # TODO: Do we need this?
+from apps.user.models import User
 
 
 class Quote(UserResource):
     text = models.TextField()
     author = models.CharField(max_length=225)
     last_viewed = models.DateTimeField(null=True, blank=True)
+
+    @classmethod
+    def get_random_quote(cls, track_last_viewed=False) -> typing.Self | None:
+        quote = cls.objects.order_by(
+            models.F("last_viewed").asc(nulls_first=True),
+        ).first()
+        if quote and track_last_viewed:
+            cls.objects.filter(pk=quote.pk).update(last_viewed=Now())
+        return quote
+
+    @typing.override
+    def __str__(self):
+        _text = textwrap.shorten(self.text, width=20, placeholder="...")
+        return f"Quote: {self.author} - {_text}"
+
+
+# TODO: Add created_at, created_by, modified_by, modified_at
+class DailyUserStandup(models.Model):
+    date = models.DateField(unique=True)
+
+    quote = models.ForeignKey(Quote, on_delete=models.SET_NULL, null=True, blank=True)
+
+    conductor = models.ForeignKey(
+        User,
+        help_text=_("User responsible for conducting the stand-up"),
+        related_name="+",
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
+    fallback_conductor = models.ForeignKey(
+        User,
+        help_text=_("Fallback user when conductor is not available"),
+        related_name="+",
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
+
+    slack_thread_ts = models.CharField(max_length=20, null=True, blank=True)
+
+    # typing hints
+    quote_id: int | None
+    conductor_id: int | None
+    fallback_conductor_id: int | None
+
+    @typing.override
+    def __str__(self):
+        return str(self.date)