@wger-project/react-components 25.10.16

package/src/components/Nutrition/models/meal.ts

@@ -0,0 +1,128 @@
+import { NutritionalValues } from "components/Nutrition/helpers/nutritionalValues";
+import { DiaryEntry } from "components/Nutrition/models/diaryEntry";
+import { MealItem } from "components/Nutrition/models/mealItem";
+import { PSEUDO_MEAL_ID } from "components/Nutrition/models/nutritionalPlan";
+import { Adapter } from "utils/Adapter";
+import { dateTimeToHHMM, dateTimeToLocaleHHMM, HHMMToDateTime, isSameDay } from "utils/date";
+
+export interface ApiMealType {
+    id: number,
+    plan: number,
+    order: number,
+    time: string | null,
+    name: string
+}
+
+
+export type MealConstructorParams = {
+    id?: number | null;
+    planId?: number | null;
+    order?: number;
+    time?: Date | null;
+    name: string;
+    items?: MealItem[];
+    diaryEntries?: DiaryEntry[];
+};
+
+export class Meal {
+
+    public id: number | null = null;
+    public planId: number | null = null;
+    public order: number;
+    public time: Date | null = null;
+    public name: string;
+    public items: MealItem[];
+    public diaryEntries: DiaryEntry[];
+
+    constructor(params: MealConstructorParams) {
+        this.id = params.id || null;
+        this.planId = params.planId || null;
+        this.order = params.order || 1;
+        this.time = params.time || null;
+        this.name = params.name;
+        this.items = params.items || [];
+        this.diaryEntries = params.diaryEntries || [];
+    }
+
+    get isRealMeal() {
+        return this.id !== PSEUDO_MEAL_ID;
+    }
+
+    get timeHHMMLocale() {
+        return dateTimeToLocaleHHMM(this.time);
+    }
+
+    get displayName() {
+        return this.name ? this.name : this.timeHHMMLocale;
+    }
+
+    /*
+     * Returns the diary entries for the current day.
+     */
+    get diaryEntriesToday(): DiaryEntry[] {
+        return this.diaryEntries.filter(entry => isSameDay(entry.datetime, new Date()));
+    }
+
+    get plannedNutritionalValues(): NutritionalValues {
+        const out = new NutritionalValues();
+        for (const item of this.items) {
+            out.add(item.nutritionalValues);
+        }
+        return out;
+    }
+
+    get loggedNutritionalValuesToday(): NutritionalValues {
+        const out = new NutritionalValues();
+        for (const entry of this.diaryEntriesToday) {
+            out.add(entry.nutritionalValues);
+        }
+        return out;
+    }
+
+    static clone(other: Meal, overrides?: Partial<MealConstructorParams>): Meal {
+        return new Meal({
+            id: overrides?.id ?? other.id,
+            planId: overrides?.planId ?? other.planId,
+            order: overrides?.order ?? other.order,
+            time: overrides?.time ?? other.time,
+            name: overrides?.name ?? other.name,
+            items: overrides?.items ?? other.items,
+            diaryEntries: overrides?.diaryEntries ?? other.diaryEntries,
+        });
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static fromJson(json: any): Meal {
+        return adapter.fromJson(json);
+    }
+
+
+    toJson() {
+        return adapter.toJson(this);
+    }
+}
+
+
+class MealAdapter implements Adapter<Meal> {
+    fromJson(item: ApiMealType) {
+        return new Meal({
+            id: item.id,
+            planId: item.plan,
+            order: item.order,
+            time: HHMMToDateTime(item.time),
+            name: item.name,
+        });
+    }
+
+    toJson(item: Meal) {
+        return {
+            ...(item.id != null ? { id: item.id } : {}),
+            plan: item.planId,
+            name: item.name,
+            order: item.order,
+            time: dateTimeToHHMM(item.time)
+        };
+    }
+}
+
+const adapter = new MealAdapter();

package/src/components/Nutrition/models/mealItem.test.ts

@@ -0,0 +1,23 @@
+import { TEST_MEAL_ITEM_1, TEST_WEIGHT_UNIT_SLICE } from "tests/nutritionTestdata";
+
+
+describe("Test the meal item model", () => {
+
+    test('correctly uses the weight unit', async () => {
+        // Arrange
+        TEST_MEAL_ITEM_1.weightUnit = TEST_WEIGHT_UNIT_SLICE;
+
+        // Act
+        const values = TEST_MEAL_ITEM_1.nutritionalValues;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(60, 2);
+        expect(values.protein).toBeCloseTo(342, 2);
+        expect(values.carbohydrates).toBeCloseTo(1116, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(611.999, 2);
+        expect(values.fat).toBeCloseTo(198, 2);
+        expect(values.fatSaturated).toBeCloseTo(54, 2);
+        expect(values.fiber).toBeCloseTo(30, 2);
+        expect(values.sodium).toBeCloseTo(2.4, 2);
+    });
+});

package/src/components/Nutrition/models/mealItem.ts

@@ -0,0 +1,134 @@
+import { NutritionalValues } from "components/Nutrition/helpers/nutritionalValues";
+import { DiaryEntry } from "components/Nutrition/models/diaryEntry";
+import { Ingredient } from "components/Nutrition/models/Ingredient";
+import { NutritionWeightUnit } from "components/Nutrition/models/weightUnit";
+import { Adapter } from "utils/Adapter";
+
+export interface ApiMealItemType {
+    id: number,
+    meal: number,
+    ingredient: number,
+    weight_unit: number,
+    order: number,
+    amount: string
+}
+
+export type MealItemConstructorParams = {
+    id?: number;
+    mealId: number;
+    amount: number;
+    order: number;
+
+    ingredientId: number;
+    ingredient?: Ingredient | null;
+
+    weightUnitId?: number | null;
+    weightUnit?: NutritionWeightUnit | null;
+};
+
+export class MealItem {
+    public id?: number | null;
+    public mealId: number;
+    public ingredientId: number;
+    public weightUnitId: number | null;
+    public amount: number;
+    public order: number;
+    public ingredient: Ingredient | null = null;
+    public weightUnit: NutritionWeightUnit | null = null;
+
+    constructor(params: MealItemConstructorParams) {
+        this.id = params.id || null;
+        this.mealId = params.mealId;
+        this.amount = params.amount;
+        this.order = params.order;
+
+        this.ingredientId = params.ingredientId;
+        this.weightUnitId = params.weightUnitId ?? null;
+        if (params.ingredient) {
+            this.ingredient = params.ingredient;
+            this.ingredientId = params.ingredient.id;
+        }
+        if (params.weightUnit) {
+            this.weightUnit = params.weightUnit;
+            this.weightUnitId = params.weightUnit.id;
+        }
+    }
+
+    get amountString(): string {
+        return this.amount.toFixed().toString() + (this.weightUnitId !== null ? ` ${this.weightUnit?.name}` : 'g');
+    }
+
+    get nutritionalValues() {
+        if (this.ingredient) {
+            return NutritionalValues.fromIngredient(this.ingredient, this.amount, this.weightUnit);
+        }
+        return new NutritionalValues();
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static fromJson(json: any): MealItem {
+        return adapter.fromJson(json);
+    }
+
+    static clone(other: MealItem, overrides?: Partial<MealItemConstructorParams>): MealItem {
+        const ingredient = overrides?.ingredient ?? other.ingredient;
+        const weightUnit = overrides?.weightUnit ?? other.weightUnit;
+
+        return new MealItem({
+            id: overrides?.id ?? (other.id ?? undefined),
+            mealId: overrides?.mealId ?? other.mealId,
+            amount: overrides?.amount ?? other.amount,
+            order: overrides?.order ?? other.order,
+            ingredientId: ingredient ? ingredient.id : (overrides?.ingredientId ?? other.ingredientId),
+            ingredient,
+            weightUnitId: weightUnit ? weightUnit.id : (overrides?.weightUnitId ?? other.weightUnitId),
+            weightUnit,
+        });
+    }
+
+    diaryEntry(planId: number, date?: Date): DiaryEntry {
+        return new DiaryEntry({
+            mealId: this.mealId,
+            planId: planId,
+            amount: this.amount,
+            datetime: date || new Date(),
+            ingredient: this.ingredient,
+            ingredientId: this.ingredientId,
+            weightUnitId: this.weightUnitId,
+            weightUnit: this.weightUnit,
+        });
+    }
+
+    toJson() {
+        return adapter.toJson(this);
+    }
+}
+
+
+class MealItemAdapter implements Adapter<MealItem> {
+    fromJson(item: ApiMealItemType) {
+        return new MealItem({
+            id: item.id,
+            mealId: item.meal,
+            ingredientId: item.ingredient,
+            weightUnitId: item.weight_unit,
+            amount: parseFloat(item.amount),
+            order: item.order,
+        });
+    }
+
+    toJson(item: MealItem) {
+        return {
+            ...(item.id != null ? { id: item.id } : {}),
+            meal: item.mealId,
+            ingredient: item.ingredientId,
+
+            // eslint-disable-next-line camelcase
+            weight_unit: item.weightUnitId,
+            amount: item.amount.toString(),
+            order: item.order,
+        };
+    }
+}
+
+const adapter = new MealItemAdapter();

package/src/components/Nutrition/models/nutritionalPlan.test.ts

@@ -0,0 +1,169 @@
+import { NutritionalPlan } from "components/Nutrition/models/nutritionalPlan";
+import { TEST_MEAL_1, TEST_NUTRITIONAL_PLAN_1 } from "tests/nutritionTestdata";
+
+jest.useFakeTimers();
+
+describe("Test the nutritional plan model", () => {
+
+    beforeAll(() => {
+        jest.setSystemTime(new Date('2023-07-01'));
+    });
+
+    afterAll(() => {
+        jest.useRealTimers();
+    });
+
+    test('correctly calculates the nutritional values logged for today', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.loggedNutritionalValuesToday;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(296.7, 2);
+        expect(values.protein).toBeCloseTo(13.82, 2);
+        expect(values.carbohydrates).toBeCloseTo(80.87, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(44.35, 2);
+        expect(values.fat).toBeCloseTo(6.51, 2);
+        expect(values.fatSaturated).toBeCloseTo(1.58, 2);
+        expect(values.fiber).toBeCloseTo(5.25, 2);
+        expect(values.sodium).toBeCloseTo(0.064, 2);
+    });
+
+    test('correctly calculates the nutritional values logged on a specific date', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.loggedNutritionalValuesDate(new Date('2023-07-07'));
+
+        // Assert
+        expect(values.energy).toBeCloseTo(48, 2);
+        expect(values.protein).toBeCloseTo(0.71, 2);
+        expect(values.carbohydrates).toBeCloseTo(11.2, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(9.424, 2);
+        expect(values.fat).toBeCloseTo(0, 2);
+        expect(values.fatSaturated).toBeCloseTo(0, 2);
+        expect(values.fiber).toBeCloseTo(0, 2);
+        expect(values.sodium).toBeCloseTo(0.0048, 2);
+    });
+
+    test('correctly calculates the average nutritional values logged for the last 7 days', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.loggedNutritionalValues7DayAvg;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(67.18, 2);
+        expect(values.protein).toBeCloseTo(2.73, 2);
+        expect(values.carbohydrates).toBeCloseTo(12.105, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(7.73, 2);
+        expect(values.fat).toBeCloseTo(1.77, 2);
+        expect(values.fatSaturated).toBeCloseTo(0.89, 2);
+        expect(values.fiber).toBeCloseTo(2.19, 2);
+        expect(values.sodium).toBeCloseTo(0.0085, 2);
+    });
+
+    test('correctly calculates the planned nutritional values', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.plannedNutritionalValues;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(3534, 2);
+        expect(values.protein).toBeCloseTo(189.56, 2);
+        expect(values.carbohydrates).toBeCloseTo(354.16, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(111.76, 2);
+        expect(values.fat).toBeCloseTo(165.239, 2);
+        expect(values.fatSaturated).toBeCloseTo(90.36, 2);
+        expect(values.fiber).toBeCloseTo(214.36, 2);
+        expect(values.sodium).toBeCloseTo(0.3296, 2);
+    });
+
+    test('correctly calculates the average nutritional values for the last 7 days', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.loggedNutritionalValues7DayAvg;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(67.18, 2);
+        expect(values.protein).toBeCloseTo(2.731, 2);
+        expect(values.carbohydrates).toBeCloseTo(12.105, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(7.733, 2);
+        expect(values.fat).toBeCloseTo(1.7675, 2);
+        expect(values.fatSaturated).toBeCloseTo(0.89, 2);
+        expect(values.fiber).toBeCloseTo(2.1875, 2);
+        expect(values.sodium).toBeCloseTo(0.0088, 2);
+    });
+
+    test('correctly calculates the average nutritional values for the current day', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.loggedNutritionalValuesToday;
+
+        // Assert
+        expect(values.energy).toBeCloseTo(296.7, 2);
+        expect(values.protein).toBeCloseTo(13.8199, 2);
+        expect(values.carbohydrates).toBeCloseTo(80.87, 2);
+        expect(values.carbohydratesSugar).toBeCloseTo(44.34999, 2);
+        expect(values.fat).toBeCloseTo(6.51, 2);
+        expect(values.fatSaturated).toBeCloseTo(1.58, 2);
+        expect(values.fiber).toBeCloseTo(5.25, 2);
+        expect(values.sodium).toBeCloseTo(0.064, 2);
+    });
+
+    test('correctly groups the diary entries by date', async () => {
+
+        // Act
+        const values = TEST_NUTRITIONAL_PLAN_1.groupDiaryEntries;
+
+        // Assert
+        expect([...values.keys()]).toStrictEqual([
+            "2023-07-01",
+            "2023-07-02",
+            "2023-07-03",
+            "2023-07-04",
+            "2023-07-05",
+            "2023-07-06",
+            "2023-07-07",
+            "2023-07-08",
+            "2023-06-01",
+            "2023-06-15",
+            "2023-06-20",
+            "2023-08-20",
+        ]);
+        expect(values.get("2023-07-01")!.entries.length).toBe(3);
+        expect(values.get("2023-07-01")!.nutritionalValues.energy).toBeCloseTo(296.7, 2);
+
+        expect(values.get("2023-07-02")!.entries.length).toBe(1);
+        expect(values.get("2023-07-02")!.nutritionalValues.energy).toBeCloseTo(12, 2);
+    });
+
+    test('correctly generates the synthetic meal entry', async () => {
+
+        // Act
+        const meal = TEST_NUTRITIONAL_PLAN_1.pseudoMealOthers('the name');
+
+        // Assert
+        expect(meal.id).toBe(-1);
+        expect(meal.name).toBe('the name');
+        expect(meal.diaryEntries.length).toBe(2);
+    });
+
+    test('the planned helper getters work correctly', async () => {
+
+        // Act
+        const plan = new NutritionalPlan({
+            id: 1,
+            creationDate: new Date(),
+            description: 'test 1',
+        });
+
+        // Assert
+        expect(plan.hasAnyPlanned).toBe(false);
+
+        plan.goalEnergy = 2000;
+        expect(plan.hasAnyPlanned).toBe(true);
+
+        plan.goalEnergy = null;
+        plan.meals = [TEST_MEAL_1];
+        expect(plan.hasAnyPlanned).toBe(true);
+    });
+});