add example and store_connection widget

Author: davidmarne

analysis_options.yaml

@@ -1,2 +1,4 @@
 analyzer:
-  strong-mode: true
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false

example/example.dart

@@ -0,0 +1,107 @@
+library example;
+
+import 'package:built_redux/built_redux.dart';
+import 'package:flutter_built_redux/flutter_built_redux.dart';
+import 'package:flutter/material.dart' hide Builder;
+import 'package:built_value/built_value.dart';
+
+part 'example.g.dart';
+
+/// an example using `StoreConnection`
+class ConnectionExample extends StatelessWidget {
+  final Store<Counter, CounterBuilder, CounterActions> store;
+
+  ConnectionExample(this.store);
+
+  @override
+  Widget build(BuildContext context) => new MaterialApp(
+        title: 'flutter_built_redux_test',
+        home: new ReduxProvider(
+          store: store,
+          child: new StoreConnection<Counter, CounterActions, int>(
+            connect: (state) => state.count,
+            builder: (BuildContext context, int count, CounterActions actions) {
+              return new Scaffold(
+                body: new Row(
+                  children: <Widget>[
+                    new RaisedButton(
+                      onPressed: actions.increment,
+                      child: new Text('Increment'),
+                    ),
+                    new Text('Count: $count'),
+                  ],
+                ),
+              );
+            },
+          ),
+        ),
+      );
+}
+
+/// an example using a widget that implements `StoreConnector`
+class ConnectorExample extends StatelessWidget {
+  final Store<Counter, CounterBuilder, CounterActions> store;
+
+  ConnectorExample(this.store);
+
+  @override
+  Widget build(BuildContext context) {
+    return new MaterialApp(
+      title: 'flutter_built_redux_test',
+      home: new ReduxProvider(
+        store: store,
+        child: new CounterWidget(),
+      ),
+    );
+  }
+}
+
+/// [CounterWidget] impelments [StoreConnector] manually
+class CounterWidget extends StoreConnector<Counter, CounterActions, int> {
+  CounterWidget();
+
+  @override
+  int connect(Counter state) {
+    return state.count;
+  }
+
+  @override
+  Widget build(BuildContext context, int count, CounterActions actions) =>
+      new Scaffold(
+        body: new Row(
+          children: <Widget>[
+            new RaisedButton(
+              onPressed: actions.increment,
+              child: new Text('Increment'),
+            ),
+            new Text('Count: $count'),
+          ],
+        ),
+      );
+}
+
+// Built redux counter store, actions, and reducer
+
+Store<Counter, CounterBuilder, CounterActions> createStore() => new Store(
+      reducerBuilder.build(),
+      new Counter(),
+      new CounterActions(),
+    );
+
+ReducerBuilder<Counter, CounterBuilder> reducerBuilder =
+    new ReducerBuilder<Counter, CounterBuilder>()
+      ..add(CounterActionsNames.increment, (s, a, b) => b.count++);
+
+abstract class CounterActions extends ReduxActions {
+  factory CounterActions() => new _$CounterActions();
+  CounterActions._();
+
+  ActionDispatcher<Null> get increment;
+}
+
+abstract class Counter implements Built<Counter, CounterBuilder> {
+  factory Counter() => new _$Counter._(count: 0);
+  Counter._();
+
+  int get count;
+}

example/example.g.dart

@@ -4,6 +4,50 @@ import 'package:meta/meta.dart';
 import 'package:flutter/widgets.dart' hide Builder;
 import 'package:built_redux/built_redux.dart';
 
+/// [StoreConnection] is a widget that rebuilds when the redux store
+/// has triggered and the connect function yields a new result. It is an implementation
+/// of `StoreConnector` that takes a connect function and builder function as parameters
+/// so `StoreConnector` doesn't have to be implemented manually.
+///
+/// [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.
+/// It requires that you return a comparable type to ensure your props setState is only called when necessary.
+/// Primitive types, built values, and collections are recommended.
+/// The result of [connect] is what gets passed to the build function's second param
+///
+/// [builder] is a function that takes a `BuildContext`, the `LocalState` returned from
+/// connect, and your `ReduxActions` class and returns a widget.
+///
+/// [StoreState] is the generic type of your built_redux store's state object
+/// [Actions] is the generic tyoe of your built_redux store's actions contiainer
+/// [LocalState] is the state from your store that this widget needs to render.
+/// [LocalState] should be comparable. It is recommended to only use primitive or built types.
+class StoreConnection<StoreState, Actions extends ReduxActions, LocalState>
+    extends StoreConnector<StoreState, Actions, LocalState> {
+  final LocalState Function(StoreState state) _connect;
+  final Widget Function(BuildContext context, LocalState state, Actions actions)
+      _builder;
+
+  StoreConnection({
+    @required LocalState connect(StoreState state),
+    @required
+        Widget builder(BuildContext context, LocalState state, Actions actions),
+    Key key,
+  })
+      : assert(connect != null, 'StoreConnection: connect must not be null'),
+        assert(builder != null, 'StoreConnection: builder must not be null'),
+        _connect = connect,
+        _builder = builder,
+        super(key: key);
+
+  @protected
+  LocalState connect(StoreState state) => _connect(state);
+
+  @protected
+  Widget build(BuildContext context, LocalState state, Actions actions) =>
+      _builder(context, state, actions);
+}
+
 /// [StoreConnector] is a widget that rebuilds when the redux store
 /// has triggered and the connect function yields a new result.
 /// [StoreState] is the generic type of your built_redux store's state object
@@ -93,7 +137,7 @@ class _StoreConnectorState<StoreState, Actions extends ReduxActions, LocalState>
 
   @override
   Widget build(BuildContext context) =>
-      widget.build(context, _state, _store.actions);
+      widget.build(context, _state, _store.actions as Actions);
 }
 
 /// [ReduxProvider] provides access to the redux store to descendant widgets.

lib/flutter_built_redux.dart

@@ -1,7 +1,7 @@
 # Important: Use "flutter packages get", not "pub get".
 name: flutter_built_redux
 author: David Marne <[email protected]>
-version: 0.4.3
+version: 0.4.4
 description: Built_redux provider for Flutter
 homepage: https://github.com/davidmarne/flutter_built_redux
 dependencies: