sandwitches 2.2.0__py3-none-any.whl

sandwitches/migrations/0001_initial.py

@@ -0,0 +1,328 @@
+# Generated by Django 6.0 on 2025-12-31 16:09
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.core.validators
+import django.db.models.deletion
+import django.utils.timezone
+import sandwitches.storage
+import simple_history.models
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("auth", "0012_alter_user_first_name_max_length"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Tag",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=50, unique=True)),
+                ("slug", models.SlugField(blank=True, max_length=60, unique=True)),
+            ],
+            options={
+                "verbose_name": "Tag",
+                "verbose_name_plural": "Tags",
+                "ordering": ("name",),
+            },
+        ),
+        migrations.CreateModel(
+            name="User",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("password", models.CharField(max_length=128, verbose_name="password")),
+                (
+                    "last_login",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="last login"
+                    ),
+                ),
+                (
+                    "is_superuser",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates that this user has all permissions without explicitly assigning them.",
+                        verbose_name="superuser status",
+                    ),
+                ),
+                (
+                    "username",
+                    models.CharField(
+                        error_messages={
+                            "unique": "A user with that username already exists."
+                        },
+                        help_text="Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
+                        max_length=150,
+                        unique=True,
+                        validators=[
+                            django.contrib.auth.validators.UnicodeUsernameValidator()
+                        ],
+                        verbose_name="username",
+                    ),
+                ),
+                (
+                    "first_name",
+                    models.CharField(
+                        blank=True, max_length=150, verbose_name="first name"
+                    ),
+                ),
+                (
+                    "last_name",
+                    models.CharField(
+                        blank=True, max_length=150, verbose_name="last name"
+                    ),
+                ),
+                (
+                    "email",
+                    models.EmailField(
+                        blank=True, max_length=254, verbose_name="email address"
+                    ),
+                ),
+                (
+                    "is_staff",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates whether the user can log into this admin site.",
+                        verbose_name="staff status",
+                    ),
+                ),
+                (
+                    "is_active",
+                    models.BooleanField(
+                        default=True,
+                        help_text="Designates whether this user should be treated as active. Unselect this instead of deleting accounts.",
+                        verbose_name="active",
+                    ),
+                ),
+                (
+                    "date_joined",
+                    models.DateTimeField(
+                        default=django.utils.timezone.now, verbose_name="date joined"
+                    ),
+                ),
+                (
+                    "avatar",
+                    models.ImageField(blank=True, null=True, upload_to="avatars"),
+                ),
+                ("bio", models.TextField(blank=True)),
+                (
+                    "language",
+                    models.CharField(
+                        choices=[("en", "English"), ("nl", "Nederlands")],
+                        default="en",
+                        max_length=10,
+                    ),
+                ),
+                (
+                    "groups",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="The groups this user belongs to. A user will get all permissions granted to each of their groups.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.group",
+                        verbose_name="groups",
+                    ),
+                ),
+                (
+                    "user_permissions",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="Specific permissions for this user.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.permission",
+                        verbose_name="user permissions",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "User",
+                "verbose_name_plural": "Users",
+            },
+            managers=[
+                ("objects", django.contrib.auth.models.UserManager()),
+            ],
+        ),
+        migrations.CreateModel(
+            name="HistoricalRecipe",
+            fields=[
+                (
+                    "id",
+                    models.BigIntegerField(
+                        auto_created=True, blank=True, db_index=True, verbose_name="ID"
+                    ),
+                ),
+                ("title", models.CharField(db_index=True, max_length=255)),
+                ("slug", models.SlugField(blank=True, max_length=255)),
+                ("description", models.TextField(blank=True)),
+                ("ingredients", models.TextField(blank=True)),
+                ("instructions", models.TextField(blank=True)),
+                ("image", models.TextField(blank=True, max_length=100, null=True)),
+                ("created_at", models.DateTimeField(blank=True, editable=False)),
+                ("updated_at", models.DateTimeField(blank=True, editable=False)),
+                ("history_id", models.AutoField(primary_key=True, serialize=False)),
+                ("history_date", models.DateTimeField(db_index=True)),
+                ("history_change_reason", models.CharField(max_length=100, null=True)),
+                (
+                    "history_type",
+                    models.CharField(
+                        choices=[("+", "Created"), ("~", "Changed"), ("-", "Deleted")],
+                        max_length=1,
+                    ),
+                ),
+                (
+                    "history_user",
+                    models.ForeignKey(
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "uploaded_by",
+                    models.ForeignKey(
+                        blank=True,
+                        db_constraint=False,
+                        null=True,
+                        on_delete=django.db.models.deletion.DO_NOTHING,
+                        related_name="+",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "historical Recipe",
+                "verbose_name_plural": "historical Recipes",
+                "ordering": ("-history_date", "-history_id"),
+                "get_latest_by": ("history_date", "history_id"),
+            },
+            bases=(simple_history.models.HistoricalChanges, models.Model),
+        ),
+        migrations.CreateModel(
+            name="Recipe",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, unique=True)),
+                ("slug", models.SlugField(blank=True, max_length=255, unique=True)),
+                ("description", models.TextField(blank=True)),
+                ("ingredients", models.TextField(blank=True)),
+                ("instructions", models.TextField(blank=True)),
+                (
+                    "image",
+                    models.ImageField(
+                        blank=True,
+                        null=True,
+                        storage=sandwitches.storage.HashedFilenameStorage(),
+                        upload_to="recipes/",
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "uploaded_by",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="recipes",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "tags",
+                    models.ManyToManyField(
+                        blank=True, related_name="recipes", to="sandwitches.tag"
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Recipe",
+                "verbose_name_plural": "Recipes",
+                "ordering": ("-created_at",),
+            },
+        ),
+        migrations.AddField(
+            model_name="user",
+            name="favorites",
+            field=models.ManyToManyField(
+                blank=True, related_name="favorited_by", to="sandwitches.recipe"
+            ),
+        ),
+        migrations.CreateModel(
+            name="Rating",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "score",
+                    models.FloatField(
+                        validators=[
+                            django.core.validators.MinValueValidator(0.0),
+                            django.core.validators.MaxValueValidator(10.0),
+                        ]
+                    ),
+                ),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="ratings",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "recipe",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="ratings",
+                        to="sandwitches.recipe",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ("-updated_at",),
+                "unique_together": {("recipe", "user")},
+            },
+        ),
+    ]

