LocalPersist/LocalJsonPersist.findBaseDirectory

Author: marcglasberg

CHANGELOG.md

@@ -3,6 +3,13 @@ the <a href="https://github.com/marcglasberg/SameAppDifferentTech/blob/main/Mobi
 Async Redux App Example GitHub Repo</a> for a full-fledged example app showcasing the fundamentals
 and best practices._
 
+# 23.3.0-dev.1
+
+* `LocalPersist` and `LocalJsonPersist` now allow you to define the base directory by setting
+  the `findBaseDirectory` static field. The default is, as before, the application's documents
+  directory. Other options are the cache directory, the downloads directory, or another custom
+  directory.
+
 # 23.2.0
 
 * You can now use the `UnlimitedRetryCheckInternet` to check if there is internet when you run some

lib/src/global_wrap_error.dart

@@ -9,7 +9,7 @@ import 'package:async_redux/async_redux.dart';
 /// `UserException`). Then:
 /// * If it returns the same [error] unaltered, this original error will be used.
 /// * If it returns something else, that it will be used instead of the original [error].
-/// * It it returns `null`, the original error will be disabled (swallowed).
+/// * If it returns `null`, the original error will be disabled (swallowed).
 ///
 /// IMPORTANT: If instead of RETURNING an error you THROW an error inside the `wrap` function,
 /// AsyncRedux will catch this error and use it instead the original error. In other

lib/src/local_json_persist.dart

