refactor(bloc): improve onTransition and onEvent signature (felangel#2241)

felangel · web-flow · commit 08200a6a03e3 · 2021-03-17T15:20:16.000-05:00
diff --git a/examples/flutter_complex_list/lib/simple_bloc_observer.dart b/examples/flutter_complex_list/lib/simple_bloc_observer.dart
@@ -8,7 +8,7 @@ class SimpleBlocObserver extends BlocObserver {
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/examples/flutter_counter/lib/counter_observer.dart b/examples/flutter_counter/lib/counter_observer.dart
@@ -6,7 +6,7 @@ import 'package:bloc/bloc.dart';
 /// {@endtemplate}
 class CounterObserver extends BlocObserver {
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print('${bloc.runtimeType} $transition');
   }
diff --git a/examples/flutter_firestore_todos/lib/blocs/simple_bloc_observer.dart b/examples/flutter_firestore_todos/lib/blocs/simple_bloc_observer.dart
@@ -4,13 +4,13 @@ import 'package:bloc/bloc.dart';
 // in order to handle transitions and errors from all Blocs.
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onEvent(BlocBase bloc, Object event) {
+  void onEvent(Bloc bloc, Object event) {
     super.onEvent(bloc, event);
     print(event);
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/examples/flutter_infinite_list/lib/simple_bloc_observer.dart b/examples/flutter_infinite_list/lib/simple_bloc_observer.dart
@@ -2,7 +2,7 @@ import 'package:bloc/bloc.dart';
 
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/examples/flutter_shopping_cart/lib/simple_bloc_observer.dart b/examples/flutter_shopping_cart/lib/simple_bloc_observer.dart
@@ -2,7 +2,7 @@ import 'package:bloc/bloc.dart';
 
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onEvent(BlocBase bloc, Object? event) {
+  void onEvent(Bloc bloc, Object? event) {
     super.onEvent(bloc, event);
     print('${bloc.runtimeType} $event');
   }
@@ -14,7 +14,7 @@ class SimpleBlocObserver extends BlocObserver {
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/examples/flutter_todos/lib/blocs/simple_bloc_observer.dart b/examples/flutter_todos/lib/blocs/simple_bloc_observer.dart
@@ -4,13 +4,13 @@ import 'package:bloc/bloc.dart';
 // in order to handle transitions and errors from all Blocs.
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onEvent(BlocBase bloc, Object event) {
+  void onEvent(Bloc bloc, Object event) {
     super.onEvent(bloc, event);
     print(event);
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/packages/bloc/CHANGELOG.md b/packages/bloc/CHANGELOG.md
@@ -2,7 +2,6 @@
 
 - **BREAKING**: refactor: `Bloc` and `Cubit` extend `BlocBase`
   - refactor: `void onError(Bloc bloc, Object error, StackTrace stackTrace)` -> `void onError(BlocBase bloc, Object error, StackTrace stackTrace)`
-  - refactor: `void onEvent(Bloc bloc, Object? event)` -> `void onEvent(BlocBase bloc, Object? event)`
   - refactor: `void onCreate(Bloc bloc)` -> `void onCreate(BlocBase bloc)`
   - refactor: `void onClose(Bloc bloc)` -> `void onClose(BlocBase bloc)`
 - **BREAKING**: refactor: `Transition` event is required
@@ -11,7 +10,6 @@
     - `myBloc.map(...)` -> `myBloc.stream.map(...)`
   - refactor: deprecate `bloc.listen` in favor of `bloc.stream.listen`
 - **BREAKING**: revert: refactor: `Change` and `onChange` removed in favor of `Transition` and `onTransition`
-- fix: `toString` on `Transition` excludes null `event`
 
 # 7.0.0-nullsafety.3
 
diff --git a/packages/bloc/README.md b/packages/bloc/README.md
@@ -292,7 +292,7 @@ class MyBlocObserver extends BlocObserver {
   }
 
   @override
-  void onEvent(BlocBase bloc, Object event) {
+  void onEvent(Bloc bloc, Object event) {
     super.onEvent(bloc, event);
     print('onEvent -- bloc: ${bloc.runtimeType}, event: $event');
   }
@@ -304,7 +304,7 @@ class MyBlocObserver extends BlocObserver {
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print('onTransition -- bloc: ${bloc.runtimeType}, transition: $transition');
   }
diff --git a/packages/bloc/example/main.dart b/packages/bloc/example/main.dart
@@ -10,7 +10,7 @@ class SimpleBlocObserver extends BlocObserver {
   }
 
   @override
-  void onEvent(BlocBase bloc, Object? event) {
+  void onEvent(Bloc bloc, Object? event) {
     super.onEvent(bloc, event);
     print('onEvent -- bloc: ${bloc.runtimeType}, event: $event');
   }
@@ -22,7 +22,7 @@ class SimpleBlocObserver extends BlocObserver {
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print('onTransition -- bloc: ${bloc.runtimeType}, transition: $transition');
   }
diff --git a/packages/bloc/lib/src/bloc_observer.dart b/packages/bloc/lib/src/bloc_observer.dart
@@ -15,7 +15,7 @@ class BlocObserver {
   /// and [event].
   @protected
   @mustCallSuper
-  void onEvent(BlocBase bloc, Object? event) {}
+  void onEvent(Bloc bloc, Object? event) {}
 
   /// Called whenever a [Change] occurs in any [bloc]
   /// A [change] occurs when a new state is emitted.
@@ -31,7 +31,7 @@ class BlocObserver {
   /// [onTransition] is called before a [bloc]'s state has been updated.
   @protected
   @mustCallSuper
-  void onTransition(BlocBase bloc, Transition transition) {}
+  void onTransition(Bloc bloc, Transition transition) {}
 
   /// Called whenever an [error] is thrown in any [Bloc] or [Cubit].
   /// The [stackTrace] argument may be [StackTrace.empty] if an error
diff --git a/packages/flutter_bloc/example/lib/main.dart b/packages/flutter_bloc/example/lib/main.dart
@@ -6,13 +6,13 @@ import 'package:flutter_bloc/flutter_bloc.dart';
 /// Custom [BlocObserver] which observes all bloc and cubit instances.
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onEvent(BlocBase bloc, Object? event) {
+  void onEvent(Bloc bloc, Object? event) {
     super.onEvent(bloc, event);
     print(event);
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print(transition);
   }
diff --git a/packages/replay_bloc/example/lib/simple_bloc_observer.dart b/packages/replay_bloc/example/lib/simple_bloc_observer.dart
@@ -3,7 +3,7 @@ import 'package:bloc/bloc.dart';
 /// Simple [BlocObserver] which just prints to the debug console.
 class SimpleBlocObserver extends BlocObserver {
   @override
-  void onEvent(BlocBase bloc, Object? event) {
+  void onEvent(Bloc bloc, Object? event) {
     super.onEvent(bloc, event);
     print('${bloc.runtimeType} $event');
   }
@@ -21,7 +21,7 @@ class SimpleBlocObserver extends BlocObserver {
   }
 
   @override
-  void onTransition(BlocBase bloc, Transition transition) {
+  void onTransition(Bloc bloc, Transition transition) {
     super.onTransition(bloc, transition);
     print('${bloc.runtimeType} $transition');
   }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class SimpleBlocObserver extends BlocObserver {`
`8`	`8`	`}`
`9`	`9`
`10`	`10`	`@override`
`11`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`11`	`+ void onTransition(Bloc bloc, Transition transition) {`
`12`	`12`	`super.onTransition(bloc, transition);`
`13`	`13`	`print(transition);`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import 'package:bloc/bloc.dart';`
`6`	`6`	`/// {@endtemplate}`
`7`	`7`	`class CounterObserver extends BlocObserver {`
`8`	`8`	`@override`
`9`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`9`	`+ void onTransition(Bloc bloc, Transition transition) {`
`10`	`10`	`super.onTransition(bloc, transition);`
`11`	`11`	`print('${bloc.runtimeType} $transition');`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import 'package:bloc/bloc.dart';`
`2`	`2`
`3`	`3`	`class SimpleBlocObserver extends BlocObserver {`
`4`	`4`	`@override`
`5`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`5`	`+ void onTransition(Bloc bloc, Transition transition) {`
`6`	`6`	`super.onTransition(bloc, transition);`
`7`	`7`	`print(transition);`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -292,7 +292,7 @@ class MyBlocObserver extends BlocObserver {`
`292`	`292`	`}`
`293`	`293`
`294`	`294`	`@override`
`295`		`- void onEvent(BlocBase bloc, Object event) {`
	`295`	`+ void onEvent(Bloc bloc, Object event) {`
`296`	`296`	`super.onEvent(bloc, event);`
`297`	`297`	`print('onEvent -- bloc: ${bloc.runtimeType}, event: $event');`
`298`	`298`	`}`
`@@ -304,7 +304,7 @@ class MyBlocObserver extends BlocObserver {`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`@override`
`307`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`307`	`+ void onTransition(Bloc bloc, Transition transition) {`
`308`	`308`	`super.onTransition(bloc, transition);`
`309`	`309`	`print('onTransition -- bloc: ${bloc.runtimeType}, transition: $transition');`
`310`	`310`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class SimpleBlocObserver extends BlocObserver {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`@override`
`13`		`- void onEvent(BlocBase bloc, Object? event) {`
	`13`	`+ void onEvent(Bloc bloc, Object? event) {`
`14`	`14`	`super.onEvent(bloc, event);`
`15`	`15`	`print('onEvent -- bloc: ${bloc.runtimeType}, event: $event');`
`16`	`16`	`}`
`@@ -22,7 +22,7 @@ class SimpleBlocObserver extends BlocObserver {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`@override`
`25`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`25`	`+ void onTransition(Bloc bloc, Transition transition) {`
`26`	`26`	`super.onTransition(bloc, transition);`
`27`	`27`	`print('onTransition -- bloc: ${bloc.runtimeType}, transition: $transition');`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import 'package:bloc/bloc.dart';`
`3`	`3`	`/// Simple [BlocObserver] which just prints to the debug console.`
`4`	`4`	`class SimpleBlocObserver extends BlocObserver {`
`5`	`5`	`@override`
`6`		`- void onEvent(BlocBase bloc, Object? event) {`
	`6`	`+ void onEvent(Bloc bloc, Object? event) {`
`7`	`7`	`super.onEvent(bloc, event);`
`8`	`8`	`print('${bloc.runtimeType} $event');`
`9`	`9`	`}`
`@@ -21,7 +21,7 @@ class SimpleBlocObserver extends BlocObserver {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`@override`
`24`		`- void onTransition(BlocBase bloc, Transition transition) {`
	`24`	`+ void onTransition(Bloc bloc, Transition transition) {`
`25`	`25`	`super.onTransition(bloc, transition);`
`26`	`26`	`print('${bloc.runtimeType} $transition');`
`27`	`27`	`}`