Update LivelihoodProductCategory releated viewset and tests see HEA-789

Author: girumb

apps/baseline/migrations/0020_remove_livelihoodproductcategory_livelihood_zone_baseline_and_more.py

@@ -0,0 +1,43 @@
+# Generated by Django 5.2.7 on 2025-11-21 05:42
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("baseline", "0019_alter_foodpurchase_times_per_year_and_more"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="livelihoodproductcategory",
+            name="livelihood_zone_baseline",
+        ),
+        migrations.RemoveField(
+            model_name="livelihoodproductcategory",
+            name="product",
+        ),
+        migrations.AddField(
+            model_name="livelihoodproductcategory",
+            name="baseline_livelihood_activity",
+            field=models.ForeignKey(
+                default=1,
+                on_delete=django.db.models.deletion.RESTRICT,
+                to="baseline.baselinelivelihoodactivity",
+                verbose_name="Baseline Livelihood Activity",
+            ),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="livelihoodproductcategory",
+            name="percentage_allocation_to_basket",
+            field=models.PositiveIntegerField(
+                blank=True,
+                help_text="The percentage of expenditure or kcals from the Livelihood Activity that is allocated to this Basket. The remainder is implicitly part of the 'Other' basket",
+                null=True,
+                verbose_name="Percentage allocation to basket",
+            ),
+        ),
+    ]

apps/baseline/models.py

@@ -345,41 +345,6 @@ class Meta:
         ]
 
 
-# @TODO Decide whether to change the name of this model when we review the
-# LIAS and finalize models for expandability and coping. Ideally we want to be
-# able to identify Livelihood Activities that are produce staple foods, and/or
-# are part of the different baskets.
-class LivelihoodProductCategory(common_models.Model):
-    """
-    The usage category of the Product in the Livelihood Zone, such as staple food or livelihood protection.
-    """
-
-    class ProductBasket(models.IntegerChoices):
-        MAIN_STAPLE = 1, _("Main Staple")
-        OTHER_STAPLE = 2, _("Other Staple")
-        SURVIVAL_NON_FOOD = 3, _("Non-food survival")
-        LIVELIHOODS_PROTECTION = 4, _("Livelihoods Protection")
-
-    livelihood_zone_baseline = models.ForeignKey(
-        LivelihoodZoneBaseline,
-        on_delete=models.RESTRICT,
-        related_name="staple_foods",
-        verbose_name=_("Livelihood Zone Baseline"),
-    )
-    product = models.ForeignKey(
-        ClassifiedProduct,
-        db_column="product_code",
-        on_delete=models.RESTRICT,
-        related_name="staple_foods",
-        verbose_name=_("Product"),
-    )
-    basket = models.PositiveSmallIntegerField(choices=ProductBasket.choices, verbose_name=_("Product Basket"))
-
-    class Meta:
-        verbose_name = _("Livelihood Product Category")
-        verbose_name_plural = _("Livelihood Product Categories")
-
-
 class CommunityManager(common_models.IdentifierManager):
     def get_by_natural_key(self, code: str, reference_year_end_date: str, full_name: str):
         try:
@@ -1400,6 +1365,52 @@ class Meta:
         proxy = True
 
 
