Merge pull request #11 from davidmarne/1.0.0

1.0.0

Author: davidmarne

Diff for: .gitignore

@@ -2,6 +2,7 @@
 packages
 .packages
 .dart_tool
+pubspec.lock
 
 example/.pub
 example/packages

Diff for: .travis.yml

@@ -4,6 +4,7 @@ dart:
 script:
   - pub run dart_dev format --check
   - pub run dart_dev analyze
+  - dart tool/build.dart
   - pub run dart_dev test
   - pub run dart_dev coverage --no-html
   - bash <(curl -s https://codecov.io/bash) -f coverage/coverage.lcov

Diff for: README.md

@@ -4,12 +4,21 @@
 ### built_redux
 
 built_redux is a state management library written in dart that enforces immutability.
-built_redux stores can be built with middleware and nested reducers
+built_redux stores can be built with middleware and nested reducers.
 
 Inspired by [redux][redux_git]
 
 Built using [built_value][built_value_git]
 
+### Framework bindings & examples
+
+[react-dart][react-dart]
+
+[flutter][flutter]
+
+[angular2][angular2]
+
+
 ### Using it in your project
 
 > __If you are not familiar with Redux or built_value__
@@ -24,7 +33,7 @@ Built using [built_value][built_value_git]
 
     ```yaml
     dependencies:
-      built_redux: "^0.1.0"
+      built_redux: "^1.0.0"
     ```
 
 2. Create a script to run generators for generating built_values and additional built_redux classes.
@@ -54,13 +63,11 @@ Built using [built_value][built_value_git]
 ```
 import 'package:built_redux/built_redux.dart';
 
-/**
- * This is a an implementation of ReduxActions. Actions are middleware and ui
- * components invoke a change to the redux store's state. By extending ReduxActions
- * the built_redux generator will generate the required boilerplate to create
- * each action and an ActionNames class.
- */
- abstract class CounterActions extends ReduxActions {
+ // This is a an implementation of ReduxActions. Actions are middleware and ui
+ // components invoke a change to the redux store's state. By extending ReduxActions
+ // the built_redux generator will generate the required boilerplate to create
+ // each action and an ActionNames class.
+  abstract class CounterActions extends ReduxActions {
    ActionDispatcher<int> increment;
    ActionDispatcher<int> decrement;
 
@@ -69,12 +76,10 @@ import 'package:built_redux/built_redux.dart';
    factory AppStateActions() => new _$AppStateActions();
  }
 
-/**
- * This is a BuiltReducer. It is essentially an implementation of built_value
- * with one extra getter named reducers. This getter is simply a map from action
- * name to a reducer function.
- */
- abstract class Counter extends BuiltReducer<Counter, CounterBuilder>
+ // This is a BuiltReducer. It is essentially an implementation of built_value
+ // with one extra getter named reducers. This getter is simply a map from action
+ // name to a reducer function.
+  abstract class Counter extends BuiltReducer<Counter, CounterBuilder>
      implements Built<Counter, CounterBuilder> {
    /// [count] value of the counter
    int get count;
@@ -89,41 +94,36 @@ import 'package:built_redux/built_redux.dart';
  }
 
 
-/**
- * These are reducers, a pure function with (state, action, builder) => state signature.
- * It describes how an action transforms the state into the next state.
- * You are required to builder passed, calling state.rebuild will NOT update
- * the state in your redux store.
- */
+// These are reducers, a pure function with (state, action, builder) => state signature.
+// It describes how an action transforms the state into the next state.
+// You are required to builder passed, calling state.rebuild will NOT update
+// the state in your redux store.
 increment(Counter state, Action<int> action, CounterBuilder builder) =>
   builder..count = state.count + action.payload;
 
 decrement(Counter state, Action<int> action, CounterBuilder builder) =>
   builder..count = state.count - action.payload;
 
-/**
- * This is a reducer builder. Use of ReducerBuilder is not required, however it
- * is strongly recommended as it gives you static type checking to make sure
- * the payload for action name provided is the same as the expected payload
- * for the action provided to your reducer. Calling .build() returns the map
- * of action names to reducers.
- */
-var _reducer =  (new ReducerBuilder<Counter, CounterBuilder>()
+ // This is a reducer builder. Use of ReducerBuilder is not required, however it
+ // is strongly recommended as it gives you static type checking to make sure
+ // the payload for action name provided is the same as the expected payload
+ // for the action provided to your reducer. Calling .build() returns the map
+ // of action names to reducers.
+ var _reducer =  (new ReducerBuilder<Counter, CounterBuilder>()
       ..add<int>(CounterActionsNames.increment, increment)
       ..add<int>(CounterActionsNames.decrement, decrement)).build();
 
 // Create a Redux store holding the state of your app.
-// Its API is subscribe, state, actions.
+// Its API contains three getters: stream, state, and actions.
 var store = new Store<Counter, CounterBuilder, CounterActions>(
   new Counter(),
   new CounterActions(),
 );
 
-// You can use subscribe() to update the UI in response to state changes.
-// Normally you'd use a view binding library (e.g. React Redux) rather than subscribe() directly.
+// You can use stream.listen() to update the UI in response to state changes.
+// Normally you'd use a view binding library (e.g. [flutter_built_redux]) rather than stream.listen() directly.
 // However it can also be handy to persist the current state in the localStorage.
-
-store.subscribe((_) =>
+store.stream.listen((_) =>
   print(store.state);
 )
 
@@ -136,27 +136,48 @@ store.actions.decrement(1);
 // 2
 ```
 
+### Nested reducers
+
+Nested reducers can be added to your BuiltReducer. In this example NestedCounter
+is another BuiltReducer. In order for nested reducers to work you must mix in
+{Built reducer name}ReduceChildren just like BaseCounterReduceChildren is below.
+This class will be generated for you by the BuiltReduxGenerator.
+```
+abstract class BaseCounter extends BuiltReducer<BaseCounter, BaseCounterBuilder>
+    with BaseCounterReduceChildren
+    implements Built<BaseCounter, BaseCounterBuilder> {
+  int get count;
+
+  NestedCounter get nestedCounter;
+
+  get reducer => _baseReducer;
+
+  // Built value boilerplate
+  BaseCounter._();
+  factory BaseCounter([updates(BaseCounterBuilder b)]) =>
+      new _$BaseCounter((BaseCounterBuilder b) => b
+        ..count = 1
+        ..nestedCounter = new NestedCounter().toBuilder());
+}
+```
+
 ### Writing middleware
 ```
-/**
- * Actions to be handled by this middleware
- */
-abstract class DoubleAction extends ReduxActions {
+ // Actions to be handled by this middleware
+ abstract class DoubleAction extends ReduxActions {
   ActionDispatcher<int> increment;
 
   DoubleAction._();
   factory DoubleAction() => new _$DoubleAction();
 }
 
-/**
- * This is a middleware builder. Use of MiddlewareBuilder is not required, however
- * just like ReducerBuilder it is strongly recommended as it gives you static type checking to make sure
- * the payload for action name provided is the same as the expected payload
- * for the action provided to your reducer. It will also call next(action) for you
- * if an action not handled by this middlware is received. Calling .build() returns the
- * middleware function that can be passed to your store at instantiation.
- */
-var doubleMiddleware =  (new MiddlwareBuilder<Counter, CounterBuilder, CounterActions>()
+ // This is a middleware builder. Use of MiddlewareBuilder is not required, however
+ // just like ReducerBuilder it is strongly recommended as it gives you static type checking to make sure
+ // the payload for action name provided is the same as the expected payload
+ // for the action provided to your reducer. It will also call next(action) for you
+ // if an action not handled by this middlware is received. Calling .build() returns the
+ // middleware function that can be passed to your store at instantiation.
+ var doubleMiddleware =  (new MiddlwareBuilder<Counter, CounterBuilder, CounterActions>()
       ..add<int>(DoubleActionNames.increment, _doubleIt)).build();
 
 _doubleIt(MiddlewareApi<Counter, CounterBuilder, CounterActions> api, ActionHandler next, Action<int> action) {
@@ -192,7 +213,7 @@ var store = new Store<Counter, CounterBuilder, CounterActions>(
   middleware: [doubleMiddleware],
 );
 
-store.subscribe(() =>
+store.stream.listen((_) =>
   print(store.state);
 )
 
@@ -205,30 +226,6 @@ store.actions.decrement(1);
 // 4
 ```
 
-### Nested reducers
-
-Nested reducers can be added to your BuiltReducer. In this example NestedCounter
-is another BuiltReducer. In order for nested reducers to work you must mix in
-{Built reducer name}ReduceChildren just like BaseCounterReduceChildren is below.
-This class will be generated for you by the BuiltReduxGenerator.
-```
-abstract class BaseCounter extends BuiltReducer<BaseCounter, BaseCounterBuilder>
-    with BaseCounterReduceChildren
-    implements Built<BaseCounter, BaseCounterBuilder> {
-  int get count;
-
-  NestedCounter get nestedCounter;
-
-  get reducer => _baseReducer;
-
-  // Built value boilerplate
-  BaseCounter._();
-  factory BaseCounter([updates(BaseCounterBuilder b)]) =>
-      new _$BaseCounter((BaseCounterBuilder b) => b
-        ..count = 1
-        ..nestedCounter = new NestedCounter().toBuilder());
-}
-```
 
 [built_value_blog]: https://medium.com/dartlang/darts-built-value-for-immutable-object-models-83e2497922d4
 
@@ -237,3 +234,11 @@ abstract class BaseCounter extends BuiltReducer<BaseCounter, BaseCounterBuilder>
 [redux_git]: https://github.com/reactjs/redux
 
 [redux_docs]: http://redux.js.org/
+
+[react-dart]: https://github.com/davidmarne/react_built_redux
+
+[flutter]: https://github.com/davidmarne/flutter_built_redux
+
+[angular2]: https://github.com/davidmarne/angular_built_redux
+
+[flutter_built_redux]: https://github.com/davidmarne/flutter_built_redux