Merge pull request #4 from davidmarne/better_generic_names

better generic names

Author: davidmarne

example/pubspec.lock

@@ -66,7 +66,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.6"
+    version: "0.1.0"
   built_value:
     description:
       name: built_value

lib/src/action.dart

@@ -9,7 +9,7 @@ class Action<Payload> {
 }
 
 // Dispatches an action to the store
-typedef Dispatcher<P>(Action<P> action);
+typedef void Dispatcher<P>(Action<P> action);
 
 /// [ActionDispatcher] dispatches an action with the name provided
 /// in the constructor and the payload supplied when called. You will notice
@@ -26,13 +26,13 @@ class ActionDispatcher<P> {
 
   String get name => _name;
 
-  call(P payload) => _dispatcher(new Action<P>()
+  void call(P payload) => _dispatcher(new Action<P>()
     ..name = name
     ..payload = payload);
 
   ActionDispatcher(this._name);
 
-  syncWithStore(dispatcher) {
+  void syncWithStore(dispatcher) {
     _dispatcher = dispatcher;
   }
 }
@@ -87,7 +87,7 @@ class ActionDispatcher<P> {
 /// ```
 ///
 abstract class ReduxActions {
-  syncWithStore(dispatcher);
+  void syncWithStore(dispatcher);
 }
 
 /// [ActionName] is an object that simply contains the action name but is typed with a generic that

lib/src/built_reducer.dart

@@ -3,12 +3,13 @@ import 'package:built_value/built_value.dart';
 import 'action.dart';
 import 'typedefs.dart';
 
-abstract class BuiltReducer<V extends Built<V, B>, B extends Builder<V, B>> implements Built<V, B> {
+abstract class BuiltReducer<State extends Built<State, StateBuilder>,
+    StateBuilder extends Builder<State, StateBuilder>> implements Built<State, StateBuilder> {
   /// This is a map, not a single function with switch statement as per js redux implementation.
   /// This is so each reducer can have the action payload generic be a different non dynamic value
-  Map<String, Reducer<dynamic, V, B>> get reducer;
+  Map<String, Reducer<dynamic, State, StateBuilder>> get reducer;
 
-  void reduce(V state, Action<dynamic> a, B builder) {
+  void reduce(State state, Action<dynamic> a, StateBuilder builder) {
     var handler = reducer[a.name];
     // TODO: warn if payload type doesn't match reducer
     if (handler != null) handler(state, a, builder);
@@ -18,17 +19,20 @@ abstract class BuiltReducer<V extends Built<V, B>, B extends Builder<V, B>> impl
 
   /// Generated by the transformer for developer convienience
   /// It will call reduce on any properties of your [BuiltReduer] that are also of type [BuiltReducer]
-  void reduceChildren(V state, Action<dynamic> a, B builder) {}
+  void reduceChildren(State state, Action<dynamic> a, StateBuilder builder) {}
 }
 
 /// [ReducerBuilder] allows you to build a reducer that handles many different actions
 /// with many different payload types, while maintaining type safety.
-/// Each [Reducer] added with add<T> must take a state of type V, an Action of type
+/// Each [Reducer] added with add<T> must take a state of type State, an Action of type
 /// Action<T>, and a builder of type B
-class ReducerBuilder<V extends BuiltReducer<V, B>, B extends Builder<V, B>> {
-  var _map = new Map<String, Reducer<dynamic, V, B>>();
+class ReducerBuilder<State extends BuiltReducer<State, StateBuilder>,
+    StateBuilder extends Builder<State, StateBuilder>> {
+  var _map = new Map<String, Reducer<dynamic, State, StateBuilder>>();
 
-  add<T>(ActionName<T> aName, Reducer<T, V, B> reducer) => _map[aName.name] = reducer;
+  void add<Payload>(ActionName<Payload> aName, Reducer<Payload, State, StateBuilder> reducer) {
+    _map[aName.name] = reducer;
+  }
 
-  build() => _map;
+  Map<String, Reducer<dynamic, State, StateBuilder>> build() => _map;
 }

lib/src/middleware.dart

@@ -27,11 +27,12 @@ class MiddlwareBuilder<State extends BuiltReducer<State, StateBuilder>,
     StateBuilder extends Builder<State, StateBuilder>, Actions extends ReduxActions> {
   var _map = new Map<String, MiddlewareHandler<State, StateBuilder, Actions>>();
 
-  add<T>(ActionName<T> aMgr, MiddlewareHandler<State, StateBuilder, Actions> handler) =>
-      _map[aMgr.name] = handler;
+  void add<T>(ActionName<T> aMgr, MiddlewareHandler<State, StateBuilder, Actions> handler) {
+    _map[aMgr.name] = handler;
+  }
 
   /// build returns a [Middlware] function that handles all actions added with [add]
-  build() =>
+  Middleware<State, StateBuilder, Actions> build() =>
       (MiddlewareApi<State, StateBuilder, Actions> api) => (ActionHandler next) => (Action action) {
             var handler = _map[action.name];
             if (handler != null) {

lib/src/store.dart

@@ -8,29 +8,30 @@ import 'built_reducer.dart';
 import 'middleware.dart';
 import 'typedefs.dart';
 
-// TODO: extend disposable
-class Store<V extends BuiltReducer<V, B>, B extends Builder<V, B>, Actions extends ReduxActions> {
+/// [Store] is the container of your state.
+class Store<State extends BuiltReducer<State, StateBuilder>,
+    StateBuilder extends Builder<State, StateBuilder>, Actions extends ReduxActions> {
   // stream used for dispatching actions
   final StreamController<Action<dynamic>> _dispatch = new StreamController.broadcast();
 
   // stream used to dispatch changes to the state
-  final StreamController<V> _stateController = new StreamController.broadcast();
+  final StreamController<State> _stateController = new StreamController.broadcast();
 
   // the current state
-  V _state;
+  State _state;
   Actions _actions;
 
   Store(
-    V defaultState,
+    State defaultState,
     Actions actions, {
-    Iterable<Middleware<V, B, Actions>> middleware: const [],
+    Iterable<Middleware<State, StateBuilder, Actions>> middleware: const [],
   }) {
     // set the initial state
     _state = defaultState;
     _actions = actions;
     _actions.syncWithStore(_dispatch.add);
 
-    final MiddlewareApi api = new MiddlewareApi<V, B, Actions>(this);
+    final MiddlewareApi api = new MiddlewareApi<State, StateBuilder, Actions>(this);
 
     // setup the middleware dispatch chain
     ActionHandler handler = (action) {
@@ -69,10 +70,10 @@ class Store<V extends BuiltReducer<V, B>, B extends Builder<V, B>, Actions exten
   }
 
   /// [subscribe] returns a stream that will be dispatched whenever the state changes
-  Stream<V> get subscribe => _stateController.stream;
+  Stream<State> get subscribe => _stateController.stream;
 
   /// [state] returns the current state
-  V get state => _state;
+  State get state => _state;
 
   /// [actions] returns the synced actions
   Actions get actions => _actions;

lib/src/typedefs.dart

@@ -6,8 +6,11 @@ import 'middleware.dart';
 
 /// [Reducer] is a function that given a state of type V, an Action of type Action<P>, and a
 /// builder of type B builds the next state
-typedef void Reducer<P, V extends Built<V, B>, B extends Builder<V, B>>(
-    V state, Action<P> action, B builder);
+typedef void Reducer<
+    Payload,
+    State extends Built<State, StateBuilder>,
+    StateBuilder extends Builder<State,
+        StateBuilder>>(State state, Action<Payload> action, StateBuilder builder);
 
 /// [ActionHandler] handles an action, this will contain the actual middleware logic
 typedef ActionHandler(Action a);
@@ -17,5 +20,7 @@ typedef ActionHandler(Action a);
 typedef ActionHandler NextActionHandler(ActionHandler next);
 
 /// [Middleware] is a function that given the store's [MiddlewareApi] returns a [NextActionHandler].
-typedef NextActionHandler Middleware<V extends BuiltReducer<V, B>, B extends Builder<V, B>,
-    Actions extends ReduxActions>(MiddlewareApi<V, B, Actions> api);
+typedef NextActionHandler Middleware<
+    State extends BuiltReducer<State, StateBuilder>,
+    StateBuilder extends Builder<State, StateBuilder>,
+    Actions extends ReduxActions>(MiddlewareApi<State, StateBuilder, Actions> api);

pubspec.yaml

@@ -1,5 +1,5 @@
 name: built_redux
-version: 0.1.0
+version: 0.1.1
 description:
   A state management library written in dart that enforces immutability
 authors: