feat(bloc): add provider, consumer and helpers

2022-05-20 22:32:30 +02:00
parent 2ac2b4d2be
commit 9ef37633cb
45 changed files with 1435 additions and 0 deletions
@@ -0,0 +1,34 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:equatable/equatable.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+
+part 'counter_event.dart';
+part 'counter_state.dart';
+
+class CounterBloc extends Bloc<CounterEvent, CounterState> {
+  CounterBloc() : super(const CounterInitial()) {
+    
+    on<CounterIncrement>((event, emit) {
+      emit(CounterModified(state.count + 1));
+    });
+
+    on<CounterDecrement>((event, emit) {
+      emit(CounterModified(state.count - 1));
+    });
+  }
+}
@@ -0,0 +1,28 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+part of 'counter_bloc.dart';
+
+abstract class CounterEvent extends Equatable {
+  const CounterEvent();
+
+  @override
+  List<Object> get props => [];
+}
+
+class CounterIncrement extends CounterEvent {}
+
+class CounterDecrement extends CounterEvent {}
@@ -0,0 +1,35 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+part of 'counter_bloc.dart';
+
+abstract class CounterState extends Equatable {
+  final int count;
+
+  const CounterState(this.count);
+
+  @override
+  List<Object> get props => [count];
+}
+
+class CounterInitial extends CounterState {
+  const CounterInitial() : super(0);
+}
+
+class CounterModified extends CounterState {
+  const CounterModified(super.count);
+}
+
@@ -0,0 +1,55 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:bloc_helper_example/counter/bloc/counter_bloc.dart';
+import 'package:flutter/material.dart';
+import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
+
+class CounterBlocPage
+    extends BlocScreen<CounterBloc, CounterEvent, CounterState> {
+  const CounterBlocPage({super.key});
+
+  @override
+  CounterBloc create(BuildContext context) => CounterBloc();
+
+  @override
+  Widget onBuild(BuildContext context, CounterState state) {
+    final textTheme = Theme.of(context).textTheme;
+    return Scaffold(
+      appBar: AppBar(title: const Text('Counter with Bloc')),
+      body: Center(child: Text('${state.count}', style: textTheme.headline2)),
+      floatingActionButton: Column(
+        mainAxisAlignment: MainAxisAlignment.end,
+        crossAxisAlignment: CrossAxisAlignment.end,
+        children: <Widget>[
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterBlocView_increment_floatingActionButton'),
+            child: const Icon(Icons.add),
+            onPressed: () => add(context, CounterIncrement()),
+          ),
+          const SizedBox(height: 8),
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterBlocView_decrement_floatingActionButton'),
+            child: const Icon(Icons.remove),
+            onPressed: () => add(context, CounterDecrement()),
+          ),
+        ],
+      ),
+    );
+  }
+}
@@ -0,0 +1,53 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
+import 'package:flutter/material.dart';
+import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
+
+/// Important, this page assumes that the [CounterCubit] is provided.
+class CounterConsumerPage
+    extends CubitConsumerScreen<CounterCubit, CounterState> {
+  const CounterConsumerPage({super.key});
+
+  @override
+  Widget onBuild(BuildContext context, CounterState state) {
+    final textTheme = Theme.of(context).textTheme;
+    return Scaffold(
+      appBar: AppBar(title: const Text('Counter with Consumer')),
+      body: Center(child: Text('${state.count}', style: textTheme.headline2)),
+      floatingActionButton: Column(
+        mainAxisAlignment: MainAxisAlignment.end,
+        crossAxisAlignment: CrossAxisAlignment.end,
+        children: <Widget>[
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterConsumerView_increment_floatingActionButton'),
+            child: const Icon(Icons.add),
+            onPressed: () => bloc(context).increment(),
+          ),
+          const SizedBox(height: 8),
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterConsumerView_decrement_floatingActionButton'),
+            child: const Icon(Icons.remove),
+            onPressed: () => bloc(context).decrement(),
+          ),
+        ],
+      ),
+    );
+  }
+}
@@ -0,0 +1,55 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
+import 'package:flutter/material.dart';
+import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
+
+class CounterCubitPage
+    extends CubitScreen<CounterCubit, CounterState> {
+  const CounterCubitPage({super.key});
+
+  @override
+  CounterCubit create(BuildContext context) => CounterCubit();
+
+  @override
+  Widget onBuild(BuildContext context, CounterState state) {
+    final textTheme = Theme.of(context).textTheme;
+    return Scaffold(
+      appBar: AppBar(title: const Text('Counter with Cubit')),
+      body: Center(child: Text('${state.count}', style: textTheme.headline2)),
+      floatingActionButton: Column(
+        mainAxisAlignment: MainAxisAlignment.end,
+        crossAxisAlignment: CrossAxisAlignment.end,
+        children: <Widget>[
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterCubitView_increment_floatingActionButton'),
+            child: const Icon(Icons.add),
+            onPressed: () => bloc(context).increment(),
+          ),
+          const SizedBox(height: 8),
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterCubitView_decrement_floatingActionButton'),
+            child: const Icon(Icons.remove),
+            onPressed: () => bloc(context).decrement(),
+          ),
+        ],
+      ),
+    );
+  }
+}
@@ -0,0 +1,60 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:bloc_helper_example/counter/bloc/counter_bloc.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
+
+class CounterProviderPage
+    extends BlocProviderScreen<CounterBloc, CounterEvent, CounterState> {
+  const CounterProviderPage({super.key});
+
+  @override
+  Widget buildChild(BuildContext context) {
+    final textTheme = Theme.of(context).textTheme;
+    return Scaffold(
+      appBar: AppBar(title: const Text('Counter with Provider')),
+      body: Center(child: BlocBuilder<CounterBloc, CounterState>(
+        builder: (context, state) {
+          return Text('${state.count}', style: textTheme.headline2);
+        },
+      )),
+      floatingActionButton: Column(
+        mainAxisAlignment: MainAxisAlignment.end,
+        crossAxisAlignment: CrossAxisAlignment.end,
+        children: <Widget>[
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterProviderView_increment_floatingActionButton'),
+            child: const Icon(Icons.add),
+            onPressed: () => add(context, CounterIncrement()),
+          ),
+          const SizedBox(height: 8),
+          FloatingActionButton(
+            heroTag: null,
+            key: const Key('counterProviderView_decrement_floatingActionButton'),
+            child: const Icon(Icons.remove),
+            onPressed: () => add(context, CounterDecrement()),
+          ),
+        ],
+      ),
+    );
+  }
+
+  @override
+  CounterBloc create(BuildContext context) => CounterBloc();
+}
@@ -0,0 +1,32 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:equatable/equatable.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+
+part 'counter_state.dart';
+
+class CounterCubit extends Cubit<CounterState> {
+  CounterCubit() : super(const CounterInitial());
+
+  void increment() {
+    emit(CounterModified(state.count + 1));
+  }
+
+  void decrement() {
+    emit(CounterModified(state.count - 1));
+  }
+}
@@ -0,0 +1,35 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+part of 'counter_cubit.dart';
+
+abstract class CounterState extends Equatable {
+  final int count;
+
+  const CounterState(this.count);
+
+  @override
+  List<Object> get props => [count];
+}
+
+class CounterInitial extends CounterState {
+  const CounterInitial() : super(0);
+}
+
+class CounterModified extends CounterState {
+  const CounterModified(super.count);
+}
+
@@ -0,0 +1,26 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:flutter/foundation.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+
+class CounterObserver extends BlocObserver {
+  @override
+  void onChange(BlocBase bloc, Change change) {
+    super.onChange(bloc, change);
+    debugPrint('${bloc.runtimeType} $change');
+  }
+}
@@ -0,0 +1,90 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:bloc_helper_example/counter/counter_bloc_page.dart';
+import 'package:bloc_helper_example/counter/counter_consumer_page.dart';
+import 'package:bloc_helper_example/counter/counter_cubit_page.dart';
+import 'package:bloc_helper_example/counter/counter_provider_page.dart';
+import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
+import 'package:bloc_helper_example/counter_observer.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_bloc/flutter_bloc.dart';
+
+void main() {
+  BlocOverrides.runZoned(() => runApp(const MyApp()),
+      blocObserver: CounterObserver());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({Key? key}) : super(key: key);
+
+  // This widget is the root of your application.
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: 'Flutter Demo',
+      theme: ThemeData(
+        primarySwatch: Colors.blue,
+      ),
+      home: const MainPage(),
+    );
+  }
+}
+
+class MainPage extends StatelessWidget {
+  const MainPage({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text('Main Page'),
+      ),
+      body: Center(
+        child: Column(
+          mainAxisAlignment: MainAxisAlignment.center,
+          children: <Widget>[
+            ElevatedButton(
+              child: const Text('Counter with BlocScreen'),
+              onPressed: () => Navigator.of(context).push(
+                  MaterialPageRoute(builder: (_) => const CounterBlocPage())),
+            ),
+            ElevatedButton(
+              child: const Text('Counter with CubitScreen'),
+              onPressed: () => Navigator.of(context).push(
+                  MaterialPageRoute(builder: (_) => const CounterCubitPage())),
+            ),
+            ElevatedButton(
+              child: const Text('Counter with BlocProviderScreen'),
+              onPressed: () => Navigator.of(context).push(MaterialPageRoute(
+                  builder: (_) => const CounterProviderPage())),
+            ),
+            ElevatedButton(
+              child: const Text('Counter with BlocConsumerScreen'),
+              onPressed: () => Navigator.of(context)
+                  .push(MaterialPageRoute(builder: (context) {
+                return BlocProvider<CounterCubit>(
+                  create: (context) => CounterCubit(),
+                  child: const CounterConsumerPage(),
+                );
+              })),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+}