Merge pull request #7 from davidmarne/0.2.0

0.2.0

Author: davidmarne

README.md

@@ -24,7 +24,7 @@ flutter_built_redux lets a widget to subscribe to the pieces of the redux state
 ### Consuming
 
 Wrap your top-level flutter widget with ReduxProvider
-```
+```dart
 class MyProviderWidget extends StatelessWidget {
   final store = new Store<MyReduxState, MyReduxStateBuilder, MyReduxStateActions>(
     new MyReduxState(),
@@ -41,45 +41,27 @@ class MyProviderWidget extends StatelessWidget {
 }
 ```
 
+Write a widget that extends StoreConnector.
 Declare the properties from your state you want this widget to subscribe to by
-creating a new built value.
-```
-abstract class MyWidgetProps implements Built<MyWidgetProps, MyWidgetPropsBuilder> {
-  String get propIWantFromMyReduxState;
-
-  // Built value boilerplate
-  MyWidgetProps._();
-  factory MyWidgetProps([updates(MyWidgetPropsBuilder b)]) => _$MyWidgetProps;
-}
+creating a implementing connect & implement the build method.
+```dart
 
 // first 3 generics are the redux store value, builder and actions, while the last
 // two are the subscribed values value and builder.
-class MyWidget extends StoreConnector<MyReduxState, MyReduxStateBuilder, MyReduxStateActions,
-    MyWidgetProps, MyWidgetPropsBuilder> {
+class MyWidget extends StoreConnector<MyReduxState, MyReduxStateBuilder, MyReduxStateActions, String> {
   MyWidget({Key key}) : super(key: key);
 
 
   // connect is the function that returns an object containing the properties from
   // your store that this component cares about. It requires that you return a
-  // built_value to ensure your props has a valid == override so setState
-  // is only called if the properties this component cares about change.
+  // comparable type to ensure your props setState is only called when necessary.
+  // Primitive types, built values, and collections are recommended.
   @override
   MyWidgetProps connect(Store<MyReduxState, MyReduxStateBuilder, MyReduxStateActions> store) =>
-      new MyWidgetProps((b) => b..propIWantFromMyReduxState = store.state.someProperty)
-
-  MyWidgetState createState() => new MyWidgetState();
-}
-
-class MyWidgetState extends StoreConnectorState<MyReduxState, MyReduxStateBuilder,
-    MyReduxStateActions, MyWidgetProps, MyWidgetPropsBuilder> {
-
-  // by extending StoreConnectorState you inherit a state property. In this case
-  // it would be of type MyWidgetProps.
-  //
-  // you also inherit an actions property, which is of type MyReduxStateActions
+      store.state.someProperty;
 
   @override
-  Widget build(BuildContext context) {
+  Widget build(BuildContext context, MyWidgetProps props, MyReduxStateActions action) {
     return new Center(
       child: new Text(state.propIWantFromMyReduxState),
     );

analysis_options.yaml

@@ -0,0 +1,2 @@
+analyzer:
+  strong-mode: true

.analysis_options renamed to example/chat_app/analysis_options.yaml

@@ -31,22 +31,14 @@ class ChatProvider extends StatelessWidget {
 }
 
 class ChatScreen extends StoreConnector<ChatMessages, ChatMessagesBuilder,
-    ChatMessagesActions, ChatMessages, ChatMessagesBuilder> {
+    ChatMessagesActions, ChatMessages> {
   ChatScreen({Key key}) : super(key: key);
 
   @override
   ChatMessages connect(ChatMessages state) => state;
 
-  ChatScreenState createState() => new ChatScreenState();
-}
-
-class ChatScreenState extends StoreConnectorState<
-    ChatMessages,
-    ChatMessagesBuilder,
-    ChatMessagesActions,
-    ChatMessages,
-    ChatMessagesBuilder> {
-  Widget _buildTextComposer(BuildContext context) {
+  Widget _buildTextComposer(
+      BuildContext context, ChatMessages state, ChatMessagesActions actions) {
     ThemeData themeData = Theme.of(context);
     return new Row(children: <Widget>[
       new Flexible(
@@ -73,70 +65,23 @@ class ChatScreenState extends StoreConnectorState<
   final ChatUser me = new ChatUser();
 
   @override
-  Widget build(BuildContext context) {
+  Widget build(
+      BuildContext context, ChatMessages state, ChatMessagesActions actions) {
     return new Scaffold(
       appBar: new AppBar(title: new Text('Chatting as ${me.name}')),
       body: new ListView(
         padding: new EdgeInsets.symmetric(vertical: 8.0),
         children: state.messages.map((ChatMessage message) {
-          return new ChatMessageListItem(message);
+          return new ListTile(
+              dense: true,
+              leading: new CircleAvatar(
+                  child: new Text(message.sender.name[0]),
+                  backgroundColor: message.sender.color),
+              title: new Text(message.sender.name),
+              subtitle: new Text(message.text));
         }).toList(),
       ),
-      bottomNavigationBar: _buildTextComposer(context),
-    );
-  }
-}
-
-class ChatMessageListItem extends StatefulWidget {
-  ChatMessageListItem(ChatMessage m)
-      : message = m,
-        super(key: new ObjectKey(m));
-
-  final ChatMessage message;
-
-  @override
-  State createState() => new ChatMessageListItemState();
-}
-
-class ChatMessageListItemState extends State<ChatMessageListItem>
-    with SingleTickerProviderStateMixin {
-  AnimationController _animationController;
-  Animation<double> _animation;
-
-  @override
-  void initState() {
-    super.initState();
-    _animationController = new AnimationController(
-      vsync: this,
-      duration: new Duration(milliseconds: 700),
-    );
-
-    _animation = new CurvedAnimation(
-      parent: _animationController,
-      curve: Curves.easeOut,
+      bottomNavigationBar: _buildTextComposer(context, state, actions),
     );
-
-    _animationController.forward();
-  }
-
-  @override
-  void dispose() {
-    _animationController.dispose();
-    super.dispose();
-  }
-
-  @override
-  Widget build(BuildContext context) {
-    final ChatMessage message = widget.message;
-    return new SizeTransition(
-        sizeFactor: _animation,
-        axisAlignment: 0.0,
-        child: new ListTile(
-            dense: true,
-            leading: new CircleAvatar(
-                child: new Text(message.sender.name[0]),
-                backgroundColor: message.sender.color),
-            title: new Text(message.sender.name),
-            subtitle: new Text(message.text)));
   }
 }

example/chat_app/lib/main.dart

@@ -5,38 +5,45 @@ import 'package:flutter/widgets.dart' hide Builder;
 import 'package:built_redux/built_redux.dart';
 import 'package:built_value/built_value.dart';
 
+/// [StoreConnector] is a widget that rebuilds when the redux store
+/// has triggered and the connect function yields a new result.
+/// [LocalState] should be comparable. It is recommended to only use primitive and built types.
 abstract class StoreConnector<
-        StoreState extends Built<StoreState, StoreStateBuilder>,
-        StoreStateBuilder extends Builder<StoreState, StoreStateBuilder>,
-        Actions extends ReduxActions,
-        LocalState extends Built<LocalState, LocalStateBuilder>,
-        LocalStateBuilder extends Builder<LocalState, LocalStateBuilder>>
-    extends StatefulWidget {
+    StoreState extends Built<StoreState, StoreStateBuilder>,
+    StoreStateBuilder extends Builder<StoreState, StoreStateBuilder>,
+    Actions extends ReduxActions,
+    LocalState> extends StatefulWidget {
   StoreConnector({Key key}) : super(key: key);
 
   /// [connect] takes the current state of the redux store and retuns an object that contains
   /// the subset of the redux state tree that this component cares about.
   @protected
   LocalState connect(StoreState state);
+
+  @override
+  StoreConnectorState<StoreState, StoreStateBuilder, Actions, LocalState>
+      createState() => new StoreConnectorState<StoreState, StoreStateBuilder,
+          Actions, LocalState>();
+
+  @protected
+  Widget build(BuildContext context, LocalState state, Actions actions);
 }
 
-abstract class StoreConnectorState<
+class StoreConnectorState<
         StoreState extends Built<StoreState, StoreStateBuilder>,
         StoreStateBuilder extends Builder<StoreState, StoreStateBuilder>,
         Actions extends ReduxActions,
-        LocalState extends Built<LocalState, LocalStateBuilder>,
-        LocalStateBuilder extends Builder<LocalState, LocalStateBuilder>>
+        LocalState>
     extends State<
-        StoreConnector<StoreState, StoreStateBuilder, Actions, LocalState,
-            LocalStateBuilder>> {
+        StoreConnector<StoreState, StoreStateBuilder, Actions, LocalState>> {
   StreamSubscription<SubstateChange<LocalState>> _storeSub;
   ReduxProvider _reduxProvider;
 
   /// [LocalState] is an object that contains the subset of the redux state tree that this component
   /// cares about.
-  LocalState state;
+  LocalState _state;
 
-  Store<StoreState, StoreStateBuilder, Actions> get store {
+  Store<StoreState, StoreStateBuilder, Actions> get _store {
     // get the store from the ReduxProvider ancestor
     if (_reduxProvider == null) {
       _reduxProvider = context.inheritFromWidgetOfExactType(ReduxProvider);
@@ -47,21 +54,18 @@ abstract class StoreConnectorState<
     return _reduxProvider.store;
   }
 
-  /// [actions] returns the actions object that contains the [ActionDispatchers] associated with the redux store
-  Actions get actions => store.actions;
-
   /// setup a subscription to the store
   @override
   void didChangeDependencies() {
     super.didChangeDependencies();
 
     // set the initial state
-    state = widget.connect(store.state);
+    _state = widget.connect(_store.state);
 
     // listen to changes
-    _storeSub = store.substateStream(widget.connect).listen((change) {
+    _storeSub = _store.substateStream(widget.connect).listen((change) {
       setState(() {
-        state = change.next;
+        _state = change.next;
       });
     });
   }
@@ -73,6 +77,11 @@ abstract class StoreConnectorState<
     _storeSub.cancel();
     super.dispose();
   }
+
+  @override
+  Widget build(BuildContext context) {
+    return widget.build(context, _state, _store.actions);
+  }
 }
 
 /// [ReduxProvider] provides access to the redux store to descendant widgets.

lib/src/store_connector.dart

@@ -1,7 +1,7 @@
 # Important: Use "flutter packages get", not "pub get".
 name: flutter_built_redux
 author: David Marne <[email protected]>
-version: 0.1.0
+version: 0.2.0
 description: Built_redux provider for Flutter
 homepage: https://github.com/davidmarne/flutter_built_redux
 dependencies:
@@ -11,13 +11,5 @@ dependencies:
   built_redux: ^6.0.0
   built_value: ^4.0.0
 
-dev_dependencies:
-  quiver:  ^0.24.0
-  rate_limit: ^0.1.0
-  test: ^0.12.13
-  built_collection: ^1.3.0
-  flutter_test:
-    sdk: flutter
-
 environment:
   sdk: ">=1.19.0 <2.0.0"