Merge pull request 'Location overview screen and model changes' (#3) from development into main

Reviewed-on: #3

lib/app_theme.dart

@@ -0,0 +1,39 @@
+import 'package:flutter/material.dart';
+
+class AppTheme {
+  AppTheme._();
+
+  static const double formColumnSpacing = 12.0;
+
+  static ThemeData get lightTheme => _baseTheme(
+    colorScheme: ColorScheme.fromSeed(
+      seedColor: Colors.indigo,
+      brightness: Brightness.light,
+    ),
+  );
+
+  static ThemeData get darkTheme => _baseTheme(
+    colorScheme: ColorScheme.fromSeed(
+      seedColor: Colors.indigo,
+      brightness: Brightness.dark,
+    ),
+  );
+
+  static ThemeData _baseTheme({required ColorScheme colorScheme}) {
+    final theme = ThemeData(useMaterial3: true, colorScheme: colorScheme);
+    final universalBorderRadius = BorderRadius.circular(12);
+
+    return theme.copyWith(
+      inputDecorationTheme: InputDecorationTheme(
+        border: OutlineInputBorder(borderRadius: universalBorderRadius),
+      ),
+
+      listTileTheme: ListTileThemeData(
+        shape: RoundedRectangleBorder(
+          borderRadius: universalBorderRadius,
+          side: BorderSide(color: colorScheme.secondaryContainer, width: 2),
+        ),
+      ),
+    );
+  }
+}

lib/main.dart

@@ -1,10 +1,14 @@
 import 'package:flutter/material.dart';
 
+import 'app_theme.dart';
 import 'model/repositories/local_repository.dart';
+import 'pages/locations_overview_page.dart';
 import 'pages/task_edit_page.dart';
 import 'pages/task_overview_page.dart';
 import 'service/controller_scope.dart';
-import 'service/task_controller.dart';
+import 'service/controllers/alarm_controller.dart';
+import 'service/controllers/location_controller.dart';
+import 'service/controllers/task_controller.dart';
 
 void main() async {
   final repository = LocalRepository();
@@ -13,8 +17,14 @@ void main() async {
 
   runApp(
     ControllerScope(
-      controller: TaskController(repository),
-      child: const MainApp(),
+      controller: LocationController(repository),
+      child: ControllerScope(
+        controller: AlarmController(repository),
+        child: ControllerScope(
+          controller: TaskController(repository),
+          child: const MainApp(),
+        ),
+      ),
     ),
   );
 }
@@ -25,9 +35,12 @@ class MainApp extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
+      theme: AppTheme.lightTheme,
+      darkTheme: AppTheme.darkTheme,
       routes: {
         TaskOverviewPage.routeName: (context) => TaskOverviewPage(),
         TaskEditPage.routeName: (context) => TaskEditPage(),
+        LocationsOverviewPage.routeName: (context) => LocationsOverviewPage(),
       },
       initialRoute: TaskOverviewPage.routeName,
     );

lib/model/callback_models/create_task_request.dart

@@ -1,4 +1,3 @@
-import '../location.dart';
 import '../task.dart';
 
 class CreateTaskRequest {

lib/model/latlng.dart

@@ -5,6 +5,15 @@ class LatLng {
   LatLng(this.lat, this.lng);
   LatLng.empty() : lat = 0, lng = 0;
 
+  /// must be formatted 'double, double'. For example 35.35217, 89.19659
+  factory LatLng.fromString(String latLng) {
+    final splitString = latLng.split(',');
+    final lat = double.parse(splitString[0].trim());
+    final lng = double.parse(splitString[1].trim());
+
+    return LatLng(lat, lng);
+  }
+
   factory LatLng.fromJson(Map<String, dynamic> json) {
     return LatLng(json['lat'] as double, json['lng'] as double);
   }
@@ -12,4 +21,18 @@ class LatLng {
   Map<String, double> toJson() {
     return {'lat': lat, 'lng': lng};
   }
+
+  @override
+  bool operator ==(Object other) {
+    if (other is! LatLng) return false;
+    return hashCode == other.hashCode;
+  }
+
+  @override
+  int get hashCode => Object.hash(lat, lng);
+
+  @override
+  String toString() {
+    return '${lat.toString()}, ${lng.toString()}';
+  }
 }

lib/model/location.dart

@@ -1,19 +1,34 @@
 import 'latlng.dart';
 
 class Location {
+  final String name;
   final LatLng coordinates;
   final String address;
 
-  Location({required this.coordinates, this.address = ''});
+  Location({required this.name, required this.coordinates, this.address = ''});
 
   factory Location.fromJson(Map<String, dynamic> json) {
     return Location(
+      name: json['name'] as String,
       address: json['address'] as String,
       coordinates: LatLng.fromJson(json['coordinates']),
     );
   }
 
   Map<String, dynamic> toJson() {
-    return {'address': address, 'coordinates': coordinates.toJson()};
+    return {
+      'name': name,
+      'address': address,
+      'coordinates': coordinates.toJson(),
+    };
   }
+
+  @override
+  bool operator ==(Object other) {
+    if (other is! Location) return false;
+    return hashCode == other.hashCode;
+  }
+
+  @override
+  int get hashCode => coordinates.hashCode;
 }

lib/model/repositories/interfaces/location_repository.dart

@@ -0,0 +1,19 @@
+import '../../location.dart';
+
+abstract class LocationRepository {
+  // Create
+
+  Future<void> createLocation(Location location);
+
+  // Read
+
+  Future<List<Location>> loadLocations();
+
+  // Update
+
+  Future<void> updateLocation(Location location);
+
+  // Delete
+
+  Future<void> deleteLocation(Location location);
+}

lib/model/repositories/local_repository.dart

@@ -3,14 +3,18 @@ import 'dart:convert';
 import 'package:shared_preferences/shared_preferences.dart';
 
 import '../alarm.dart';
+import '../location.dart';
 import '../task.dart';
 import 'interfaces/alarm_repository.dart';
+import 'interfaces/location_repository.dart';
 import 'interfaces/task_repository.dart';
 
-class LocalRepository implements TaskRepository, AlarmRepository {
+class LocalRepository
+    implements TaskRepository, AlarmRepository, LocationRepository {
   static const String _tasksKey = 'tasks';
   static const String _taskOrderKey = 'taskOrder';
   static const String _alarmsKey = 'alarms';
+  static const String _locationsKey = 'locations';
 
   SharedPreferencesWithCache? _prefs;
 
@@ -18,7 +22,12 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     if (_prefs == null) {
       await SharedPreferencesWithCache.create(
         cacheOptions: const SharedPreferencesWithCacheOptions(
-          allowList: <String>{_tasksKey, _taskOrderKey},
+          allowList: <String>{
+            _tasksKey,
+            _taskOrderKey,
+            _alarmsKey,
+            _locationsKey,
+          },
         ),
       ).then((value) => _prefs = value);
     }
@@ -29,6 +38,13 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     _prefs!.setStringList(_tasksKey, jsonList);
   }
 
+  Future<void> _saveLocations(List<Location> locations) async {
+    final jsonList = locations
+        .map<String>((e) => jsonEncode(e.toJson()))
+        .toList();
+    _prefs!.setStringList(_locationsKey, jsonList);
+  }
+
   Future<void> _saveTaskOrder(List<String> taskOrder) async {
     final jsonList = taskOrder.map((e) => jsonEncode(e)).toList();
     return _prefs!.setStringList(_taskOrderKey, jsonList);
@@ -62,6 +78,13 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     _saveAlarms(alarms);
   }
 
+  @override
+  Future<void> createLocation(Location location) async {
+    final locations = await loadLocations();
+    locations.add(location);
+    _saveLocations(locations);
+  }
+
   // Read
 
   @override
@@ -83,6 +106,15 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     return jsonList.map<Alarm>((e) => Alarm.fromJson(jsonDecode(e))).toList();
   }
 
+  @override
+  Future<List<Location>> loadLocations() async {
+    final Iterable<String> jsonList =
+        _prefs!.getStringList(_locationsKey) ?? [];
+    return jsonList
+        .map<Location>((e) => Location.fromJson(jsonDecode(e)))
+        .toList();
+  }
+
   // Update
 
   @override
@@ -106,6 +138,14 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     _saveAlarms(alarms);
   }
 
+  @override
+  Future<void> updateLocation(Location location) async {
+    final locations = await loadLocations();
+    locations.remove(location);
+    locations.add(location);
+    _saveLocations(locations);
+  }
+
   // Delete
 
   @override
@@ -128,4 +168,11 @@ class LocalRepository implements TaskRepository, AlarmRepository {
     alarms.remove(alarm);
     _saveAlarms(alarms);
   }
+
+  @override
+  Future<void> deleteLocation(Location location) async {
+    final locations = await loadLocations();
+    locations.remove(location);
+    _saveLocations(locations);
+  }
 }

lib/pages/locations_overview_page.dart

@@ -0,0 +1,74 @@
+import 'package:flutter/material.dart';
+
+import '../model/extensions/controller_context.dart';
+import '../model/location.dart';
+import '../service/controllers/location_controller.dart';
+import '../widgets/dialogs/create_location_dialog.dart';
+
+class LocationsOverviewPage extends StatefulWidget {
+  static const routeName = '/locations';
+  const LocationsOverviewPage({super.key});
+
+  @override
+  State<LocationsOverviewPage> createState() => _LocationsOverviewPageState();
+}
+
+class _LocationsOverviewPageState extends State<LocationsOverviewPage> {
+  List<Location> locations = [];
+  @override
+  Widget build(BuildContext context) {
+    locations = context.controller<LocationController>().locations;
+
+    return Scaffold(
+      appBar: AppBar(title: Text('Manage Locations')),
+      body: Padding(
+        padding: EdgeInsetsGeometry.symmetric(
+          horizontal: MediaQuery.of(context).size.width * 0.05,
+        ),
+        child: ListView.builder(
+          itemBuilder: listViewBuilder,
+          itemCount: context.controller<LocationController>().locations.length,
+        ),
+      ),
+      floatingActionButton: FloatingActionButton(
+        onPressed: onAddLocationButtonPressed,
+        child: Icon(Icons.add),
+      ),
+    );
+  }
+
+  Widget listViewBuilder(BuildContext context, int index) {
+    final location = locations.elementAt(index);
+    final String subtitle = location.address.isEmpty
+        ? location.coordinates.toString()
+        : location.address;
+
+    return ListTile(
+      title: Text(location.name),
+      subtitle: Text(subtitle),
+      onTap: () => onEditLocationButtonPressed(location),
+    );
+  }
+
+  void onAddLocationButtonPressed() async {
+    final result = await showDialog<Location?>(
+      context: context,
+      builder: (context) => CreateLocationDialog(),
+      barrierDismissible: false,
+    );
+    if (mounted && result != null) {
+      context.controller<LocationController>().addLocation(result);
+    }
+  }
+
+  void onEditLocationButtonPressed(Location location) async {
+    final result = await showDialog<Location?>(
+      context: context,
+      builder: (context) => CreateLocationDialog(initialLocation: location),
+      barrierDismissible: false,
+    );
+    if (mounted && result != null) {
+      context.controller<LocationController>().updateLocation(location, result);
+    }
+  }
+}

lib/pages/task_edit_page.dart

@@ -1,9 +1,10 @@
 import 'package:flutter/material.dart';
 
+import '../app_theme.dart';
 import '../model/callback_models/create_task_request.dart';
 import '../model/extensions/controller_context.dart';
 import '../model/task.dart';
-import '../service/task_controller.dart';
+import '../service/controllers/task_controller.dart';
 import '../service/tools.dart';
 import '../widgets/time_selector.dart';
 
@@ -80,7 +81,9 @@ class _TaskEditPageState extends State<TaskEditPage> {
             horizontal: MediaQuery.of(context).size.width * 0.05,
           ),
           child: Column(
+            spacing: AppTheme.formColumnSpacing,
             children: [
+              SizedBox(height: 6),
               TextFormField(
                 autofocus: true,
                 controller: titleController,
@@ -165,7 +168,7 @@ class _TaskEditPageState extends State<TaskEditPage> {
           ],
         ),
       ).then((result) {
-        if (result != null && result && context.mounted) {
+        if (result != null && result && mounted) {
           Navigator.of(context).pop();
         }
       });

lib/pages/task_overview_page.dart

@@ -3,8 +3,10 @@ import 'package:flutter/material.dart';
 import '../model/callback_models/create_task_request.dart';
 import '../model/extensions/controller_context.dart';
 import '../model/task.dart';
-import '../service/task_controller.dart';
+import '../service/controllers/task_controller.dart';
 import '../service/tools.dart';
+import '../widgets/task_dismissible.dart';
+import 'locations_overview_page.dart';
 import 'task_edit_page.dart';
 
 class TaskOverviewPage extends StatefulWidget {
@@ -21,11 +23,29 @@ class _TaskOverviewPageState extends State<TaskOverviewPage> {
   @override
   Widget build(BuildContext context) {
     return Scaffold(
-      appBar: AppBar(),
-      body: ReorderableListView.builder(
-        itemBuilder: itemBuilder,
-        itemCount: tasks.length,
-        onReorderItem: context.controller<TaskController>().reorderTask,
+      appBar: AppBar(
+        title: Text('Hallo Yannick'),
+        actions: [
+          PopupMenuButton(
+            itemBuilder: (_) => [
+              PopupMenuItem(
+                onTap: onLocationsButtonTapped,
+                child: Text('Locations'),
+              ),
+            ],
+            icon: Icon(Icons.more_vert),
+          ),
+        ],
+      ),
+      body: Padding(
+        padding: EdgeInsetsGeometry.symmetric(
+          horizontal: MediaQuery.of(context).size.width * 0.05,
+        ),
+        child: ReorderableListView.builder(
+          itemBuilder: itemBuilder,
+          itemCount: tasks.length,
+          onReorderItem: context.controller<TaskController>().reorderTask,
+        ),
       ),
       floatingActionButton: FloatingActionButton(
         onPressed: onCreateTaskTapped,
@@ -37,24 +57,32 @@ class _TaskOverviewPageState extends State<TaskOverviewPage> {
   Widget itemBuilder(BuildContext context, int index) {
     final task = tasks.elementAt(index);
 
-    return ListTile(
+    return Padding(
       key: Key(task.id),
-      title: Text(task.title),
-      subtitle: task.description.isNotEmpty ? Text(task.description) : null,
-      trailing: Checkbox(
-        value: task.isCompleted,
-        onChanged: (isCompleted) => context
-            .controller<TaskController>()
-            .saveTask(task.copyWith(isCompleted: isCompleted)),
+      padding: const EdgeInsets.only(bottom: 12),
+      child: TaskDismissible(
+        key: Key(task.id),
+        onDismissedRight: () =>
+            context.controller<TaskController>().deleteTask(task),
+        child: ListTile(
+          title: Text(task.title),
+          subtitle: task.description.isNotEmpty ? Text(task.description) : null,
+          trailing: Checkbox(
+            value: task.isCompleted,
+            onChanged: (isCompleted) => context
+                .controller<TaskController>()
+                .saveTask(task.copyWith(isCompleted: isCompleted)),
+          ),
+          onTap: () async {
+            final result = await onTaskTapped(task);
+            if (result != null && context.mounted) {
+              context.controller<TaskController>().saveTask(
+                result.toTask(id: task.id),
+              );
+            }
+          },
+        ),
       ),
-      onTap: () async {
-        final result = await onTaskTapped(task);
-        if (result != null && context.mounted) {
-          context.controller<TaskController>().saveTask(
-            result.toTask(id: task.id),
-          );
-        }
-      },
     );
   }
 
@@ -70,10 +98,13 @@ class _TaskOverviewPageState extends State<TaskOverviewPage> {
         await Navigator.of(context).pushNamed(TaskEditPage.routeName)
             as CreateTaskRequest?;
 
-    if (result != null && context.mounted) {
+    if (result != null && mounted) {
       context.controller<TaskController>().saveTask(
         result.toTask(id: generateId()),
       );
     }
   }
+
+  void onLocationsButtonTapped() =>
+      Navigator.of(context).pushNamed(LocationsOverviewPage.routeName);
 }

lib/service/controllers/alarm_controller.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart';
 
-import '../model/alarm.dart';
-import '../model/repositories/interfaces/alarm_repository.dart';
+import '../../model/alarm.dart';
+import '../../model/repositories/interfaces/alarm_repository.dart';
 
 class AlarmController extends ChangeNotifier {
   AlarmController(AlarmRepository repository) : _repository = repository {

lib/service/controllers/location_controller.dart

@@ -0,0 +1,45 @@
+import 'package:flutter/material.dart';
+
+import '../../model/location.dart';
+import '../../model/repositories/interfaces/location_repository.dart';
+
+class LocationController extends ChangeNotifier {
+  LocationController(LocationRepository repository) : _repository = repository {
+    _loadLocations();
+  }
+
+  final LocationRepository _repository;
+
+  final List<Location> _locations = [];
+
+  List<Location> get locations => _locations;
+
+  Future<void> addLocation(Location location) {
+    _locations.add(location);
+    notifyListeners();
+    return _repository.createLocation(location);
+  }
+
+  Future<void> deleteLocation(Location location) {
+    _locations.remove(location);
+    notifyListeners();
+    return _repository.deleteLocation(location);
+  }
+
+  Future<void> updateLocation(Location oldLocation, Location newLocation) {
+    final index = _locations.indexOf(oldLocation);
+    _locations.remove(oldLocation);
+    _locations.insert(index, newLocation);
+    notifyListeners();
+    return _repository
+        .deleteLocation(oldLocation)
+        .whenComplete(() => _repository.createLocation(newLocation));
+  }
+
+  Future<void> _loadLocations() {
+    _locations.clear();
+    return _repository.loadLocations().then(
+      (value) => _locations.addAll(value),
+    );
+  }
+}

lib/service/controllers/task_controller.dart

@@ -1,7 +1,7 @@
 import 'package:flutter/material.dart' show ChangeNotifier;
 
-import '../model/repositories/interfaces/task_repository.dart';
-import '../model/task.dart';
+import '../../model/repositories/interfaces/task_repository.dart';
+import '../../model/task.dart';
 
 class TaskController extends ChangeNotifier {
   TaskController(TaskRepository repository) : _repository = repository {

lib/service/validators.dart

@@ -12,3 +12,17 @@ String? dateTimeValidator(String? value) {
 
   return DateTime.tryParse(value) != null ? null : 'Not a date format';
 }
+
+String? coordinatesValidator(String? value) {
+  if (value == null || value.isEmpty) return null;
+
+  if (RegExp(r'^\d+\.?\d*, *\d+\.?\d*$').hasMatch(value)) {
+    return null;
+  }
+  return 'Not a valid coordinate format';
+}
+
+String? notEmptyValidator(String? value) {
+  if (value != null && value.isNotEmpty) return null;
+  return 'Can\'t be empty';
+}

lib/widgets/dialogs/create_location_dialog.dart

@@ -0,0 +1,93 @@
+import 'package:flutter/material.dart';
+
+import '../../app_theme.dart';
+import '../../model/latlng.dart';
+import '../../model/location.dart';
+import '../../service/validators.dart';
+
+class CreateLocationDialog extends StatefulWidget {
+  const CreateLocationDialog({super.key, this.initialLocation});
+  final Location? initialLocation;
+
+  @override
+  State<CreateLocationDialog> createState() => _CreateLocationDialogState();
+}
+
+class _CreateLocationDialogState extends State<CreateLocationDialog> {
+  final nameController = TextEditingController();
+  final addressController = TextEditingController();
+  final coordinatesController = TextEditingController();
+  final formKey = GlobalKey<FormState>(debugLabel: 'Create Location Form');
+
+  @override
+  void initState() {
+    if (widget.initialLocation != null) {
+      nameController.text = widget.initialLocation!.name;
+      addressController.text = widget.initialLocation!.address;
+      coordinatesController.text = widget.initialLocation!.coordinates
+          .toString();
+    }
+    super.initState();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return AlertDialog(
+      actions: [
+        TextButton(onPressed: onCancelPressed, child: Text('Cancel')),
+        TextButton(onPressed: onSavePressed, child: Text('Save')),
+      ],
+      title: Text('Create Location'),
+      content: Form(
+        key: formKey,
+        child: Column(
+          spacing: AppTheme.formColumnSpacing,
+          mainAxisSize: MainAxisSize.min,
+          children: [
+            TextFormField(
+              autofocus: true,
+              textInputAction: TextInputAction.next,
+              controller: nameController,
+              keyboardType: TextInputType.text,
+              decoration: InputDecoration(labelText: 'Name'),
+              validator: notEmptyValidator,
+            ),
+            TextFormField(
+              textInputAction: TextInputAction.next,
+              controller: addressController,
+              keyboardType: TextInputType.streetAddress,
+              decoration: InputDecoration(labelText: 'Address (optional)'),
+            ),
+            TextFormField(
+              textInputAction: TextInputAction.done,
+              controller: coordinatesController,
+              onFieldSubmitted: (_) => onSavePressed(),
+              keyboardType: TextInputType.numberWithOptions(),
+              decoration: InputDecoration(
+                labelText: 'Coordinates',
+                hint: Text('25.5892, 50.5051662'),
+              ),
+              validator: (value) {
+                return notEmptyValidator(value) ?? coordinatesValidator(value);
+              },
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+
+  void onCancelPressed() => Navigator.of(context).pop();
+
+  void onSavePressed() {
+    if (formKey.currentState!.validate()) {
+      Navigator.of(context).pop(
+        Location(
+          name: nameController.text,
+          coordinates: LatLng.fromString(coordinatesController.text),
+          address: addressController.text,
+        ),
+      );
+    }
+  }
+}

lib/widgets/task_dismissible.dart

@@ -0,0 +1,44 @@
+import 'package:flutter/material.dart';
+
+class TaskDismissible extends StatelessWidget {
+  const TaskDismissible({
+    required super.key,
+    this.onDismissedRight,
+    required this.child,
+  });
+
+  final VoidCallback? onDismissedRight;
+  final Widget child;
+
+  @override
+  Widget build(BuildContext context) {
+    return Dismissible(
+      key: key!,
+      direction: DismissDirection.startToEnd,
+      background: Container(
+        decoration: BoxDecoration(
+          borderRadius: BorderRadius.circular(12),
+          color: Theme.of(context).colorScheme.error,
+        ),
+        child: Align(
+          alignment: AlignmentGeometry.centerLeft,
+          child: Padding(
+            padding: const EdgeInsets.symmetric(horizontal: 12),
+            child: Icon(
+              Icons.delete,
+              color: Theme.of(context).colorScheme.onError,
+            ),
+          ),
+        ),
+      ),
+      onDismissed: onDismissed,
+      child: child,
+    );
+  }
+
+  void onDismissed(DismissDirection direction) {
+    if (direction == DismissDirection.startToEnd && onDismissedRight != null) {
+      onDismissedRight!();
+    }
+  }
+}