feat: 5418 - Prices - "Are you sure you want to exit?" feature (#5737)

Impacted files: * `price_add_product_card.dart`: now accessing amount items through specific methods * `price_amount_card.dart`: now accessing amount items through specific methods * `price_amount_model.dart`: new `hasChanged` getter * `price_model.dart`: new `hasChanged` getter; now giving access to amount items through specific methods * `price_proof_card.dart`: minor refactoring * `product_price_add_page.dart`: used `WillPopScore2` in order to check for changes against back gesture; now accessing amount items through specific methods * `user_preferences_prices.dart`: usage of `AppNavigator` for a better management of back gesture
openfoodfacts · Oct 25, 2024 · 44ce678 · 44ce678
1 parent bb1c105
commit 44ce678
Show file tree

Hide file tree

Showing 7 changed files with 221 additions and 102 deletions.
diff --git a/packages/smooth_app/lib/pages/preferences/user_preferences_prices.dart b/packages/smooth_app/lib/pages/preferences/user_preferences_prices.dart
@@ -2,6 +2,7 @@ import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:openfoodfacts/openfoodfacts.dart';
 import 'package:smooth_app/helpers/launch_url_helper.dart';
+import 'package:smooth_app/pages/navigator/app_navigator.dart';
 import 'package:smooth_app/pages/preferences/abstract_user_preferences.dart';
 import 'package:smooth_app/pages/preferences/lazy_counter.dart';
 import 'package:smooth_app/pages/preferences/lazy_counter_widget.dart';
@@ -130,6 +131,12 @@ class UserPreferencesPrices extends AbstractUserPreferences {
     ];
   }
 
