Added a new field calories for products (closes #268)

changelog/52_UNRELEASED_2019-xx-xx.md

@@ -28,6 +28,7 @@
   - Improved that on any stock changes the corresponding product table row is properly refreshed
 - New `config.php` setting `FEATURE_SETTING_STOCK_COUNT_OPENED_PRODUCTS_AGAINST_MINIMUM_STOCK_AMOUNT` to configure if opened products should be considered for minimum stock amounts (defaults to `true`, so opened products will now be considered missing by default - please change this setting if you want the old behaviour)
 - The product description now can have formattings (HTML/WYSIWYG editor like for recipes)
+- Products now have a new field for calories (kcal, per stock quantity unit)
 - "Factor purchase to stock quantity unit" (product option) can now also be a decimal number when "Allow partial units in stock" is enabled
 - New "Sub feature flags" in `config.php` to disable some sub-features (hide the corresponding UI elements) if you don't need them (all new feature flags default to `true`, so no changed behaviour when not configured)
   - `FEATURE_FLAG_STOCK_PRICE_TRACKING` to disable product price tracking
@@ -42,6 +43,7 @@
 
 ### Recipe improvements
 - Based on the new linked quantity units, recipe ingredients can now use any product related unit, the amount is calculated according to the cnoversion factor of the unit relation
+- Based on the new calories field per product, the calories per recipe are now shown based on the selected servings (in the header, next to the costs)
 - New option "price factor" per recipe ingredient (defaults to `1`) - the resulting costs of the recipe ingredient will be multiplied by that factor
   - Use this for example for spices in combination with "Only check if a single unit is in stock" to not take the full price of a pack of pepper into account for a recipe
 - The search field on the recipe overview page now also searches for product names of recipe ingredients (means it's possible to search an recipe by a product name)

controllers/RecipesController.php

@@ -68,6 +68,7 @@ class RecipesController extends BaseController
 			'selectedRecipeSubRecipesPositions' => $selectedRecipeSubRecipesPositions,
 			'includedRecipeIdsAbsolute' => $includedRecipeIdsAbsolute,
 			'selectedRecipeTotalCosts' => FindObjectInArrayByPropertyValue($recipesResolved, 'recipe_id', $selectedRecipe->id)->costs,
+			'selectedRecipeTotalCalories' => FindObjectInArrayByPropertyValue($recipesResolved, 'recipe_id', $selectedRecipe->id)->calories,
 			'userfields' => $this->UserfieldsService->GetFields('recipes'),
 			'userfieldValues' => $this->UserfieldsService->GetAllValues('recipes'),
 			'quantityUnitConversionsResolved' => $this->Database->quantity_unit_conversions_resolved()

localization/strings.pot

@@ -1492,3 +1492,9 @@ msgstr ""
 
 msgid "Output"
 msgstr ""
+
+msgid "Energy (kcal)"
+msgstr ""
+
+msgid "Per stock quantity unit"
+msgstr ""

migrations/0088.sql

@@ -0,0 +1,107 @@
+ALTER TABLE products
+ADD calories INTEGER;
+
+DROP VIEW recipes_pos_resolved;
+CREATE VIEW recipes_pos_resolved
+AS
+
+-- Multiplication by 1.0 to force conversion to float (REAL)
+
+SELECT
+	r.id AS recipe_id,
+	rp.id AS recipe_pos_id,
+	rp.product_id AS product_id,
+	rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) AS recipe_amount,
+	IFNULL(sc.amount_aggregated, 0) AS stock_amount,
+	CASE WHEN IFNULL(sc.amount_aggregated, 0) >= CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END THEN 1 ELSE 0 END AS need_fulfilled,
+	CASE WHEN IFNULL(sc.amount_aggregated, 0) - CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END < 0 THEN ABS(IFNULL(sc.amount_aggregated, 0) - (CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END)) ELSE 0 END AS missing_amount,
+	IFNULL(sl.amount, 0) * p.qu_factor_purchase_to_stock AS amount_on_shopping_list,
+	CASE WHEN IFNULL(sc.amount_aggregated, 0) + (CASE WHEN r.not_check_shoppinglist = 1 THEN 0 ELSE IFNULL(sl.amount, 0) END * p.qu_factor_purchase_to_stock) >= CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END THEN 1 ELSE 0 END AS need_fulfilled_with_shopping_list,
+	rp.qu_id,
+	(CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END / p.qu_factor_purchase_to_stock) * pcp.last_price * rp.price_factor AS costs,
+	CASE WHEN rnr.recipe_id = rnr.includes_recipe_id THEN 0 ELSE 1 END AS is_nested_recipe_pos,
+	rp.ingredient_group,
+	rp.id, -- Just a dummy id column
+	rnr.includes_recipe_id as child_recipe_id,
+	rp.note,
+	rp.variable_amount AS recipe_variable_amount,
+	rp.only_check_single_unit_in_stock,
+	rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) * IFNULL(p.calories, 0) AS calories
+FROM recipes r
+JOIN recipes_nestings_resolved rnr
+	ON r.id = rnr.recipe_id
+JOIN recipes rnrr
+	ON rnr.includes_recipe_id = rnrr.id
+JOIN recipes_pos rp
+	ON rnr.includes_recipe_id = rp.recipe_id
+JOIN products p
+	ON rp.product_id = p.id
+LEFT JOIN (
+	SELECT product_id, SUM(amount) AS amount
+	FROM shopping_list
+	GROUP BY product_id) sl
+	ON rp.product_id = sl.product_id
+LEFT JOIN stock_current sc
+	ON rp.product_id = sc.product_id
+LEFT JOIN products_current_price pcp
+	ON rp.product_id = pcp.product_id
+WHERE rp.not_check_stock_fulfillment = 0
+
+UNION
+
+-- Just add all recipe positions which should not be checked against stock with fulfilled need
+
+SELECT
+	r.id AS recipe_id,
+	rp.id AS recipe_pos_id,
+	rp.product_id AS product_id,
+	rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) AS recipe_amount,
+	IFNULL(sc.amount_aggregated, 0) AS stock_amount,
+	1 AS need_fulfilled,
+	0 AS missing_amount,
+	IFNULL(sl.amount, 0) * p.qu_factor_purchase_to_stock AS amount_on_shopping_list,
+	1 AS need_fulfilled_with_shopping_list,
+	rp.qu_id,
+	(CASE WHEN rp.only_check_single_unit_in_stock = 1 THEN 1 ELSE rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) END / p.qu_factor_purchase_to_stock) * pcp.last_price * rp.price_factor AS costs,
+	CASE WHEN rnr.recipe_id = rnr.includes_recipe_id THEN 0 ELSE 1 END AS is_nested_recipe_pos,
+	rp.ingredient_group,
+	rp.id, -- Just a dummy id column
+	rnr.includes_recipe_id as child_recipe_id,
+	rp.note,
+	rp.variable_amount AS recipe_variable_amount,
+	rp.only_check_single_unit_in_stock,
+	rp.amount * (r.desired_servings*1.0 / r.base_servings*1.0) * (rnr.includes_servings*1.0 / CASE WHEN rnr.recipe_id != rnr.includes_recipe_id THEN rnrr.base_servings*1.0 ELSE 1 END) * IFNULL(p.calories, 0) AS calories
+FROM recipes r
+JOIN recipes_nestings_resolved rnr
+	ON r.id = rnr.recipe_id
+JOIN recipes rnrr
+	ON rnr.includes_recipe_id = rnrr.id
+JOIN recipes_pos rp
+	ON rnr.includes_recipe_id = rp.recipe_id
+JOIN products p
+	ON rp.product_id = p.id
+LEFT JOIN (
+	SELECT product_id, SUM(amount) AS amount
+	FROM shopping_list
+	GROUP BY product_id) sl
+	ON rp.product_id = sl.product_id
+LEFT JOIN stock_current sc
+	ON rp.product_id = sc.product_id
+LEFT JOIN products_current_price pcp
+	ON rp.product_id = pcp.product_id
+WHERE rp.not_check_stock_fulfillment = 1;
+
+DROP VIEW recipes_resolved;
+CREATE VIEW recipes_resolved
+AS
+SELECT
+	r.id AS recipe_id,
+	IFNULL(MIN(rpr.need_fulfilled), 1) AS need_fulfilled,
+	IFNULL(MIN(rpr.need_fulfilled_with_shopping_list), 1) AS need_fulfilled_with_shopping_list,
+	(SELECT COUNT(*) FROM recipes_pos_resolved WHERE recipe_id = r.id AND need_fulfilled = 0) AS missing_products_count,
+	IFNULL(SUM(rpr.costs), 0) AS costs,
+	IFNULL(SUM(rpr.calories), 0) AS calories
+FROM recipes r
+LEFT JOIN recipes_pos_resolved rpr
+	ON r.id = rpr.recipe_id
+GROUP BY r.id;

public/js/grocy.js

@@ -519,6 +519,11 @@ function RefreshLocaleNumberDisplay()
 	{
 		$(this).text(parseFloat($(this).text()).toLocaleString(undefined, { minimumFractionDigits: 0, maximumFractionDigits: 3 }));
 	});
+
+	$(".locale-number-format[data-format='generic']").each(function ()
+	{
+		$(this).text(parseFloat($(this).text()).toLocaleString(undefined, { minimumFractionDigits: 0, maximumFractionDigits: 2 }));
+	});
 }
 RefreshLocaleNumberDisplay();
 

services/DemoDataGeneratorService.php

@@ -87,12 +87,13 @@ class DemoDataGeneratorService extends BaseService
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id) VALUES ('{$this->__t_sql('Salami')}', 2, 3, 3, 1, 6); --18
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id) VALUES ('{$this->__t_sql('Toast')}', 3, 5, 5, 1, 2); --19
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id) VALUES ('{$this->__t_sql('Minced meat')}', 2, 3, 3, 1, 4); --20
-				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, enable_tare_weight_handling, tare_weight) VALUES ('{$this->__t_sql('Flour')}', 3, 8, 8, 1, 3, 1, 500); --21
-				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id) VALUES ('{$this->__t_sql('Sugar')}', 3, 3, 3, 1, 3); --22
-				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id) VALUES ('{$this->__t_sql('Milk')}', 2, 10, 10, 1, 6); --23
+				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, enable_tare_weight_handling, tare_weight, calories) VALUES ('{$this->__t_sql('Flour')}', 3, 8, 8, 1, 3, 1, 500, 2); --21
+				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, calories) VALUES ('{$this->__t_sql('Sugar')}', 3, 3, 3, 1, 3, 4); --22
+				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, calories) VALUES ('{$this->__t_sql('Milk')}', 2, 10, 10, 1, 6, 1); --23
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, parent_product_id) VALUES ('{$this->__t_sql('Milk Chocolate')}', 4, 3, 3, 1, 1, 2); --24
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, parent_product_id) VALUES ('{$this->__t_sql('Dark Chocolate')}', 4, 3, 3, 1, 1, 2); --25
 				INSERT INTO products (name, location_id, qu_id_purchase, qu_id_stock, qu_factor_purchase_to_stock, product_group_id, parent_product_id, barcode) VALUES ('{$this->__t_sql('Waffle rolls')}', 4, 3, 3, 1, 1, 2, '22111289'); --26
