Merge pull request #36 from Fueled/add-closeUpto

feat(*): add close upto

Author: Hussein Aladeen

flowr/src/main/java/com/fueled/flowr/Flowr.java

@@ -56,7 +56,6 @@ public class Flowr implements FragmentManager.OnBackStackChangedListener,
 
     private List<FlowrDeepLinkHandler> deepLinkHandlers;
 
-
     /**
      * Constructor to use when creating a new router for an activity
      * that has no toolbar.
@@ -250,10 +249,17 @@ protected final String getTagPrefix() {
         return tagPrefix;
     }
 
-    protected <T extends Fragment & FlowrFragment> void displayFragment(TransactionData<T> data) {
+    /**
+     *
+     * @param data  TransactionData used to configure fragment transaction
+     * @param <T>   type Fragment & FlowrFragment
+     * @return      id Identifier of the committed transaction.
+     */
+    protected <T extends Fragment & FlowrFragment> int displayFragment(TransactionData<T> data) {
+        int identifier = -1;
         try {
             if (screen == null) {
-                return;
+                return identifier;
             }
 
             injectDeepLinkInfo(data);
@@ -282,15 +288,15 @@ protected <T extends Fragment & FlowrFragment> void displayFragment(TransactionD
                 transaction.add(mainContainerId, fragment);
             }
 
-            transaction.commit();
+            identifier = transaction.commit();
 
             if (data.isSkipBackStack()) {
                 setCurrentFragment(fragment);
             }
-
         } catch (Exception e) {
             Log.e(TAG, "Error while displaying fragment.", e);
         }
+        return identifier;
     }
 
     /**
@@ -402,6 +408,26 @@ public void close(int n) {
         }
     }
 
+    /**
+     * Closes the current activity if the fragments back stack is empty,
+     * otherwise pop upto fragments with id Identifier from the stack.
+     *
+     * @param id    Identifier of the committed transaction.
+     */
+    public void closeUpto(int id) {
+        if (screen == null) {
+            return;
+        }
+
+        int count = screen.getScreenFragmentManager().getBackStackEntryCount();
+        if (count > 1) {
+            screen.getScreenFragmentManager()
+                    .popBackStackImmediate(id, FragmentManager.POP_BACK_STACK_INCLUSIVE);
+        } else {
+            close();
+        }
+    }
+
     /**
      * Closes the current activity if the fragments back stack is empty,
      * otherwise pop the top fragment from the stack and publish the results response.
@@ -427,6 +453,21 @@ public void closeWithResults(ResultResponse resultResponse, int n) {
         }
     }
 
+    /**
+     * Closes the current activity if the fragments back stack is empty,
+     * otherwise pop upto fragments with id Identifier from the stack and publish the results response.
+     *
+     * @param resultResponse    the results response to be published
+     * @param id                Identifier of the committed transaction.
+     */
+    public void closeUptoWithResults(ResultResponse resultResponse, int id) {
+        closeUpto(id);
+
+        if (resultResponse != null) {
+            resultPublisher.publishResult(resultResponse);
+        }
+    }
+
     /**
      * Clears the fragments back stack.
      */
@@ -740,9 +781,11 @@ public Builder noTransactionAnimation() {
 
         /**
          * Displays the fragment using this builder configurations.
+         *
+         * @return id Identifier of the committed transaction.
          */
-        public void displayFragment() {
-            Flowr.this.displayFragment(data);
+        public int displayFragment() {
+            return Flowr.this.displayFragment(data);
         }
 
         /**
@@ -752,8 +795,10 @@ public void displayFragment() {
          *                    it will be later used to deliver the results to the correct fragment instance.
          * @param requestCode this code will be returned in {@link ResultResponse} when the fragment is closed,
          *                    and it can be used to identify the request from which the results were returned.
+         *
+         * @return id Identifier of the committed transaction.
          */
-        public void displayFragmentForResults(String fragmentId, int requestCode) {
+        public int displayFragmentForResults(String fragmentId, int requestCode) {
             if (!TextUtils.isEmpty(fragmentId)) {
                 if (data.getArgs() == null) {
                     data.setArgs(new Bundle());
@@ -763,7 +808,7 @@ public void displayFragmentForResults(String fragmentId, int requestCode) {
                         getResultRequestBundle(fragmentId, requestCode));
             }
 
-            Flowr.this.displayFragment(data);
+            return Flowr.this.displayFragment(data);
         }
 
         private Bundle getResultRequestBundle(String fragmentId, int requestCode) {

…led/flowr/sample/CategoriesFragment.java …m/fueled/flowr/sample/FirstFragment.javasample/src/main/java/com/fueled/flowr/sample/CategoriesFragment.java renamed to sample/src/main/java/com/fueled/flowr/sample/FirstFragment.java sample/src/main/java/com/fueled/flowr/sample/CategoriesFragment.java renamed to sample/src/main/java/com/fueled/flowr/sample/FirstFragment.java

@@ -3,31 +3,40 @@
 import android.view.View;
 
 import com.fueled.flowr.NavigationIconType;
+import com.fueled.flowr.annotations.DeepLink;
 import com.fueled.flowr.sample.core.AbstractFragment;
 
 /**
  * Created by [email protected] on 18/05/2017.
  * Copyright (c) 2017 Fueled. All rights reserved.
  */
-public class CategoriesFragment extends AbstractFragment {
+
+@DeepLink(value = "/first")
+public class FirstFragment extends AbstractFragment implements View.OnClickListener {
 
     @Override
     public int getLayoutId() {
-        return R.layout.fragment_categories;
+        return R.layout.fragment_first;
     }
 
     @Override
     protected void setupView(View view) {
-
+        view.findViewById(R.id.add_stack_button).setOnClickListener(this);
     }
 
     @Override
     public String getTitle() {
-        return "Categories Fragment";
+        return "First Fragment";
     }
 
     @Override
     public NavigationIconType getNavigationIconType() {
         return NavigationIconType.HAMBURGER;
     }
+
+    @Override
+    public void onClick(View view) {
+        getFlowr().open("/second")
+                .displayFragmentForResults(HomeFragment.targetFragmentId, HomeFragment.RC_STACK);
+    }
 }

sample/src/main/java/com/fueled/flowr/sample/HomeFragment.java

@@ -1,7 +1,9 @@
 package com.fueled.flowr.sample;
 
 import android.databinding.DataBindingUtil;
+import android.os.Bundle;
 import android.view.View;
+import android.widget.Toast;
 
 import com.fueled.flowr.NavigationIconType;
 import com.fueled.flowr.sample.core.AbstractFragment;
@@ -13,6 +15,10 @@
  */
 public class HomeFragment extends AbstractFragment implements View.OnClickListener {
 
+    public static final int RC_STACK = 101;
+    public static int backStackIdentifier;
+    public static String targetFragmentId;
+
     private FragmentHomeBinding binding;
 
     @Override
@@ -25,6 +31,7 @@ protected void setupView(View view) {
         binding = DataBindingUtil.bind(view);
         binding.homeOpenViewButton.setOnClickListener(this);
         binding.homeOpenLinkButton.setOnClickListener(this);
+        binding.homeOpenFirstButton.setOnClickListener(this);
     }
 
     @Override
@@ -41,8 +48,12 @@ public NavigationIconType getNavigationIconType() {
     public void onClick(View view) {
         if (view.getId() == R.id.home_open_view_button) {
             displayViewFragment();
-        } else {
+        } else if (view.getId() == R.id.home_open_link_button) {
             displayLinkFragment();
+        } else if (view.getId() == R.id.home_open_first_button) {
+            displayFirstFragment();
+        } else {
+
         }
     }
 
@@ -57,4 +68,19 @@ private void displayLinkFragment() {
         getFlowr().open("/hello")
                 .displayFragment();
     }
+
+    private void displayFirstFragment() {
+        targetFragmentId = getFragmentId();
+        backStackIdentifier = getFlowr().open("/first")
+                .displayFragmentForResults(targetFragmentId, RC_STACK);
+    }
+
+    @Override
+    protected void onFragmentResults(int requestCode, int resultCode, Bundle data) {
+        super.onFragmentResults(requestCode, resultCode, data);
+        if (requestCode == RC_STACK && data.containsKey(SecondFragment.RESULT_FROM_SECOND)) {
+            String resultFromStack = data.getString(SecondFragment.RESULT_FROM_SECOND);
+            Toast.makeText(getContext(), resultFromStack, Toast.LENGTH_SHORT).show();
+        }
+    }
 }

sample/src/main/java/com/fueled/flowr/sample/MainActivity.java

@@ -81,7 +81,7 @@ public boolean onNavigationItemSelected(@NonNull MenuItem item) {
                         displayNavigationScreen(HomeFragment.class);
                         break;
                     case R.id.navigation_menu_categories:
-                        displayNavigationScreen(CategoriesFragment.class);
+                        displayNavigationScreen(FirstFragment.class);
                         break;
                     default:
                         break;

sample/src/main/java/com/fueled/flowr/sample/SecondFragment.java

@@ -0,0 +1,56 @@
+package com.fueled.flowr.sample;
+
+import android.app.Activity;
+import android.os.Bundle;
+import android.support.annotation.NonNull;
+import android.view.View;
+
+import com.fueled.flowr.Flowr;
+import com.fueled.flowr.NavigationIconType;
+import com.fueled.flowr.annotations.DeepLink;
+import com.fueled.flowr.sample.core.AbstractFragment;
+
+/**
+ * Created by [email protected] on 18/05/2017.
+ * Copyright (c) 2017 Fueled. All rights reserved.
+ */
+
+@DeepLink(value = "/second")
+public class SecondFragment extends AbstractFragment implements View.OnClickListener {
+
+    public static final String RESULT_FROM_SECOND = "RESULT_FROM_SECOND";
+
+    @Override
+    public int getLayoutId() {
+        return R.layout.fragment_stack2;
+    }
+
+    @Override
+    protected void setupView(View view) {
+        view.findViewById(R.id.return_home_button).setOnClickListener(this);
+    }
+
+    @Override
+    public String getTitle() {
+        return "Second Fragment";
+    }
+
+    @Override
+    public NavigationIconType getNavigationIconType() {
+        return NavigationIconType.HAMBURGER;
+    }
+
+    @Override
+    public void onClick(View view) {
+        getFlowr().closeUptoWithResults(
+                Flowr.getResultsResponse(getArguments(), Activity.RESULT_OK, getBundle()),
+                HomeFragment.backStackIdentifier);
+    }
+
+    @NonNull
+    private Bundle getBundle() {
+        Bundle args = new Bundle();
+        args.putString(RESULT_FROM_SECOND, "Wow! Whata Stack!");
+        return args;
+    }
+}

sample/src/main/java/com/fueled/flowr/sample/core/FragmentResultPublisherImpl.java

@@ -25,7 +25,7 @@ private FragmentResultPublisherImpl() {
 
     @Override
     public void publishResult(ResultResponse resultResponse) {
-
+        publishSubject.onNext(resultResponse);
     }
 
     public Disposable observeResultsForFragment(final String fragmentId, Consumer<ResultResponse> consumer) {
@@ -52,5 +52,4 @@ public static FragmentResultPublisherImpl getInstance() {
 
         return instance;
     }
-
 }

…/main/res/layout/fragment_categories.xml …e/src/main/res/layout/fragment_first.xmlsample/src/main/res/layout/fragment_categories.xml renamed to sample/src/main/res/layout/fragment_first.xml sample/src/main/res/layout/fragment_categories.xml renamed to sample/src/main/res/layout/fragment_first.xml

@@ -5,10 +5,11 @@
               android:background="#FFFFFF"
               android:orientation="vertical">
 
-    <TextView
+    <Button
+        android:id="@+id/add_stack_button"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
         android:layout_gravity="center"
-        android:text="@string/categories_message"/>
+        android:text="@string/first_message"/>
 
 </FrameLayout>

sample/src/main/res/layout/fragment_home.xml

@@ -22,6 +22,13 @@
             android:layout_marginTop="10dp"
             android:text="@string/open_link_fragment"/>
 
+        <Button
+            android:id="@+id/home_open_first_button"
+            android:layout_width="wrap_content"
+            android:layout_height="wrap_content"
+            android:layout_marginTop="10dp"
+            android:text="@string/open_first_fragment"/>
+
     </LinearLayout>
 
 </layout>

sample/src/main/res/layout/fragment_stack2.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
+              android:layout_width="match_parent"
+              android:layout_height="match_parent"
+              android:background="#FFFFFF"
+              android:orientation="vertical">
+
+    <Button
+        android:id="@+id/return_home_button"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content"
+        android:layout_gravity="center"
+        android:text="@string/second_message"/>
+
+</FrameLayout>

sample/src/main/res/values/strings.xml

@@ -9,9 +9,12 @@
     <!-- Home Fragment -->
     <string name="open_view_fragment">Open View Fragment</string>
     <string name="open_link_fragment">Open Link Fragment</string>
+    <string name="open_first_fragment">Open First Fragment</string>
 
     <!-- Categories Fragment -->
     <string name="categories_message">Categories Fragment!</string>
+    <string name="first_message">Open Second Fragment</string>
+    <string name="second_message">Return to Home Fragment</string>
 
     <!-- View Fragment -->
     <string name="view_pick_nav_color">Pick Navigation Bar Color</string>