Merge pull request #1 from ReKotlin/master

Merge from Head Fork

Author: kmmraj

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to ReKotlin-Router
+
+If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request (on a branch other than master or gh-pages).
+
+When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
+
+## License
+
+By contributing your code, you agree to license your contribution under the terms of the MIT : https://github.com/ReKotlin/rekotlin-router/blob/master/LICENSE.md
+
+All files are released with the MIT license.

README.md

@@ -1,4 +1,6 @@
-# ReKotlin-Router [![CircleCI](https://circleci.com/gh/kmmraj/rekotlin-router.svg?style=svg)](https://circleci.com/gh/kmmraj/rekotlin-router)  [![License MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/ReKotlin/rekotlin-router/blob/master/LICENSE.md)
+
+# ReKotlin-Router [![Build Status](https://travis-ci.org/ReKotlin/rekotlin-router.svg?branch=master)](https://travis-ci.org/ReKotlin/rekotlin-router) [![License MIT](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/ReKotlin/rekotlin-router/blob/master/LICENSE.md)
+
 
 A declarative router for [ReKotlin](https://github.com/GeoThings/ReKotlin). Allows developers to declare routes in a similar manner as URLs are used on the web.
 
@@ -195,7 +197,27 @@ For general usage questions please use the [mailing list][list] or [StackOverflo
 
 # Contributing
 
-There's still a lot of work to do here! We would love to see you involved! You can find all the details on how to get started in the [Contributing Guide](/CONTRIBUTING.md).
+There's still a lot of work to do here! We would love to see you involved!
+
+### Submitting patches
+
+The best way to submit a patch is to [fork the project on github](https://help.github.com/articles/fork-a-repo/) then send us a
+[pull request](https://help.github.com/articles/creating-a-pull-request/) via [github](https://github.com).
+
+If you create your own fork, it might help to enable rebase by default
+when you pull by executing
+``` bash
+git config --global pull.rebase true
+```
+This will avoid your local repo having too many merge commits
+which will help keep your pull request simple and easy to apply.
+
+Before submitting the pull request, make sure all existing tests are passing, and add the new test if it is required.
+
+### New functionality
+If you want to add new functionality, please file a new proposal issue first to make sure that it is not in progress already. If you have any questions, feel free to create a question issue.
+
+You can find all the details on how to get started in the [Contributing Guide](/CONTRIBUTING.md).
 
 ## Compiling & Running tests
 

build.gradle

@@ -5,7 +5,6 @@ version '0.1.0-SNAPSHOT'
 
 
 buildscript {
-
     ext {
         kotlin_version = '1.1.50'
         dokka_version = '0.9.15'

rekotlin-router/build.gradle

@@ -9,7 +9,8 @@ apply plugin: 'maven-publish'
 
 
 group 'org.rekotlin-router'
-version '0.1.2'
+version '0.1.6'
+
 
 ext {
     junitPlugin_version = '1.0.0'
@@ -57,8 +58,7 @@ android {
         minSdkVersion 16
         targetSdkVersion 25
         versionCode 1
-        versionName "0.1.2"
-
+        versionName "0.1.6"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
 
     }
@@ -138,15 +138,15 @@ bintray {
     key = System.getenv("bintrayApiKey")
     publications = ['rekotlinRouter']
     pkg {
-        repo = 'rekotlin-router'
-        name = 'rekotlin-router'
+        repo = libraryName
+        name = libraryName
         websiteUrl = siteUrl
         vcsUrl = gitUrl
-        licenses = ["MIT"]
+        licenses = [licenseName]
         publish = true
         version {
             name = android.defaultConfig.versionName
-            desc = 'Redux based declarative routing for Android'
+            desc = libraryDescription
             released  = new Date()
         }
     }

rekotlin-router/src/main/java/org/rekotlinrouter/NavigationReducer.kt

@@ -15,20 +15,20 @@ class NavigationReducer {
     companion object NavRed {
 
         fun handleAction(action: Action, state: NavigationState?): NavigationState {
-            var navigationState = state ?: NavigationState()
+          var navigationState = state ?: NavigationState()
 
-            when(action)  {
-                is SetRouteAction -> {
-                    navigationState = setRoute(navigationState,action)
-                }
-                is SetRouteSpecificData -> {
-                    navigationState = setRouteSpecificData(navigationState, action.route,  action.data)
-                }
-                else -> {
-                    navigationState = NavigationState()
-                }
+          when(action)  {
+            is SetRouteAction -> {
+                navigationState = setRoute(navigationState,action)
             }
-            return navigationState
+            is SetRouteSpecificData -> {
+                navigationState = setRouteSpecificData(navigationState, action.route,  action.data)
+            }
+            else -> {
+                navigationState = NavigationState()
+            }
+          }
+          return navigationState
         }
 
         fun setRoute(state: NavigationState, setRouteAction: SetRouteAction): NavigationState {
@@ -43,10 +43,21 @@ class NavigationReducer {
         fun setRouteSpecificData(state: NavigationState, route: Route, data: Any): NavigationState {
             val routeString = FullRoute(route).routeString
 
-            if (state.routeSpecificState.containsKey(routeString)) {
-                state.routeSpecificState.replace(routeString, data)
-            } else {
-                state.routeSpecificState.put(routeString, data)
+            state.routeSpecificState[routeString] = data
+
+            return state
+        }
+
+        fun reduce(action: Action, oldState: NavigationState?): NavigationState {
+            val state =  oldState ?: NavigationReducer.handleAction(action = action, state = oldState)
+            when (action) {
+                is SetRouteAction -> {
+                    return NavigationReducer.handleAction(action = action, state = state)
+                }
+
+                is SetRouteSpecificData -> {
+                    return NavigationReducer.handleAction(action = action, state = state)
+                }
             }
             return state
         }

rekotlin-router/src/main/java/org/rekotlinrouter/Router.kt

@@ -146,28 +146,28 @@ class Router<routerStateType: StateType> (var store: Store<routerStateType>,
             routeBuildingIndex -= 1
         }
 
+        // This is the 3. case:
+        // "The new route has a different element after the commonSubroute, we need to replace
+        //  the old route element with the new one"
+        if((oldRoute.count() > (commonSubroute + 1))
+                && (newRoute.count() > (commonSubroute + 1))) {
+            val changeAction = change(routableIndexForRouteSegment(commonSubroute),
+                    oldRoute[commonSubroute + 1],
+                    newRoute[commonSubroute + 1])
+
+            routingActions.add(changeAction)
+        }
         // This is the 1. case:
         // "The old route had an element after the commonSubroute and the new route does not
         //  we need to pop the route segment after the commonSubroute"
-        if(oldRoute.count() > newRoute.count()) {
+        else if(oldRoute.count() > newRoute.count()) {
             val popAction = pop(routableIndexForRouteSegment(routeBuildingIndex - 1),
                     oldRoute[routeBuildingIndex])
 
             //routingActions = routingActions.plus(popAction)
             routingActions.add(popAction)
             routeBuildingIndex -= 1
         }
-        // This is the 3. case:
-        // "The new route has a different element after the commonSubroute, we need to replace
-        //  the old route element with the new one"
-        else if((oldRoute.count() > (commonSubroute + 1))
-                && (newRoute.count() > (commonSubroute + 1))) {
-            val changeAction = change(routableIndexForRouteSegment(commonSubroute),
-                    oldRoute[commonSubroute + 1],
-                    newRoute[commonSubroute + 1])
-
-           routingActions.add(changeAction)
-        }
 
         // Push remainder of elements in new Route that weren't in old Route, this covers
         // the 2. case:

rekotlin-router/src/main/res/values/strings.xml

@@ -1,3 +1,2 @@
 <resources>
-    <string name="app_name">rekrouter</string>
 </resources>

rekotlin-router/src/test/java/org/rekotlinrouter/ReKotlinRouterUnitTests.kt

@@ -153,6 +153,43 @@ internal class ReKotlinRouterUnitTests {
         assertThat(new).isEqualTo(statsActivityIdentifier)
     }
 
+    @Test
+   // @DisplayName("generates a pop action followed by a change action on root when whole route changes")
+    fun test_change_action_on_root_when_no_common_subroute() {
+        // Given
+        val oldRoute = arrayListOf(mainActivityIdentifier,counterActivityIdentifier)
+        val newRoute = arrayListOf(statsActivityIdentifier)
+
+        // When
+        val routingActions = Router.routingActionsForTransitionFrom(oldRoute, newRoute)
+
+        // Then
+        var action1Correct: Boolean = false
+        var action2Correct: Boolean = false
+
+        routingActions.forEach { routingAction ->
+            when(routingAction) {
+                is pop -> {
+                    if(routingAction.responsibleRoutableIndex == 1
+                            && routingAction.segmentToBePopped == counterActivityIdentifier){
+                        action1Correct = true
+                    }
+                }
+                is change -> {
+                    if(routingAction.responsibleRoutableIndex == 0
+                            && routingAction.segmentToBeReplaced == mainActivityIdentifier
+                            && routingAction.newSegment == statsActivityIdentifier){
+                        action2Correct = true
+                    }
+                }
+            }
+        }
+
+        assertThat(action1Correct).isTrue()
+        assertThat(action2Correct).isTrue()
+        assertThat(routingActions.count()).isEqualTo(2)
+    }
+
     @Test
    // @DisplayName("calculates no actions for transition from empty route to empty route")
     fun test_no_action_when_transistion_from_empty_to_empty_route(){