+# @TODO Decide whether to change the name of this model when we review the
+# LIAS and finalize models for expandability and coping. Ideally we want to be
+# able to identify Livelihood Activities that are produce staple foods, and/or
+# are part of the different baskets.
+class LivelihoodProductCategory(common_models.Model):
+    """
+    The usage category of the Product in the Livelihood Zone, such as staple food or livelihood protection.
+    """
+
+    class ProductBasket(models.IntegerChoices):
+        MAIN_STAPLE = 1, _("Main Staple")
+        OTHER_STAPLE = 2, _("Other Staple")
+        SURVIVAL_NON_FOOD = 3, _("Non-food survival")
+        LIVELIHOODS_PROTECTION = 4, _("Livelihoods Protection")
+
+    baseline_livelihood_activity = models.ForeignKey(
+        BaselineLivelihoodActivity,
+        on_delete=models.RESTRICT,
+        verbose_name=_("Baseline Livelihood Activity"),
+    )
+    basket = models.PositiveSmallIntegerField(choices=ProductBasket.choices, verbose_name=_("Product Basket"))
+    percentage_allocation_to_basket = models.PositiveIntegerField(
+        blank=True,
+        null=True,
+        verbose_name=_("Percentage allocation to basket"),
+        help_text=_(
+            "The percentage of expenditure or kcals from the Livelihood Activity that is allocated to this Basket. The remainder is implicitly part of the 'Other' basket"
+        ),
+    )
+
+    def clean(self):
+        super().clean()
+        if self.percentage_allocation_to_basket and self.percentage_allocation_to_basket > 100:
+            raise ValidationError(
+                {
+                    "percentage_allocation_to_basket": _(
+                        f"Percentage allocation cannot exceed 100%. Got: {self.percentage_allocation_to_basket}%"
+                    )
+                }
+            )
+
+    class Meta:
+        verbose_name = _("Livelihood Product Category")
+        verbose_name_plural = _("Livelihood Product Categories")
+
+
 class MilkProduction(LivelihoodActivity):
     """
     Production of milk by households in a Wealth Group for their own consumption, for sale and for other uses.

apps/baseline/serializers.py

@@ -155,9 +155,9 @@ class Meta:
             "id",
             "source_organization",
             "source_organization_name",
-            "livelihood_zone_baseline",
-            "livelihood_zone_baseline_label",
+            "baseline_livelihood_activity",
             "livelihood_zone",
+            "livelihood_zone_baseline_label",
             "livelihood_zone_name",
             "livelihood_zone_country",
             "livelihood_zone_country_name",
@@ -166,33 +166,45 @@ class Meta:
             "product_description",
             "basket",
             "basket_name",
+            "percentage_allocation_to_basket",
         ]
 
     source_organization = serializers.CharField(
-        source="livelihood_zone_baseline.source_organization.pk", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.source_organization.pk", read_only=True
     )
     source_organization_name = serializers.CharField(
-        source="livelihood_zone_baseline.source_organization.name", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.source_organization.name", read_only=True
     )
     livelihood_zone_baseline_label = serializers.SerializerMethodField()
 
     def get_livelihood_zone_baseline_label(self, obj):
-        return str(obj.livelihood_zone_baseline)
+        return str(obj.baseline_livelihood_activity.livelihood_zone_baseline)
 
-    product_description = serializers.CharField(source="product.description", read_only=True)
-    product_common_name = serializers.CharField(source="product.common_name", read_only=True)
+    product = serializers.SerializerMethodField()
+
+    def get_product(self, obj):
+        return str(obj.baseline_livelihood_activity.livelihood_strategy.product)
+
+    product_description = serializers.CharField(
+        source="baseline_livelihood_activity.livelihood_strategy.product.description", read_only=True
+    )
+    product_common_name = serializers.CharField(
+        source="baseline_livelihood_activity.livelihood_strategy.product.common_name", read_only=True
+    )
     livelihood_zone_name = serializers.CharField(
-        source="livelihood_zone_baseline.livelihood_zone.name", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.livelihood_zone.name", read_only=True
+    )
+    livelihood_zone = serializers.CharField(
+        source="baseline_livelihood_activity.livelihood_zone_baseline.livelihood_zone.pk", read_only=True
     )
-    livelihood_zone = serializers.CharField(source="livelihood_zone_baseline.livelihood_zone.pk", read_only=True)
     source_organization_name = serializers.CharField(
-        source="livelihood_zone_baseline.source_organization.name", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.source_organization.name", read_only=True
     )
     livelihood_zone_country = serializers.CharField(
-        source="livelihood_zone_baseline.livelihood_zone.country.pk", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.livelihood_zone.country.pk", read_only=True
     )
     livelihood_zone_country_name = serializers.CharField(
-        source="livelihood_zone_baseline.livelihood_zone.country.name", read_only=True
+        source="baseline_livelihood_activity.livelihood_zone_baseline.livelihood_zone.country.name", read_only=True
     )
     basket_name = serializers.SerializerMethodField()
 

apps/baseline/tests/factories.py

@@ -123,20 +123,6 @@ class Meta:
     currency = factory.SubFactory(CurrencyFactory)
 
 
-class LivelihoodProductCategoryFactory(factory.django.DjangoModelFactory):
-    class Meta:
-        model = LivelihoodProductCategory
-        django_get_or_create = [
-            "livelihood_zone_baseline",
-            "product",
-            "basket",
-        ]
-
-    livelihood_zone_baseline = factory.SubFactory(LivelihoodZoneBaselineFactory)
-    product = factory.SubFactory(ClassifiedProductFactory)
-    basket = factory.Iterator(["1", "2", "3", "4"])
-
-
 class CommunityFactory(factory.django.DjangoModelFactory):
     class Meta:
         model = Community
@@ -358,6 +344,19 @@ class Meta:
     scenario = LivelihoodActivityScenario.RESPONSE
 
 
+class LivelihoodProductCategoryFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = LivelihoodProductCategory
+        django_get_or_create = [
+            "baseline_livelihood_activity",
+            "basket",
+        ]
+
+    baseline_livelihood_activity = factory.SubFactory(BaselineLivelihoodActivityFactory)
+    basket = factory.Iterator([1, 2, 3, 4])
+    percentage_allocation_to_basket = fuzzy.FuzzyInteger(0, 100)
+
+
 class MilkProductionFactory(LivelihoodActivityFactory):
     class Meta:
         model = MilkProduction

apps/baseline/tests/test_viewsets.py

@@ -711,7 +711,7 @@ def test_get_record(self):
             "id",
             "source_organization",
             "source_organization_name",
-            "livelihood_zone_baseline",
+            "baseline_livelihood_activity",
             "livelihood_zone_baseline_label",
             "livelihood_zone",
             "livelihood_zone_name",
@@ -722,6 +722,7 @@ def test_get_record(self):
             "product_description",
             "basket",
             "basket_name",
+            "percentage_allocation_to_basket",
         )
         self.assertCountEqual(
             response.json().keys(),
@@ -765,8 +766,7 @@ def test_list_returns_filtered_data(self):
         response = self.client.get(
             self.url,
             {
-                "livelihood_zone_baseline": self.data[0].livelihood_zone_baseline.pk,
-                "product": self.data[0].product.pk,
+                "baseline_livelihood_activity": self.data[0].baseline_livelihood_activity.pk,
                 "basket": self.data[0].basket,
             },
         )

apps/baseline/viewsets.py

@@ -271,8 +271,7 @@ class LivelihoodProductCategoryFilterSet(filters.FilterSet):
     class Meta:
         model = LivelihoodProductCategory
         fields = [
-            "livelihood_zone_baseline",
-            "product",
+            "baseline_livelihood_activity",
             "basket",
         ]
 
@@ -283,8 +282,9 @@ class LivelihoodProductCategoryViewSet(BaseModelViewSet):
     """
 
     queryset = LivelihoodProductCategory.objects.select_related(
-        "livelihood_zone_baseline__livelihood_zone__country",
-        "livelihood_zone_baseline__source_organization",
+        "baseline_livelihood_activity__livelihood_zone_baseline__livelihood_zone__country",
+        "baseline_livelihood_activity__livelihood_zone_baseline__source_organization",
+        "baseline_livelihood_activity__livelihood_strategy__product",
     )
     serializer_class = LivelihoodProductCategorySerializer
     filterset_class = LivelihoodProductCategoryFilterSet