refactor: rename JsonCachePrefs to JsonCacheSharedPreferences

Author: rafamizes

CHANGELOG.md

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - rename class JsonCacheSecStorage to JsonCacheFlutterSecureStorage — **BREAKING CHANGE** — [126](https://github.com/dartoos-dev/json_cache/issues/126).
 
+- rename class JsonCachePrefs to JsonCacheSharedPreferences — **BREAKING CHANGE** — [127](https://github.com/dartoos-dev/json_cache/issues/127).
+
 ### Removed
 
 - support for the 'EncryptedSharedPreferences' package — **BREAKING CHANGE** — [125](https://github.com/dartoos-dev/json_cache/issues/125).

README.md

@@ -28,7 +28,7 @@ Rultor.com](https://www.rultor.com/b/dartoos-dev/json_cache)](https://www.rultor
 - [Implementations](#implementations)
   - [JsonCacheMem — Thread-safe In-memory cache](#jsoncachemem)
   - [JsonCacheTry — Enhanced Diagnostic Messages](#jsoncachetry)
-  - [JsonCachePrefs — SharedPreferences](#jsoncacheprefs)
+  - [JsonCacheSharedPreferences — SharedPreferences](#jsoncachesharedpreferences)
   - [JsonCacheLocalStorage — LocalStorage](#jsoncachelocalstorage)
   - [JsonCacheFlutterSecureStorage — FlutterSecureStorage](#jsoncachefluttersecurestorage)
   - [JsonCacheCrossLocalStorage — CrossLocalStorage](#jsoncachecrosslocalstorage)
@@ -202,8 +202,8 @@ normally pass another `JsonCache` instance to it whenever you instantiate a
 ```dart
   …
   /// Cache initialization
-  final prefs = await SharedPreferences.getInstance();
-  final JsonCacheMem jsonCache = JsonCacheMem(JsonCachePrefs(prefs));
+  final sharedPrefs = await SharedPreferences.getInstance();
+  final JsonCacheMem jsonCache = JsonCacheMem(JsonCacheSharedPreferences(sharedPrefs));
   …
   /// Saving profile and preferences data.
   await jsonCache.refresh('profile', {'name': 'John Doe', 'email': 'johndoe@email.com', 'accountType': 'premium'});
@@ -254,22 +254,22 @@ object. For example:
 ```dart
   …
   // Local storage cache initialization
-  final prefs = await SharedPreferences.getInstance();
+  final sharedPrefs = await SharedPreferences.getInstance();
   // JsonCacheTry instance initialized with in-memory and local storage caches.
-  final jsonCacheTry = JsonCacheTry(JsonCacheMem(JsonCachePrefs(prefs)));
+  final jsonCacheTry = JsonCacheTry(JsonCacheMem(JsonCacheSharedPreferences(sharedPrefs)));
   …
 ```
 
-### JsonCachePrefs
+### JsonCacheSharedPreferences
 
-[JsonCachePrefs](https://pub.dev/documentation/json_cache/latest/json_cache/JsonCachePrefs-class.html)
+[JsonCacheSharedPreferences](https://pub.dev/documentation/json_cache/latest/json_cache/JsonCacheSharedPreferences-class.html)
 is an implementation on top of the
 [shared_preferences](https://pub.dev/packages/shared_preferences) package.
 
 ```dart
   …
-  final prefs = await SharedPreferences.getInstance();
-  final JsonCache jsonCache = JsonCacheMem(JsonCachePrefs(prefs));
+  final sharedPrefs = await SharedPreferences.getInstance();
+  final JsonCache jsonCache = JsonCacheMem(JsonCacheSharedPreferences(sharedPrefs));
   …
 ```
 ### JsonCacheLocalStorage
@@ -314,8 +314,8 @@ is an implementation on top of the
 
 ```dart
   …
-  final LocalStorageInterface prefs = await LocalStorage.getInstance();
-  final JsonCache jsonCache = JsonCacheMem(JsonCacheCrossLocalStorage(prefs));
+  final LocalStorageInterface localStorage = await LocalStorage.getInstance();
+  final JsonCache jsonCache = JsonCacheMem(JsonCacheCrossLocalStorage(localStorage));
 ```
 
 ### JsonCacheHive

lib/json_cache.dart

@@ -10,6 +10,6 @@ export 'src/json_cache_hive.dart';
 export 'src/json_cache_hollow.dart';
 export 'src/json_cache_local_storage.dart';
 export 'src/json_cache_mem.dart';
-export 'src/json_cache_prefs.dart';
+export 'src/json_cache_shared_preferences.dart';
 export 'src/json_cache_try.dart';
 export 'src/json_cache_wrap.dart';

lib/src/json_cache_prefs.dart renamed to lib/src/json_cache_shared_preferences.dart

@@ -4,23 +4,23 @@ import 'package:json_cache/json_cache.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
 /// Persistent preferences file cache.
-class JsonCachePrefs implements JsonCache {
-  /// [_prefs] a [SharedPreferences] instance.
-  const JsonCachePrefs(this._prefs);
+class JsonCacheSharedPreferences implements JsonCache {
+  /// Sets the [SharedPreferences] instance.
+  const JsonCacheSharedPreferences(this._sharedPreferences);
 
-  // The preferences file object.
-  final SharedPreferences _prefs;
+  // The shared preferences file object.
+  final SharedPreferences _sharedPreferences;
 
   /// Frees up the preferences file space.
   @override
   Future<void> clear() async {
-    await _prefs.clear();
+    await _sharedPreferences.clear();
   }
 
   /// Removes an entry from the preferences file storage at [key].
   @override
   Future<void> remove(String key) async {
-    await _prefs.remove(key);
+    await _sharedPreferences.remove(key);
   }
 
   /// Writes [value] to the preferences file.
@@ -29,14 +29,14 @@ class JsonCachePrefs implements JsonCache {
   /// under the hood.
   @override
   Future<void> refresh(String key, Map<String, dynamic> value) async {
-    await _prefs.setString(key, json.encode(value));
+    await _sharedPreferences.setString(key, json.encode(value));
   }
 
   /// The value at [key] from the preferences file; it returns null if a cache
   /// miss occurs.
   @override
   Future<Map<String, dynamic>?> value(String key) async {
-    final strJson = _prefs.getString(key);
+    final strJson = _sharedPreferences.getString(key);
     return strJson == null
         ? null
         : json.decode(strJson) as Map<String, dynamic>;
@@ -45,6 +45,6 @@ class JsonCachePrefs implements JsonCache {
   /// Checks whether there is data in the preferences at [key].
   @override
   Future<bool> contains(String key) async {
-    return _prefs.containsKey(key);
+    return _sharedPreferences.containsKey(key);
   }
 }

test/json_cache_mem_test.dart

@@ -195,7 +195,8 @@ void main() {
       test('value missing from L1 cache', () async {
         const key = 'aValue';
         const value = <String, dynamic>{'must be a json encodable value': true};
-        final prefs = JsonCachePrefs(await SharedPreferences.getInstance());
+        final prefs =
+            JsonCacheSharedPreferences(await SharedPreferences.getInstance());
         await prefs.refresh(key, value);
         final JsonCacheMem memCache = JsonCacheMem(prefs);
         final cacheL2Value = await memCache.value(key);

test/json_cache_prefs_test.dart renamed to test/json_cache_shared_preferences_test.dart

@@ -4,12 +4,12 @@ import 'package:shared_preferences/shared_preferences.dart';
 
 void main() {
   SharedPreferences.setMockInitialValues({});
-  group('JsonCachePrefs', () {
+  group('JsonCacheSharedPreferences', () {
     test('clear, value, refresh', () async {
       const profKey = 'profile';
       const profData = <String, Object>{'id': 1, 'name': 'John Due'};
-      final JsonCachePrefs prefsCache =
-          JsonCachePrefs(await SharedPreferences.getInstance());
+      final JsonCacheSharedPreferences prefsCache =
+          JsonCacheSharedPreferences(await SharedPreferences.getInstance());
       await prefsCache.refresh(profKey, profData);
       var prof = await prefsCache.value(profKey);
       expect(prof, profData);
@@ -26,8 +26,8 @@ void main() {
         'theme': 'dark',
         'notifications': {'enabled': true}
       };
-      final JsonCachePrefs prefs =
-          JsonCachePrefs(await SharedPreferences.getInstance());
+      final JsonCacheSharedPreferences prefs =
+          JsonCacheSharedPreferences(await SharedPreferences.getInstance());
       // update data
       await prefs.refresh(profKey, profData);
       await prefs.refresh(prefKey, prefData);
@@ -51,8 +51,8 @@ void main() {
         'theme': 'dark',
         'notifications': {'enabled': true}
       };
-      final JsonCachePrefs prefsCache =
-          JsonCachePrefs(await SharedPreferences.getInstance());
+      final JsonCacheSharedPreferences prefsCache =
+          JsonCacheSharedPreferences(await SharedPreferences.getInstance());
       await prefsCache.refresh(profKey, profData);
       await prefsCache.refresh(prefKey, prefData);