sandwitches/migrations/0002_historicalrecipe_servings_recipe_servings.py

@@ -0,0 +1,27 @@
+# Generated by Django 6.0 on 2026-01-13 11:59
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("sandwitches", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalrecipe",
+            name="servings",
+            field=models.IntegerField(
+                default=1, validators=[django.core.validators.MinValueValidator(1)]
+            ),
+        ),
+        migrations.AddField(
+            model_name="recipe",
+            name="servings",
+            field=models.IntegerField(
+                default=1, validators=[django.core.validators.MinValueValidator(1)]
+            ),
+        ),
+    ]

sandwitches/migrations/0003_setting.py

@@ -0,0 +1,35 @@
+# Generated by Django 6.0 on 2026-01-14 09:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("sandwitches", "0002_historicalrecipe_servings_recipe_servings"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Setting",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("site_name", models.CharField(default="Sandwitches", max_length=255)),
+                ("site_description", models.TextField(blank=True)),
+                ("email", models.EmailField(blank=True, max_length=254)),
+                ("ai_connection_point", models.URLField(blank=True)),
+                ("ai_model", models.CharField(blank=True, max_length=255)),
+                ("ai_api_key", models.CharField(blank=True, max_length=255)),
+            ],
+            options={
+                "verbose_name": "Site Settings",
+            },
+        ),
+    ]

sandwitches/migrations/0004_alter_setting_ai_api_key_and_more.py

