Change home architecture

app/analysis_options.yaml

@@ -6,6 +6,7 @@ linter:
     sort_pub_dependencies: false
     lines_longer_than_80_chars: false
     directives_ordering: false
+    one_member_abstracts: false
 
 analyzer:
   exclude:

app/lib/app/view/app_view.dart

@@ -31,9 +31,11 @@ class MyApp extends StatelessWidget {
         ),
         BlocProvider(
           create: (context) => HomeCubit(
-            HomeService(
-              context.read<PreferencesStorage>(),
-              context.read<RemoteClient>(),
+            GetHomeDataUseCase(
+              HomeRepositoryImpl(
+                HomeLocalDataSource(context.read<PreferencesStorage>()),
+                HomeRemoteDataSource(context.read<RemoteClient>()),
+              ),
             ),
           ),
         ),

app/lib/models/models.dart

@@ -1,7 +1,6 @@
 export 'hatim/hatim_juz.dart';
-export 'home/home_model.dart';
-export 'home/hatim_read_model.dart';
 export 'hatim/hatim_page.dart';
+export 'hatim/hatim_read_model.dart';
 export 'juz/juz_data.dart';
 export 'juz/juz_model.dart';
 export 'juz/juz_surah_model.dart';

app/lib/modules/hatim/logic/hatim_read/hatim_read_cubit.dart

@@ -1,6 +1,5 @@
 import 'package:equatable/equatable.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
-
 import 'package:my_quran/core/core.dart';
 import 'package:my_quran/models/models.dart';
 import 'package:my_quran/modules/modules.dart';

app/lib/modules/home/data/data.dart

@@ -0,0 +1,4 @@
+export 'model/home_model_response.dart';
+export 'repository/home_repository.dart';
+export 'source/home_local_data_source.dart';
+export 'source/home_remote_data_source.dart';

app/lib/modules/home/data/model/home_model_response.dart

@@ -0,0 +1,19 @@
+import 'package:json_annotation/json_annotation.dart';
+
+part 'home_model_response.g.dart';
+
+@JsonSerializable()
+class HomeModelResponse {
+  const HomeModelResponse({
+    required this.allDoneHatims,
+    required this.allDonePages,
+    required this.donePages,
+  });
+
+  factory HomeModelResponse.fromJson(Map<String, dynamic> json) => _$HomeModelResponseFromJson(json);
+  Map<String, dynamic> toJson() => _$HomeModelResponseToJson(this);
+
+  final int allDoneHatims;
+  final int allDonePages;
+  final int donePages;
+}

app/lib/modules/home/data/repository/home_repository.dart

@@ -0,0 +1,33 @@
+import 'dart:developer';
+
+import 'package:my_quran/modules/modules.dart';
+
+class HomeRepositoryImpl implements HomeRepository {
+  const HomeRepositoryImpl(
+    this.localDataSource,
+    this.remoteDataSource,
+  );
+
+  final HomeLocalDataSource localDataSource;
+  final HomeRemoteDataSource remoteDataSource;
+
+  @override
+  Future<HomeModel> getData(String token) async {
+    try {
+      final remoteData = await remoteDataSource.getRemoteData(token);
+      await localDataSource.saveLocalData(remoteData);
+      return _convertData(remoteData);
+    } catch (e) {
+      log('HomeRepositoryImpl, getData error: $e');
+      return _convertData(localDataSource.getLocalData());
+    }
+  }
+
+  HomeModel _convertData(HomeModelResponse response) {
+    return HomeModel(
+      allDoneHatims: response.allDoneHatims,
+      allDonePages: response.allDonePages,
+      donePages: response.donePages,
+    );
+  }
+}

app/lib/modules/home/data/source/home_local_data_source.dart

@@ -0,0 +1,25 @@
+import 'dart:convert';
+import 'package:mq_storage/mq_storage.dart';
+import 'package:my_quran/modules/modules.dart';
+
+class HomeLocalDataSource {
+  const HomeLocalDataSource(this.storage);
+
+  final PreferencesStorage storage;
+
+  static const _homeDataCacheKey = 'home-model';
+
+  HomeModelResponse getLocalData() {
+    final localValue = storage.readString(key: _homeDataCacheKey);
+    if (localValue != null) {
+      final data = jsonDecode(localValue);
+      return HomeModelResponse.fromJson(data as Map<String, dynamic>);
+    } else {
+      return const HomeModelResponse(allDoneHatims: 0, allDonePages: 0, donePages: 0);
+    }
+  }
+
+  Future<void> saveLocalData(HomeModelResponse data) async {
+    await storage.writeString(key: _homeDataCacheKey, value: jsonEncode(data.toJson()));
+  }
+}

app/lib/modules/home/data/source/home_remote_data_source.dart

@@ -0,0 +1,22 @@
+import 'package:my_quran/config/config.dart';
+import 'package:my_quran/core/core.dart';
+import 'package:my_quran/modules/modules.dart';
+
+class HomeRemoteDataSource {
+  const HomeRemoteDataSource(this.remoteClient);
+
+  final RemoteClient remoteClient;
+
+  Future<HomeModelResponse> getRemoteData(String token) async {
+    final remoteValue = await remoteClient.get<HomeModelResponse>(
+      apiConst.home,
+      fromJson: HomeModelResponse.fromJson,
+      token: token,
+    );
+
+    return remoteValue.fold(
+      (left) => throw Exception('Failed to fetch remote data $left'),
+      (right) => right,
+    );
+  }
+}

app/lib/modules/home/domain/domain.dart

@@ -0,0 +1,3 @@
+export 'entity/home_model.dart';
+export 'repository/home_repository.dart';
+export 'usecase/get_data_usecase.dart';

app/lib/modules/home/domain/entity/home_model.dart

@@ -0,0 +1,11 @@
+class HomeModel {
+  const HomeModel({
+    required this.allDoneHatims,
+    required this.allDonePages,
+    required this.donePages,
+  });
+
+  final int allDoneHatims;
+  final int allDonePages;
+  final int donePages;
+}

app/lib/modules/home/domain/repository/home_repository.dart

@@ -0,0 +1,5 @@
+import 'package:my_quran/modules/modules.dart';
+
+abstract class HomeRepository {
+  Future<HomeModel> getData(String token);
+}

app/lib/modules/home/domain/usecase/get_data_usecase.dart

@@ -0,0 +1,11 @@
+import 'package:my_quran/modules/modules.dart';
+
+class GetHomeDataUseCase {
+  const GetHomeDataUseCase(this.repository);
+
+  final HomeRepository repository;
+
+  Future<HomeModel> execute(String token) {
+    return repository.getData(token);
+  }
+}

app/lib/modules/home/home.dart

@@ -1,4 +1,3 @@
-export 'logic/home_cubit.dart';
-export 'view/home_view.dart';
-export 'widgets/home_card.dart';
-export 'service/home_service.dart';
+export 'data/data.dart';
+export 'domain/domain.dart';
+export 'presentation/presentation.dart';

app/lib/modules/home/presentation/cubit/home_cubit.dart

@@ -0,0 +1,21 @@
+import 'package:equatable/equatable.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:my_quran/core/core.dart';
+import 'package:my_quran/modules/modules.dart';
+
+part 'home_state.dart';
+
+class HomeCubit extends Cubit<HomeState> {
+  HomeCubit(this.getHomeDataUseCase) : super(const HomeState());
+
+  final GetHomeDataUseCase getHomeDataUseCase;
+
+  Future<void> getData(String token) async {
+    try {
+      final homeModel = await getHomeDataUseCase.execute(token);
+      emit(HomeState(status: FetchStatus.success, homeModel: homeModel));
+    } catch (_) {
+      emit(const HomeState(status: FetchStatus.error));
+    }
+  }
+}

app/lib/modules/home/logic/home_state.dart → app/lib/modules/home/presentation/cubit/home_state.dart

@@ -1,11 +1,14 @@
 part of 'home_cubit.dart';
 
 class HomeState extends Equatable {
-  const HomeState(this.status, {this.homeModel});
+  const HomeState({
+    this.status = FetchStatus.loading,
+    this.homeModel,
+  });
 
   final HomeModel? homeModel;
   final FetchStatus status;
 
   @override
-  List<Object?> get props => [homeModel];
+  List<Object?> get props => [homeModel, status];
 }

app/lib/modules/home/presentation/presentation.dart

@@ -0,0 +1,3 @@
+export 'cubit/home_cubit.dart';
+export 'view/home_view.dart';
+export 'widgets/home_card.dart';

app/test/helpers/pump_app.dart

@@ -10,7 +10,7 @@ extension PumpApp on WidgetTester {
     AppService appService,
     ThemeService themeService,
     AuthService authStorage,
-    HomeService homeService,
+    HomeRepository homeRepo,
   ) {
     return pumpWidget(
       RepositoryProvider(
@@ -19,7 +19,7 @@ extension PumpApp on WidgetTester {
           providers: [
             BlocProvider(create: (context) => AppCubit(appService, themeService)),
             BlocProvider(create: (context) => AuthCubit(authStorage)),
-            BlocProvider(create: (context) => HomeCubit(homeService)),
+            BlocProvider(create: (context) => HomeCubit(GetHomeDataUseCase(homeRepo))),
           ],
           child: const QuranApp(),
         ),

app/test/widget_test.dart

@@ -6,24 +6,30 @@ import 'package:mq_storage/mq_storage.dart';
 import 'package:my_quran/app/app.dart';
 import 'package:my_quran/constants/contants.dart';
 import 'package:my_quran/core/core.dart';
-import 'package:my_quran/modules/home/home.dart';
+import 'package:my_quran/modules/modules.dart';
 
 import 'helpers/helpers.dart';
 
 final class MockPreferencesStorage extends Mock implements PreferencesStorage {}
 
 final class MockRemoteClient extends Mock implements RemoteClient {}
 
+final class MockHomeRepositoryImpl implements HomeRepository {
+  @override
+  Future<HomeModel> getData(String token) async {
+    return const HomeModel(allDoneHatims: 8, allDonePages: 5325, donePages: 634);
+  }
+}
+
 // flutter test
 
 void main() {
   testWidgets('Punmp app', (WidgetTester tester) async {
     final storage = MockPreferencesStorage();
     final remoteClient = MockRemoteClient();
-
     final appService = AppService(storage);
     final authStorage = AuthService(storage, remoteClient);
-    final homeService = HomeService(storage, remoteClient);
+    final homeRepo = MockHomeRepositoryImpl();
     final themeService = ThemeService(storage);
 
     when(() => storage.readString(key: AppConst.tokenKey)).thenReturn(null);
@@ -32,8 +38,7 @@ void main() {
     when(() => storage.readString(key: AppConst.modeKey)).thenReturn(null);
     when(() => storage.readString(key: AppConst.colorKey)).thenReturn(null);
 
-    // // Build our app and trigger a frame.
-    await tester.pumpApp(appService, themeService, authStorage, homeService);
+    await tester.pumpApp(appService, themeService, authStorage, homeRepo);
     await tester.pumpAndSettle();
     expect(find.byType(MaterialApp), findsOneWidget);
   });