Merge pull request #613 from wger-project/ingredient-details

popup ingredient details in typeahead suggestions and recently used

Author: Dieterbe

lib/models/nutrition/ingredient.dart

@@ -24,9 +24,27 @@ part 'ingredient.g.dart';
 
 @JsonSerializable()
 class Ingredient {
+  // fields returned by django api that we ignore here:
+  // uuid, last_updated, last_imported, weight_units, language
+  // most license fields
+
   @JsonKey(required: true)
   final int id;
 
+  // some ingredients don't have these 3 fields set.  E.g. USDA entries that
+  // have been removed upstream, or manually added ingredients.
+  @JsonKey(required: true, name: 'remote_id')
+  final String? remoteId;
+
+  @JsonKey(required: true, name: 'source_name')
+  final String? sourceName;
+
+  @JsonKey(required: true, name: 'source_url')
+  final String? sourceUrl;
+
+  @JsonKey(required: true, name: 'license_object_url')
+  final String? licenseObjectURl;
+
   /// Barcode of the product
   @JsonKey(required: true)
   final String? code;
@@ -73,6 +91,10 @@ class Ingredient {
   IngredientImage? image;
 
   Ingredient({
+    required this.remoteId,
+    required this.sourceName,
+    required this.sourceUrl,
+    this.licenseObjectURl,
     required this.id,
     required this.code,
     required this.name,

lib/models/nutrition/ingredient.g.dart

@@ -16,6 +16,8 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+import 'package:wger/models/nutrition/nutritional_goals.dart';
+
 class NutritionalValues {
   double energy = 0;
   double protein = 0;
@@ -114,6 +116,19 @@ class NutritionalValues {
     return 'e: $energy, p: $protein, c: $carbohydrates, cS: $carbohydratesSugar, f: $fat, fS: $fatSaturated, fi: $fiber, s: $sodium';
   }
 
+  NutritionalGoals toGoals() {
+    return NutritionalGoals(
+      energy: energy,
+      protein: protein,
+      carbohydrates: carbohydrates,
+      carbohydratesSugar: carbohydratesSugar,
+      fat: fat,
+      fatSaturated: fatSaturated,
+      fiber: fiber,
+      sodium: sodium,
+    );
+  }
+
   @override
   //ignore: avoid_equals_and_hash_code_on_mutable_classes
   int get hashCode => Object.hash(

lib/models/nutrition/nutritional_values.dart

@@ -38,10 +38,9 @@ class NutritionPlansProvider with ChangeNotifier {
   static const _nutritionalPlansInfoPath = 'nutritionplaninfo';
   static const _mealPath = 'meal';
   static const _mealItemPath = 'mealitem';
-  static const _ingredientPath = 'ingredient';
+  static const _ingredientInfoPath = 'ingredientinfo';
   static const _ingredientSearchPath = 'ingredient/search';
   static const _nutritionDiaryPath = 'nutritiondiary';
-  static const _ingredientImagePath = 'ingredient-image';
 
   final WgerBaseProvider baseProvider;
   List<NutritionalPlan> _plans = [];
@@ -131,6 +130,7 @@ class NutritionPlansProvider with ChangeNotifier {
     try {
       plan = findById(planId);
     } on NoSuchEntryException {
+      // TODO: remove this useless call, because we will fetch all details below
       plan = await fetchAndSetPlanSparse(planId);
     }
 
@@ -144,6 +144,7 @@ class NutritionPlansProvider with ChangeNotifier {
       final List<MealItem> mealItems = [];
       final meal = Meal.fromJson(mealData);
 
+      // TODO: we should add these ingredients to the ingredient cache
       for (final mealItemData in mealData['meal_items']) {
         final mealItem = MealItem.fromJson(mealItemData);
 
@@ -298,7 +299,7 @@ class NutritionPlansProvider with ChangeNotifier {
       // Get ingredient from the server and save to cache
     } on StateError {
       final data = await baseProvider.fetch(
-        baseProvider.makeUrl(_ingredientPath, id: ingredientId),
+        baseProvider.makeUrl(_ingredientInfoPath, id: ingredientId),
       );
       ingredient = Ingredient.fromJson(data);
       _ingredients.add(ingredient);
@@ -370,14 +371,15 @@ class NutritionPlansProvider with ChangeNotifier {
 
     // Send the request
     final data = await baseProvider.fetch(
-      baseProvider.makeUrl(_ingredientPath, query: {'code': code}),
+      baseProvider.makeUrl(_ingredientInfoPath, query: {'code': code}),
     );
 
     if (data['count'] == 0) {
       return null;
-    } else {
-      return Ingredient.fromJson(data['results'][0]);
     }
+    // TODO we should probably add it to ingredient cache.
+    // TODO: we could also use the ingredient cache for code searches
+    return Ingredient.fromJson(data['results'][0]);
   }
 
   /// Log meal to nutrition diary

lib/providers/nutrition.dart

@@ -94,7 +94,7 @@ class _HomeTabsScreenState extends State<HomeTabsScreen> with SingleTickerProvid
           exercisesProvider.fetchAndSetInitialData(),
         ]);
       } catch (e) {
-        log('fire! fire!');
+        log('Exception loading base data');
         log(e.toString());
       }
 
@@ -109,7 +109,7 @@ class _HomeTabsScreenState extends State<HomeTabsScreen> with SingleTickerProvid
           measurementProvider.fetchAndSetAllCategoriesAndEntries(),
         ]);
       } catch (e) {
-        log('fire! fire!');
+        log('Exception loading plans, weight, measurements and gallery');
         log(e.toString());
       }
 
@@ -121,7 +121,7 @@ class _HomeTabsScreenState extends State<HomeTabsScreen> with SingleTickerProvid
           await nutritionPlansProvider.fetchAndSetPlanFull(plan.id!);
         }
       } catch (e) {
-        log('fire! fire!');
+        log('Exception loading current nutritional plan');
         log(e.toString());
       }
 

lib/screens/home_tabs_screen.dart

@@ -353,7 +353,7 @@ class IngredientFormState extends State<IngredientForm> {
                 child: Column(
                   children: [
                     Text(
-                      'Macros preview',
+                      'Macros preview', // TODO fix l10n
                       style: Theme.of(context).textTheme.titleMedium,
                     ),
                     FutureBuilder<Ingredient>(
@@ -430,24 +430,42 @@ class IngredientFormState extends State<IngredientForm> {
                 itemCount: suggestions.length,
                 shrinkWrap: true,
                 itemBuilder: (context, index) {
+                  void select() {
+                    final ingredient = suggestions[index].ingredient;
+                    selectIngredient(
+                      ingredient.id,
+                      ingredient.name,
+                      suggestions[index].amount,
+                    );
+                  }
+
                   return Card(
                     child: ListTile(
-                      onTap: () {
-                        final ingredient = suggestions[index].ingredient;
-                        selectIngredient(
-                          ingredient.id,
-                          ingredient.name,
-                          suggestions[index].amount,
-                        );
-                      },
+                      onTap: select,
                       title: Text(
                         '${suggestions[index].ingredient.name} (${suggestions[index].amount.toStringAsFixed(0)}$unit)',
                       ),
                       subtitle: Text(getShortNutritionValues(
                         suggestions[index].ingredient.nutritionalValues,
                         context,
                       )),
-                      trailing: const Icon(Icons.copy),
+                      trailing: Row(
+                        mainAxisSize: MainAxisSize.min,
+                        children: [
+                          IconButton(
+                            icon: const Icon(Icons.info_outline),
+                            onPressed: () {
+                              showIngredientDetails(
+                                context,
+                                suggestions[index].ingredient.id,
+                                select: select,
+                              );
+                            },
+                          ),
+                          const SizedBox(width: 5),
+                          const Icon(Icons.copy),
+                        ],
+                      ),
                     ),
                   );
                 },

lib/widgets/nutrition/forms.dart

@@ -16,12 +16,15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_gen/gen_l10n/app_localizations.dart';
+import 'package:provider/provider.dart';
+import 'package:wger/models/nutrition/ingredient.dart';
 import 'package:wger/models/nutrition/meal.dart';
 import 'package:wger/models/nutrition/nutritional_values.dart';
+import 'package:wger/providers/nutrition.dart';
 import 'package:wger/widgets/core/core.dart';
+import 'package:wger/widgets/nutrition/ingredient_dialogs.dart';
 
 List<String> getNutritionColumnNames(BuildContext context) => [
       AppLocalizations.of(context).energy,
@@ -95,3 +98,15 @@ String getKcalConsumedVsPlanned(Meal meal, BuildContext context) {
 
   return '${consumed.toStringAsFixed(0)} / ${planned.toStringAsFixed(0)} ${loc.kcal}';
 }
+
+void showIngredientDetails(BuildContext context, int id, {void Function()? select}) {
+  showDialog(
+    context: context,
+    builder: (context) => FutureBuilder<Ingredient>(
+      future: Provider.of<NutritionPlansProvider>(context, listen: false).fetchIngredient(id),
+      builder: (BuildContext context, AsyncSnapshot<Ingredient> snapshot) {
+        return IngredientDetails(snapshot, select: select);
+      },
+    ),
+  );
+}