Merge pull request #8 from mohamad-liyaghi/products

Products

Author: mohamad-liyaghi

apps/products/__init__.py

@@ -0,0 +1,39 @@
+from django.contrib import admin
+from .models import Product
+
+
+@admin.register(Product)
+class ProductAdmin(admin.ModelAdmin):
+    list_display = [
+        "name",
+        "restaurant",
+        "price",
+        "quantity",
+        "max_quantity_per_order",
+        "type",
+    ]
+    list_filter = ["type"]
+    search_fields = ["name", "restaurant__name"]
+    ordering = ["type", "price"]
+    readonly_fields = ["uuid"]
+    fieldsets = [
+        (
+            None,
+            {
+                "fields": [
+                    "uuid",
+                    "restaurant",
+                    "name",
+                    "description",
+                    "price",
+                    "quantity",
+                    "max_quantity_per_order",
+                    "type",
+                ]
+            },
+        )
+    ]
+    raw_id_fields = ["restaurant"]
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related("restaurant")

apps/products/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ProductsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "products"

apps/products/apps.py

@@ -0,0 +1,8 @@
+from django.db import models
+
+
+class ProductType(models.TextChoices):
+    FOOD = "f", "Food"
+    DRINK = "d", "Drink"
+    SALAD = "s", "Salad"
+    OTHER = "o", "Other"

apps/products/enums.py

@@ -0,0 +1,59 @@
+# Generated by Django 5.0.7 on 2024-08-05 09:21
+
+import django.db.models.deletion
+import uuid
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("restaurants", "0003_restaurant_is_soft_deleted"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Product",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "uuid",
+                    models.UUIDField(default=uuid.uuid4, editable=False, unique=True),
+                ),
+                ("name", models.CharField(max_length=255)),
+                ("description", models.TextField()),
+                ("price", models.DecimalField(decimal_places=2, max_digits=10)),
+                ("quantity", models.PositiveIntegerField()),
+                ("max_quantity_per_order", models.PositiveIntegerField()),
+                (
+                    "type",
+                    models.CharField(
+                        choices=[
+                            ("f", "Food"),
+                            ("d", "Drink"),
+                            ("s", "Salad"),
+                            ("o", "Other"),
+                        ],
+                        max_length=1,
+                    ),
+                ),
+                (
+                    "restaurant",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="products",
+                        to="restaurants.restaurant",
+                    ),
+                ),
+            ],
+        ),
+    ]

apps/products/migrations/0001_initial.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.7 on 2024-08-05 09:58
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("products", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="product",
+            name="description",
+            field=models.TextField(blank=True, null=True),
+        ),
+    ]

apps/products/migrations/0002_alter_product_description.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.7 on 2024-08-05 10:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("products", "0002_alter_product_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="product",
+            name="is_deleted",
+            field=models.BooleanField(default=False),
+        ),
+    ]

apps/products/migrations/0003_product_is_deleted.py

@@ -0,0 +1,34 @@
+from django.db import models
+from django.core.exceptions import ValidationError
+from uuid import uuid4
+from products.enums import ProductType
+from restaurants.models import Restaurant
+from restaurants.enums import RestaurantStatus
+
+
+class Product(models.Model):
+    restaurant = models.ForeignKey(Restaurant, on_delete=models.CASCADE, related_name="products")
+    uuid = models.UUIDField(default=uuid4, editable=False, unique=True)
+    name = models.CharField(max_length=255)
+    description = models.TextField(blank=True, null=True)
+    price = models.DecimalField(max_digits=10, decimal_places=2)
+    quantity = models.PositiveIntegerField()
+    max_quantity_per_order = models.PositiveIntegerField()
+    type = models.CharField(max_length=1, choices=ProductType.choices)
+    is_deleted = models.BooleanField(default=False)
+
+    @property
+    def is_available(self):
+        return self.quantity > 0
+
+    def __str__(self):
+        return self.name
+
+    # restaurant should be approved
+    def clean(self):
+        if self.restaurant.status != RestaurantStatus.APPROVED:
+            raise ValidationError("Restaurant is not approved")
+
+    def save(self, *args, **kwargs):
+        self.full_clean()
+        super().save(*args, **kwargs)

