Update mapEventToState parameter name (#31)

felangel · Dec 12, 2018 · 41a5c3c · 41a5c3c
1 parent d47f501
commit 41a5c3c
Show file tree

Hide file tree

Showing 19 changed files with 59 additions and 50 deletions.
diff --git a/examples/angular_counter/lib/src/counter_page/counter_bloc.dart b/examples/angular_counter/lib/src/counter_page/counter_bloc.dart
@@ -19,12 +19,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }
diff --git a/examples/angular_github_search/lib/src/github_search/bloc/github_search_bloc.dart b/examples/angular_github_search/lib/src/github_search/bloc/github_search_bloc.dart
@@ -32,7 +32,7 @@ class GithubSearchBloc extends Bloc<GithubSearchEvent, GithubSearchState> {
 
   @override
   Stream<GithubSearchState> mapEventToState(
-      GithubSearchState state, GithubSearchEvent event) async* {
+      GithubSearchState currentState, GithubSearchEvent event) async* {
     if (event is TextChanged) {
       final String term = event.text;
       if (term.isEmpty) {

diff --git a/examples/flutter_infinite_list/lib/bloc/post_bloc.dart b/examples/flutter_infinite_list/lib/bloc/post_bloc.dart
@@ -19,14 +19,14 @@ class PostBloc extends Bloc<PostEvent, PostState> {
   get initialState => PostState.initial();
 
   @override
-  Stream<PostState> mapEventToState(state, event) async* {
-    if (event is Fetch && !state.hasReachedMax) {
+  Stream<PostState> mapEventToState(currentState, event) async* {
+    if (event is Fetch && !currentState.hasReachedMax) {
       try {
-        final posts = await _fetchPosts(state.posts.length, 20);
+        final posts = await _fetchPosts(currentState.posts.length, 20);
         if (posts.isEmpty) {
-          yield state.copyWith(hasReachedMax: true);
+          yield currentState.copyWith(hasReachedMax: true);
         } else {
-          yield PostState.success(state.posts + posts);
+          yield PostState.success(currentState.posts + posts);
         }
       } catch (_) {
         yield PostState.failure();

diff --git a/examples/flutter_login/lib/authentication/authentication_bloc.dart b/examples/flutter_login/lib/authentication/authentication_bloc.dart
@@ -24,7 +24,7 @@ class AuthenticationBloc
 
   @override
   Stream<AuthenticationState> mapEventToState(
-      AuthenticationState state, AuthenticationEvent event) async* {
+      AuthenticationState currentState, AuthenticationEvent event) async* {
     if (event is AppStarted) {
       final bool hasToken = await _hasToken();
 
@@ -36,14 +36,14 @@ class AuthenticationBloc
     }
 
     if (event is LoggedIn) {
-      yield state.copyWith(isLoading: true);
+      yield currentState.copyWith(isLoading: true);
 
       await _persistToken(event.token);
       yield AuthenticationState.authenticated();
     }
 
     if (event is LoggedOut) {
-      yield state.copyWith(isLoading: true);
+      yield currentState.copyWith(isLoading: true);
 
       await _deleteToken();
       yield AuthenticationState.unauthenticated();

diff --git a/examples/flutter_login/lib/login/login_bloc.dart b/examples/flutter_login/lib/login/login_bloc.dart
@@ -23,7 +23,7 @@ class LoginBloc extends Bloc<LoginEvent, LoginState> {
 
   @override
   Stream<LoginState> mapEventToState(
-    LoginState state,
+    LoginState currentState,
     LoginEvent event,
   ) async* {
     if (event is LoginButtonPressed) {

diff --git a/packages/angular_bloc/example/example.dart b/packages/angular_bloc/example/example.dart
@@ -35,12 +35,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   }
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }

diff --git a/packages/angular_bloc/test/bloc_pipe_test.dart b/packages/angular_bloc/test/bloc_pipe_test.dart
@@ -28,12 +28,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }

diff --git a/packages/bloc/README.md b/packages/bloc/README.md
@@ -59,7 +59,7 @@ class SimpleBloc extends Bloc<dynamic, String> {
   String get initialState => '';
 
   @override
-  Stream<String> mapEventToState(String state, dynamic event) async* {
+  Stream<String> mapEventToState(String currentState, dynamic event) async* {
     yield 'data';
   }
 }
@@ -156,7 +156,7 @@ class LoginBloc extends Bloc<LoginEvent, LoginState> {
   }
 
   @override
-  Stream<LoginState> mapEventToState(LoginState state, LoginEvent event) async* {
+  Stream<LoginState> mapEventToState(LoginState currentState, LoginEvent event) async* {
     if (event is LoginButtonPressed) {
       yield LoginState.loading();
 

diff --git a/packages/bloc/example/main.dart b/packages/bloc/example/main.dart
@@ -17,16 +17,16 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
       /// Simulating Network Latency
       await Future<void>.delayed(Duration(seconds: 1));
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
       /// Simulating Network Latency
       await Future<void>.delayed(Duration(milliseconds: 500));
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }

diff --git a/packages/bloc/lib/src/bloc.dart b/packages/bloc/lib/src/bloc.dart
@@ -3,8 +3,8 @@ import 'dart:async';
 import 'package:rxdart/rxdart.dart';
 import 'package:bloc/bloc.dart';
 
-/// Takes a [Stream] of events as input
-/// and transforms them into a [Stream] of states as output.
+/// Takes a [Stream] of [E] events as input
+/// and transforms them into a [Stream] of [S] states as output.
 abstract class Bloc<E, S> {
   final PublishSubject<E> _eventSubject = PublishSubject<E>();
 
@@ -51,7 +51,7 @@ abstract class Bloc<E, S> {
   /// `mapEventToState` is called whenever an event is dispatched by the presentation layer.
   /// `mapEventToState` must convert that event, along with the current state, into a new state
   /// and return the new state in the form of a [Stream] which is consumed by the presentation layer.
-  Stream<S> mapEventToState(S state, E event);
+  Stream<S> mapEventToState(S currentState, E event);
 
   void _bindStateSubject() {
     E currentEvent;

diff --git a/packages/bloc/test/helpers/async/async_bloc.dart b/packages/bloc/test/helpers/async/async_bloc.dart
@@ -10,9 +10,11 @@ class AsyncBloc extends Bloc<AsyncEvent, AsyncState> {
 
   @override
   Stream<AsyncState> mapEventToState(
-      AsyncState state, AsyncEvent event) async* {
-    yield state.copyWith(isLoading: true);
+    AsyncState currentState,
+    AsyncEvent event,
+  ) async* {
+    yield currentState.copyWith(isLoading: true);
     await Future<void>.delayed(Duration(milliseconds: 500));
-    yield state.copyWith(isLoading: false, isSuccess: true);
+    yield currentState.copyWith(isLoading: false, isSuccess: true);
   }
 }
diff --git a/packages/bloc/test/helpers/complex/complex_bloc.dart b/packages/bloc/test/helpers/complex/complex_bloc.dart
@@ -12,7 +12,10 @@ class ComplexBloc extends Bloc<ComplexEvent, ComplexState> {
   }
 
   @override
-  Stream<ComplexState> mapEventToState(ComplexState state, ComplexEvent event) {
+  Stream<ComplexState> mapEventToState(
+    ComplexState currentState,
+    ComplexEvent event,
+  ) {
     if (event is ComplexEventA) {
       return Observable.just(ComplexStateA());
     }

diff --git a/packages/bloc/test/helpers/counter/counter_bloc.dart b/packages/bloc/test/helpers/counter/counter_bloc.dart
@@ -12,12 +12,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   CounterBloc([this.onTransitionCallback]);
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 

diff --git a/packages/bloc/test/helpers/simple/simple_bloc.dart b/packages/bloc/test/helpers/simple/simple_bloc.dart
@@ -6,7 +6,7 @@ class SimpleBloc extends Bloc<dynamic, String> {
   String get initialState => '';
 
   @override
-  Stream<String> mapEventToState(String state, dynamic event) {
+  Stream<String> mapEventToState(String currentState, dynamic event) {
     return Observable.just('data');
   }
 }
diff --git a/packages/flutter_bloc/example/lib/main.dart b/packages/flutter_bloc/example/lib/main.dart
@@ -106,12 +106,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }
diff --git a/packages/flutter_bloc/test/bloc_builder_test.dart b/packages/flutter_bloc/test/bloc_builder_test.dart
@@ -113,7 +113,8 @@ class ThemeBloc extends Bloc<ThemeEvent, ThemeData> {
   ThemeData get initialState => _lightTheme;
 
   @override
-  Stream<ThemeData> mapEventToState(ThemeData state, ThemeEvent event) async* {
+  Stream<ThemeData> mapEventToState(
+      ThemeData currentState, ThemeEvent event) async* {
     if (event is SetDarkTheme) {
       yield _darkTheme;
     } else {
@@ -129,7 +130,10 @@ class DarkThemeBloc extends Bloc<ThemeEvent, ThemeData> {
   ThemeData get initialState => _darkTheme;
 
   @override
-  Stream<ThemeData> mapEventToState(ThemeData state, ThemeEvent event) async* {
+  Stream<ThemeData> mapEventToState(
+    ThemeData currentState,
+    ThemeEvent event,
+  ) async* {
     if (event is SetDarkTheme) {
       yield _darkTheme;
     } else {

diff --git a/packages/flutter_bloc/test/bloc_provider_test.dart b/packages/flutter_bloc/test/bloc_provider_test.dart
@@ -95,12 +95,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   }
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is IncrementCounter) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is DecrementCounter) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 
@@ -121,7 +121,7 @@ class SimpleBloc extends Bloc<dynamic, String> {
   String get initialState => '';
 
   @override
-  Stream<String> mapEventToState(String state, dynamic event) async* {
+  Stream<String> mapEventToState(String currentState, dynamic event) async* {
     yield 'state';
   }
 }

diff --git a/performance_tests/flutter_bloc/bloc_builder/test_driver/counter_bloc.dart b/performance_tests/flutter_bloc/bloc_builder/test_driver/counter_bloc.dart
@@ -17,12 +17,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }
diff --git a/performance_tests/flutter_bloc/bloc_provider/test_driver/counter_bloc.dart b/performance_tests/flutter_bloc/bloc_provider/test_driver/counter_bloc.dart
@@ -17,12 +17,12 @@ class CounterBloc extends Bloc<CounterEvent, int> {
   int get initialState => 0;
 
   @override
-  Stream<int> mapEventToState(int state, CounterEvent event) async* {
+  Stream<int> mapEventToState(int currentState, CounterEvent event) async* {
     if (event is Increment) {
-      yield state + 1;
+      yield currentState + 1;
     }
     if (event is Decrement) {
-      yield state - 1;
+      yield currentState - 1;
     }
   }
 }