@@ -52,12 +52,27 @@ class LocalJsonPersist {
   /// Make it an empty string to remove it.
   static String defaultDbSubDir = "db";
 
+  /// If running from Flutter, the default base directory is the application's documents dir.
+  /// If running from tests (detected by the `LocalFileSystem` not being present),
+  /// it will use the system's temp directory.
+  ///
+  /// You can change this variable to globally change the directory:
+  /// ```
+  /// // Will use the application's cache directory.
+  /// findDirectoryToUse = LocalPersist.findAppCacheDir;
+  ///
+  /// // Will use the application's downloads directory.
+  /// findDirectoryToUse = LocalPersist.findAppDownloadsDir;
+  /// ```
+  ///
+  static Future<void> Function() findBaseDirectory = findAppDocDir;
+
   /// The default is adding a ".json" termination to the file name.
   static const String jsonTermination = ".json";
 
-  static Directory? get appDocDir => _appDocDir;
+  static Directory? get appDocDir => _baseDirectory;
 
-  static Directory? get _appDocDir => LocalPersist.appDocDir;
+  static Directory? get _baseDirectory => LocalPersist.appDocDir;
 
   static f.FileSystem get _fileSystem => LocalPersist.getFileSystem();
 
@@ -106,6 +121,18 @@ class LocalJsonPersist {
         _file = file,
         _fileSystemRef = _fileSystem;
 
+  /// If running from Flutter, this will get the application's documents directory.
+  /// If running from tests, it will use the system's temp directory.
+  static Future<void> findAppDocDir() => LocalPersist.findAppDocDir();
+
+  /// If running from Flutter, this will get the application's cache directory.
+  /// If running from tests, it will use the system's temp directory.
+  static Future<void> findAppCacheDir() => LocalPersist.findAppCacheDir();
+
+  /// If running from Flutter, this will get the application's downloads directory.
+  /// If running from tests, it will use the system's temp directory.
+  static Future<void> findAppDownloadsDir() => LocalPersist.findAppDownloadsDir();
+
   /// Saves the given simple object as JSON.
   /// If the file exists, it will be overwritten.
   Future<File> save(Object? simpleObj) async {
@@ -312,7 +339,7 @@ class LocalJsonPersist {
     if (_file != null)
       return _file!;
     else {
-      if (_appDocDir == null) await _findAppDocDir();
+      if (_baseDirectory == null) await findBaseDirectory();
       String pathNameStr = pathName(
         dbName,
         dbSubDir: dbSubDir,
@@ -334,7 +361,7 @@ class LocalJsonPersist {
     List<String>? subDirs,
   }) {
     return p.joinAll([
-      LocalJsonPersist._appDocDir!.path,
+      LocalJsonPersist._baseDirectory!.path,
       dbSubDir ?? LocalJsonPersist.defaultDbSubDir,
       if (subDirs != null) ...subDirs,
       "$dbName${LocalJsonPersist.jsonTermination}"
@@ -344,10 +371,6 @@ class LocalJsonPersist {
   static String _getStringFromEnum(Object dbName) =>
       (dbName is String) ? dbName : dbName.toString().split(".").last;
 
-  /// If running from Flutter, this will get the application's documents directory.
-  /// If running from tests, it will use the system's temp directory.
-  static Future<void> _findAppDocDir() async => LocalPersist.findAppDocDir();
-
   /// Decodes a single JSON into a simple object, from the given [bytes].
   static Object? decodeJson(Uint8List bytes) {
     ByteBuffer buffer = bytes.buffer;

lib/src/local_persist.dart

@@ -86,12 +86,27 @@ class LocalPersist {
   /// Make it an empty string to remove it.
   static String defaultDbSubDir = "db";
 
+  /// If running from Flutter, the default base directory is the application's documents dir.
+  /// If running from tests (detected by the `LocalFileSystem` not being present),
+  /// it will use the system's temp directory.
+  ///
+  /// You can change this variable to globally change the directory:
+  /// ```
+  /// // Will use the application's cache directory.
+  /// findDirectoryToUse = LocalPersist.findAppCacheDir;
+  ///
+  /// // Will use the application's downloads directory.
+  /// findDirectoryToUse = LocalPersist.findAppDownloadsDir;
+  /// ```
+  ///
+  static Future<void> Function() findBaseDirectory = LocalPersist.findAppDocDir;
+
   /// The default is adding a ".db" termination to the file name.
   /// This is not final, so you can change it.
   static String defaultTermination = ".db";
 
-  static Directory? get appDocDir => _appDocDir;
-  static Directory? _appDocDir;
+  static Directory? get appDocDir => _baseDirectory;
+  static Directory? _baseDirectory;
 
   // In a json sequence, each object may have at most 65.536 bytes.
   // Note this refers to a single json object, not to the total json sequence file,
@@ -297,7 +312,7 @@ class LocalPersist {
     if (_file != null)
       return _file!;
     else {
-      if (_appDocDir == null) await findAppDocDir();
+      if (_baseDirectory == null) await findBaseDirectory();
       String pathNameStr = pathName(
         dbName,
         dbSubDir: dbSubDir,
@@ -319,7 +334,7 @@ class LocalPersist {
     List<String>? subDirs,
   }) {
     return p.joinAll([
-      LocalPersist._appDocDir!.path,
+      LocalPersist._baseDirectory!.path,
       dbSubDir ?? LocalPersist.defaultDbSubDir,
       if (subDirs != null) ...subDirs,
       "$dbName${LocalPersist.defaultTermination}"
@@ -332,16 +347,46 @@ class LocalPersist {
   /// If running from Flutter, this will get the application's documents directory.
   /// If running from tests, it will use the system's temp directory.
   static Future<void> findAppDocDir() async {
-    if (_appDocDir != null) return;
+    if (_baseDirectory != null) return;
+
+    if (_fileSystem == const LocalFileSystem()) {
+      try {
+        _baseDirectory = await getApplicationDocumentsDirectory();
+      } on MissingPluginException catch (_) {
+        _baseDirectory = const LocalFileSystem().systemTempDirectory;
+      }
+    } else
+      _baseDirectory = _fileSystem.systemTempDirectory;
+  }
+
+  /// If running from Flutter, this will get the application's cache directory.
+  /// If running from tests, it will use the system's temp directory.
+  static Future<void> findAppCacheDir() async {
+    if (_baseDirectory != null) return;
+
+    if (_fileSystem == const LocalFileSystem()) {
+      try {
+        _baseDirectory = await getApplicationCacheDirectory();
+      } on MissingPluginException catch (_) {
+        _baseDirectory = const LocalFileSystem().systemTempDirectory;
+      }
+    } else
+      _baseDirectory = _fileSystem.systemTempDirectory;
+  }
+
+  /// If running from Flutter, this will get the application's downloads directory.
+  /// If running from tests, it will use the system's temp directory.
+  static Future<void> findAppDownloadsDir() async {
+    if (_baseDirectory != null) return;
 
     if (_fileSystem == const LocalFileSystem()) {
       try {
-        _appDocDir = await getApplicationDocumentsDirectory();
+        _baseDirectory = await getDownloadsDirectory();
       } on MissingPluginException catch (_) {
-        _appDocDir = const LocalFileSystem().systemTempDirectory;
+        _baseDirectory = const LocalFileSystem().systemTempDirectory;
       }
     } else
-      _appDocDir = _fileSystem.systemTempDirectory;
+      _baseDirectory = _fileSystem.systemTempDirectory;
   }
 
   static Uint8List encode(List<Object> simpleObjs) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: async_redux
 description: The modern version of Redux. State management that's simple to learn and easy to use; Powerful enough to handle complex applications with millions of users; Testable.
-version: 23.2.0
+version: 23.3.0-dev.1
 # author: Marcelo Glasberg <marcglasberg@gmail.com>
 homepage: https://github.com/marcglasberg/async_redux
 topics: