rename Logger to RxStorageLogger and others... (#17)

Author: hoc081098

.github/workflows/dart.yml

@@ -8,7 +8,7 @@ on:
  branches: [ master ]
  paths-ignore: [ '**.md' ]
  schedule:
-  # Runs at 02:00 UTC on the 1, 4, 7, 10, 13, 16, 19, 22, 25, 28 and 31st of every month.
+ # Runs at 02:00 UTC on the 1, 4, 7, 10, 13, 16, 19, 22, 25, 28 and 31st of every month.
  - cron: "0 2 */3 * *"
 
 jobs:
@@ -18,7 +18,7 @@ jobs:
 
  strategy:
  matrix:
- sdk: [ stable, beta, dev, 2.12.0 ]
+ sdk: [ 2.12.0, 2.15.0, stable, beta, dev ]
 
  steps:
  - uses: actions/checkout@v2

lib/src/impl/real_storage.dart

@@ -33,7 +33,7 @@ class RealRxStorage<Key extends Object, Options,
  DisposeBag(const <Object>[], '( RealRxStorage ~ ${shortHash(this)} )');
 
  /// Logger controller. Nullable
- StreamController<LoggerEvent<Key, Options>>? _loggerEventController;
+ StreamController<RxStorageLoggerEvent<Key, Options>>? _loggerEventController;
 
  /// Nullable.
  S? _storage;
@@ -46,7 +46,7 @@ class RealRxStorage<Key extends Object, Options,
  /// Construct a [RealRxStorage].
  RealRxStorage(
  FutureOr<S> storageOrFuture, [
- final Logger<Key, Options>? logger,
+ final RxStorageLogger<Key, Options>? logger,
  this._onDispose,
  ]) {
  if (storageOrFuture is Future<S>) {
@@ -67,13 +67,13 @@ class RealRxStorage<Key extends Object, Options,
  // Internal
  //
 
- void _setupLogger(Logger logger) {
+ void _setupLogger(RxStorageLogger logger) {
  _loggerEventController = StreamController(sync: true)
  ..disposedBy(_bag)
  ..stream.listen(logger.log).disposedBy(_bag);
 
  _keyValuesSubject
- .map<LoggerEvent<Key, Options>>(
+ .map<RxStorageLoggerEvent<Key, Options>>(
  (map) => KeysChangedEvent(map.toListOfKeyAndValues()))
  .listen(_loggerEventController!.add)
  .disposedBy(_bag);
@@ -84,7 +84,7 @@ class RealRxStorage<Key extends Object, Options,
  bool get _isLogEnabled => _loggerEventController != null;
 
  /// Crash if [_loggerEventController] is null.
- void _publishLog(LoggerEvent<Key, Options> event) {
+ void _publishLog(RxStorageLoggerEvent<Key, Options> event) {
  assert(_debugAssertNotDisposed());
 
  _loggerEventController!.add(event);
@@ -195,7 +195,8 @@ class RealRxStorage<Key extends Object, Options,
  /// Log event if logging is enabled.
  @protected
  @nonVirtual
- void logIfEnabled(LoggerEvent<Key, Options> Function() eventProducer) {
+ void logIfEnabled(
+ RxStorageLoggerEvent<Key, Options> Function() eventProducer) {
  assert(_debugAssertNotDisposed());
 
  if (_isLogEnabled) {

lib/src/interface/rx_storage.dart

@@ -15,7 +15,7 @@ abstract class RxStorage<Key extends Object, Options>
  /// Constructs a [RxStorage] by wrapping a [Storage].
  factory RxStorage(
  FutureOr<Storage<Key, Options>> storageOrFuture, [
- Logger<Key, Options>? logger,
+ RxStorageLogger<Key, Options>? logger,
  void Function()? onDispose,
  ]) =>
  RealRxStorage<Key, Options, Storage<Key, Options>>(

lib/src/logger/default_logger.dart

@@ -9,8 +9,8 @@ import 'logger.dart';
 // ignore_for_file: public_member_api_docs
 
 /// Default Logger's implementation, simply print to the console.
-class DefaultLogger<Key extends Object, Options>
- implements Logger<Key, Options> {
+class RxStorageDefaultLogger<Key extends Object, Options>
+ implements RxStorageLogger<Key, Options> {
  //
  // some unicode characters
  // and constants.
@@ -31,8 +31,9 @@ class DefaultLogger<Key extends Object, Options>
  /// If [trimValueOutput] is true, value text will be trimmed to max [maxValueTextLength] characters.
  final bool trimValueOutput;
 
- /// Construct a [DefaultLogger].
- const DefaultLogger({this.tag = defaultTag, this.trimValueOutput = false});
+ /// Construct a [RxStorageDefaultLogger].
+ const RxStorageDefaultLogger(
+ {this.tag = defaultTag, this.trimValueOutput = false});
 
  @pragma('vm:prefer-inline')
  @pragma('dart2js:tryInline')
@@ -62,7 +63,11 @@ class DefaultLogger<Key extends Object, Options>
 
  @nonVirtual
  @override
- void log(LoggerEvent<Key, Options> event) {
+ void log(RxStorageLoggerEvent<Key, Options> event) {
+ if (handleLogEvent(event)) {
+ return;
+ }
+
  //
  // BEGIN: STREAM
  //
@@ -196,13 +201,13 @@ class DefaultLogger<Key extends Object, Options>
  //
  // END: WRITE
  //
-
- logOther(event);
  }
 
- /// Logs other events.
- void logOther(LoggerEvent<Key, Options> event) =>
- throw Exception('Unhandled event: $event');
+ /// This method can be overridden to handle custom [RxStorageLoggerEvent] implementations or handle
+ /// the standard events in a different way.
+ ///
+ /// Returns `true` if event was handled, `false` otherwise.
+ bool handleLogEvent(RxStorageLoggerEvent<Key, Options> event) => false;
 }
 
 extension on String {

lib/src/logger/empty_logger.dart

@@ -2,10 +2,11 @@ import 'event.dart';
 import 'logger.dart';
 
 /// Log nothing :)
-class EmptyLogger<Key extends Object, Options> implements Logger<Key, Options> {
- /// Constructs a [EmptyLogger].
- const EmptyLogger();
+class RxStorageEmptyLogger<Key extends Object, Options>
+ implements RxStorageLogger<Key, Options> {
+ /// Constructs a [RxStorageEmptyLogger].
+ const RxStorageEmptyLogger();
 
  @override
- void log(LoggerEvent<Key, Options> event) {}
+ void log(RxStorageLoggerEvent<Key, Options> event) {}
 }

lib/src/logger/event.dart

@@ -5,15 +5,15 @@ import '../model/key_and_value.dart';
 
 /// Event when reading, writing storage.
 @immutable
-abstract class LoggerEvent<Key extends Object, Options> {}
+abstract class RxStorageLoggerEvent<Key extends Object, Options> {}
 
 //
 // BEGIN: STREAM
 //
 
 /// Key changed when mutating storage.
 class KeysChangedEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// A list containing all changed values associated with keys.
  final List<KeyAndValue<Key, Object?>> keyAndValues;
 
@@ -23,7 +23,7 @@ class KeysChangedEvent<Key extends Object, Options>
 
 /// Stream emits new data event.
 class OnDataStreamEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// Changed value with key.
  final KeyAndValue<Key, Object?> keyAndValue;
 
@@ -33,7 +33,7 @@ class OnDataStreamEvent<Key extends Object, Options>
 
 /// Stream emits error event.
 class OnErrorStreamEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// Error from upstream (eg. cast error, ...)
  final RxStorageError error;
 
@@ -51,7 +51,7 @@ class OnErrorStreamEvent<Key extends Object, Options>
 
 /// Read value successfully.
 class ReadValueSuccessEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// Read value with key.
  final KeyAndValue<Key, Object?> keyAndValue;
 
@@ -64,7 +64,7 @@ class ReadValueSuccessEvent<Key extends Object, Options>
 
 /// Read value failed.
 class ReadValueFailureEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The key.
  final Key key;
 
@@ -83,7 +83,7 @@ class ReadValueFailureEvent<Key extends Object, Options>
 
 /// Read all values successfully.
 class ReadAllSuccessEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// All values read from storage.
  final List<KeyAndValue<Key, Object?>> all;
 
@@ -96,7 +96,7 @@ class ReadAllSuccessEvent<Key extends Object, Options>
 
 /// Read all values failed.
 class ReadAllFailureEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The error occurred when reading.
  final RxStorageError error;
 
@@ -117,7 +117,7 @@ class ReadAllFailureEvent<Key extends Object, Options>
 
 /// Clear storage successfully.
 class ClearSuccessEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The options.
  final Options? options;
 
@@ -127,7 +127,7 @@ class ClearSuccessEvent<Key extends Object, Options>
 
 /// Clear storage failed.
 class ClearFailureEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The error occurred while clearing.
  final RxStorageError error;
 
@@ -140,7 +140,7 @@ class ClearFailureEvent<Key extends Object, Options>
 
 /// Remove successfully.
 class RemoveSuccessEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The key.
  final Key key;
 
@@ -153,7 +153,7 @@ class RemoveSuccessEvent<Key extends Object, Options>
 
 /// Remove failed.
 class RemoveFailureEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The key.
  final Key key;
 
@@ -169,7 +169,7 @@ class RemoveFailureEvent<Key extends Object, Options>
 
 /// Write successfully.
 class WriteSuccessEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The key and value.
  final KeyAndValue<Key, Object?> keyAndValue;
 
@@ -182,7 +182,7 @@ class WriteSuccessEvent<Key extends Object, Options>
 
 /// Write failed.
 class WriteFailureEvent<Key extends Object, Options>
- implements LoggerEvent<Key, Options> {
+ implements RxStorageLoggerEvent<Key, Options> {
  /// The key and value.
  final KeyAndValue<Key, Object?> keyAndValue;
 

lib/src/logger/logger.dart

@@ -1,7 +1,7 @@
 import 'event.dart';
 
 /// Log messages about operations (such as read, write, value change) and stream events.
-abstract class Logger<Key extends Object, Options> {
+abstract class RxStorageLogger<Key extends Object, Options> {
  /// Logs event.
- void log(LoggerEvent<Key, Options> event);
+ void log(RxStorageLoggerEvent<Key, Options> event);
 }

test/fake_storage.dart

@@ -11,35 +11,35 @@ abstract class StringKeyStorage extends Storage<String, void> {
 abstract class StringKeyRxStorage extends StringKeyStorage
  implements RxStorage<String, void> {}
 
-abstract class FakeLogger extends Logger<String, void> {}
+abstract class FakeLogger extends RxStorageLogger<String, void> {}
 
-class FakeDefaultLogger extends DefaultLogger<String, void>
+class FakeDefaultLogger extends RxStorageDefaultLogger<String, void>
  implements FakeLogger {
  const FakeDefaultLogger();
 
  @override
- void logOther(LoggerEvent<String, void> event) {
+ bool handleLogEvent(RxStorageLoggerEvent<String, void> event) {
  if (event is ReloadSuccessEvent) {
  print(
- '$tag ${DefaultLogger.rightArrow} ReloadSuccessEvent ${DefaultLogger.rightArrow} ${event.map}');
- return;
+ '$tag ${RxStorageDefaultLogger.rightArrow} ReloadSuccessEvent ${RxStorageDefaultLogger.rightArrow} ${event.map}');
+ return true;
  }
  if (event is ReloadFailureEvent) {
  print(
- '$tag ${DefaultLogger.rightArrow} ReloadFailureEvent ${DefaultLogger.rightArrow} ${event.error}');
- return;
+ '$tag ${RxStorageDefaultLogger.rightArrow} ReloadFailureEvent ${RxStorageDefaultLogger.rightArrow} ${event.error}');
+ return true;
  }
- super.logOther(event);
+ return false;
  }
 }
 
-class ReloadSuccessEvent implements LoggerEvent<String, void> {
+class ReloadSuccessEvent implements RxStorageLoggerEvent<String, void> {
  final Map<String, Object?> map;
 
  ReloadSuccessEvent(this.map);
 }
 
-class ReloadFailureEvent implements LoggerEvent<String, void> {
+class ReloadFailureEvent implements RxStorageLoggerEvent<String, void> {
  final RxStorageError error;
 
  ReloadFailureEvent(this.error);

test/logger/default_logger_test.dart

@@ -4,7 +4,7 @@ import 'package:test/test.dart';
 
 void main() {
  group('DefaultLogger<String, void>', () {
- final logger = DefaultLogger<String, void>(tag: 'TAG');
+ final logger = RxStorageDefaultLogger<String, void>(tag: 'TAG');
 
  test('KeysChangedEvent', () {
  const keyAndValues = [
@@ -163,7 +163,7 @@ void main() {
  });
 
  group('DefaultLogger<String, int>', () {
- final logger = DefaultLogger<String, int>(tag: 'TAG');
+ final logger = RxStorageDefaultLogger<String, int>(tag: 'TAG');
 
  test('KeysChangedEvent', () {
  const keyAndValues = [

test/logger/logger_adapter_test.dart

@@ -4,7 +4,7 @@ import 'package:test/test.dart';
 void main() {
  group('EmptyLogger', () {
  test('Works', () {
- final logger = EmptyLogger<String, void>();
+ final logger = RxStorageEmptyLogger<String, void>();
  const keyAndValue = KeyAndValue('key', 'value', String);
 
  logger.log(OnDataStreamEvent(keyAndValue));