+  // we need the [AppNavigator] for a better back-gesture management.
+  @override
+  Future<void> runHeaderAction() async => AppNavigator.of(context).push(
+        AppRoutes.PREFERENCES(PreferencePageType.PRICES),
+      );
+
   UserPreferencesItem _getPriceListTile(
     final String title,
     final String path,

diff --git a/packages/smooth_app/lib/pages/prices/price_add_product_card.dart b/packages/smooth_app/lib/pages/prices/price_add_product_card.dart
@@ -96,7 +96,8 @@ class _PriceAddProductCardState extends State<PriceAddProductCard> {
       context,
       listen: false,
     );
-    for (final PriceAmountModel model in priceModel.priceAmountModels) {
+    for (int i = 0; i < priceModel.length; i++) {
+      final PriceAmountModel model = priceModel.elementAt(i);
       if (model.product.barcode == barcode) {
         await showDialog<void>(
           context: context,
@@ -111,7 +112,7 @@ class _PriceAddProductCardState extends State<PriceAddProductCard> {
         return;
       }
     }
-    priceModel.priceAmountModels.add(
+    priceModel.add(
       PriceAmountModel(
         product: PriceMetaProduct.unknown(
           barcode,

diff --git a/packages/smooth_app/lib/pages/prices/price_amount_card.dart b/packages/smooth_app/lib/pages/prices/price_amount_card.dart
@@ -32,7 +32,7 @@ class _PriceAmountCardState extends State<PriceAmountCard> {
     final PriceAmountModel model = Provider.of<PriceModel>(
       context,
       listen: false,
-    ).priceAmountModels[widget.index];
+    ).elementAt(widget.index);
     _controllerPaid = TextEditingController(text: model.paidPrice);
     _controllerWithoutDiscount =
         TextEditingController(text: model.priceWithoutDiscount);
@@ -49,8 +49,8 @@ class _PriceAmountCardState extends State<PriceAmountCard> {
   Widget build(BuildContext context) {
     final AppLocalizations appLocalizations = AppLocalizations.of(context);
     final PriceModel priceModel = Provider.of<PriceModel>(context);
-    final PriceAmountModel model = priceModel.priceAmountModels[widget.index];
-    final int total = priceModel.priceAmountModels.length;
+    final PriceAmountModel model = priceModel.elementAt(widget.index);
+    final int total = priceModel.length;
 
     return SmoothCard(
       child: Column(
@@ -62,12 +62,8 @@ class _PriceAmountCardState extends State<PriceAmountCard> {
           PriceProductListTile(
             product: model.product,
             trailingIconData: total == 1 ? null : Icons.clear,
-            onPressed: total == 1
-                ? null
-                : () {
-                    priceModel.priceAmountModels.removeAt(widget.index);
-                    priceModel.notifyListeners();
-                  },
+            onPressed:
+                total == 1 ? null : () => priceModel.removeAt(widget.index),
           ),
           SmoothLargeButtonWithIcon(
             icon: model.promo ? Icons.check_box : Icons.check_box_outline_blank,

diff --git a/packages/smooth_app/lib/pages/prices/price_amount_model.dart b/packages/smooth_app/lib/pages/prices/price_amount_model.dart
@@ -8,10 +8,29 @@ class PriceAmountModel {
     required this.product,
   });
 
-  PriceMetaProduct product;
+  final PriceMetaProduct product;
 
-  String paidPrice = '';
-  String priceWithoutDiscount = '';
+  bool _hasChanged = false;
+
+  bool get hasChanged => _hasChanged;
+
+  String _paidPrice = '';
+
+  String get paidPrice => _paidPrice;
+
+  set paidPrice(final String value) {
+    _hasChanged = true;
+    _paidPrice = value;
+  }
+
+  String _priceWithoutDiscount = '';
+
+  String get priceWithoutDiscount => _priceWithoutDiscount;
+
+  set priceWithoutDiscount(final String value) {
+    _hasChanged = true;
+    _priceWithoutDiscount = value;
+  }
 
   late double _checkedPaidPrice;
   double? _checkedPriceWithoutDiscount;
@@ -20,7 +39,14 @@ class PriceAmountModel {
 
   double? get checkedPriceWithoutDiscount => _checkedPriceWithoutDiscount;
 
-  bool promo = false;
+  bool _promo = false;
+
+  bool get promo => _promo;
+
+  set promo(final bool value) {
+    _hasChanged = true;
+    _promo = value;
+  }
 
   static double? validateDouble(final String value) =>
       double.tryParse(value) ??

diff --git a/packages/smooth_app/lib/pages/prices/price_model.dart b/packages/smooth_app/lib/pages/prices/price_model.dart
@@ -24,23 +24,43 @@ class PriceModel with ChangeNotifier {
         _date = DateTime.now(),
         _currency = currency,
         _locations = locations,
-        priceAmountModels = <PriceAmountModel>[
+        _priceAmountModels = <PriceAmountModel>[
           if (initialProduct != null) PriceAmountModel(product: initialProduct),
         ];
 
   PriceModel.proof({
     required Proof proof,
-  }) : priceAmountModels = <PriceAmountModel>[] {
-    setProof(proof);
+  }) : _priceAmountModels = <PriceAmountModel>[] {
+    setProof(proof, init: true);
   }
 
-  void setProof(final Proof proof) {
+  bool _hasChanged = false;
+
+  bool get hasChanged {
+    if (_hasChanged) {
+      return true;
+    }
+    for (final PriceAmountModel priceAmountModel in _priceAmountModels) {
+      if (priceAmountModel.hasChanged) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  void setProof(final Proof proof, {final bool init = false}) {
+    if (!init) {
+      _hasChanged = true;
+    }
     _proof = proof;
     _cropParameters = null;
     _proofType = proof.type!;
     _date = proof.date!;
     _locations = null;
     _currency = proof.currency!;
+    if (!init) {
+      notifyListeners();
+    }
   }
 
   /// Checks if a proof cannot be reused for prices adding.
@@ -58,13 +78,30 @@ class PriceModel with ChangeNotifier {
 
   bool get hasImage => _proof != null || _cropParameters != null;
 
-  final List<PriceAmountModel> priceAmountModels;
+  final List<PriceAmountModel> _priceAmountModels;
+
+  void add(final PriceAmountModel priceAmountModel) {
+    _hasChanged = true;
+    _priceAmountModels.add(priceAmountModel);
+    notifyListeners();
+  }
+
+  void removeAt(final int index) {
+    _hasChanged = true;
+    _priceAmountModels.removeAt(index);
+    notifyListeners();
+  }
+
+  PriceAmountModel elementAt(final int index) => _priceAmountModels[index];
+
+  int get length => _priceAmountModels.length;
 
   CropParameters? _cropParameters;
 
   CropParameters? get cropParameters => _cropParameters;
 
   set cropParameters(final CropParameters? value) {
+    _hasChanged = true;
     _cropParameters = value;
     _proof = null;
     notifyListeners();
@@ -79,6 +116,7 @@ class PriceModel with ChangeNotifier {
   ProofType get proofType => _proof != null ? _proof!.type! : _proofType;
 
   set proofType(final ProofType proofType) {
+    _hasChanged = true;
     _proofType = proofType;
     notifyListeners();
   }
@@ -88,6 +126,7 @@ class PriceModel with ChangeNotifier {
   DateTime get date => _date;
 
   set date(final DateTime date) {
+    _hasChanged = true;
     _date = date;
     notifyListeners();
   }
@@ -100,6 +139,7 @@ class PriceModel with ChangeNotifier {
   List<OsmLocation>? get locations => _locations;
 
   set locations(final List<OsmLocation>? locations) {
+    _hasChanged = true;
     _locations = locations;
     notifyListeners();
   }
@@ -113,6 +153,7 @@ class PriceModel with ChangeNotifier {
   Currency get currency => _currency;
 
   set currency(final Currency currency) {
+    _hasChanged = true;
     _currency = currency;
     notifyListeners();
   }
@@ -133,7 +174,7 @@ class PriceModel with ChangeNotifier {
       }
     }
 
-    for (final PriceAmountModel priceAmountModel in priceAmountModels) {
+    for (final PriceAmountModel priceAmountModel in _priceAmountModels) {
       final String? checkParameters = priceAmountModel.checkParameters(context);
       if (checkParameters != null) {
         return checkParameters;
@@ -152,7 +193,7 @@ class PriceModel with ChangeNotifier {
     final List<bool> pricesAreDiscounted = <bool>[];
     final List<double> prices = <double>[];
     final List<double?> pricesWithoutDiscount = <double?>[];
-    for (final PriceAmountModel priceAmountModel in priceAmountModels) {
+    for (final PriceAmountModel priceAmountModel in _priceAmountModels) {
       barcodes.add(priceAmountModel.product.barcode);
       pricesAreDiscounted.add(priceAmountModel.promo);
       prices.add(priceAmountModel.checkedPaidPrice);

diff --git a/packages/smooth_app/lib/pages/prices/price_proof_card.dart b/packages/smooth_app/lib/pages/prices/price_proof_card.dart
@@ -128,7 +128,6 @@ enum _ProofSource {
         );
         if (proof != null) {
           model.setProof(proof);
-          model.notifyListeners();
         }
         return;
       case _ProofSource.camera: