feat: added quality facet error for reversed kcal and kj (#8438)

added quality facet error for reversed kcal and kj
openfoodfacts · May 23, 2023 · 0c76d76 · 0c76d76
1 parent d7fd285
commit 0c76d76
Show file tree

Hide file tree

Showing 3 changed files with 91 additions and 2 deletions.
diff --git a/lib/ProductOpener/DataQualityFood.pm b/lib/ProductOpener/DataQualityFood.pm
@@ -701,12 +701,24 @@ sub check_nutrition_data ($product_ref) {
 			# energy in kcal greater than in kj
 			if ($product_ref->{nutriments}{"energy-kcal_value"} > $product_ref->{nutriments}{"energy-kj_value"}) {
 				push @{$product_ref->{data_quality_errors_tags}}, "en:energy-value-in-kcal-greater-than-in-kj";
+
+				# additionally check if kcal value and kj value are reversed. Exact opposite condition as next error below
+				if (
+					(
+						$product_ref->{nutriments}{"energy-kcal_value"}
+						> 3.7 * $product_ref->{nutriments}{"energy-kj_value"} - 2
+					)
+					and ($product_ref->{nutriments}{"energy-kcal_value"}
+						< 4.7 * $product_ref->{nutriments}{"energy-kj_value"} + 2)
+					)
+				{
+					push @{$product_ref->{data_quality_errors_tags}}, "en:energy-value-in-kcal-and-kj-are-reversed";
+				}
 			}
 
 			# check energy in kcal is ~ 4.2 (+/- 0.5) energy in kj
 			#   +/- 2 to avoid false positives due to rounded values below 2 Kcal.
 			#   Eg. 1.49 Kcal -> 6.26 KJ in reality, can be rounded by the producer to 1 Kcal -> 6 KJ.
-			# TODO: add tests in /tests/unit/dataqualityfood.t
 			if (
 				(
 					$product_ref->{nutriments}{"energy-kj_value"}

diff --git a/taxonomies/data_quality.txt b/taxonomies/data_quality.txt
@@ -30,9 +30,13 @@ description:fr:La valeur de l'énergie en kJ doit être environ 4,2 fois plus gr
 en:Energy value in kcal greater than in kJ
 es:Valor energético en kcal mayor que en kJ
 fr:La valeur de l'énergie en kcal est plus grande qu'en kJ
-description:en:The energy value in kJ must be about 4.2 times greater than the value in kcal. The values could be inverted.
+description:en:The energy value in kJ must be about 4.2 times greater than the value in kcal. The values could be reversed.
 description:fr:La valeur de l'énergie en kJ doit être environ 4,2 fois plus grande que la valeur en kcal. Les valeurs sont peut être inversées.
 
+<en:Nutrition errors
+en:Energy value in kcal and kj are reversed
+description:en:The energy value in kJ must be about 4.2 times greater than the value in kcal. The values seems to be reversed.
+
 <en:Nutrition errors
 en:Energy value in kJ does not match value computed from other nutrients
 fr:Valeur énergétique en kJ ne correspondant pas à la valeur calculée à partir des autres nutriments

diff --git a/tests/unit/dataqualityfood.t b/tests/unit/dataqualityfood.t
@@ -744,4 +744,77 @@ $product_ref = {quantity => "300 ml e / 342 g"};
 ProductOpener::DataQuality::check_quality($product_ref);
 check_quality_and_test_product_has_quality_tag($product_ref, 'en:quantity-contains-e', 'quantity contains e', 1);
 
+# testing of ProductOpener::DataQualityFood::check_nutrition_data kJ vs kcal
+$product_ref = {
+	nutriments => {
+		"energy-kj_value" => 686,
+		"energy-kcal_value" => 165,
+	}
+};
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-greater-than-in-kj',
+	'1 kcal = 4.184 kJ', 0
+);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-does-not-match-value-in-kj',
+	'1 kcal = 4.184 kJ, value in kJ is between 165*3.7-2=608.5 and 165*4.7+2=777.5', 0
+);
+$product_ref = {
+	nutriments => {
+		"energy-kj_value" => 100,
+		"energy-kcal_value" => 200,
+	}
+};
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-greater-than-in-kj',
+	'1 kcal = 4.184 kJ', 1
+);
+$product_ref = {
+	nutriments => {
+		"energy-kj_value" => 496,
+		"energy-kcal_value" => 105,
+	}
+};
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-does-not-match-value-in-kj',
+	'1 kcal = 4.184 kJ, value in kJ is larger than 105*4.7+2=495.5', 1
+);
+$product_ref = {
+	nutriments => {
+		"energy-kj_value" => 386,
+		"energy-kcal_value" => 105,
+	}
+};
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-does-not-match-value-in-kj',
+	'1 kcal = 4.184 kJ, value in kJ is lower than 105*3.7-2=495.5', 1
+);
+$product_ref = {
+	nutriments => {
+		"energy-kj_value" => 165,
+		"energy-kcal_value" => 686,
+	}
+};
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-greater-than-in-kj',
+	'1 kcal = 4.184 kJ', 1
+);
+ProductOpener::DataQuality::check_quality($product_ref);
+check_quality_and_test_product_has_quality_tag(
+	$product_ref,
+	'en:energy-value-in-kcal-and-kj-are-reversed',
+	'1 kcal = 4.184 kJ, value in kcal is between 165*3.7-2=608.5 and 165*4.7+2=777.5', 1
+);
+
 done_testing();