[Dependencies] Update Router to Work with ReSwift 0.2.4

- Also add a Changelog

Author: Ben-G

Changelog.md

@@ -0,0 +1,12 @@
+#Upcoming Release
+
+#0.2.4
+
+*Released: 01/23/2015*
+
+**Other:**
+
+- Due to the new requirement in ReSwift, that top level reducers need to be able to take an empty application state and return a hydrated one, `NavigationReducer` is no longer a top-level reducer. You now need to call it from within your app reducer. Refer to the docs for more details. - @Ben-G
+- Drop iOS Deployment target to 8.0 - @Ben-G
+- Add Support for watchOS, tvOS, OSX - @Ben-G
+- Documentation updates - @Ben-G

README.md

@@ -63,7 +63,22 @@ After you've initialized your store, create an instance of `Router`, passing in
 router = Router(store: mainStore, rootRoutable: RootRoutable(routable: rootViewController))
 ```
 
-We'll discuss `Routable` in the next section.
+We'll discuss `Routable` in the next main section.
+
+##Calling the Navigation Reducer
+
+The `NavigationReducer` is provided as part of `ReSwiftRouter`. You need to call it from within your top-level reducer. Here's a simple example from the specs:
+
+```swift
+struct AppReducer: Reducer {
+    func handleAction(action: Action, state: FakeAppState?) -> FakeAppState {
+        return FakeAppState(
+            navigationState: NavigationReducer.handleAction(action, state: state?.navigationState)
+        )
+    }
+}
+```
+This will reducer will handle all routing relevant actions.
 
 #Implementing `Routable`
 

ReSwiftRouter/NavigationReducer.swift

@@ -8,11 +8,17 @@
 
 import ReSwift
 
-public struct NavigationReducer: Reducer {
+/** 
+ The Navigation Reducer handles the state slice concerned with storing the current navigation
+ information. Note, that this reducer is **not** a *top-level* reducer, you need to use it within
+ another reducer and pass in the relevant state slice. Take a look at the specs to see an
+ example set up. 
+ */
+public struct NavigationReducer {
 
-    public init() {}
+    public static func handleAction(action: Action, state: NavigationState?) -> NavigationState {
+        let state = state ?? NavigationState()
 
-    public func handleAction(state: HasNavigationState, action: Action) -> HasNavigationState {
         switch action {
         case let action as SetRouteAction:
             return setRoute(state, route: action.route)
@@ -23,10 +29,10 @@ public struct NavigationReducer: Reducer {
         return state
     }
 
-    func setRoute(var state: HasNavigationState, route: [RouteElementIdentifier]) -> HasNavigationState {
-        state.navigationState.route = route
+    static func setRoute(var state: NavigationState, route: [RouteElementIdentifier]) -> NavigationState {
+        state.route = route
 
         return state
     }
 
-}
+}

ReSwiftRouter/NavigationState.swift

@@ -19,4 +19,4 @@ public struct NavigationState {
 
 public protocol HasNavigationState {
     var navigationState: NavigationState { get set }
-}
+}

ReSwiftRouter/Router.swift

@@ -11,12 +11,12 @@ import ReSwift
 
 public class Router<State: StateType>: StoreSubscriber {
 
-    var store: MainStore<State>
+    var store: Store<State>
     var lastNavigationState = NavigationState()
     var routables: [Routable] = []
     let waitForRoutingCompletionQueue = dispatch_queue_create("WaitForRoutingCompletionQueue", nil)
 
-    public init(store: MainStore<State>, rootRoutable: Routable) {
+    public init(store: Store<State>, rootRoutable: Routable) {
         self.store = store
         self.routables.append(rootRoutable)
 

ReSwiftRouterTests/ReSwiftRouterIntegrationTests.swift

@@ -39,8 +39,16 @@ struct FakeAppState: StateType, HasNavigationState {
 }
 
 class FakeReducer: Reducer {
-    func handleAction(state: FakeAppState, action: Action) -> FakeAppState {
-        return state
+    func handleAction(action: Action, state: FakeAppState?) -> FakeAppState {
+        return state ?? FakeAppState()
+    }
+}
+
+struct AppReducer: Reducer {
+    func handleAction(action: Action, state: FakeAppState?) -> FakeAppState {
+        return FakeAppState(
+            navigationState: NavigationReducer.handleAction(action, state: state?.navigationState)
+        )
     }
 }
 
@@ -50,10 +58,10 @@ class SwiftFlowRouterIntegrationTests: QuickSpec {
 
         describe("routing calls") {
 
-            var store: MainStore<FakeAppState>!
+            var store: Store<FakeAppState>!
 
             beforeEach {
-                store = MainStore(reducer: CombinedReducer([NavigationReducer()]), state: FakeAppState())
+                store = Store(reducer: CombinedReducer([AppReducer()]), state: FakeAppState())
             }
 
             describe("setup") {