apps/products/migrations/__init__.py

@@ -0,0 +1,25 @@
+from rest_framework import serializers
+from products.models import Product
+from restaurants.serializers import RestaurantSerializer
+
+
+class ProductSerializer(serializers.ModelSerializer):
+    restaurant = RestaurantSerializer(read_only=True)
+
+    class Meta:
+        model = Product
+        fields = (
+            "uuid",
+            "name",
+            "restaurant",
+            "price",
+            "quantity",
+            "max_quantity_per_order",
+            "type",
+            "is_available",
+        )
+        read_only_fields = ("uuid", "is_available")
+
+    def create(self, validated_data) -> Product:
+        validated_data.setdefault("restaurant", self.context["restaurant"])
+        return super().create(validated_data)

apps/products/models.py

@@ -0,0 +1,129 @@
+import pytest
+from products.models import Product
+from products.enums import ProductType
+
+
+@pytest.fixture(scope="session")
+def available_food_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Available Food Product",
+            description="Available Food Product Description",
+            price=10.00,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.FOOD,
+        )
+
+
+@pytest.fixture(scope="session")
+def unavailable_food_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Unavailable Food Product",
+            description="Unavailable Food Product Description",
+            price=10.00,
+            quantity=0,
+            max_quantity_per_order=5,
+            type=ProductType.FOOD,
+        )
+
+
+@pytest.fixture(scope="session")
+def available_drink_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Available Drink Product",
+            description="Available Drink Product Description",
+            price=5.00,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.DRINK,
+        )
+
+
+@pytest.fixture(scope="session")
+def unavailable_drink_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Unavailable Drink Product",
+            description="Unavailable Drink Product Description",
+            price=5.00,
+            quantity=0,
+            max_quantity_per_order=5,
+            type=ProductType.DRINK,
+        )
+
+
+@pytest.fixture(scope="session")
+def available_salad_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Available Salad Product",
+            description="Available Salad Product Description",
+            price=7.50,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.SALAD,
+        )
+
+
+@pytest.fixture(scope="session")
+def unavailable_salad_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Unavailable Salad Product",
+            description="Unavailable Salad Product Description",
+            price=7.50,
+            quantity=0,
+            max_quantity_per_order=5,
+            type=ProductType.SALAD,
+        )
+
+
+@pytest.fixture(scope="session")
+def available_other_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Available Coffee Product",
+            description="Available Coffee Product Description",
+            price=3.50,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.OTHER,
+        )
+
+
+@pytest.fixture(scope="session")
+def unavailable_other_product(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Unavailable Coffee Product",
+            description="Unavailable Coffee Product Description",
+            price=3.50,
+            quantity=0,
+            max_quantity_per_order=5,
+            type=ProductType.OTHER,
+        )
+
+
+@pytest.fixture(scope="session")
+def available_food_to_delete(django_db_setup, django_db_blocker, approved_restaurant) -> Product:
+    with django_db_blocker.unblock():
+        yield Product.objects.create(
+            restaurant=approved_restaurant,
+            name="Available Food Product",
+            description="Available Food Product Description",
+            price=10.00,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.FOOD,
+        )

apps/products/serializers.py

@@ -0,0 +1,24 @@
+import pytest
+from django.core.exceptions import ValidationError
+from products.models import Product
+from products.enums import ProductType
+
+
+@pytest.mark.django_db
+class TestProductModel:
+    def test_product_is_available(self, available_food_product, unavailable_food_product):
+        assert available_food_product.is_available
+        assert not unavailable_food_product.is_available
+
+    def test_product_clean_method(self, denied_restaurant):
+        product = Product(
+            restaurant=denied_restaurant,
+            name="Test Product",
+            description="Test Description",
+            price=10.0,
+            quantity=10,
+            max_quantity_per_order=5,
+            type=ProductType.FOOD,
+        )
+        with pytest.raises(ValidationError):
+            product.save()