[Compass App] Refactor model (#2431)

This PR removes the `compass_model` subproject and moves each data model
class to the respective `app` or `server` project.

Although this leads to code duplication, this is a more realistic
implementation where clients and servers have their own respective data
model class implementations.

The model classes for the server are located in `server/lib/model`.

Model classes for the app are located in two places:

- API-only model: `app/lib/data/services/api/model`.
- Domain model: `app/lib/domain/model`.

In general, models located under the domain are used across the app,
while the API-only models are only used for interacting with the API
client.

Tests have been updated.

## Pre-launch Checklist

- [x] I read the [Flutter Style Guide] _recently_, and have followed its
advice.
- [x] I signed the [CLA].
- [x] I read the [Contributors Guide].
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-devrel
channel on [Discord].

<!-- Links -->
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
[CLA]: https://cla.developers.google.com/
[Discord]:
https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
[Contributors Guide]:
https://github.com/flutter/samples/blob/main/CONTRIBUTING.md

Author: miquelbeltran

compass_app/app/lib/data/repositories/activity/activity_repository.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/result.dart';
 
 /// Data source for activities.

compass_app/app/lib/data/repositories/activity/activity_repository_local.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/result.dart';
 import '../../services/local/local_data_service.dart';
 import 'activity_repository.dart';

compass_app/app/lib/data/repositories/activity/activity_repository_remote.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/result.dart';
 import '../../services/api/api_client.dart';
 import 'activity_repository.dart';

compass_app/app/lib/data/repositories/auth/auth_repository_remote.dart

@@ -1,9 +1,10 @@
-import 'package:compass_model/model.dart';
 import 'package:logging/logging.dart';
 
 import '../../../utils/result.dart';
 import '../../services/api/api_client.dart';
 import '../../services/api/auth_api_client.dart';
+import '../../services/api/model/login_request/login_request.dart';
+import '../../services/api/model/login_response/login_response.dart';
 import '../../services/shared_preferences_service.dart';
 import 'auth_repository.dart';
 

compass_app/app/lib/data/repositories/booking/booking_repository.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/booking/booking.dart';
 import '../../../domain/models/booking/booking_summary.dart';
 import '../../../utils/result.dart';
 

compass_app/app/lib/data/repositories/booking/booking_repository_local.dart

@@ -1,7 +1,7 @@
 import 'dart:async';
 
-import 'package:compass_model/model.dart';
 import 'package:collection/collection.dart';
+import '../../../domain/models/booking/booking.dart';
 import '../../../domain/models/booking/booking_summary.dart';
 import '../../../utils/result.dart';
 

compass_app/app/lib/data/repositories/booking/booking_repository_remote.dart

@@ -1,6 +1,7 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/activity/activity.dart';
+import '../../../domain/models/booking/booking.dart';
 import '../../../domain/models/booking/booking_summary.dart';
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/result.dart';
 import '../../services/api/api_client.dart';
 import '../../services/api/model/booking/booking_api_model.dart';

compass_app/app/lib/data/repositories/continent/continent_repository.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/continent/continent.dart';
 import '../../../utils/result.dart';
 
 /// Data source with all possible continents.

compass_app/app/lib/data/repositories/continent/continent_repository_local.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/continent/continent.dart';
 import '../../../utils/result.dart';
 import '../../services/local/local_data_service.dart';
 import 'continent_repository.dart';

compass_app/app/lib/data/repositories/continent/continent_repository_remote.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/continent/continent.dart';
 import '../../../utils/result.dart';
 import '../../services/api/api_client.dart';
 import 'continent_repository.dart';

compass_app/app/lib/data/repositories/destination/destination_repository.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/result.dart';
 
 /// Data source with all possible destinations

compass_app/app/lib/data/repositories/destination/destination_repository_local.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/result.dart';
 import '../../services/local/local_data_service.dart';
 import 'destination_repository.dart';

compass_app/app/lib/data/repositories/destination/destination_repository_remote.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/result.dart';
 import '../../services/api/api_client.dart';
 import 'destination_repository.dart';

compass_app/app/lib/data/repositories/itinerary_config/itinerary_config_repository.dart

@@ -1,5 +1,4 @@
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../utils/result.dart';
 
 /// Data source for the current [ItineraryConfig]

compass_app/app/lib/data/repositories/itinerary_config/itinerary_config_repository_memory.dart

@@ -1,7 +1,6 @@
 import 'dart:async';
 
-import 'package:compass_model/model.dart';
-
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../utils/result.dart';
 import 'itinerary_config_repository.dart';
 

compass_app/app/lib/data/services/api/api_client.dart

@@ -1,7 +1,9 @@
 import 'dart:convert';
 import 'dart:io';
-import 'package:compass_model/model.dart';
 
+import '../../../domain/models/activity/activity.dart';
+import '../../../domain/models/continent/continent.dart';
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/result.dart';
 import 'model/booking/booking_api_model.dart';
 

compass_app/app/lib/data/services/api/auth_api_client.dart

@@ -1,11 +1,11 @@
-// TODO: Configurable baseurl/host/port
 import 'dart:convert';
 import 'dart:io';
 
-import 'package:compass_model/model.dart';
-
 import '../../../utils/result.dart';
+import 'model/login_request/login_request.dart';
+import 'model/login_response/login_response.dart';
 
+// TODO: Configurable baseurl/host/port
 class AuthApiClient {
   Future<Result<LoginResponse>> login(LoginRequest loginRequest) async {
     final client = HttpClient();

compass_app/model/lib/src/model/auth/login_request/login_request.dart renamed to compass_app/app/lib/data/services/api/model/login_request/login_request.dart

@@ -1,9 +1,11 @@
 import 'dart:convert';
 
-import 'package:compass_model/model.dart';
 import 'package:flutter/services.dart';
 
 import '../../../config/assets.dart';
+import '../../../domain/models/activity/activity.dart';
+import '../../../domain/models/continent/continent.dart';
+import '../../../domain/models/destination/destination.dart';
 
 class LocalDataService {
   List<Continent> getContinents() {

compass_app/model/lib/src/model/auth/login_request/login_request.freezed.dart renamed to compass_app/app/lib/data/services/api/model/login_request/login_request.freezed.dart

@@ -1,10 +1,13 @@
-import 'package:compass_model/model.dart';
 import 'package:logging/logging.dart';
 
 import '../../../data/repositories/activity/activity_repository.dart';
 import '../../../data/repositories/booking/booking_repository.dart';
 import '../../../data/repositories/destination/destination_repository.dart';
 import '../../../utils/result.dart';
+import '../../models/activity/activity.dart';
+import '../../models/booking/booking.dart';
+import '../../models/destination/destination.dart';
+import '../../models/itinerary_config/itinerary_config.dart';
 
 /// Component for creating [Booking] objects from [ItineraryConfig].
 ///

compass_app/model/lib/src/model/auth/login_request/login_request.g.dart renamed to compass_app/app/lib/data/services/api/model/login_request/login_request.g.dart

@@ -1,10 +1,10 @@
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 import 'package:logging/logging.dart';
 import 'package:share_plus/share_plus.dart';
 
 import '../../../utils/result.dart';
 import '../../../ui/core/ui/date_format_start_end.dart';
+import '../../models/booking/booking.dart';
 
 typedef ShareFunction = Future<void> Function(String text);
 

compass_app/model/lib/src/model/auth/login_response/login_response.dart renamed to compass_app/app/lib/data/services/api/model/login_response/login_response.dart

@@ -1,6 +1,8 @@
-import 'package:compass_model/model.dart';
 import 'package:freezed_annotation/freezed_annotation.dart';
 
+import '../activity/activity.dart';
+import '../destination/destination.dart';
+
 part 'booking.freezed.dart';
 part 'booking.g.dart';
 

compass_app/model/lib/src/model/auth/login_response/login_response.freezed.dart renamed to compass_app/app/lib/data/services/api/model/login_response/login_response.freezed.dart

@@ -1,9 +1,9 @@
-import 'package:compass_model/model.dart';
 import 'package:flutter/foundation.dart';
 import 'package:logging/logging.dart';
 
 import '../../../data/repositories/activity/activity_repository.dart';
 import '../../../data/repositories/itinerary_config/itinerary_config_repository.dart';
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/command.dart';
 import '../../../utils/result.dart';
 

compass_app/model/lib/src/model/auth/login_response/login_response.g.dart renamed to compass_app/app/lib/data/services/api/model/login_response/login_response.g.dart

@@ -1,7 +1,7 @@
 import 'package:cached_network_image/cached_network_image.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/image_error_listener.dart';
 import '../../core/ui/custom_checkbox.dart';
 

compass_app/app/lib/data/services/local/local_data_service.dart

@@ -1,7 +1,6 @@
-import 'package:compass_model/model.dart';
-
 import '../../../../data/repositories/auth/auth_repository.dart';
 import '../../../../data/repositories/itinerary_config/itinerary_config_repository.dart';
+import '../../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../../utils/command.dart';
 import '../../../../utils/result.dart';
 

compass_app/app/lib/domain/components/booking/booking_create_component.dart

@@ -1,9 +1,10 @@
-import 'package:compass_model/model.dart';
 import 'package:flutter/foundation.dart';
 import 'package:logging/logging.dart';
 
 import '../../../data/repositories/booking/booking_repository.dart';
 import '../../../data/repositories/itinerary_config/itinerary_config_repository.dart';
+import '../../../domain/models/booking/booking.dart';
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../utils/command.dart';
 import '../../../utils/result.dart';
 import '../../../domain/components/booking/booking_create_component.dart';

compass_app/app/lib/domain/components/booking/booking_share_component.dart

@@ -1,7 +1,7 @@
 import 'package:cached_network_image/cached_network_image.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 
+import '../../../domain/models/activity/activity.dart';
 import '../../../utils/image_error_listener.dart';
 import '../../core/themes/dimens.dart';
 import '../view_models/booking_viewmodel.dart';

compass_app/model/lib/src/model/activity/activity.dart renamed to compass_app/app/lib/domain/models/activity/activity.dart

@@ -1,7 +1,7 @@
 import 'package:cached_network_image/cached_network_image.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 
+import '../../../domain/models/booking/booking.dart';
 import '../../../utils/image_error_listener.dart';
 import '../../core/localization/applocalization.dart';
 import '../../core/themes/colors.dart';

compass_app/model/lib/src/model/activity/activity.freezed.dart renamed to compass_app/app/lib/domain/models/activity/activity.freezed.dart

@@ -1,6 +1,6 @@
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../localization/applocalization.dart';
 import '../themes/colors.dart';
 import '../themes/dimens.dart';

compass_app/model/lib/src/model/activity/activity.g.dart renamed to compass_app/app/lib/domain/models/activity/activity.g.dart

@@ -1,8 +1,9 @@
-import 'package:compass_model/model.dart';
 import 'package:logging/logging.dart';
 
 import '../../../data/repositories/destination/destination_repository.dart';
 import '../../../data/repositories/itinerary_config/itinerary_config_repository.dart';
+import '../../../domain/models/destination/destination.dart';
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../utils/command.dart';
 import '../../../utils/result.dart';
 import 'package:flutter/cupertino.dart';

compass_app/model/lib/src/model/booking/booking.dart renamed to compass_app/app/lib/domain/models/booking/booking.dart

@@ -1,7 +1,6 @@
-import 'package:compass_model/model.dart';
-
 import 'package:cached_network_image/cached_network_image.dart';
 import 'package:flutter/material.dart';
+import '../../../domain/models/destination/destination.dart';
 import '../../../utils/image_error_listener.dart';
 import '../../core/themes/text_styles.dart';
 import '../../core/ui/tag_chip.dart';

compass_app/model/lib/src/model/booking/booking.freezed.dart renamed to compass_app/app/lib/domain/models/booking/booking.freezed.dart

@@ -1,9 +1,10 @@
 import 'package:flutter/material.dart';
-import 'package:compass_model/model.dart';
 import 'package:logging/logging.dart';
 
 import '../../../data/repositories/continent/continent_repository.dart';
 import '../../../data/repositories/itinerary_config/itinerary_config_repository.dart';
+import '../../../domain/models/continent/continent.dart';
+import '../../../domain/models/itinerary_config/itinerary_config.dart';
 import '../../../utils/command.dart';
 import '../../../utils/result.dart';
 

compass_app/model/lib/src/model/booking/booking.g.dart renamed to compass_app/app/lib/domain/models/booking/booking.g.dart

@@ -1,8 +1,8 @@
 import 'package:cached_network_image/cached_network_image.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 import 'package:google_fonts/google_fonts.dart';
 
+import '../../../domain/models/continent/continent.dart';
 import '../../../utils/image_error_listener.dart';
 import '../../core/localization/applocalization.dart';
 import '../../core/themes/colors.dart';

compass_app/model/lib/src/model/continent/continent.dart renamed to compass_app/app/lib/domain/models/continent/continent.dart

@@ -9,8 +9,6 @@ environment:
 dependencies:
   cached_network_image: ^3.3.1
   collection: ^1.18.0
-  compass_model:
-    path: ../model
   flutter:
     sdk: flutter
   flutter_localizations:

compass_app/model/lib/src/model/continent/continent.freezed.dart renamed to compass_app/app/lib/domain/models/continent/continent.freezed.dart

@@ -1,5 +1,5 @@
 import 'package:compass_app/domain/components/booking/booking_create_component.dart';
-import 'package:compass_model/model.dart';
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 import '../../../../testing/fakes/repositories/fake_activities_repository.dart';

compass_app/model/lib/src/model/continent/continent.g.dart renamed to compass_app/app/lib/domain/models/continent/continent.g.dart

@@ -1,5 +1,5 @@
 import 'package:compass_app/domain/components/booking/booking_share_component.dart';
-import 'package:compass_model/model.dart';
+import 'package:compass_app/domain/models/booking/booking.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 import '../../../../testing/models/activity.dart';

compass_app/model/lib/src/model/destination/destination.dart renamed to compass_app/app/lib/domain/models/destination/destination.dart

@@ -1,7 +1,7 @@
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:compass_app/ui/activities/view_models/activities_viewmodel.dart';
 import 'package:compass_app/ui/activities/widgets/activities_screen.dart';
 import 'package:compass_app/ui/activities/widgets/activity_entry.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mocktail/mocktail.dart';

compass_app/model/lib/src/model/destination/destination.freezed.dart renamed to compass_app/app/lib/domain/models/destination/destination.freezed.dart

@@ -1,6 +1,6 @@
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:compass_app/ui/auth/logout/view_models/logout_viewmodel.dart';
 import 'package:compass_app/ui/auth/logout/widgets/logout_button.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mocktail_image_network/mocktail_image_network.dart';
 

compass_app/model/lib/src/model/destination/destination.g.dart renamed to compass_app/app/lib/domain/models/destination/destination.g.dart

@@ -1,8 +1,8 @@
 import 'package:compass_app/domain/components/booking/booking_create_component.dart';
 import 'package:compass_app/domain/components/booking/booking_share_component.dart';
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:compass_app/ui/booking/view_models/booking_viewmodel.dart';
 import 'package:compass_app/ui/booking/widgets/booking_screen.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter_test/flutter_test.dart';
 

compass_app/model/lib/src/model/itinerary_config/itinerary_config.dart renamed to compass_app/app/lib/domain/models/itinerary_config/itinerary_config.dart

@@ -1,6 +1,6 @@
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:compass_app/ui/results/view_models/results_viewmodel.dart';
 import 'package:compass_app/ui/results/widgets/results_screen.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mocktail/mocktail.dart';
 import 'package:mocktail_image_network/mocktail_image_network.dart';

compass_app/model/lib/src/model/itinerary_config/itinerary_config.freezed.dart renamed to compass_app/app/lib/domain/models/itinerary_config/itinerary_config.freezed.dart

@@ -1,5 +1,5 @@
+import 'package:compass_app/domain/models/itinerary_config/itinerary_config.dart';
 import 'package:compass_app/ui/results/view_models/results_viewmodel.dart';
-import 'package:compass_model/model.dart';
 import 'package:flutter_test/flutter_test.dart';
 
 import '../../../testing/fakes/repositories/fake_destination_repository.dart';

compass_app/model/lib/src/model/itinerary_config/itinerary_config.g.dart renamed to compass_app/app/lib/domain/models/itinerary_config/itinerary_config.g.dart

@@ -1,6 +1,6 @@
 import 'package:compass_app/data/repositories/activity/activity_repository.dart';
+import 'package:compass_app/domain/models/activity/activity.dart';
 import 'package:compass_app/utils/result.dart';
-import 'package:compass_model/src/model/activity/activity.dart';
 import 'package:flutter/foundation.dart';
 
 import '../../models/activity.dart';

compass_app/app/lib/ui/activities/view_models/activities_viewmodel.dart

@@ -1,8 +1,8 @@
 import 'package:collection/collection.dart';
 import 'package:compass_app/data/repositories/booking/booking_repository.dart';
+import 'package:compass_app/domain/models/booking/booking.dart';
 import 'package:compass_app/domain/models/booking/booking_summary.dart';
 import 'package:compass_app/utils/result.dart';
-import 'package:compass_model/src/model/booking/booking.dart';
 
 class FakeBookingRepository implements BookingRepository {
   List<Booking> bookings = List.empty(growable: true);

compass_app/app/lib/ui/activities/widgets/activity_entry.dart

@@ -1,5 +1,5 @@
-import 'package:compass_model/model.dart';
 import 'package:compass_app/data/repositories/continent/continent_repository.dart';
+import 'package:compass_app/domain/models/continent/continent.dart';
 import 'package:compass_app/utils/result.dart';
 import 'package:flutter/foundation.dart';
 

compass_app/app/lib/ui/auth/logout/view_models/logout_viewmodel.dart

@@ -1,5 +1,5 @@
-import 'package:compass_model/model.dart';
 import 'package:compass_app/data/repositories/destination/destination_repository.dart';
+import 'package:compass_app/domain/models/destination/destination.dart';
 import 'package:compass_app/utils/result.dart';
 import 'package:flutter/foundation.dart';