@@ -0,0 +1,37 @@
+# Generated by Django 6.0 on 2026-01-14 09:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("sandwitches", "0003_setting"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="setting",
+            name="ai_api_key",
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AlterField(
+            model_name="setting",
+            name="ai_connection_point",
+            field=models.URLField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name="setting",
+            name="ai_model",
+            field=models.CharField(blank=True, max_length=255, null=True),
+        ),
+        migrations.AlterField(
+            model_name="setting",
+            name="email",
+            field=models.EmailField(blank=True, max_length=254, null=True),
+        ),
+        migrations.AlterField(
+            model_name="setting",
+            name="site_description",
+            field=models.TextField(blank=True, null=True),
+        ),
+    ]

sandwitches/migrations/0005_rating_comment.py

@@ -0,0 +1,17 @@
+# Generated by Django 6.0 on 2026-01-14 10:03
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("sandwitches", "0004_alter_setting_ai_api_key_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rating",
+            name="comment",
+            field=models.TextField(blank=True),
+        ),
+    ]

sandwitches/migrations/0006_historicalrecipe_is_highlighted_and_more.py

@@ -0,0 +1,22 @@
+# Generated by Django 6.0.1 on 2026-01-17 16:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("sandwitches", "0005_rating_comment"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalrecipe",
+            name="is_highlighted",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name="recipe",
+            name="is_highlighted",
+            field=models.BooleanField(default=False),
+        ),
+    ]

sandwitches/models.py

@@ -0,0 +1,218 @@
+from django.db import models
+from django.utils.text import slugify
+from .storage import HashedFilenameStorage
+from simple_history.models import HistoricalRecords
+from django.contrib.auth.models import AbstractUser
+from django.db.models import Avg
+from .tasks import email_users
+from django.conf import settings
+from django.core.validators import MinValueValidator, MaxValueValidator
+import logging
+from django.urls import reverse
+from solo.models import SingletonModel
+
+from imagekit.models import ImageSpecField
+from imagekit.processors import ResizeToFill
+
+hashed_storage = HashedFilenameStorage()
+
+
+class Setting(SingletonModel):
+    site_name = models.CharField(max_length=255, default="Sandwitches")
+    site_description = models.TextField(blank=True, null=True)
+    email = models.EmailField(blank=True, null=True)
+    ai_connection_point = models.URLField(blank=True, null=True)
+    ai_model = models.CharField(max_length=255, blank=True, null=True)
+    ai_api_key = models.CharField(max_length=255, blank=True, null=True)
+
+    def __str__(self):
+        return "Site Settings"
+
+    class Meta:
+        verbose_name = "Site Settings"
+
+
+class User(AbstractUser):
+    avatar = models.ImageField(upload_to="avatars", blank=True, null=True)
+    avatar_thumbnail = ImageSpecField(
+        source="avatar",
+        processors=[ResizeToFill(100, 50)],
+        format="JPEG",
+        options={"quality": 60},
+    )
+    bio = models.TextField(blank=True)
+    language = models.CharField(
+        max_length=10,
+        choices=settings.LANGUAGES,
+        default=settings.LANGUAGE_CODE,
+    )
+    favorites = models.ManyToManyField(
+        "Recipe", related_name="favorited_by", blank=True
+    )
+
+    class Meta:
+        verbose_name = "User"
+        verbose_name_plural = "Users"
+
+    def __str__(self):
+        return self.username
+
+
+class Tag(models.Model):
+    name = models.CharField(max_length=50, unique=True)
+    slug = models.SlugField(max_length=60, unique=True, blank=True)
+
+    class Meta:
+        ordering = ("name",)
+        verbose_name = "Tag"
+        verbose_name_plural = "Tags"
+
+    def save(self, *args, **kwargs):
+        if not self.slug:
+            base = slugify(self.name)[:55]
+            slug = base
+            n = 1
+            while Tag.objects.filter(slug=slug).exclude(pk=self.pk).exists():  # ty:ignore[unresolved-attribute]
+                slug = f"{base}-{n}"
+                n += 1
+            self.slug = slug
+        super().save(*args, **kwargs)
+
+    def __str__(self):
+        return self.name
+
+
+class Recipe(models.Model):
+    title = models.CharField(max_length=255, unique=True)
+    slug = models.SlugField(max_length=255, unique=True, blank=True)
+    description = models.TextField(blank=True)
+    ingredients = models.TextField(blank=True)
+    instructions = models.TextField(blank=True)
+    servings = models.IntegerField(default=1, validators=[MinValueValidator(1)])
+    uploaded_by = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        related_name="recipes",
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+    )
+    image = models.ImageField(
+        upload_to="recipes/",
+        storage=hashed_storage,
+        blank=True,
+        null=True,
+    )
+    image_thumbnail = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(150, 150)],
+        format="JPEG",
+        options={"quality": 70},
+    )
+    image_small = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(400, 300)],
+        format="JPEG",
+        options={"quality": 75},
+    )
+    image_medium = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(700, 500)],
+        format="JPEG",
+        options={"quality": 85},
+    )
+    image_large = ImageSpecField(
+        source="image",
+        processors=[ResizeToFill(1200, 800)],
+        format="JPEG",
+        options={"quality": 95},
+    )
+    tags = models.ManyToManyField(Tag, blank=True, related_name="recipes")
+    is_highlighted = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+    history = HistoricalRecords()
+
+    class Meta:
+        ordering = ("-created_at",)
+        verbose_name = "Recipe"
+        verbose_name_plural = "Recipes"
+
+    def save(self, *args, **kwargs):
+        is_new = self._state.adding
+
+        if not self.slug:
+            base = slugify(self.title)[:240]
+            slug = base
+            n = 1
+            while Recipe.objects.filter(slug=slug).exclude(pk=self.pk).exists():  # ty:ignore[unresolved-attribute]
+                slug = f"{base}-{n}"
+                n += 1
+            self.slug = slug
+
+        super().save(*args, **kwargs)
+
+        send_email = getattr(settings, "SEND_EMAIL")
+        logging.debug(f"SEND_EMAIL is set to {send_email}")
+
+        if is_new or settings.DEBUG:
+            if send_email:
+                email_users.enqueue(recipe_id=self.pk)
+            else:
+                logging.warning(
+                    "Email sending is disabled; not sending email notification, make sure SEND_EMAIL is set to True in settings."
+                )
+        else:
+            logging.debug(
+                "Existing recipe saved (update); skipping email notification."
+            )
+
+    def get_absolute_url(self):
+        return reverse("recipe_detail", kwargs={"slug": self.slug})
+
+    def tag_list(self):
+        return list(self.tags.values_list("name", flat=True))  # ty:ignore[possibly-missing-attribute]
+
+    def set_tags_from_string(self, tag_string):
+        """
+        Accepts a comma separated string like "tag1, tag2" and attaches existing tags
+        or creates new ones as needed. Returns the Tag queryset assigned.
+        """
+        names = [t.strip() for t in (tag_string or "").split(",") if t.strip()]
+        tags = []
+        for name in names:
+            tag = Tag.objects.filter(name__iexact=name).first()  # ty:ignore[unresolved-attribute]
+            if not tag:
+                tag = Tag.objects.create(name=name)  # ty:ignore[unresolved-attribute]
+            tags.append(tag)
+        self.tags.set(tags)  # ty:ignore[possibly-missing-attribute]
+        return self.tags.all()  # ty:ignore[possibly-missing-attribute]
+
+    def average_rating(self):
+        agg = self.ratings.aggregate(avg=Avg("score"))  # ty:ignore[unresolved-attribute]
+        return agg["avg"] or 0
+
+    def rating_count(self):
+        return self.ratings.count()  # ty:ignore[unresolved-attribute]
+
+    def __str__(self):
+        return self.title
+
+
+class Rating(models.Model):
+    recipe = models.ForeignKey(Recipe, related_name="ratings", on_delete=models.CASCADE)
+    user = models.ForeignKey(
+        settings.AUTH_USER_MODEL, related_name="ratings", on_delete=models.CASCADE
+    )
+    score = models.FloatField(
+        validators=[MinValueValidator(0.0), MaxValueValidator(10.0)]
+    )
+    comment = models.TextField(blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        unique_together = ("recipe", "user")
+        ordering = ("-updated_at",)
+
+    def __str__(self):
+        return f"{self.recipe} — {self.score} by {self.user}"