diff --git a/lib/features/core/data/constants/const_sorters.dart b/lib/features/core/data/constants/const_sorters.dart
new file mode 100644
index 0000000..7e9c152
--- /dev/null
+++ b/lib/features/core/data/constants/const_sorters.dart
@@ -0,0 +1,8 @@
+import 'package:string_similarity/string_similarity.dart';
+
+abstract class ConstSorters {
+ /// Uses Dice's Coefficient as a similarity heuristic, for a 2-way comparison, between a [targetWord]
+ /// and given words.
+ static int stringsSimilarityTarget(String a, String b, {required String targetWord}) =>
+ a.similarityTo(targetWord).compareTo(b.similarityTo(targetWord));
+}
diff --git a/lib/features/core/data/extensions/map_extensions.dart b/lib/features/core/data/extensions/map_extensions.dart
index a185aa1..26f310a 100644
--- a/lib/features/core/data/extensions/map_extensions.dart
+++ b/lib/features/core/data/extensions/map_extensions.dart
@@ -1,3 +1,6 @@
extension MapExtensions on Map {
Map get deepCopy => {...this};
+
+ /// Returns the values of a [Map] at given [keys] indices.
+ Iterable valuesByKeys({required Iterable keys}) => keys.map((final key) => this[key]!);
}
diff --git a/lib/features/home/services/images_service.dart b/lib/features/home/services/images_service.dart
index 0bf756c..3b5d2b9 100644
--- a/lib/features/home/services/images_service.dart
+++ b/lib/features/home/services/images_service.dart
@@ -1,12 +1,14 @@
import 'dart:async';
+import '/features/core/data/constants/const_sorters.dart';
import '/features/core/data/extensions/iterable_extensions.dart';
+import '/features/core/data/extensions/map_extensions.dart';
import '/features/core/services/logging_service.dart';
import '/features/core/utils/mutex.dart';
-import '/features/home/data/models/image_model.dart';
import '/locator.dart';
import '../abstracts/images_api.dart';
import '../data/enums/search_option.dart';
+import '../data/models/image_model.dart';
/// Handles fetching and storing of Images.
///
@@ -24,8 +26,9 @@ class ImagesService {
final ImagesApi _imagesApi;
final LoggingService _loggingService;
- late final Iterable _imageModels;
- Iterable get imageModels => _imageModels.deepCopy;
+ late final Map _imageModels;
+ Iterable get imageModels => _imageModels.values.deepCopy;
+
final Mutex _searchMutex = Mutex();
/// Manual initialization triggering
@@ -36,7 +39,10 @@ class ImagesService {
Future _init() async {
_loggingService.info('Fetching and creating image models...');
- _imageModels = await _imagesApi.fetchImageUri(token: '');
+ _imageModels = {
+ for (final imageModel in await _imagesApi.fetchImageUri(token: ''))
+ imageModel.imageName: imageModel
+ };
_imageModels.isNotEmpty
? _loggingService.good("Created ${_imageModels.length} images' models")
@@ -49,10 +55,18 @@ class ImagesService {
int get lastAvailableImageIndex => _imageModels.length - 1;
int get numberOfImages => _imageModels.length;
- ImageModel imageModelAt({required int index}) => _imageModels.elementAt(index);
+ ImageModel imageModelAt({required int index}) => _imageModels.values.elementAt(index);
Future get lastQueryIsCompleted => _searchMutex.lastOperationCompletionAwaiter;
+ /// Performs searching on images, both locally and by a Web API endpoint.
+ ///
+ /// For now, a simple mechanism is used for handling async calls between (posssible) API fetches ->
+ /// just 'pile-up'. A mechanism can be made to 'cancel' a fetch if a newer search request comes in,
+ /// but that may be more complicated, and not the point of the assignment I think.
+ /// There are lots of optimizations possible for new inputs, for example reducing search frontier
+ /// by using set-cover/subsetting optimizations on backspace, and so on, but again, not the point,
+ /// I think.
Future> searchImages({
required SearchOption searchOption,
required String imageNamePart,
@@ -61,7 +75,12 @@ class ImagesService {
try {
switch (searchOption) {
case SearchOption.local:
- return [];
+ final rankedKeys = _imageModels.keys
+ .where((final imageName) => imageName.contains(imageNamePart))
+ .toList(growable: false)
+ ..sort((final a, final b) =>
+ ConstSorters.stringsSimilarityTarget(targetWord: imageNamePart, a, b));
+ return _imageModels.valuesByKeys(keys: rankedKeys).toList(growable: false);
case SearchOption.web:
return await _imagesApi.searchImages(
searchStr: imageNamePart,
diff --git a/lib/features/home/views/gallery/gallery_view_model.dart b/lib/features/home/views/gallery/gallery_view_model.dart
index f6e274b..5de2262 100644
--- a/lib/features/home/views/gallery/gallery_view_model.dart
+++ b/lib/features/home/views/gallery/gallery_view_model.dart
@@ -7,12 +7,12 @@ import 'package:flutter_cache_manager/flutter_cache_manager.dart';
import '/features/core/abstracts/base_view_model.dart';
import '/features/core/services/logging_service.dart';
import '/features/core/services/navigation_service.dart';
-import '/features/home/data/models/image_model.dart';
-import '/features/home/services/image_cache_manager_service.dart';
-import '/features/home/services/images_service.dart';
-import '/features/home/views/image_carousel/image_carousel_view.dart';
import '/locator.dart';
import '../../data/enums/search_option.dart';
+import '../../data/models/image_model.dart';
+import '../../services/image_cache_manager_service.dart';
+import '../../services/images_service.dart';
+import '../image_carousel/image_carousel_view.dart';
class GalleryViewModel extends BaseViewModel {
GalleryViewModel({
@@ -54,17 +54,20 @@ class GalleryViewModel extends BaseViewModel {
// If empty-string (from backspacing) -> reset state.
if (searchTerm.isEmpty) {
_imageSearchResultsNotifier.value = [];
+ _loggingService.info('Clearing results on search string removal');
return;
}
// Detached call to prevent UI blocking
- unawaited(_imagesService
- .searchImages(
- imageNamePart: searchTerm,
- searchOption: searchOptionListenable.value,
- )
- .then(
- (final fetchedImageModels) => _imageSearchResultsNotifier.value = fetchedImageModels));
+ unawaited(
+ _imagesService
+ .searchImages(
+ imageNamePart: searchTerm,
+ searchOption: searchOptionListenable.value,
+ )
+ .then(
+ (final fetchedImageModels) => _imageSearchResultsNotifier.value = fetchedImageModels),
+ );
// Force-update to trigger listening to `lastQueryResultDone()`.
_imageSearchResultsNotifier.notifyListeners();
@@ -72,14 +75,20 @@ class GalleryViewModel extends BaseViewModel {
void searchPressed() {
// If transitioning from 'Searching', clear previous results immediately
- if (_isSearchingNotifier.value) _imageSearchResultsNotifier.value = [];
+ if (_isSearchingNotifier.value) {
+ _imageSearchResultsNotifier.value = [];
+ _loggingService.info('Clearing results on view mode change');
+ }
_isSearchingNotifier.value = !_isSearchingNotifier.value;
}
Future get lastQueryResultDone => _imagesService.lastQueryIsCompleted;
- void onSearchOptionChanged(SearchOption? option) => _searchOptionNotifier.value = option!;
+ void onSearchOptionChanged(SearchOption? option) {
+ _searchOptionNotifier.value = option!;
+ _loggingService.info('Switching over to $option search');
+ }
void onPromptPressed() => _isDisplayingPressingPrompt.value = false;
diff --git a/pubspec.lock b/pubspec.lock
index ca2f9cb..67d91e0 100644
--- a/pubspec.lock
+++ b/pubspec.lock
@@ -546,6 +546,13 @@ packages:
url: "https://pub.dartlang.org"
source: hosted
version: "1.1.1"
+ string_similarity:
+ dependency: "direct main"
+ description:
+ name: string_similarity
+ url: "https://pub.dartlang.org"
+ source: hosted
+ version: "2.0.0"
synchronized:
dependency: transitive
description:
diff --git a/pubspec.yaml b/pubspec.yaml
index 1a242bf..7495f6e 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -29,6 +29,7 @@ dependencies:
intl_utils: ^2.8.1
connectivity_plus: ^3.0.2
internet_connection_checker: ^1.0.0+1
+ string_similarity: ^2.0.0
# Util frontend
flutter_markdown: ^0.6.13