feat: Nutrition page improvements (#3121)

* Nutrition page: use an enum instead of a boolean for the unit + only notify when the value has really changed * Add an access to the initialValue
openfoodfacts · Oct 13, 2022 · 33d5b3c · 33d5b3c
1 parent 6058346
commit 33d5b3c
Show file tree

Hide file tree

Showing 4 changed files with 222 additions and 48 deletions.
diff --git a/packages/smooth_app/lib/pages/product/nutrition_container.dart b/packages/smooth_app/lib/pages/product/nutrition_container.dart
@@ -1,11 +1,11 @@
-import 'package:flutter/material.dart';
 import 'package:intl/intl.dart';
 import 'package:openfoodfacts/interface/JsonObject.dart';
 import 'package:openfoodfacts/model/Nutriments.dart';
 import 'package:openfoodfacts/model/OrderedNutrient.dart';
 import 'package:openfoodfacts/model/OrderedNutrients.dart';
 import 'package:openfoodfacts/model/Product.dart';
 import 'package:openfoodfacts/utils/UnitHelper.dart';
+import 'package:smooth_app/pages/text_field_helper.dart';
 
 /// Nutrition data, for nutrient order and conversions.
 class NutritionContainer {
@@ -87,8 +87,14 @@ class NutritionContainer {
   /// Returns true if the [OrderedNutrient] is not relevant.
   bool _isNotRelevant(final OrderedNutrient orderedNutrient) {
     final String nutrientId = orderedNutrient.id;
-    final double? value100g = getValue(getValueKey(nutrientId, false));
-    final double? valueServing = getValue(getValueKey(nutrientId, true));
+    final double? value100g = getValue(getValueKey(
+      nutrientId,
+      NutritionUnit.per100g,
+    ));
+    final double? valueServing = getValue(getValueKey(
+      nutrientId,
+      NutritionUnit.perServing,
+    ));
     return value100g == null &&
         valueServing == null &&
         (!orderedNutrient.important) &&
@@ -118,8 +124,14 @@ class NutritionContainer {
     final Map<String, dynamic> map = <String, dynamic>{};
     for (final OrderedNutrient orderedNutrient in getDisplayableNutrients()) {
       final String nutrientId = orderedNutrient.id;
-      final String key100g = getValueKey(nutrientId, false);
-      final String keyServing = getValueKey(nutrientId, true);
+      final String key100g = getValueKey(
+        nutrientId,
+        NutritionUnit.per100g,
+      );
+      final String keyServing = getValueKey(
+        nutrientId,
+        NutritionUnit.perServing,
+      );
       final double? value100g = getValue(key100g);
       final double? valueServing = getValue(keyServing);
       if (value100g == null && valueServing == null) {
@@ -142,16 +154,16 @@ class NutritionContainer {
   double? getValue(final String valueKey) => _values[valueKey];
 
   /// Stores the text from the end-user input.
-  void setControllerText(final String controllerKey, final String text) {
+  void setControllerText(final String controllerKey, final String? text) {
     if (controllerKey == fakeNutrientIdServingSize) {
-      _servingSize = text.trim().isEmpty ? null : text;
+      _servingSize = text?.trim().isNotEmpty == false ? null : text;
       return;
     }
 
     double? value;
-    if (text.isNotEmpty) {
+    if (text?.isNotEmpty == true) {
       try {
-        value = double.parse(text.replaceAll(',', '.'));
+        value = double.parse(text!.replaceAll(',', '.'));
       } catch (e) {
         //
       }
@@ -227,9 +239,11 @@ class NutritionContainer {
   /// * [perServing] false: per 100g.
   static String getValueKey(
     String nutrientId,
-    final bool perServing,
+    final NutritionUnit nutritionUnit,
   ) {
+    final bool perServing = nutritionUnit == NutritionUnit.perServing;
     nutrientId = _fixNutrientId(nutrientId);
+
     // 'energy-kcal' is directly for serving (no 'energy-kcal_serving')
     if (nutrientId == _energyKCalId && perServing) {
       return _energyKCalId;
@@ -330,7 +344,8 @@ class NutritionContainer {
       final String nutrientId = orderedNutrient.id;
       final Unit unit = getUnit(nutrientId);
       for (int i = 0; i < 2; i++) {
-        final bool perServing = i == 0;
+        final NutritionUnit perServing =
+            i == 0 ? NutritionUnit.perServing : NutritionUnit.per100g;
         final String valueKey = getValueKey(nutrientId, perServing);
         final double? value = convertWeightFromG(
           JsonObject.parseDouble(json[valueKey]),
@@ -344,35 +359,31 @@ class NutritionContainer {
   }
 
   bool isEdited(
-    final Map<String, TextEditingController> controllers,
+    final Map<String, TextEditingControllerWithInitialValue> controllers,
     final NumberFormat numberFormat,
     final bool noNutritionData,
+    final bool nutritionUnitHasChanged,
   ) {
-    if (_isEditedControllers(controllers, numberFormat)) {
+    if (_isEditedControllers(controllers)) {
       return true;
     }
     if (this.noNutritionData != noNutritionData) {
       return true;
     }
+    if (nutritionUnitHasChanged) {
+      return true;
+    }
     if (_isEditedUnits()) {
       return true;
     }
     return false;
   }
 
   bool _isEditedControllers(
-    final Map<String, TextEditingController> controllers,
-    final NumberFormat numberFormat,
+    final Map<String, TextEditingControllerWithInitialValue> controllers,
   ) {
     for (final String key in controllers.keys) {
-      final TextEditingController controller = controllers[key]!;
-      final String text = controller.value.text;
-      final double? value = getValue(key);
-      if (value == null) {
-        if (text != '') {
-          return true;
-        }
-      } else if (numberFormat.format(value) != text) {
+      if (controllers[key]!.valueHasChanged) {
         return true;
       }
     }
@@ -388,3 +399,8 @@ class NutritionContainer {
     return false;
   }
 }
+
+enum NutritionUnit {
+  per100g,
+  perServing,
+}