Merge pull request #53 from brianegan/flutter-team-fixes

Version 4.0.0

Author: brianegan

.travis.yml

@@ -4,6 +4,13 @@ dart:
 - stable
 - dev
 with_content_shell: false
-dart_task:
-- test: --platform vm
-- dartanalyzer: --fatal-warnings lib
+script:
+  - dartanalyzer --fatal-infos --fatal-warnings ./
+  - dartfmt -n ./lib --set-exit-if-changed
+  - pub global activate coverage
+  - pub run test test/redux_test.dart
+  - dart --disable-service-auth-codes --enable-vm-service=8111 --pause-isolates-on-exit test/redux_test.dart &
+  - nohup pub global run coverage:collect_coverage --port=8111 --out=coverage.json --wait-paused --resume-isolates
+  - pub global run coverage:format_coverage --lcov --in=coverage.json --out=lcov.info --packages=.packages --report-on=lib
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

CHANGELOG.md

@@ -1,3 +1,16 @@
+# 4.0.0
+
+  * `dispatch` returns the provided action 
+  * Removed Dart 1.x support
+  * Enforce Pedantic package lint rules
+  * Enforce `public_member_api_docs` lint rule and add docs to missing parts
+  * Update `travis.yml` with support for dartfmt, analysis, and code coverage
+  * Add coverage badge to root README
+  * Pub.dev updates
+    * Longer description
+    * https for package url
+    * update example folder to include README
+
 # 3.0.1
 
   * Update README based on feedback

README.md

