Merge pull request #10 from shubham-gupta-16/improve_view_model

Fixed ViewModel Dispose major bug

Author: shubham16g

.github/workflows/publish.yaml

@@ -0,0 +1,12 @@
+name: Publish to pub.dev
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+jobs:
+  publish:
+    uses: dart-lang/setup-dart/blob/main/.github/workflows/publish.yml
+    # with:
+    #   working-directory: path/to/package/within/repository

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.3
+Fixed ViewModel Dispose major bug
+- ViewModel not disposing fixed
+- Responsive Example added
+
 ## 0.5.2
 Fixed Bugs and make package simpler
 - ViewModelStatelessWidget removed

example/lib/more_examples_section.dart

@@ -1,10 +1,12 @@
 import 'package:example/multiple_view_models_example/multiple_view_models_example.dart';
 import 'package:example/post_frame_callback_example/post_frame_callback_example.dart';
+import 'package:example/responsive_example/responsive_example.dart';
 import 'package:flutter/material.dart';
 
 final _moreExamples = {
   "Multiple ViewModels Example": const MultipleViewModelsExample(),
   "PostFrameCallback Example": const PostFrameCallbackExample(),
+  "Responsive Example": const ResponsiveExample(),
 };
 
 class MoreExamplesSection extends StatelessWidget {

example/lib/multiple_view_models_example/view_model/second_view_model.dart

@@ -21,6 +21,6 @@ class SecondViewModel extends ViewModel {
   @override
   void dispose() {
     _messageSharedFlow.dispose();
-    debugPrint("FirstViewModel disposed");
+    debugPrint("SecondViewModel disposed");
   }
 }

example/lib/responsive_example/responsive_example.dart

@@ -0,0 +1,55 @@
+import 'package:flutter/material.dart';
+import 'package:view_model_x/view_model_x.dart';
+
+import 'view_model/first_view_model.dart';
+import 'view_model/second_view_model.dart';
+
+class ResponsiveExample extends StatelessWidget {
+  const ResponsiveExample({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    final isDesktop = MediaQuery.of(context).size.width > 600;
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text("Responsive"),
+      ),
+      body: isDesktop
+          ? const FirstSection()
+          : ViewModelProvider(
+              create: (context) => SecondViewModel(),
+              child: const SecondSection()),
+    );
+  }
+}
+
+class FirstSection extends StatelessWidget {
+  const FirstSection({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return ViewModelProvider(
+      create: (c) => FirstViewModel(),
+      builder: (ctx, v) => Container(
+        color: Colors.green,
+        child: Center(
+          child: Text(ViewModelProvider.of<FirstViewModel>(ctx)
+              .counterStateFlow
+              .value
+              .toString()),
+        ),
+      ),
+    );
+  }
+}
+
+class SecondSection extends StatelessWidget {
+  const SecondSection({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return Container(
+      color: Colors.yellow,
+    );
+  }
+}

example/lib/responsive_example/view_model/first_view_model.dart

@@ -0,0 +1,21 @@
+import 'package:flutter/cupertino.dart';
+import 'package:view_model_x/view_model_x.dart';
+
+class FirstViewModel extends ViewModel {
+  // initialize StateFlow
+  final _counterStateFlow = MutableStateFlow<int>(1);
+
+  StateFlow<int> get counterStateFlow => _counterStateFlow;
+
+  void increment() {
+    // by changing the value, listeners were notified
+    _counterStateFlow.value = _counterStateFlow.value + 1;
+  }
+
+  @override
+  void dispose() {
+    // must dispose all flows
+    _counterStateFlow.dispose();
+    debugPrint("FirstViewModel disposed");
+  }
+}

example/lib/responsive_example/view_model/second_view_model.dart

@@ -0,0 +1,26 @@
+import 'package:flutter/foundation.dart';
+import 'package:view_model_x/view_model_x.dart';
+
+class SecondViewModel extends ViewModel {
+  // initialize SharedFlow
+  final _messageSharedFlow = MutableSharedFlow<String>();
+
+  SharedFlow<String> get messageSharedFlow => _messageSharedFlow;
+
+  void showPopupMessage() {
+    // by emitting the value, listeners were notified
+    debugPrint("hi");
+    _messageSharedFlow.emit("Hello from MyViewModel!");
+  }
+
+  @override
+  void init() {
+    debugPrint("init inside vm");
+  }
+
+  @override
+  void dispose() {
+    _messageSharedFlow.dispose();
+    debugPrint("SecondViewModel disposed");
+  }
+}

example/pubspec.lock

@@ -176,7 +176,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.5.2"
+    version: "0.5.3"
 sdks:
   dart: ">=2.18.6 <3.0.0"
   flutter: ">=1.17.0"

lib/src/view_model_provider.dart

@@ -1,19 +1,36 @@
 import 'package:flutter/widgets.dart';
 import 'package:provider/provider.dart';
+import 'package:provider/single_child_widget.dart';
 
 import 'provider_single_child_widget.dart';
 import 'view_model.dart';
 
 /// [ViewModelProvider] is used to wrap the widget with your custom [ViewModel].
 /// This requires [create] which accepts custom [ViewModel] and [child] Widget.
+class VMP<T extends ViewModel> extends SingleChildStatelessWidget {
+  const VMP({super.key, super.child});
+
+  @override
+  Widget buildWithChild(BuildContext context, Widget? child) {
+    // TODO: implement buildWithChild
+    throw UnimplementedError();
+  }
+}
+
 class ViewModelProvider<T extends ViewModel> extends Provider<T>
     with ProviderSingleChildWidget {
   ViewModelProvider(
       {super.key,
       required super.create,
       super.lazy,
       super.builder,
-      super.child});
+      super.child})
+      : super(dispose: _dispose);
+
+  static void _dispose<T extends ViewModel>(BuildContext context, T viewModel) {
+    debugPrint('provider dispose');
+    viewModel.dispose();
+  }
 
   /// [ViewModelProvider].[of] method allows to get the custom [ViewModel] from anywhere nested inside [ViewModelProvider]'s [child]
   static F of<F extends ViewModel>(BuildContext context) {

pubspec.yaml

@@ -1,6 +1,6 @@
 name: view_model_x
 description: An Android similar state management package (StateFlow and SharedFlow with ViewModel) which helps to implement MVVM pattern easily.
-version: 0.5.2
+version: 0.5.3
 homepage: https://github.com/shubham-gupta-16/view_model_x
 repository: https://github.com/shubham-gupta-16/view_model_x
 issue_tracker: https://github.com/shubham-gupta-16/view_model_x/issues