Handle place picker dialog on configuration change (#334)

* Handle place picker dialog on configuration change

* Javadoc

* Update support repo version number for caching on Circle CI

* Rename `ARG_NAME_TITLE` to `ARG_NAME_MESSAGE` for clarity

* Change `title` to `message` in local var

Author: ecgreb

circle.yml

@@ -21,7 +21,7 @@ dependencies:
   pre:
     - if [ ! -e /usr/local/android-sdk-linux/build-tools/25.0.2 ]; then echo y | android update sdk --all --no-ui --filter "build-tools-25.0.2"; fi;
     - if [ ! -e /usr/local/android-sdk-linux/platforms/android-25 ]; then echo y | android update sdk --all --no-ui --filter "android-25"; fi;
-    - if ! $(grep -q "Revision=43.0.0" /usr/local/android-sdk-linux/extras/android/m2repository/source.properties); then echo y | android update sdk --all --no-ui --filter "extra-android-m2repository"; fi;
+    - if ! $(grep -q "Revision=45.0.0" /usr/local/android-sdk-linux/extras/android/m2repository/source.properties); then echo y | android update sdk --all --no-ui --filter "extra-android-m2repository"; fi;
   cache_directories:
     - /usr/local/android-sdk-linux/build-tools/25.0.2
     - /usr/local/android-sdk-linux/platforms/android-25

mapzen-places-api/src/main/java/com/mapzen/places/api/internal/PlaceDialogFragment.java

@@ -0,0 +1,92 @@
+package com.mapzen.places.api.internal;
+
+import com.mapzen.places.api.R;
+
+import android.app.AlertDialog;
+import android.app.Dialog;
+import android.app.DialogFragment;
+import android.content.DialogInterface;
+import android.os.Bundle;
+
+/**
+ * Confirmation dialog shown to the user when a POI has been selected.
+ */
+public class PlaceDialogFragment extends DialogFragment implements DialogInterface.OnClickListener {
+  public static final String TAG = PlaceDialogFragment.class.getSimpleName();
+
+  private static final String ARG_NAME_MESSAGE = "message";
+
+  private AlertDialog dialog;
+  private PlaceDialogListener listener;
+
+  /**
+   * Create new instance of the dialog fragment.
+   *
+   * @param message text to be displayed in the dialog.
+   * @return a new instance of the dialog fragment.
+   */
+  public static PlaceDialogFragment newInstance(String message) {
+    final PlaceDialogFragment fragment = new PlaceDialogFragment();
+    Bundle args = new Bundle();
+    args.putString(ARG_NAME_MESSAGE, message);
+    fragment.setArguments(args);
+    return fragment;
+  }
+
+  @Override public Dialog onCreateDialog(Bundle savedInstanceState) {
+    final String message = getArguments().getString(ARG_NAME_MESSAGE);
+    dialog = new AlertDialog.Builder(getActivity())
+        .setTitle(R.string.use_this_place)
+        .setMessage(message)
+        .setNegativeButton(R.string.change_location, this)
+        .setPositiveButton(R.string.select, this)
+        .create();
+    return dialog;
+  }
+
+  /**
+   * Update text displayed in the dialog.
+   *
+   * @param detail new text to display.
+   */
+  public void setMessage(String detail) {
+    dialog.setMessage(detail);
+    getArguments().putString(ARG_NAME_MESSAGE, detail);
+  }
+
+  @Override public void onClick(DialogInterface dialog, int which) {
+    if (listener == null) {
+      return;
+    }
+
+    if (which == DialogInterface.BUTTON_POSITIVE) {
+      listener.onPlaceConfirmed();
+    } else {
+      listener.onPlaceDismissed();
+    }
+  }
+
+  /**
+   * Set place dialog listener.
+   *
+   * @param listener the callbacks to invoke when the dialog is confirmed or dismissed.
+   */
+  public void setListener(PlaceDialogListener listener) {
+    this.listener = listener;
+  }
+
+  /**
+   * Dialog listener interface.
+   */
+  public interface PlaceDialogListener {
+    /**
+     * Positive button click listener.
+     */
+    void onPlaceConfirmed();
+
+    /**
+     * Negative button click listener.
+     */
+    void onPlaceDismissed();
+  }
+}

mapzen-places-api/src/main/java/com/mapzen/places/api/internal/PlacePickerActivity.java

@@ -14,8 +14,6 @@
 import com.mapzen.tangram.LngLat;
 
 import android.app.Activity;
-import android.app.AlertDialog;
-import android.content.DialogInterface;
 import android.content.Intent;
 import android.graphics.Point;
 import android.graphics.PointF;
@@ -30,13 +28,13 @@
  */
 public class PlacePickerActivity extends Activity implements
     PlacePickerViewController, OnMapReadyCallback, LabelPickListener,
-    DialogInterface.OnClickListener {
+    PlaceDialogFragment.PlaceDialogListener {
 
   PlacePickerPresenter presenter;
   PlaceAutocompleteView autocompleteView;
   MapView mapView;
   MapzenMap map;
-  AlertDialog dialog;
+  PlaceDialogFragment dialog;
   String dialogPlaceId;
 
   private boolean mapInitComplete = false;
@@ -61,6 +59,12 @@ public class PlacePickerActivity extends Activity implements
 
     mapView = (MapView) findViewById(R.id.mz_map_view);
     mapView.getMapAsync(this);
+
+    final PlaceDialogFragment fragment =
+        (PlaceDialogFragment) getFragmentManager().findFragmentByTag(PlaceDialogFragment.TAG);
+    if (fragment != null) {
+      fragment.setListener(this);
+    }
   }
 
   @Override protected void onPause() {
@@ -101,14 +105,10 @@ public class PlacePickerActivity extends Activity implements
   }
 
   @Override public void showDialog(String id, String title) {
-    dialog = new AlertDialog.Builder(this)
-        .setTitle(R.string.use_this_place)
-        .setMessage(title)
-        .setNegativeButton(R.string.change_location, this)
-        .setPositiveButton(R.string.select, this)
-        .create();
-    dialog.show();
+    dialog = PlaceDialogFragment.newInstance(title);
+    dialog.show(getFragmentManager(), PlaceDialogFragment.TAG);
     dialogPlaceId = id;
+    dialog.setListener(this);
   }
 
   @Override public void updateDialog(String id, String detail) {
@@ -117,10 +117,12 @@ public class PlacePickerActivity extends Activity implements
     }
   }
 
-  @Override public void onClick(DialogInterface dialogInterface, int i) {
-    if (i == DialogInterface.BUTTON_POSITIVE) {
-      presenter.onPlaceConfirmed();
-    }
+  @Override public void onPlaceConfirmed() {
+    presenter.onPlaceConfirmed();
+    dialogPlaceId = null;
+  }
+
+  @Override public void onPlaceDismissed() {
     dialogPlaceId = null;
   }
 

mapzen-places-api/src/main/java/com/mapzen/places/api/internal/PlacePickerPresenterImpl.java

@@ -15,9 +15,8 @@ class PlacePickerPresenterImpl implements PlacePickerPresenter {
   private static final String PROPERTY_ID = "id";
   private static final String PROPERTY_NAME = "name";
 
-  PlacePickerViewController controller;
-  PlaceDetailFetcher detailFetcher;
-  Place place;
+  private PlacePickerViewController controller;
+  private PlaceDetailFetcher detailFetcher;
 
   /**
    * Construct a new object.
@@ -36,7 +35,7 @@ class PlacePickerPresenterImpl implements PlacePickerPresenter {
 
     detailFetcher.fetchDetails(properties, new OnPlaceDetailsFetchedListener() {
       @Override public void onFetchSuccess(Place place, String details) {
-        PlacePickerPresenterImpl.this.place = place;
+        PlaceStore.instance().setCurrentSelectedPlace(place);
         controller.updateDialog(id, details);
       }
 
@@ -49,11 +48,11 @@ class PlacePickerPresenterImpl implements PlacePickerPresenter {
   }
 
   @Override public void onPlaceConfirmed() {
-    controller.finishWithPlace(place);
+    controller.finishWithPlace(PlaceStore.instance().getCurrentSelectedPlace());
   }
 
   @Override public void onAutocompletePlacePicked(Place place, String details) {
-    this.place = place;
+    PlaceStore.instance().setCurrentSelectedPlace(place);
     controller.showDialog(place.getId(), details);
     //TODO:dialog change location should bring back autocomplete ui
     //TODO:hide map ui and just have dialog visible

mapzen-places-api/src/main/java/com/mapzen/places/api/internal/PlaceStore.java

@@ -0,0 +1,32 @@
+package com.mapzen.places.api.internal;
+
+import com.mapzen.places.api.Place;
+
+/**
+ * In-memory store used to persist data for currently selected place.
+ */
+public class PlaceStore {
+  private static PlaceStore instance = new PlaceStore();
+
+  /**
+   * Return place store singleton instance.
+   *
+   * @return the place store instance.
+   */
+  public static PlaceStore instance() {
+    return instance;
+  }
+
+  private PlaceStore() {
+  }
+
+  private Place currentSelectedPlace;
+
+  public Place getCurrentSelectedPlace() {
+    return currentSelectedPlace;
+  }
+
+  public void setCurrentSelectedPlace(Place currentSelectedPlace) {
+    this.currentSelectedPlace = currentSelectedPlace;
+  }
+}

mapzen-places-api/src/test/java/com/mapzen/places/api/internal/PlacePickerPresenterTest.java

@@ -39,6 +39,15 @@ public class PlacePickerPresenterTest {
     assertThat(controller.dialogShown).isTrue();
   }
 
+  @Test public void onAutocompletePlacePicked_shouldPersistPlaceOnRotation() throws Exception {
+    Place place = new PlaceImpl.Builder().build();
+    presenter.onAutocompletePlacePicked(place, "details");
+    presenter = new PlacePickerPresenterImpl(new TestPlaceDetailFetcher());
+    presenter.setController(controller);
+    presenter.onPlaceConfirmed();
+    assertThat(controller.place).isEqualTo(place);
+  }
+
   @Test public void onHideView_shouldDisableLocationServices() throws Exception {
     controller.myLocationEnabled = true;
     presenter.onHideView();

mapzen-places-api/src/test/java/com/mapzen/places/api/internal/TestPlacePickerController.java

@@ -8,6 +8,7 @@ class TestPlacePickerController implements PlacePickerViewController {
   String dialogTitle = null;
   boolean finished = false;
   boolean myLocationEnabled = false;
+  Place place = null;
 
   @Override public void showDialog(String id, String title) {
     dialogShown = true;
@@ -19,6 +20,7 @@ class TestPlacePickerController implements PlacePickerViewController {
   }
 
   @Override public void finishWithPlace(Place place) {
+    this.place = place;
     finished = true;
   }
 

samples/mapzen-places-api-sample/src/main/java/com/mapzen/places/api/sample/PlacePickerDemoActivity.java

@@ -23,9 +23,10 @@ public class PlacePickerDemoActivity extends AppCompatActivity {
 
   private static final int PERMISSIONS_REQUEST_CODE = 1;
   private static final int NUMBER_OF_PERMISSIONS = 1;
-
   private static final int PLACE_PICKER_REQUEST = 1;
 
+  private static boolean isPickingPlace = false;
+
   TextView placeName;
   TextView placeAddress;
   TextView placeAttribution;
@@ -35,7 +36,10 @@ public class PlacePickerDemoActivity extends AppCompatActivity {
     super.onCreate(savedInstanceState);
     setContentView(R.layout.place_picker_demo);
     setupTextViews();
-    safeLaunchPicker();
+
+    if (!isPickingPlace) {
+      safeLaunchPicker();
+    }
   }
 
   @Override public void onRequestPermissionsResult(int requestCode, String[] permissions,
@@ -57,6 +61,7 @@ public class PlacePickerDemoActivity extends AppCompatActivity {
 
   @Override protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     super.onActivityResult(requestCode, resultCode, data);
+    isPickingPlace = false;
 
     if (requestCode == PLACE_PICKER_REQUEST && resultCode == RESULT_OK) {
       Place place = PlacePicker.getPlace(this, data);
@@ -111,6 +116,7 @@ private void launchPlacePicker() {
     Intent intent = new PlacePicker.IntentBuilder()
         .setLatLngBounds(new LatLngBounds(southwest, northeast))
         .build(this);
+    isPickingPlace = true;
     startActivityForResult(intent, PLACE_PICKER_REQUEST);
   }