feat: dictionary for word lookups

CoderUni · CoderUni · commit 7332d21bb726 · 2025-07-20T20:53:12.000+08:00
diff --git a/assets/dict.csv b/assets/dict.csv
diff --git a/lib/app/view/app.dart b/lib/app/view/app.dart
@@ -4,6 +4,7 @@ import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:qack/gen/fonts.gen.dart';
 import 'package:qack/l10n/arb/app_localizations.dart';
 import 'package:qack/layout/device_info_setter.dart';
+import 'package:qack/presentation/dictionary/bloc/dictionary_bloc.dart';
 import 'package:qack/presentation/history/bloc/history_bloc.dart';
 import 'package:qack/presentation/history/repositories/repositories.dart';
 import 'package:qack/presentation/home/bloc/home_bloc.dart';
@@ -22,6 +23,7 @@ class App extends StatelessWidget {
     required this.secureStorage,
     required this.settingsBloc,
     required this.historyBloc,
+    required this.dictionaryBloc,
     required this.wordOfTheDayCubit,
     required this.appDatabase,
     super.key,
@@ -30,6 +32,7 @@ class App extends StatelessWidget {
   final FlutterSecureStorage secureStorage;
   final SettingsBloc settingsBloc;
   final HistoryBloc historyBloc;
+  final DictionaryBloc dictionaryBloc;
   final WordOfTheDayCubit wordOfTheDayCubit;
   final AppDatabase appDatabase;
 
@@ -50,6 +53,7 @@ class App extends StatelessWidget {
       child: _App(
         settingsBloc: settingsBloc,
         historyBloc: historyBloc,
+        dictionaryBloc: dictionaryBloc,
         wordOfTheDayCubit: wordOfTheDayCubit,
       ),
     );
@@ -60,10 +64,12 @@ class _App extends StatelessWidget {
   const _App({
     required this.settingsBloc,
     required this.historyBloc,
+    required this.dictionaryBloc,
     required this.wordOfTheDayCubit,
   });
   final SettingsBloc settingsBloc;
   final HistoryBloc historyBloc;
+  final DictionaryBloc dictionaryBloc;
   final WordOfTheDayCubit wordOfTheDayCubit;
 
   @override
@@ -81,6 +87,9 @@ class _App extends StatelessWidget {
         BlocProvider(
           create: (context) => historyBloc,
         ),
+        BlocProvider(
+          create: (context) => dictionaryBloc,
+        ),
         BlocProvider(create: (context) => wordOfTheDayCubit),
         BlocProvider(create: (context) => BottomNavigationBarCubit()),
       ],
diff --git a/lib/bootstrap.dart b/lib/bootstrap.dart
@@ -7,6 +7,8 @@ import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:get_it/get_it.dart';
 import 'package:http_client/http_client.dart';
 import 'package:qack/constants/key_name.dart';
+import 'package:qack/presentation/dictionary/bloc/dictionary_bloc.dart';
+import 'package:qack/presentation/dictionary/repositories/repositories.dart';
 import 'package:qack/presentation/history/bloc/history_bloc.dart';
 import 'package:qack/presentation/history/repositories/repositories.dart';
 import 'package:qack/presentation/home/cubit/word_of_the_day_cubit.dart';
@@ -43,6 +45,7 @@ Future<void> bootstrap(
     FlutterSecureStorage secureStorage,
     SettingsBloc settingsBloc,
     HistoryBloc historyBloc,
+    DictionaryBloc dictionaryBloc,
     WordOfTheDayCubit wordOfTheDayCubit,
     AppDatabase appDatabase,
   ) builder,
@@ -102,6 +105,11 @@ Future<void> bootstrap(
     HistoryRepository(appDatabase: appDatabase),
   )..add(const HistoryFetched());
 
+  // Initialize dictionary bloc
+  final dictionaryBloc =
+      DictionaryBloc(DictionaryRepository(appDatabase: appDatabase))
+        ..add(DictionaryFetched());
+
   // Initialize word of the day cubit
   final wordOfTheDayCubit = WordOfTheDayCubit(
     const WordOfTheDayRepository(),
@@ -121,6 +129,7 @@ Future<void> bootstrap(
       secureStorage,
       settingsBloc,
       historyBloc,
+      dictionaryBloc,
       wordOfTheDayCubit,
       appDatabase,
     ),
diff --git a/lib/main_development.dart b/lib/main_development.dart
@@ -3,6 +3,7 @@ import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:qack/app/view/app.dart';
 import 'package:qack/bootstrap.dart';
 import 'package:qack/constants/key_name.dart';
+import 'package:qack/presentation/dictionary/bloc/dictionary_bloc.dart';
 import 'package:qack/presentation/history/bloc/history_bloc.dart';
 import 'package:qack/presentation/home/cubit/word_of_the_day_cubit.dart';
 import 'package:qack/presentation/settings/bloc/settings_bloc.dart';
@@ -36,13 +37,15 @@ Future<void> main() async {
           FlutterSecureStorage secureStorage,
           SettingsBloc settingsBloc,
           HistoryBloc historyBloc,
+          DictionaryBloc  dictionaryBloc,
           WordOfTheDayCubit wordOfTheDayCubit,
           AppDatabase appDatabase,
         ) async {
           return App(
             secureStorage: secureStorage,
             settingsBloc: settingsBloc,
             historyBloc: historyBloc,
+            dictionaryBloc: dictionaryBloc,
             wordOfTheDayCubit: wordOfTheDayCubit,
             appDatabase: appDatabase,
           );
diff --git a/lib/main_production.dart b/lib/main_production.dart
@@ -3,6 +3,7 @@ import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:qack/app/view/app.dart';
 import 'package:qack/bootstrap.dart';
 import 'package:qack/constants/constants.dart';
+import 'package:qack/presentation/dictionary/bloc/dictionary_bloc.dart';
 import 'package:qack/presentation/history/bloc/history_bloc.dart';
 import 'package:qack/presentation/home/cubit/word_of_the_day_cubit.dart';
 import 'package:qack/presentation/settings/bloc/settings_bloc.dart';
@@ -35,13 +36,15 @@ Future<void> main() async {
           FlutterSecureStorage secureStorage,
           SettingsBloc settingsBloc,
           HistoryBloc historyBloc,
+          DictionaryBloc dictionaryBloc,
           WordOfTheDayCubit wordOfTheDayCubit,
           AppDatabase appDatabase,
         ) async {
           return App(
             secureStorage: secureStorage,
             settingsBloc: settingsBloc,
             historyBloc: historyBloc,
+            dictionaryBloc: dictionaryBloc,
             wordOfTheDayCubit: wordOfTheDayCubit,
             appDatabase: appDatabase,
           );
diff --git a/lib/main_staging.dart b/lib/main_staging.dart
@@ -3,6 +3,7 @@ import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 import 'package:qack/app/view/app.dart';
 import 'package:qack/bootstrap.dart';
 import 'package:qack/constants/constants.dart';
+import 'package:qack/presentation/dictionary/bloc/dictionary_bloc.dart';
 import 'package:qack/presentation/history/bloc/history_bloc.dart';
 import 'package:qack/presentation/home/cubit/word_of_the_day_cubit.dart';
 import 'package:qack/presentation/settings/bloc/settings_bloc.dart';
@@ -35,13 +36,15 @@ Future<void> main() async {
           FlutterSecureStorage secureStorage,
           SettingsBloc settingsBloc,
           HistoryBloc historyBloc,
+          DictionaryBloc dictionaryBloc,
           WordOfTheDayCubit wordOfTheDayCubit,
           AppDatabase appDatabase,
         ) async {
           return App(
             secureStorage: secureStorage,
             settingsBloc: settingsBloc,
             historyBloc: historyBloc,
+            dictionaryBloc: dictionaryBloc,
             wordOfTheDayCubit: wordOfTheDayCubit,
             appDatabase: appDatabase,
           );
diff --git a/lib/presentation/dictionary/bloc/dictionary_bloc.dart b/lib/presentation/dictionary/bloc/dictionary_bloc.dart
@@ -0,0 +1,75 @@
+import 'package:bloc/bloc.dart';
+import 'package:equatable/equatable.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
+import 'package:qack/presentation/dictionary/repositories/repositories.dart';
+import 'package:qack/utils/database/database.dart';
+import 'package:sentry_flutter/sentry_flutter.dart';
+
+part 'dictionary_event.dart';
+part 'dictionary_state.dart';
+
+class DictionaryBloc extends Bloc<DictionaryEvent, DictionaryState> {
+  DictionaryBloc(this.repository) : super(const DictionaryState()) {
+    on<DictionaryFetched>(_onDictionaryFetched);
+    on<DictionaryQueried>(_onDictionaryQueried);
+  }
+  final DictionaryRepository repository;
+
+  Future<void> _onDictionaryFetched(
+    DictionaryFetched event,
+    Emitter<DictionaryState> emit,
+  ) async {
+    try {
+      final entries = await repository.fetchDictionaryEntries();
+
+      emit(
+        state.copyWith(
+          method: DictionaryMethod.fetchDictionary,
+          status: DictionaryStatus.success,
+          dictionaryEntries: entries,
+        ),
+      );
+    } on Exception catch (e) {
+      emit(
+        state.copyWith(
+          method: DictionaryMethod.fetchDictionary,
+          status: DictionaryStatus.failure,
+        ),
+      );
+
+      await Sentry.captureException(
+        e,
+        stackTrace: StackTrace.current,
+      );
+    }
+  }
+
+  Future<void> _onDictionaryQueried(
+    DictionaryQueried event,
+    Emitter<DictionaryState> emit,
+  ) async {
+    try {
+      final entries = await repository.queryDictionaryEntries(event.query);
+
+      emit(
+        state.copyWith(
+          method: DictionaryMethod.queryDictionary,
+          status: DictionaryStatus.success,
+          dictionaryEntries: entries,
+        ),
+      );
+    } on Exception catch (e) {
+      emit(
+        state.copyWith(
+          method: DictionaryMethod.queryDictionary,
+          status: DictionaryStatus.failure,
+        ),
+      );
+
+      await Sentry.captureException(
+        e,
+        stackTrace: StackTrace.current,
+      );
+    }
+  }
+}
diff --git a/lib/presentation/dictionary/bloc/dictionary_event.dart b/lib/presentation/dictionary/bloc/dictionary_event.dart
@@ -0,0 +1,18 @@
+part of 'dictionary_bloc.dart';
+
+class DictionaryEvent extends Equatable {
+  @override
+  List<Object?> get props => [];
+}
+
+class DictionaryFetched extends DictionaryEvent {
+  @override
+  List<Object?> get props => [];
+}
+
+class DictionaryQueried extends DictionaryEvent {
+  DictionaryQueried(this.query);
+  final String query;
+  @override
+  List<Object?> get props => [query];
+}
diff --git a/lib/presentation/dictionary/bloc/dictionary_state.dart b/lib/presentation/dictionary/bloc/dictionary_state.dart
@@ -0,0 +1,41 @@
+part of 'dictionary_bloc.dart';
+
+enum DictionaryMethod {
+  initial,
+  fetchDictionary,
+  queryDictionary,
+}
+
+enum DictionaryStatus {
+  initial,
+  loading,
+  success,
+  failure,
+}
+
+class DictionaryState extends Equatable {
+  const DictionaryState({
+    this.method = DictionaryMethod.initial,
+    this.status = DictionaryStatus.initial,
+    this.dictionaryEntries = const [],
+  });
+
+  final DictionaryMethod method;
+  final DictionaryStatus status;
+  final List<DictionaryData> dictionaryEntries;
+
+  DictionaryState copyWith({
+    DictionaryMethod? method,
+    DictionaryStatus? status,
+    List<DictionaryData>? dictionaryEntries,
+  }) {
+    return DictionaryState(
+      method: method ?? this.method,
+      status: status ?? this.status,
+      dictionaryEntries: dictionaryEntries ?? this.dictionaryEntries,
+    );
+  }
+
+  @override
+  List<Object?> get props => [method, status, dictionaryEntries];
+}
diff --git a/lib/presentation/dictionary/components/components.dart b/lib/presentation/dictionary/components/components.dart
@@ -0,0 +1 @@
+export 'dictionary_list_tile.dart';
diff --git a/lib/presentation/dictionary/components/dictionary_list_tile.dart b/lib/presentation/dictionary/components/dictionary_list_tile.dart
@@ -0,0 +1,29 @@
+import 'package:flutter/material.dart';
+import 'package:qack/utils/database/database.dart';
+import 'package:qack/widgets/divider.dart';
+
+class DictionaryListTile extends StatelessWidget {
+  const DictionaryListTile({required this.entry, super.key});
+  final DictionaryData entry;
+
+  @override
+  Widget build(BuildContext context) {
+    return Padding(
+      padding: const EdgeInsets.symmetric(vertical: 4, horizontal: 8),
+      child: Column(
+        mainAxisSize: MainAxisSize.min,
+        crossAxisAlignment: CrossAxisAlignment.start,
+        children: [
+          Text(
+            '${entry.simplified} '
+            '${(entry.simplified != entry.traditional) ? "(${entry.traditional}) " : ""}'
+            '- ${entry.pinyin}',
+          ),
+          Text(entry.definitions),
+          const SizedBox(height: 4),
+          const AppDivider(),
+        ],
+      ),
+    );
+  }
+}
diff --git a/lib/presentation/dictionary/repositories/dictionary_repository.dart b/lib/presentation/dictionary/repositories/dictionary_repository.dart
@@ -0,0 +1,36 @@
+import 'package:qack/utils/database/database.dart';
+
+final class DictionaryRepository {
+  DictionaryRepository({
+    required this.appDatabase,
+  });
+
+  final AppDatabase appDatabase;
+
+  Future<List<DictionaryData>> fetchDictionaryEntries() async {
+    // Fetch dictionary entries from the database
+    return (appDatabase.select(appDatabase.dictionary)..limit(100)).get();
+  }
+
+  Future<List<DictionaryData>> queryDictionaryEntries(String query) async {
+    final ftsQuery = '${query.trim()}*';
+    final likeQuery =
+        // ignore: lines_longer_than_80_chars
+        '${query.trim().replaceAllMapped(RegExp(r'[\\%_]'), (m) => '\\${m[0]}')}%';
+
+    final result = await appDatabase.queryDictionary(ftsQuery, likeQuery).get();
+
+    if (result.isEmpty) return [];
+    // Convert the result to TranslationHistory objects
+    return result.map((entry) {
+      return DictionaryData(
+        id: entry.parentID,
+        simplified: entry.simplified,
+        traditional: entry.traditional,
+        pinyin: entry.pinyin,
+        definitions: entry.definitions,
+        examples: entry.examples,
+      );
+    }).toList();
+  }
+}
diff --git a/lib/presentation/dictionary/repositories/repositories.dart b/lib/presentation/dictionary/repositories/repositories.dart
@@ -0,0 +1 @@
+export 'dictionary_repository.dart';
diff --git a/lib/presentation/dictionary/view/dictionary_page.dart b/lib/presentation/dictionary/view/dictionary_page.dart
diff --git a/lib/presentation/home/repositories/home_respository.dart b/lib/presentation/home/repositories/home_respository.dart