+				UPDATE products SET calories = 123 WHERE IFNULL(calories, 0) = 0;
 
 				/* Prevent invalid quantity unit assignments */
 				UPDATE products SET qu_id_stock = (SELECT MIN(id) FROM quantity_units) WHERE id IN (SELECT id FROM products WHERE qu_id_stock NOT IN (SELECT id FROM quantity_units));

views/productform.blade.php

@@ -201,6 +201,17 @@
 					</label>
 				</div>
 			</div>
+
+			@php if($mode == 'edit') { $value = $product->calories; } else { $value = ''; } @endphp
+			@include('components.numberpicker', array(
+				'id' => 'calories',
+				'label' => 'Energy (kcal)',
+				'min' => 0,
+				'step' => 1,
+				'value' => $value,
+				'invalidFeedback' => $__t('The amount cannot be lower than %s', '0'),
+				'hint' => $__t('Per stock quantity unit') 
+			))
 			@endif
 
 			<div class="form-group">

views/recipes.blade.php

@@ -151,7 +151,7 @@
 
 			<div class="card-body mb-0 pb-0">
 				<div class="row">
-					<div class="col-5">
+					<div class="col-4">
 						@include('components.numberpicker', array(
 							'id' => 'servings-scale',
 							'label' => 'Servings',
@@ -161,8 +161,14 @@
 							'additionalAttributes' => 'data-recipe-id="' . $selectedRecipe->id . '"'
 						))
 					</div>
+					<div class="col-2">
+						<label>{{ $__t('Energy (kcal)') }}</label>
+						<p class="font-weight-bold font-italic">
+							<span class="locale-number-format" data-format="generic">{{ $selectedRecipeTotalCalories }}</span>
+						</p>
+					</div>
 					@if(GROCY_FEATURE_FLAG_STOCK_PRICE_TRACKING)
-					<div class="col-7">
+					<div class="col-6">
 						<label>{{ $__t('Costs') }}&nbsp;&nbsp;
 							<span class="small text-muted">{{ $__t('Based on the prices of the last purchase per product') }}</span>
 						</label>