Documentation majorly

Author: YoungMayor

.gitignore

@@ -30,4 +30,4 @@ migrate_working_dir/
 .flutter-plugins-dependencies
 build/
 
-fake_storage/
+**/fake_storage/

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [0.1.1] - Documentation update
+
+### Added
+- Documented methods
+- `.pubignore` to certain parts
+
+---
+
 ## [0.1.0] - Initial Release
 
 ### Added

example/example.dart

@@ -0,0 +1,107 @@
+import 'package:flutter/material.dart';
+import 'package:mayr_storage/mayr_storage.dart';
+
+/// [main.dart]
+void main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+
+  // Initialise MayrStorage
+  await MayrStorage.init();
+
+  runApp(const MyApp());
+}
+
+/// [storage.dart]
+class Storage {
+  // Normal SharedPreferences storage
+  static final normalToken = 'NORMAL_TOKEN'.storage<String>();
+
+  // Secure storage using encrypted shared preferences
+  static final secureToken = 'SECURE_TOKEN'.secureStorage<String>();
+
+  // GetBox Storage
+  static final boxToken = 'BOX_TOKEN'.boxStorage<String>();
+}
+
+/// [my_app.dart]
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: Scaffold(
+        appBar: AppBar(title: const Text('Mayr Storage Example')),
+        body: const StorageDemo(),
+      ),
+    );
+  }
+}
+
+/// [storage_demo.dart]
+class StorageDemo extends StatefulWidget {
+  const StorageDemo({super.key});
+
+  @override
+  State<StorageDemo> createState() => _StorageDemoState();
+}
+
+class _StorageDemoState extends State<StorageDemo> {
+  String? normalValue;
+  String? secureValue;
+  String? boxValue;
+
+  @override
+  void initState() {
+    super.initState();
+    loadValues();
+  }
+
+  Future<void> loadValues() async {
+    normalValue = await Storage.normalToken.read();
+    secureValue = await Storage.secureToken.read();
+    boxValue = Storage.boxToken.read();
+
+    setState(() {});
+  }
+
+  Future<void> writeValues() async {
+    await Storage.normalToken.write('NormalTokenValue');
+    await Storage.secureToken.write('SecureTokenValue');
+    Storage.boxToken.write('BoxTokenValue');
+
+    await loadValues();
+  }
+
+  Future<void> clearValues() async {
+    await Storage.normalToken.delete();
+    await Storage.secureToken.delete();
+    Storage.boxToken.delete();
+
+    await loadValues();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Padding(
+      padding: const EdgeInsets.all(16.0),
+      child: Column(
+        mainAxisAlignment: MainAxisAlignment.center,
+        children: [
+          Text('Normal Token: $normalValue'),
+          Text('Secure Token: $secureValue'),
+          Text('Box Token: $boxValue'),
+          const SizedBox(height: 20),
+          ElevatedButton(
+            onPressed: writeValues,
+            child: const Text('Write Values'),
+          ),
+          ElevatedButton(
+            onPressed: clearValues,
+            child: const Text('Clear Values'),
+          ),
+        ],
+      ),
+    );
+  }
+}

lib/src/drivers/abstract/preferences_storage.dart

@@ -1,9 +1,12 @@
 part of '../../mayr_storage.dart';
 
 abstract interface class PreferencesStorage<ValueT> {
+  /// Delete stored record
   Future<void> delete() async => write(null);
 
+  /// Read stored record
   Future<ValueT?> read();
 
+  /// Write record to storage
   Future<void> write(ValueT? value);
 }

lib/src/drivers/encrypt_shared_preferences_storage.dart

@@ -2,23 +2,23 @@ part of './../mayr_storage.dart';
 
 class EncryptSharedPreferencesStorage<ValueT>
     extends PreferencesStorage<ValueT> {
-  final String preferenceKey;
+  final String _preferenceKey;
 
-  EncryptSharedPreferencesStorage(this.preferenceKey);
+  EncryptSharedPreferencesStorage(this._preferenceKey);
 
   @override
   Future<ValueT?> read() async {
     EncryptedSharedPreferences securePref =
         EncryptedSharedPreferences.getInstance();
 
     if (ValueT == bool) {
-      return securePref.getBool(preferenceKey) as ValueT?;
+      return securePref.getBool(_preferenceKey) as ValueT?;
     } else if (ValueT == String) {
-      return securePref.getString(preferenceKey) as ValueT?;
+      return securePref.getString(_preferenceKey) as ValueT?;
     } else if (ValueT == int) {
-      return securePref.getInt(preferenceKey) as ValueT?;
+      return securePref.getInt(_preferenceKey) as ValueT?;
     } else if (ValueT == double) {
-      return securePref.getDouble(preferenceKey) as ValueT?;
+      return securePref.getDouble(_preferenceKey) as ValueT?;
     } else {
       throw Exception("Unsupported type");
     }
@@ -32,13 +32,13 @@ class EncryptSharedPreferencesStorage<ValueT>
     if (value == null) {
       securePref.clear();
     } else if (ValueT == bool) {
-      securePref.setBool(preferenceKey, value as bool);
+      securePref.setBool(_preferenceKey, value as bool);
     } else if (ValueT == String) {
-      securePref.setString(preferenceKey, value as String);
+      securePref.setString(_preferenceKey, value as String);
     } else if (ValueT == int) {
-      securePref.setInt(preferenceKey, value as int);
+      securePref.setInt(_preferenceKey, value as int);
     } else if (ValueT == double) {
-      securePref.setDouble(preferenceKey, value as double);
+      securePref.setDouble(_preferenceKey, value as double);
     } else {
       throw Exception("Unsupported type");
     }

lib/src/drivers/get_box_storage.dart

@@ -1,18 +1,22 @@
 part of '../mayr_storage.dart';
 
 class GetBoxStorage<ValueT> {
-  final String boxName;
-
-  GetBoxStorage(this.boxName);
+  final String _boxName;
 
   late final GetStorage _box = GetStorage();
 
-  void write(ValueT? value) => _box.write(boxName, value);
-
-  ValueT? read() => _box.read(boxName);
+  GetBoxStorage(this._boxName);
 
-  void delete() => _box.remove(boxName);
+  /// Delete stored record
+  void delete() => _box.remove(_boxName);
 
+  /// Listen for updates
   void listen(void Function(ValueT newValue) handler) =>
-      _box.listenKey(boxName, (newValue) => handler(newValue));
+      _box.listenKey(_boxName, (newValue) => handler(newValue));
+
+  /// Read value from storage
+  ValueT? read() => _box.read(_boxName);
+
+  /// Write value to storage
+  void write(ValueT? value) => _box.write(_boxName, value);
 }

lib/src/drivers/shared_preferences_storage.dart

@@ -1,22 +1,22 @@
 part of '../mayr_storage.dart';
 
 class SharedPreferencesStorage<ValueT> extends PreferencesStorage<ValueT> {
-  SharedPreferencesStorage(this.preferenceKey);
+  final String _preferenceKey;
 
-  final String preferenceKey;
+  SharedPreferencesStorage(this._preferenceKey);
 
   @override
   Future<ValueT?> read() async {
     SharedPreferences sharedPref = await SharedPreferences.getInstance();
 
     if (ValueT == bool) {
-      return sharedPref.getBool(preferenceKey) as ValueT?;
+      return sharedPref.getBool(_preferenceKey) as ValueT?;
     } else if (ValueT == String) {
-      return sharedPref.getString(preferenceKey) as ValueT?;
+      return sharedPref.getString(_preferenceKey) as ValueT?;
     } else if (ValueT == int) {
-      return sharedPref.getInt(preferenceKey) as ValueT?;
+      return sharedPref.getInt(_preferenceKey) as ValueT?;
     } else if (ValueT == double) {
-      return sharedPref.getDouble(preferenceKey) as ValueT?;
+      return sharedPref.getDouble(_preferenceKey) as ValueT?;
     } else {
       throw Exception("Unsupported type");
     }
@@ -29,13 +29,13 @@ class SharedPreferencesStorage<ValueT> extends PreferencesStorage<ValueT> {
     if (value == null) {
       sharedPref.clear();
     } else if (ValueT == bool) {
-      sharedPref.setBool(preferenceKey, value as bool);
+      sharedPref.setBool(_preferenceKey, value as bool);
     } else if (ValueT == String) {
-      sharedPref.setString(preferenceKey, value as String);
+      sharedPref.setString(_preferenceKey, value as String);
     } else if (ValueT == int) {
-      sharedPref.setInt(preferenceKey, value as int);
+      sharedPref.setInt(_preferenceKey, value as int);
     } else if (ValueT == double) {
-      sharedPref.setDouble(preferenceKey, value as double);
+      sharedPref.setDouble(_preferenceKey, value as double);
     } else {
       throw Exception("Unsupported type");
     }

lib/src/extension.dart

@@ -1,11 +1,14 @@
 part of './mayr_storage.dart';
 
 extension KeyStorageExtensions on String {
+  /// Get Box Storage using GetStorage internally
   GetBoxStorage<ValueT> boxStorage<ValueT>() => GetBoxStorage<ValueT>(this);
 
+  /// Get Secure Storage using Encrypted Shared Preferences internally
   EncryptSharedPreferencesStorage<ValueT> secureStorage<ValueT>() =>
       EncryptSharedPreferencesStorage<ValueT>(this);
 
+  /// Get Shared Preferences Storage
   SharedPreferencesStorage<ValueT> storage<ValueT>() =>
       SharedPreferencesStorage<ValueT>(this);
 }

lib/src/mayr_storage.dart

@@ -9,6 +9,7 @@ part './drivers/shared_preferences_storage.dart';
 part './extension.dart';
 
 class MayrStorage {
+  /// Init MayrStorage
   static Future init() async {
     await GetStorage.init();
 

pubspec.yaml

@@ -2,7 +2,7 @@ name: mayr_storage
 description: >-
   Simple and unified storage solution for Flutter apps.
   Easily manage SharedPreferences, EncryptedSharedPreferences, and GetStorage with a clean, consistent API.
-version: 0.1.0
+version: 0.1.1
 homepage: https://github.com/YoungMayor/mayr_flutter_storage
 repository: https://github.com/YoungMayor/mayr_flutter_storage
 issue_tracker: https://github.com/YoungMayor/mayr_flutter_storage/issues