@@ -1,18 +1,10 @@
 # redux.dart
 
 [![Build Status](https://api.travis-ci.org/johnpryan/redux.dart.svg?branch=master)](https://travis-ci.org/johnpryan/redux.dart)
+[![codecov](https://codecov.io/gh/johnpryan/redux.dart/branch/master/graph/badge.svg)](https://codecov.io/gh/johnpryan/redux.dart)
 
 [Redux](http://redux.js.org/) for Dart using generics for typed State. It includes a rich ecosystem of [Docs](#docs), [Middleware](#middleware), [Dev Tools](#dev-tools) and can be combined with Flutter using the [flutter_redux](https://pub.dartlang.org/packages/flutter_redux) package.
 
-## Redux 3.0.0 Migration & Dart 2 support
-
-In order to support Dart 2, some of the APIs needed to change. The good news: This actually simplifies Redux! The bad news: you may need to update your projects.
-
-  * Change `ReducerBinding` to `TypedReducer` 
-  * Remove `combineTypedReducer`. Use `combineReducers` with a combination of normal reducers and/or `TypedReducer`s.
-  * Change `MiddlewareBinding` to `TypedMiddleware`.
-  * Remove `combineTypedMiddleware` -- no longer needed! Just create a normal `List<Middleware<State>>`!
-  
 ## Docs
 
   * [Motivation and Principles](https://github.com/johnpryan/redux.dart/blob/master/doc/why.md) - Learn why Redux might make sense for your app and the principles behind it.

analysis_options.yaml

@@ -1,3 +1,5 @@
+include: package:pedantic/analysis_options.yaml
+
 analyzer:
   strong-mode:
     implicit-casts: false
@@ -12,3 +14,4 @@ linter:
     - test_types_in_equals
     - unrelated_type_equality_checks
     - valid_regexps
+    - public_member_api_docs

example/README.md

@@ -0,0 +1,5 @@
+## Examples
+
+* [Counter example](https://github.com/johnpryan/redux.dart/tree/master/example/vanilla_counter) - an example of how to search as a user types, demonstrating both the Middleware and Epic approaches.
+* [Middleware example](https://github.com/johnpryan/redux.dart/tree/master/example/middleware) - an example of how to search as a user types, demonstrating both the Middleware and Epic approaches.
+* [Combining Reducers example](https://github.com/johnpryan/redux.dart/tree/master/example/combined_reducers) - a port of the standard "Counter Button" example from Flutter

example/combined_reducers/index.dart

@@ -28,10 +28,10 @@ enum AppAction { increment, decrement }
 // to a console. For that, use Middleware.
 AppState counterReducer(AppState state, dynamic action) {
   if (action == AppAction.increment) {
-    return new AppState(state.count + 1, state.clickCount);
+    return AppState(state.count + 1, state.clickCount);
   }
   if (action == AppAction.decrement) {
-    return new AppState(state.count - 1, state.clickCount);
+    return AppState(state.count - 1, state.clickCount);
   }
 
   return state;
@@ -41,10 +41,10 @@ AppState counterReducer(AppState state, dynamic action) {
 // can be used for Action and State.
 AppState clickCounterReducer(AppState state, dynamic action) {
   if (action == AppAction.increment) {
-    return new AppState(state.count, state.clickCount + 1);
+    return AppState(state.count, state.clickCount + 1);
   }
   if (action == AppAction.decrement) {
-    return new AppState(state.count, state.clickCount + 1);
+    return AppState(state.count, state.clickCount + 1);
   }
 
   return state;
@@ -56,9 +56,9 @@ void main() {
     counterReducer,
     clickCounterReducer,
   ]);
-  final store = new Store<AppState>(
+  final store = Store<AppState>(
     combined,
-    initialState: new AppState(0, 0),
+    initialState: AppState(0, 0),
   );
 
   render(store.state);
@@ -79,7 +79,7 @@ void main() {
   });
 
   querySelector('#incrementAsync').onClick.listen((_) {
-    new Future<Null>.delayed(new Duration(milliseconds: 1000)).then((_) {
+    Future<Null>.delayed(Duration(milliseconds: 1000)).then((_) {
       store.dispatch(AppAction.increment);
     });
   });

example/index.html

@@ -31,14 +31,14 @@ int counterReducer(int state, dynamic action) {
 // A piece of middleware that will log all actions with a timestamp to your
 // console!
 void loggingMiddleware(Store<int> store, dynamic action, NextDispatcher next) {
-  print('${new DateTime.now()}: $action');
+  print('${DateTime.now()}: $action');
 
   next(action);
 }
 
 void main() {
   // Create a new reducer and store for the app.
-  final store = new Store<int>(
+  final store = Store<int>(
     counterReducer,
     initialState: 0,
     middleware: <Middleware<int>>[loggingMiddleware],
@@ -62,7 +62,7 @@ void main() {
   });
 
   querySelector('#incrementAsync').onClick.listen((_) {
-    new Future<Null>.delayed(new Duration(milliseconds: 1000)).then((_) {
+    Future<Null>.delayed(Duration(milliseconds: 1000)).then((_) {
       store.dispatch(Actions.increment);
     });
   });

example/middleware/index.dart

@@ -30,7 +30,7 @@ int counterReducer(int state, dynamic action) {
 
 void main() {
   // Create a new reducer and store for the app.
-  final store = new Store(counterReducer, initialState: 0);
+  final store = Store(counterReducer, initialState: 0);
 
   render(store.state);
   store.onChange.listen(render);
@@ -50,7 +50,7 @@ void main() {
   });
 
   querySelector('#incrementAsync').onClick.listen((_) {
-    new Future<Null>.delayed(new Duration(milliseconds: 1000)).then((_) {
+    Future<Null>.delayed(Duration(milliseconds: 1000)).then((_) {
       store.dispatch(Actions.increment);
     });
   });

example/vanilla_counter/index.dart

@@ -45,6 +45,8 @@ typedef State Reducer<State>(State state, dynamic action);
 ///
 ///     final store = new Store<int>(new CounterReducer());
 abstract class ReducerClass<State> {
+  /// The [Reducer] function that converts the current state and action into a
+  /// new state
   State call(State state, dynamic action);
 }
 
@@ -98,6 +100,7 @@ typedef void Middleware<State>(
 ///       middleware: [new LoggingMiddleware()],
 ///     );
 abstract class MiddlewareClass<State> {
+  /// A [Middleware] function that intercepts a dispatched action
   void call(Store<State> store, dynamic action, NextDispatcher next);
 }
 
@@ -159,21 +162,35 @@ class Store<State> {
   State _state;
   List<NextDispatcher> _dispatchers;
 
+  /// Creates an instance of a Redux Store.
+  ///
+  /// The [reducer] argument specifies how the state should be changed in
+  /// response to dispatched actions.
+  ///
+  /// The optional [initialState] argument defines the State of the store when
+  /// the Store is first created.
+  ///
+  /// The optional [middleware] argument takes a list of [Middleware] functions
+  /// or [MiddlewareClass]. See the [Middleware] documentation for information
+  /// on how they are used.
+  ///
+  /// The [syncStream] argument allows you to use a synchronous
+  /// [StreamController] instead of an async `StreamController` under the hood.
+  /// By default, the Stream is async.
   Store(
     this.reducer, {
     State initialState,
     List<Middleware<State>> middleware = const [],
-    bool syncStream: false,
+    bool syncStream = false,
 
     /// If set to true, the Store will not emit onChange events if the new State
     /// that is returned from your [reducer] in response to an Action is equal
     /// to the previous state.
     ///
     /// Under the hood, it will use the `==` method from your State class to
     /// determine whether or not the two States are equal.
-    bool distinct: false,
-  })
-      : _changeController = new StreamController.broadcast(sync: syncStream) {
+    bool distinct = false,
+  }) : _changeController = StreamController.broadcast(sync: syncStream) {
     _state = initialState;
     _dispatchers = _createDispatchers(
       middleware,
@@ -246,8 +263,9 @@ class Store<State> {
   /// to the state using the given [Reducer]. Please note: [Middleware] can
   /// intercept actions, and can modify actions or stop them from passing
   /// through to the reducer.
-  void dispatch(dynamic action) {
+  dynamic dispatch(dynamic action) {
     _dispatchers[0](action);
+    return action;
   }
 
   /// Closes down the Store so it will no longer be operational. Only use this