Self hosted FLOSS fitness/workout, nutrition and weight tracker
introduce milliliter and other types of serving sizes, and add backend tests. Also able to calculate the macro's per special serving size
Luca van der Wijngaartee16fb31b1c4
diff --git a/wger/nutrition/api/serializers.py b/wger/nutrition/api/serializers.pyindex e5b616c28..d33d4abcc 100644--- a/wger/nutrition/api/serializers.py+++ b/wger/nutrition/api/serializers.py@@ -38,6 +38,8 @@ class IngredientWeightUnitSerializer(serializers.ModelSerializer):IngredientWeightUnit serializer"""+ unit_name = serializers.CharField(source='unit.name', read_only=True)+class Meta:model = IngredientWeightUnitfields = (@@ -46,6 +48,7 @@ class IngredientWeightUnitSerializer(serializers.ModelSerializer):'gram','ingredient','unit',+ 'unit_name',)@@ -54,13 +57,17 @@ class IngredientWeightUnitInfoSerializer(serializers.ModelSerializer):IngredientWeightUnit info serializer"""+ unit_name = serializers.CharField(source='unit.name', read_only=True)+class Meta:model = IngredientWeightUnitdepth = 1fields = (+ 'id','gram','amount','unit',+ 'unit_name',)@@ -113,6 +120,8 @@ class IngredientSerializer(serializers.ModelSerializer):Ingredient serializer"""+ weight_units = IngredientWeightUnitInfoSerializer(source='ingredientweightunit_set', many=True)+class Meta:model = Ingredientfields = (@@ -138,6 +147,7 @@ class IngredientSerializer(serializers.ModelSerializer):'sodium','is_vegan','is_vegetarian',+ 'weight_units','license','license_title','license_object_url',diff --git a/wger/nutrition/api/views.py b/wger/nutrition/api/views.pyindex 674c1336e..15e11fc2a 100644--- a/wger/nutrition/api/views.py+++ b/wger/nutrition/api/views.py@@ -84,7 +84,18 @@ class IngredientViewSet(viewsets.ReadOnlyModelViewSet):serializer_class = IngredientSerializerordering_fields = '__all__'filterset_class = IngredientFilterSet- queryset = Ingredient.objects.all()+ queryset = Ingredient.objects.select_related(+ 'language',+ 'license',+ ).prefetch_related('ingredientweightunit_set__unit')++ def get_object(self):+ """+ Opportunistically sync OFF serving units for accessed ingredients.+ """+ ingredient = super().get_object()+ ingredient.sync_serving_unit_from_off_if_missing()+ return ingredient@method_decorator(cache_page(settings.WGER_SETTINGS['INGREDIENT_CACHE_TTL']))def list(self, request, *args, **kwargs):diff --git a/wger/nutrition/extract_info/off.py b/wger/nutrition/extract_info/off.pyindex 683abe550..1a6c6e739 100644--- a/wger/nutrition/extract_info/off.py+++ b/wger/nutrition/extract_info/off.py@@ -34,33 +34,38 @@ OFF_REQUIRED_NUTRIMENTS = ['fat_100g',]-GRAM_PATTERN = re.compile(r'(?P<gram>\d+(?:[\.,]\d+)?)\s*g\b', re.IGNORECASE)+MASS_PATTERN = re.compile(r'(?P<mass>\d+(?:[\.,]\d+)?)\s*(?P<unit>kg|g|mg)\b', re.IGNORECASE)AMOUNT_AND_UNIT_PATTERN = re.compile(r'^\s*(?P<amount>\d+(?:[\.,]\d+)?)\s*(?P<unit>[^\d\(\),;\|][^\(\),;\|]*)$')-def extract_serving_size_data(serving_size: str) -> tuple[int | None, str | None, float | None]:- if not serving_size:- return None, None, None+def _mass_match_to_gram(match: re.Match) -> int | None:+ mass = float(match.group('mass').replace(',', '.'))+ unit = match.group('unit').lower()- gram_match = GRAM_PATTERN.search(serving_size)- if not gram_match:- return None, None, None+ factor = {'kg': 1000, 'g': 1, 'mg': 0.001}.get(unit)+ if factor is None:+ return None- gram_value = float(gram_match.group('gram').replace(',', '.'))+ gram_value = mass * factorif gram_value <= 0:- return None, None, None+ return None++ return int(round(gram_value))- gram = int(round(gram_value))- # If only grams are provided (e.g. "30 g"), expose a generic serving unit.+def extract_serving_size_data(serving_size: str) -> tuple[int | None, str | None, float | None]:+ if not serving_size:+ return None, None, None++ # Parse textual amount/unit even if no explicit mass value is present.amount = 1.0unit = 'Serving'no_parentheses = re.sub(r'\([^\)]*\)', '', serving_size)- no_grams = GRAM_PATTERN.sub('', no_parentheses)- candidate = re.sub(r'\s+', ' ', no_grams).strip(' ,;-/').strip()+ no_mass = MASS_PATTERN.sub('', no_parentheses)+ candidate = re.sub(r'\s+', ' ', no_mass).strip(' ,;-/').strip()if candidate:parsed = AMOUNT_AND_UNIT_PATTERN.match(candidate)@@ -76,6 +81,19 @@ def extract_serving_size_data(serving_size: str) -> tuple[int | None, str | Noneif not unit:unit = 'Serving'+ # Prefer mass values in parenthesis, e.g. "200 ml (206 g)".+ parenthesis_matches = [+ _mass_match_to_gram(match)+ for content in re.findall(r'\(([^\)]*)\)', serving_size)+ for match in MASS_PATTERN.finditer(content)+ ]+ parenthesis_matches = [value for value in parenthesis_matches if value is not None]++ all_matches = [_mass_match_to_gram(match) for match in MASS_PATTERN.finditer(serving_size)]+ all_matches = [value for value in all_matches if value is not None]++ gram = parenthesis_matches[0] if parenthesis_matches else (all_matches[0] if all_matches else None)+return gram, unit[:200], amountdiff --git a/wger/nutrition/forms.py b/wger/nutrition/forms.pyindex 32ec900fc..2a996afe3 100644--- a/wger/nutrition/forms.py+++ b/wger/nutrition/forms.py@@ -49,6 +49,15 @@ from wger.utils.widgets import Html5NumberInputlogger = logging.getLogger(__name__)+class IngredientWeightUnitChoiceField(forms.ModelChoiceField):+ """+ Display ingredient units with their gram conversion.+ """++ def label_from_instance(self, obj):+ return f'{obj.amount} {obj.unit.name} = {obj.gram}g'++class UnitChooserForm(forms.Form):"""A small form to select an amount and a unit for an ingredient@@ -194,9 +203,10 @@ class DailyCaloriesForm(forms.ModelForm):class MealItemForm(forms.ModelForm):- weight_unit = forms.ModelChoiceField(+ weight_unit = IngredientWeightUnitChoiceField(queryset=IngredientWeightUnit.objects.none(),- empty_label='g',+ label=gettext_lazy('Unit'),+ empty_label=gettext_lazy('grams (g)'),required=False,)ingredient = forms.ModelChoiceField(@@ -226,6 +236,10 @@ class MealItemForm(forms.ModelForm):def __init__(self, *args, **kwargs):super(MealItemForm, self).__init__(*args, **kwargs)+ self.fields['amount'].label = gettext_lazy('Quantity')+ self.fields['amount'].help_text = gettext_lazy(+ 'Enter a quantity and choose grams (g) or one of the serving units.'+ )# Get the ingredient_idingredient_id = None@@ -234,7 +248,13 @@ class MealItemForm(forms.ModelForm):ingredient_id = kwargs['instance'].ingredient_idif kwargs.get('data'):- ingredient_id = kwargs['data']['ingredient']+ data = kwargs['data']+ ingredient_id = data.get('ingredient') or data.get('ingredient_id')++ try:+ ingredient_id = int(ingredient_id) if ingredient_id else None+ except (TypeError, ValueError):+ ingredient_id = None# Filter the available ingredientsif ingredient_id:diff --git a/wger/nutrition/models/ingredient.py b/wger/nutrition/models/ingredient.pyindex dd6909eda..ff48319d8 100644--- a/wger/nutrition/models/ingredient.py+++ b/wger/nutrition/models/ingredient.py@@ -447,8 +447,18 @@ class Ingredient(AbstractLicenseModel, models.Model):fetch_ingredient_image_task.delay(self.pk)def update_or_create_serving_unit_from_off(self, ingredient_data):- if not ingredient_data.serving_size_gram or not ingredient_data.serving_size_unit:- return+ if not ingredient_data.serving_size_unit:+ return (False, False)++ gram = ingredient_data.serving_size_gram+ if not gram:+ gram = self._derive_serving_size_gram(+ ingredient_data.serving_size_amount,+ ingredient_data.serving_size_unit,+ )++ if not gram:+ return (False, False)# Local imports to avoid model import cycles.from wger.nutrition.models import (@@ -475,47 +485,121 @@ class Ingredient(AbstractLicenseModel, models.Model):).first()if existing_weight_unit:- existing_weight_unit.gram = ingredient_data.serving_size_gram+ existing_weight_unit.gram = gramexisting_weight_unit.amount = amountexisting_weight_unit.save(update_fields=['gram', 'amount'])+ return (False, True) # (created, updated)else:IngredientWeightUnit.objects.create(ingredient=self,unit=unit,- gram=ingredient_data.serving_size_gram,+ gram=gram,amount=amount,)+ return (True, False) # (created, updated)- @classmethod- def fetch_ingredient_from_off(cls, code: str):+ @staticmethod+ def _derive_serving_size_gram(amount, unit):"""- Searches OFF by barcode and creates a local ingredient from the result+ Derive gram equivalents for volume-based servings using 1 g/ml fallback."""- # wger- from wger.nutrition.extract_info.off import extract_info_from_off+ if not amount or not unit:+ return None++ normalized_unit = unit.strip().lower()+ conversion = {+ 'ml': 1,+ 'milliliter': 1,+ 'millilitre': 1,+ 'cl': 10,+ 'centiliter': 10,+ 'centilitre': 10,+ 'dl': 100,+ 'deciliter': 100,+ 'decilitre': 100,+ 'l': 1000,+ 'liter': 1000,+ 'litre': 1000,+ }++ if normalized_unit not in conversion:+ return None- logger.info(f'Searching for ingredient {code} in OFF')+ try:+ return int(round(float(amount) * conversion[normalized_unit]))+ except (TypeError, ValueError):+ return None++ @staticmethod+ def _fetch_off_product(code: str, context: str = ''):+ """+ Fetch product data from OFF and handle transient API errors.+ """try:api = API(user_agent=wger_user_agent(), timeout=3)- result = api.product.get(code)+ return api.product.get(code)except JSONDecodeError as e:- logger.info(f'Got JSONDecodeError from OFF: {e}')- return None+ logger.info(f'Got JSONDecodeError from OFF{context}: {e}')except (ReadTimeout, ConnectTimeout):- logger.info('Timeout from OFF')- return None+ logger.info(f'Timeout from OFF{context}')except HTTPError as e:- logger.info(f'Got HTTPError from OFF: {e}')+ logger.info(f'Got HTTPError from OFF{context}: {e}')++ return None++ @staticmethod+ def _extract_off_ingredient_data(result: dict, language_id: int):+ """+ Extract normalized ingredient data from an OFF payload.+ """+ # wger+ from wger.nutrition.extract_info.off import extract_info_from_off++ try:+ return extract_info_from_off(result, language_id)+ except (KeyError, ValueError) as e:+ logger.debug(f'Error extracting data from OFF: {e}')return None+ def sync_serving_unit_from_off_if_missing(self):+ """+ Fetch serving-size data from OFF for existing ingredients missing local units.+ """+ if self.source_name != Source.OPEN_FOOD_FACTS.value or not self.code:+ return (False, False)++ if self.ingredientweightunit_set.exists():+ return (False, False)++ result = self._fetch_off_product(self.code, ' while syncing serving size')++ if not result:+ return (False, False)++ ingredient_data = self._extract_off_ingredient_data(result, self.language_id)+ if not ingredient_data:+ return (False, False)++ return self.update_or_create_serving_unit_from_off(ingredient_data)++ @classmethod+ def fetch_ingredient_from_off(cls, code: str):+ """+ Searches OFF by barcode and creates a local ingredient from the result+ """+ logger.info(f'Searching for ingredient {code} in OFF')+ result = cls._fetch_off_product(code)+if not result:logger.info('Product not found')return None- try:- ingredient_data = extract_info_from_off(result, load_language(result['lang']).pk)- except (KeyError, ValueError) as e:- logger.debug(f'Error extracting data from OFF: {e}')+ language = load_language(result.get('lang'))+ if not language:+ return None++ ingredient_data = cls._extract_off_ingredient_data(result, language.pk)+ if not ingredient_data:return Noneif not ingredient_data.name:diff --git a/wger/nutrition/tests/test_ingredient.py b/wger/nutrition/tests/test_ingredient.pyindex 5af65f870..609888c90 100644--- a/wger/nutrition/tests/test_ingredient.py+++ b/wger/nutrition/tests/test_ingredient.py@@ -43,6 +43,7 @@ from wger.nutrition.models import (Ingredient,IngredientWeightUnit,Meal,+ Source,WeightUnit,)from wger.nutrition.models.image import Image@@ -243,6 +244,13 @@ class IngredientDetailTestCase(WgerTestCase):self.ingredient_detail(editor=False)+ @patch('wger.nutrition.models.Ingredient.sync_serving_unit_from_off_if_missing')+ def test_ingredient_detail_triggers_lazy_serving_sync(self, mock_sync):+ response = self.client.get(reverse('nutrition:ingredient:view', kwargs={'pk': 6}))++ self.assertEqual(response.status_code, 200)+ mock_sync.assert_called_once()+class IngredientSearchTestCase(WgerTestCase):"""@@ -546,6 +554,30 @@ class IngredientModelTestCase(WgerTestCase):self.assertEqual(ingredient_unit.gram, 30)self.assertEqual(ingredient_unit.amount, Decimal('2.00'))+ @patch('openfoodfacts.api.ProductResource.get')+ def test_fetch_from_off_creates_volume_serving_unit(self, mock_api):+ self.off_response['serving_size'] = '200 ml (206 g)'+ mock_api.return_value = self.off_response++ ingredient = Ingredient.fetch_ingredient_from_off('1234')++ unit = WeightUnit.objects.get(language=ingredient.language, name='ml')+ ingredient_unit = IngredientWeightUnit.objects.get(ingredient=ingredient, unit=unit)+ self.assertEqual(ingredient_unit.gram, 206)+ self.assertEqual(ingredient_unit.amount, Decimal('200.00'))++ @patch('openfoodfacts.api.ProductResource.get')+ def test_fetch_from_off_creates_volume_serving_unit_without_mass(self, mock_api):+ self.off_response['serving_size'] = '200 ml'+ mock_api.return_value = self.off_response++ ingredient = Ingredient.fetch_ingredient_from_off('1234')++ unit = WeightUnit.objects.get(language=ingredient.language, name='ml')+ ingredient_unit = IngredientWeightUnit.objects.get(ingredient=ingredient, unit=unit)+ self.assertEqual(ingredient_unit.gram, 200)+ self.assertEqual(ingredient_unit.amount, Decimal('200.00'))+@patch('openfoodfacts.api.ProductResource.get')def test_fetch_from_off_updates_existing_serving_unit(self, mock_api):self.off_response['serving_size'] = '2 biscuits (30 g)'@@ -609,6 +641,101 @@ class IngredientModelTestCase(WgerTestCase):ingredient = Ingredient.fetch_ingredient_from_off('1234')self.assertIsNone(ingredient)+ @patch('openfoodfacts.api.ProductResource.get')+ def test_sync_serving_unit_from_off_if_missing_creates_unit(self, mock_api):+ mock_api.return_value = {+ **self.off_response,+ 'serving_size': '2 biscuits (30 g)',+ }+ ingredient = Ingredient.objects.get(pk=1)+ ingredient.source_name = Source.OPEN_FOOD_FACTS.value+ ingredient.code = '1234'+ ingredient.save(update_fields=['source_name', 'code'])+ ingredient.ingredientweightunit_set.all().delete()++ created, updated = ingredient.sync_serving_unit_from_off_if_missing()++ self.assertEqual((created, updated), (True, False))+ self.assertEqual(ingredient.ingredientweightunit_set.count(), 1)++ @patch('openfoodfacts.api.ProductResource.get')+ def test_sync_serving_unit_from_off_if_missing_skips_existing_units(self, mock_api):+ ingredient = Ingredient.objects.get(pk=1)+ ingredient.source_name = Source.OPEN_FOOD_FACTS.value+ ingredient.code = '1234'+ ingredient.save(update_fields=['source_name', 'code'])+ ingredient.ingredientweightunit_set.get_or_create(+ unit=WeightUnit.objects.get(pk=5),+ defaults={'gram': 15, 'amount': Decimal('1.00')},+ )++ created, updated = ingredient.sync_serving_unit_from_off_if_missing()++ self.assertEqual((created, updated), (False, False))+ mock_api.assert_not_called()++ @patch('openfoodfacts.api.ProductResource.get')+ def test_sync_serving_unit_from_off_if_missing_skips_non_off_source(self, mock_api):+ ingredient = Ingredient.objects.get(pk=1)+ ingredient.source_name = Source.USDA.value+ ingredient.code = '1234'+ ingredient.save(update_fields=['source_name', 'code'])+ ingredient.ingredientweightunit_set.all().delete()++ created, updated = ingredient.sync_serving_unit_from_off_if_missing()++ self.assertEqual((created, updated), (False, False))+ mock_api.assert_not_called()++ @patch('openfoodfacts.api.ProductResource.get')+ def test_sync_serving_unit_from_off_if_missing_skips_missing_code(self, mock_api):+ ingredient = Ingredient.objects.get(pk=1)+ ingredient.source_name = Source.OPEN_FOOD_FACTS.value+ ingredient.code = ''+ ingredient.save(update_fields=['source_name', 'code'])+ ingredient.ingredientweightunit_set.all().delete()++ created, updated = ingredient.sync_serving_unit_from_off_if_missing()++ self.assertEqual((created, updated), (False, False))+ mock_api.assert_not_called()++ @patch('openfoodfacts.api.ProductResource.get')+ def test_sync_serving_unit_from_off_if_missing_handles_off_fetch_failure(self, mock_api):+ mock_api.return_value = None+ ingredient = Ingredient.objects.get(pk=1)+ ingredient.source_name = Source.OPEN_FOOD_FACTS.value+ ingredient.code = '1234'+ ingredient.save(update_fields=['source_name', 'code'])+ ingredient.ingredientweightunit_set.all().delete()++ created, updated = ingredient.sync_serving_unit_from_off_if_missing()++ self.assertEqual((created, updated), (False, False))+ self.assertEqual(ingredient.ingredientweightunit_set.count(), 0)++ @patch('openfoodfacts.api.ProductResource.get')+ def test_fetch_from_off_does_not_create_unit_for_non_derivable_serving_size(self, mock_api):+ self.off_response['serving_size'] = '2 tbsp'+ mock_api.return_value = self.off_response++ ingredient = Ingredient.fetch_ingredient_from_off('1234')++ self.assertIsNotNone(ingredient)+ self.assertEqual(ingredient.ingredientweightunit_set.count(), 0)+++class IngredientInfoLazyServingUnitSyncApiTestCase(WgerTestCase):+ @patch('wger.nutrition.models.Ingredient.sync_serving_unit_from_off_if_missing')+ def test_detail_triggers_lazy_sync(self, mock_sync):+ self.client.get(reverse('api-ingredientinfo-detail', kwargs={'pk': 1}))+ mock_sync.assert_called_once()++ @patch('wger.nutrition.models.Ingredient.sync_serving_unit_from_off_if_missing')+ def test_list_does_not_trigger_lazy_sync(self, mock_sync):+ self.client.get(reverse('api-ingredientinfo-list'))+ mock_sync.assert_not_called()+class IngredientApiCodeSearch(BaseTestCase, ApiBaseTestCase):url = '/api/v2/ingredient/'diff --git a/wger/nutrition/tests/test_meal_item.py b/wger/nutrition/tests/test_meal_item.pyindex f2e9ca8b7..efc19d5f0 100644--- a/wger/nutrition/tests/test_meal_item.py+++ b/wger/nutrition/tests/test_meal_item.py@@ -15,6 +15,9 @@# wgerfrom wger.core.tests import api_base_test+from wger.core.tests.base_testcase import WgerTestCase+from wger.nutrition.forms import MealItemForm+from wger.nutrition.models import IngredientWeightUnitfrom wger.nutrition.models import MealItem@@ -31,3 +34,53 @@ class MealItemApiTestCase(api_base_test.ApiBaseResourceTestCase):'amount': 100,'ingredient': 1,}+++class MealItemFormTestCase(WgerTestCase):+ """+ Tests for meal item form quantity/unit behavior.+ """++ def test_weight_unit_field_has_explicit_grams_label(self):+ """+ The empty choice should clearly represent grams.+ """+ form = MealItemForm()+ self.assertEqual(str(form.fields['weight_unit'].empty_label), 'grams (g)')++ def test_weight_unit_choices_include_serving_label(self):+ """+ Serving-size options should include amount and gram conversion.+ """+ form = MealItemForm(data={'ingredient': 1})+ labels = [str(label) for _, label in form.fields['weight_unit'].choices]++ self.assertTrue(any(' = ' in label and label.endswith('g') for label in labels))+ self.assertTrue(+ all(+ unit.ingredient_id == 1+ for unit in form.fields['weight_unit'].queryset.select_related('ingredient')+ )+ )++ def test_weight_unit_queryset_accepts_ingredient_id_key(self):+ """+ The form should also support ingredient_id in bound data.+ """+ form = MealItemForm(data={'ingredient_id': 1})++ self.assertTrue(form.fields['weight_unit'].queryset.exists())+ self.assertTrue(+ all(+ unit.ingredient_id == 1+ for unit in form.fields['weight_unit'].queryset.select_related('ingredient')+ )+ )++ def test_invalid_ingredient_keeps_empty_weight_unit_queryset(self):+ """+ Invalid ingredient values should not crash and should keep unit choices empty.+ """+ form = MealItemForm(data={'ingredient': 'not-a-number'})++ self.assertEqual(form.fields['weight_unit'].queryset.count(), 0)diff --git a/wger/nutrition/tests/test_off.py b/wger/nutrition/tests/test_off.pyindex 0facae5c1..c66848778 100644--- a/wger/nutrition/tests/test_off.py+++ b/wger/nutrition/tests/test_off.py@@ -218,3 +218,21 @@ class ExtractInfoFromOffTestCase(SimpleTestCase):self.assertEqual(result.serving_size_gram, 30)self.assertEqual(result.serving_size_unit, 'Serving')self.assertEqual(result.serving_size_amount, 1)++ def test_serving_size_volume_with_gram_equivalent(self):+ self.off_data1['serving_size'] = '200 ml (206 g)'++ result = extract_info_from_off(self.off_data1, 1)++ self.assertEqual(result.serving_size_gram, 206)+ self.assertEqual(result.serving_size_unit, 'ml')+ self.assertEqual(result.serving_size_amount, 200)++ def test_serving_size_without_mass_is_parsed(self):+ self.off_data1['serving_size'] = '200 ml'++ result = extract_info_from_off(self.off_data1, 1)++ self.assertIsNone(result.serving_size_gram)+ self.assertEqual(result.serving_size_unit, 'ml')+ self.assertEqual(result.serving_size_amount, 200)diff --git a/wger/nutrition/views/ingredient.py b/wger/nutrition/views/ingredient.pyindex 58bc1bbfc..6c1eb34a4 100644--- a/wger/nutrition/views/ingredient.py+++ b/wger/nutrition/views/ingredient.py@@ -99,6 +99,10 @@ def view(request, pk, slug=None):ingredient,settings.WGER_SETTINGS['INGREDIENT_CACHE_TTL'],)++ # Opportunistically fetch missing OFF serving units during page load.+ ingredient.sync_serving_unit_from_off_if_missing()+context['ingredient'] = ingredientcontext['image'] = ingredient.get_image(request)context['form'] = UnitChooserForm(