Add new and const back in. Not ready yet in Dart 2, causing problems.

brianegan · brianegan · commit 0a01f65e28ef · 2018-03-19T23:10:41.000+01:00
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,7 @@ addons:
       - libstdc++6
       - fonts-droid
 before_script:
-  - git clone https://github.com/flutter/flutter.git -b beta --depth 1
+  - git clone https://github.com/flutter/flutter.git -b master --depth 1
   - ./flutter/bin/flutter doctor
 script:
   - ./flutter/bin/flutter test --preview-dart-2 --coverage --coverage-path=lcov.info
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,8 +5,12 @@
   * Works with Dart 2 (no longer supports Dart 1)
   * Stronger Type info Required
   * Breaking Changes: 
-    * `StoreProvider` now requires generic type info: `StoreProvider<AppState>`
-    * `new StoreProvider.of(context).store` is now `StoreProvider.of<AppState>(context)` 
+    * `StoreProvider` now requires generic type info: `new StoreProvider<AppState>`
+    * `new StoreProvider.of(context).store` is now `StoreProvider.of<AppState>(context)`
+    
+## 0.3.6
+
+  * Add `onWillChange`. This function will be called before the builder and can be used for working with Imperative APIs, such as Navigator, TextEditingController, or TabController.
 
 ## 0.3.5
 
diff --git a/README.md b/README.md
@@ -16,6 +16,13 @@ This package is built to work with [Redux.dart](https://pub.dartlang.org/package
 
   * Dart 1: 0.3.x
   * Dart 2: 0.4.0+. See the migration guide below!
+  
+## Dart 2 Migration Guide
+
+Dart 2 requires more strict typing (yay!), and gives us the option to make getting the Store from the StoreProvider more convenient!
+
+  1. Change `new StoreProvider(...)` to `new StoreProvider<StateClass>(...)` in your Widget tree. 
+  2. Change `new StoreProvider.of(context).store` to `StoreProvider.of<StateClass>(context)` if you're directly fetching the `Store<AppState>` yourself from the `StoreProvider<AppState>`. No need to access the `store` field directly any more since Dart 2 can now infer the proper type with a static function :)
 
 ## Examples
 
@@ -71,21 +78,21 @@ class FlutterReduxApp extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-      theme: ThemeData.dark(),
+      theme: new ThemeData.dark(),
       title: title,
-      home: StoreProvider<int>(
+      home: new StoreProvider<int>(
         // Pass the store to the StoreProvider. Any ancestor `StoreConnector`
         // Widgets will find and use this value as the `Store`.
         store: store,
-        child: Scaffold(
-          appBar: AppBar(
-            title: Text(title),
+        child: new Scaffold(
+          appBar: new AppBar(
+            title: new Text(title),
           ),
-          body: Center(
-            child: Column(
+          body: new Center(
+            child: new Column(
               mainAxisAlignment: MainAxisAlignment.center,
               children: [
-                Text(
+                new Text(
                   'You have pushed the button this many times:',
                 ),
                 // Connect the Store to a Text Widget that renders the current
@@ -103,10 +110,12 @@ class FlutterReduxApp extends StatelessWidget {
                 // count. No need to manually manage subscriptions or Streams!
                 new StoreConnector<int, String>(
                   converter: (store) => store.state.toString(),
-                  builder: (context, count) => Text(
-                        count,
-                        style: Theme.of(context).textTheme.display1,
-                      ),
+                  builder: (context, count) {
+                    return new Text(
+                      count,
+                      style: Theme.of(context).textTheme.display1,
+                    );
+                  },
                 )
               ],
             ),
@@ -122,26 +131,21 @@ class FlutterReduxApp extends StatelessWidget {
               // with no parameters. It only dispatches an Increment action.
               return () => store.dispatch(Actions.Increment);
             },
-            builder: (context, callback) => FloatingActionButton(
-                  // Attach the `callback` to the `onPressed` attribute
-                  onPressed: callback,
-                  tooltip: 'Increment',
-                  child: Icon(Icons.add),
-                ),
+            builder: (context, callback) {
+              return new FloatingActionButton(
+                // Attach the `callback` to the `onPressed` attribute
+                onPressed: callback,
+                tooltip: 'Increment',
+                child: new Icon(Icons.add),
+              );
+            },
           ),
         ),
       ),
     );
   }
 }
-```  
-
-## Dart 2 Migration
-
-Dart 2 requires more strict typing (yay!), and gives us the option to make getting the Store from the StoreProvider more convenient!
-
-  1. Change `new StoreProvider(...)` to `StoreProvider<StateClass>(...)` in your Widget tree. 
-  2. Change `new StoreProvider.of(context).store` to `StoreProvider.of<StateClass>(context)` if you're directly fetching the `Store<AppState>` yourself from the `StoreProvider<AppState>`. No need to access the `store` field directly any more since Dart 2 can now infer the proper type with a static function :)  
+```    
 
 ## Purpose
 
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -35,21 +35,21 @@ class FlutterReduxApp extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return MaterialApp(
-      theme: ThemeData.dark(),
+      theme: new ThemeData.dark(),
       title: title,
-      home: StoreProvider<int>(
+      home: new StoreProvider<int>(
         // Pass the store to the StoreProvider. Any ancestor `StoreConnector`
         // Widgets will find and use this value as the `Store`.
         store: store,
-        child: Scaffold(
-          appBar: AppBar(
-            title: Text(title),
+        child: new Scaffold(
+          appBar: new AppBar(
+            title: new Text(title),
           ),
-          body: Center(
-            child: Column(
+          body: new Center(
+            child: new Column(
               mainAxisAlignment: MainAxisAlignment.center,
               children: [
-                Text(
+                new Text(
                   'You have pushed the button this many times:',
                 ),
                 // Connect the Store to a Text Widget that renders the current
@@ -67,10 +67,12 @@ class FlutterReduxApp extends StatelessWidget {
                 // count. No need to manually manage subscriptions or Streams!
                 new StoreConnector<int, String>(
                   converter: (store) => store.state.toString(),
-                  builder: (context, count) => Text(
-                        count,
-                        style: Theme.of(context).textTheme.display1,
-                      ),
+                  builder: (context, count) {
+                    return new Text(
+                      count,
+                      style: Theme.of(context).textTheme.display1,
+                    );
+                  },
                 )
               ],
             ),
@@ -86,12 +88,14 @@ class FlutterReduxApp extends StatelessWidget {
               // with no parameters. It only dispatches an Increment action.
               return () => store.dispatch(Actions.Increment);
             },
-            builder: (context, callback) => FloatingActionButton(
-                  // Attach the `callback` to the `onPressed` attribute
-                  onPressed: callback,
-                  tooltip: 'Increment',
-                  child: Icon(Icons.add),
-                ),
+            builder: (context, callback) {
+              return new FloatingActionButton(
+                // Attach the `callback` to the `onPressed` attribute
+                onPressed: callback,
+                tooltip: 'Increment',
+                child: new Icon(Icons.add),
+              );
+            },
           ),
         ),
       ),
diff --git a/lib/flutter_redux.dart b/lib/flutter_redux.dart
@@ -16,8 +16,7 @@ class StoreProvider<S> extends InheritedWidget {
     Key key,
     @required Store<S> store,
     @required Widget child,
-  })
-      : assert(store != null),
+  })  : assert(store != null),
         assert(child != null),
         _store = store,
         super(key: key, child: child);
@@ -83,6 +82,15 @@ typedef OnDisposeCallback<S> = void Function(
 /// your `converter` function.
 typedef IgnoreChangeTest<S> = bool Function(S state);
 
+/// A function that will be run on State change.
+///
+/// This function is passed the `ViewModel`, and if `distinct` is `true`,
+/// it will only be called if the `ViewModel` changes.
+///
+/// This can be useful for imperative calls to things like Navigator,
+/// TabController, etc
+typedef OnWillChangeCallback<ViewModel> = void Function(ViewModel viewModel);
+
 /// Build a widget based on the state of the [Store].
 ///
 /// Before the [builder] is run, the [converter] will convert the store into a
@@ -113,7 +121,7 @@ class StoreConnector<S, ViewModel> extends StatelessWidget {
   ///
   /// This can be useful for dispatching actions that fetch data for your Widget
   /// when it is first displayed.
-  final OnInitCallback onInit;
+  final OnInitCallback<S> onInit;
 
   /// A function that will be run when the StoreConnector is removed from the
   /// Widget Tree.
@@ -122,7 +130,7 @@ class StoreConnector<S, ViewModel> extends StatelessWidget {
   ///
   /// This can be useful for dispatching actions that remove stale data from
   /// your State tree.
-  final OnDisposeCallback onDispose;
+  final OnDisposeCallback<S> onDispose;
 
   /// Determines whether the Widget should be rebuilt when the Store emits an
   /// onChange event.
@@ -144,6 +152,15 @@ class StoreConnector<S, ViewModel> extends StatelessWidget {
   /// your [converter] function.
   final IgnoreChangeTest<S> ignoreChange;
 
+  /// A function that will be run on State change.
+  ///
+  /// This function is passed the `ViewModel`, and if `distinct` is `true`,
+  /// it will only be called if the `ViewModel` changes.
+  ///
+  /// This can be useful for imperative calls to things like Navigator,
+  /// TabController, etc
+  final OnWillChangeCallback<ViewModel> onWillChange;
+
   StoreConnector({
     Key key,
     @required this.builder,
@@ -153,8 +170,8 @@ class StoreConnector<S, ViewModel> extends StatelessWidget {
     this.onDispose,
     this.rebuildOnChange = true,
     this.ignoreChange,
-  })
-      : assert(builder != null),
+    this.onWillChange,
+  })  : assert(builder != null),
         assert(converter != null),
         super(key: key);
 
@@ -169,6 +186,7 @@ class StoreConnector<S, ViewModel> extends StatelessWidget {
       onDispose: onDispose,
       rebuildOnChange: rebuildOnChange,
       ignoreChange: ignoreChange,
+      onWillChange: onWillChange,
     );
   }
 }
@@ -194,7 +212,7 @@ class StoreBuilder<S> extends StatelessWidget {
   ///
   /// This can be useful for dispatching actions that fetch data for your Widget
   /// when it is first displayed.
-  final OnInitCallback onInit;
+  final OnInitCallback<S> onInit;
 
   /// A function that will be run when the StoreBuilder is removed from the
   /// Widget Tree.
@@ -203,16 +221,22 @@ class StoreBuilder<S> extends StatelessWidget {
   ///
   /// This can be useful for dispatching actions that remove stale data from
   /// your State tree.
-  final OnDisposeCallback onDispose;
+  final OnDisposeCallback<S> onDispose;
+
+  /// A function that will be run on State change.
+  ///
+  /// This can be useful for imperative calls to things like Navigator,
+  /// TabController, etc
+  final OnWillChangeCallback<Store<S>> onWillChange;
 
   StoreBuilder({
     Key key,
     @required this.builder,
     this.onInit,
     this.onDispose,
     this.rebuildOnChange = true,
-  })
-      : assert(builder != null),
+    this.onWillChange,
+  })  : assert(builder != null),
         super(key: key);
 
   @override
@@ -223,6 +247,7 @@ class StoreBuilder<S> extends StatelessWidget {
       rebuildOnChange: rebuildOnChange,
       onInit: onInit,
       onDispose: onDispose,
+      onWillChange: onWillChange,
     );
   }
 }
@@ -234,9 +259,10 @@ class _StoreStreamListener<S, ViewModel> extends StatefulWidget {
   final Store<S> store;
   final bool rebuildOnChange;
   final bool distinct;
-  final OnInitCallback onInit;
-  final OnDisposeCallback onDispose;
+  final OnInitCallback<S> onInit;
+  final OnDisposeCallback<S> onDispose;
   final IgnoreChangeTest<S> ignoreChange;
+  final OnWillChangeCallback<ViewModel> onWillChange;
 
   _StoreStreamListener({
     Key key,
@@ -248,8 +274,8 @@ class _StoreStreamListener<S, ViewModel> extends StatefulWidget {
     this.onDispose,
     this.rebuildOnChange = true,
     this.ignoreChange,
-  })
-      : super(key: key);
+    this.onWillChange,
+  }) : super(key: key);
 
   @override
   State<StatefulWidget> createState() {
@@ -318,6 +344,11 @@ class _StoreStreamListenerState<S, ViewModel>
     stream = stream
         .transform(new StreamTransformer.fromHandlers(handleData: (vm, sink) {
       latestValue = vm;
+
+      if (widget.onWillChange != null) {
+        widget.onWillChange(latestValue);
+      }
+
       sink.add(vm);
     }));
   }
diff --git a/test/flutter_redux_test.dart b/test/flutter_redux_test.dart
