1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
from django.db import models
from django.core.exceptions import ValidationError
class Tag(models.Model):
"""Flexible tagging for ingredients — protein, carb, veg, seasoning, etc.
An ingredient can have multiple tags."""
name = models.CharField(max_length=50, unique=True)
class Meta:
ordering = ["name"]
def __str__(self):
return self.name
class Ingredient(models.Model):
"""Master list of known ingredients."""
name = models.CharField(max_length=100, unique=True) # canonical: "egg noodles"
default_unit = models.CharField(max_length=20) # "nests", "g", "items"
tags = models.ManyToManyField(Tag, blank=True)
shelf_life_days = models.IntegerField(
null=True, blank=True, help_text="Typical fridge life in days once opened/defrosted"
)
aliases = models.JSONField(
default=list, blank=True, help_text='Alternative names, e.g. ["noodles", "egg noodle nests"]'
)
class Meta:
ordering = ["name"]
def __str__(self):
return self.name
class PantryItem(models.Model):
"""What's in the kitchen right now."""
class Location(models.TextChoices):
FRIDGE = "fridge", "Fridge"
FREEZER = "freezer", "Freezer"
CUPBOARD = "cupboard", "Cupboard"
ingredient = models.ForeignKey(Ingredient, on_delete=models.CASCADE)
quantity = models.DecimalField(max_digits=8, decimal_places=2)
unit = models.CharField(max_length=20)
location = models.CharField(max_length=20, choices=Location.choices)
stored_date = models.DateField(auto_now_add=True)
expiry_date = models.DateField(null=True, blank=True)
is_staple = models.BooleanField(
default=False, help_text="Always restock when gone (onions, frozen chips)"
)
notes = models.TextField(blank=True)
class Meta:
ordering = ["expiry_date", "ingredient__name"]
def __str__(self):
return f"{self.ingredient.name} ({self.quantity} {self.unit}) [{self.location}]"
def clean(self):
"""Business rules for pantry items."""
if self.location == self.Location.FREEZER and self.expiry_date is not None:
raise ValidationError("Freezer items should not have an expiry date (frozen = no expiry).")
if self.location == self.Location.FRIDGE and self.expiry_date is None:
# Try to auto-set from ingredient shelf life
if self.ingredient_id and self.ingredient.shelf_life_days:
from datetime import date, timedelta
self.expiry_date = date.today() + timedelta(days=self.ingredient.shelf_life_days)
# Don't raise an error — some fridge items just don't have a known expiry
def save(self, *args, **kwargs):
self.full_clean()
super().save(*args, **kwargs)
# --- Meta-Recipes ---
class MetaRecipe(models.Model):
"""A cooking template with swappable ingredient slots."""
name = models.CharField(max_length=100) # "Stir Fry"
method = models.TextField(help_text="Cooking instructions (markdown)")
prep_time_mins = models.IntegerField(null=True, blank=True)
cook_time_mins = models.IntegerField(null=True, blank=True)
default_servings = models.IntegerField(default=2)
gear_needed = models.CharField(max_length=200, blank=True) # "frying pan"
tags = models.JSONField(default=list, blank=True) # ["quick", "one-pan"]
class Meta:
ordering = ["name"]
def __str__(self):
return self.name
class Slot(models.Model):
"""A swappable category in a meta-recipe (e.g. 'protein', 'carb')."""
meta_recipe = models.ForeignKey(MetaRecipe, on_delete=models.CASCADE, related_name="slots")
name = models.CharField(max_length=50) # "protein", "carb", "veg"
required = models.BooleanField(default=True)
max_choices = models.IntegerField(
default=1, help_text="Max ingredients to pick (1 for protein, 3 for veg)"
)
class Meta:
ordering = ["meta_recipe", "name"]
def __str__(self):
return f"{self.meta_recipe.name} > {self.name}"
class SlotOption(models.Model):
"""An ingredient that can fill a slot, with quantity per serving.
Example: Stir Fry > protein slot > pork mince, 250g per serving.
"""
slot = models.ForeignKey(Slot, on_delete=models.CASCADE, related_name="options")
ingredient = models.ForeignKey(Ingredient, on_delete=models.CASCADE)
quantity_per_serving = models.DecimalField(max_digits=8, decimal_places=2)
unit = models.CharField(max_length=20)
notes = models.CharField(max_length=200, blank=True) # "skin off", "defrost first"
class Meta:
ordering = ["slot", "ingredient__name"]
def __str__(self):
return f"{self.slot} > {self.ingredient.name} ({self.quantity_per_serving} {self.unit})"
class MetaRecipeBase(models.Model):
"""Ingredients always needed regardless of slot choices.
Example: Stir Fry always needs 1 onion + 2 cloves garlic per serving.
"""
meta_recipe = models.ForeignKey(
MetaRecipe, on_delete=models.CASCADE, related_name="base_ingredients"
)
ingredient = models.ForeignKey(Ingredient, on_delete=models.CASCADE)
quantity_per_serving = models.DecimalField(max_digits=8, decimal_places=2)
unit = models.CharField(max_length=20)
class Meta:
ordering = ["meta_recipe", "ingredient__name"]
def __str__(self):
return f"{self.meta_recipe.name} base: {self.ingredient.name}"
# --- Fixed Recipes ---
class Recipe(models.Model):
"""Traditional recipe with a fixed ingredient list."""
name = models.CharField(max_length=200)
method = models.TextField(help_text="Cooking instructions (markdown)")
prep_time_mins = models.IntegerField(null=True, blank=True)
cook_time_mins = models.IntegerField(null=True, blank=True)
servings = models.IntegerField(default=2)
source_url = models.URLField(blank=True)
source_book = models.CharField(max_length=200, blank=True)
gear_needed = models.CharField(max_length=200, blank=True)
tags = models.JSONField(default=list, blank=True)
class Meta:
ordering = ["name"]
def __str__(self):
return self.name
class RecipeIngredient(models.Model):
"""An ingredient in a fixed recipe with quantity."""
recipe = models.ForeignKey(Recipe, on_delete=models.CASCADE, related_name="ingredients")
ingredient = models.ForeignKey(Ingredient, on_delete=models.CASCADE)
quantity = models.DecimalField(max_digits=8, decimal_places=2)
unit = models.CharField(max_length=20)
optional = models.BooleanField(default=False)
class Meta:
ordering = ["recipe", "ingredient__name"]
def __str__(self):
return f"{self.recipe.name}: {self.ingredient.name}"
# --- Cook Log & Shopping ---
class CookLog(models.Model):
"""What was cooked and when. Links to either a meta-recipe or fixed recipe."""
date = models.DateField(auto_now_add=True)
meta_recipe = models.ForeignKey(
MetaRecipe, null=True, blank=True, on_delete=models.SET_NULL
)
recipe = models.ForeignKey(Recipe, null=True, blank=True, on_delete=models.SET_NULL)
slot_choices = models.JSONField(
default=dict,
blank=True,
help_text='Slot choices for meta-recipe, e.g. {"protein": "pork mince", "carb": "noodles"}',
)
servings = models.IntegerField(default=2)
notes = models.TextField(blank=True)
class Meta:
ordering = ["-date"]
def __str__(self):
recipe_name = self.meta_recipe or self.recipe or "Unknown"
return f"{self.date}: {recipe_name}"
def clean(self):
if not self.meta_recipe and not self.recipe:
raise ValidationError("Must link to either a meta-recipe or a fixed recipe.")
if self.meta_recipe and self.recipe:
raise ValidationError("Cannot link to both a meta-recipe and a fixed recipe.")
class ShoppingListItem(models.Model):
"""Items on the shopping list."""
ingredient = models.ForeignKey(
Ingredient, null=True, blank=True, on_delete=models.SET_NULL
)
name = models.CharField(max_length=100, help_text="Fallback name if not in ingredients table")
quantity = models.DecimalField(max_digits=8, decimal_places=2, null=True, blank=True)
unit = models.CharField(max_length=20, blank=True)
reason = models.CharField(max_length=200, blank=True) # "for stir fry" / "restock staple"
added_date = models.DateField(auto_now_add=True)
checked = models.BooleanField(default=False)
class Meta:
ordering = ["checked", "added_date"]
def __str__(self):
display = self.ingredient.name if self.ingredient else self.name
return f"{'✅' if self.checked else '🛒'} {display}"
|