Add more constructors

Change-Id: I5778ad28795bb97a56ff04aa70f53e3d553bbefb

Author: samtstern

app/build.gradle

@@ -48,6 +48,9 @@ dependencies {
     compile('com.facebook.android:facebook-android-sdk:4.25.0')
     compile("com.twitter.sdk.android:twitter-core:3.0.0@aar") { transitive = true }
 
+    compile "android.arch.lifecycle:runtime:$architectureVersion"
+    compile "android.arch.lifecycle:extensions:$architectureVersion"
+
     // The following dependencies are not required to use the Firebase UI library.
     // They are used to make some aspects of the demo app implementation simpler for
     // demonstrative purposes, and you may find them useful in your own apps; YMMV.

common/src/main/java/com/firebase/ui/common/BaseCachingSnapshotParser.java

@@ -15,7 +15,6 @@ public abstract class BaseCachingSnapshotParser<S, T> implements BaseSnapshotPar
     private Map<String, T> mObjectCache = new HashMap<>();
     private BaseSnapshotParser<S, T> mInnerParser;
 
-    // TODO(samstern): Can probably use this in RTDB module as well, CachingOSA is not necessary.
     public BaseCachingSnapshotParser(BaseSnapshotParser<S, T> innerParser) {
         mInnerParser = innerParser;
     }

constants.gradle

@@ -12,4 +12,5 @@ project.ext {
 
     firebaseVersion = '11.0.8'
     supportLibraryVersion = '26.0.1'
+    architectureVersion = '1.0.0-alpha8'
 }

database/build.gradle

@@ -29,9 +29,9 @@ dependencies {
     // Needed to override play services
     compile "com.android.support:support-v4:$supportLibraryVersion"
 
-    compile 'android.arch.lifecycle:runtime:1.0.0-alpha8'
-    compile 'android.arch.lifecycle:extensions:1.0.0-alpha8'
-    annotationProcessor 'android.arch.lifecycle:compiler:1.0.0-alpha8'
+    compile "android.arch.lifecycle:runtime:$architectureVersion"
+    compile "android.arch.lifecycle:extensions:$architectureVersion"
+    annotationProcessor "android.arch.lifecycle:compiler:$architectureVersion"
 
     compile "com.google.firebase:firebase-database:$firebaseVersion"
 

firestore/build.gradle

@@ -31,7 +31,11 @@ dependencies {
 
     compile "com.google.firebase:firebase-firestore:$firebaseVersion"
 
+    compile "android.arch.lifecycle:runtime:$architectureVersion"
+    compile "android.arch.lifecycle:extensions:$architectureVersion"
+    annotationProcessor "android.arch.lifecycle:compiler:$architectureVersion"
+
     androidTestCompile 'junit:junit:4.12'
-    androidTestCompile 'com.android.support.test:runner:0.5'
-    androidTestCompile 'com.android.support.test:rules:0.5'
+    androidTestCompile 'com.android.support.test:runner:1.0.0'
+    androidTestCompile 'com.android.support.test:rules:1.0.0'
 }

firestore/src/main/java/com/firebase/ui/firestore/FirestoreRecyclerAdapter.java

@@ -1,6 +1,12 @@
 package com.firebase.ui.firestore;
 
+import android.arch.lifecycle.Lifecycle;
+import android.arch.lifecycle.LifecycleObserver;
+import android.arch.lifecycle.LifecycleOwner;
+import android.arch.lifecycle.OnLifecycleEvent;
+import android.support.annotation.Nullable;
 import android.support.v7.widget.RecyclerView;
+import android.util.Log;
 
 import com.firebase.ui.common.ChangeEventType;
 import com.google.firebase.firestore.DocumentSnapshot;
@@ -14,22 +20,102 @@
  * @param <VH> viewholder class.
  */
 public abstract class FirestoreRecyclerAdapter<T, VH extends RecyclerView.ViewHolder>
-        extends RecyclerView.Adapter<VH> implements ChangeEventListener {
+        extends RecyclerView.Adapter<VH>
+        implements ChangeEventListener, LifecycleObserver {
+
+    private static final String TAG = "FirestoreRecycler";
 
     private ObservableSnapshotArray<T> mArray;
 
+    /**
+     * Create a new RecyclerView adapter to bind data from a Firestore query where each
+     * {@link DocumentSnapshot} is converted to the specified model class.
+     *
+     * See {@link #FirestoreRecyclerAdapter(ObservableSnapshotArray, LifecycleOwner)}.
+     *
+     * @param query the Firestore query.
+     * @param modelClass the model class.
+     */
     public FirestoreRecyclerAdapter(Query query, Class<T> modelClass) {
+        this(query, modelClass, null);
+    }
+
+    /**
+     * Create a new RecyclerView adapter bound to a LifecycleOwner.
+     *
+     * See {@link #FirestoreRecyclerAdapter(Query, Class)}
+     */
+    public FirestoreRecyclerAdapter(Query query, Class<T> modelClass, LifecycleOwner owner) {
         mArray = new FirestoreArray<>(query, modelClass);
+        if (owner != null) {
+            owner.getLifecycle().addObserver(this);
+        }
     }
 
-    public abstract void onBindViewHolder(VH vh, int i, T model);
+    /**
+     * Create a new RecyclerView adapter to bind data from a Firestore query where each
+     * {@link DocumentSnapshot} is parsed by the specified parser.
+     *
+     * See {@link #FirestoreRecyclerAdapter(ObservableSnapshotArray, LifecycleOwner)}.
+     *
+     * @param query the Firestore query.
+     * @param parser the snapshot parser.
+     */
+    public FirestoreRecyclerAdapter(Query query, SnapshotParser<T> parser) {
+        this(query, parser, null);
+    }
+
+    /**
+     * Create a new RecyclerView adapter bound to a LifecycleOwner.
+     *
+     * See {@link #FirestoreRecyclerAdapter(Query, SnapshotParser)}.
+     */
+    public FirestoreRecyclerAdapter(Query query, SnapshotParser<T> parser, LifecycleOwner owner) {
+        mArray = new FirestoreArray<T>(query, parser);
+        if (owner != null) {
+            owner.getLifecycle().addObserver(this);
+        }
+    }
 
+    /**
+     * Create a new RecyclerView adapter to bind data from an {@link ObservableSnapshotArray}.
+     *
+     * @param array the observable array of data from Firestore.
+     * @param owner (optional) a LifecycleOwner to observe.
+     */
+    public FirestoreRecyclerAdapter(ObservableSnapshotArray<T> array,
+                                    @Nullable LifecycleOwner owner) {
+        mArray = array;
+        if (owner != null) {
+            owner.getLifecycle().addObserver(this);
+        }
+    }
+
+    /**
+     * Called when data has been added/changed and an item needs to be displayed.
+     *
+     * @param vh the view to populate.
+     * @param i the position in the list of the view being populated.
+     * @param model the model object containing the data that should be used to populate the view.
+     */
+    protected abstract void onBindViewHolder(VH vh, int i, T model);
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_START)
     public void startListening() {
-        mArray.addChangeEventListener(this);
+        if (!mArray.isListening(this)) {
+            mArray.addChangeEventListener(this);
+        }
     }
 
+    @OnLifecycleEvent(Lifecycle.Event.ON_STOP)
     public void stopListening() {
         mArray.removeChangeEventListener(this);
+        notifyDataSetChanged();
+    }
+
+    @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
+    void cleanup(LifecycleOwner source) {
+        source.getLifecycle().removeObserver(this);
     }
 
     @Override
@@ -64,11 +150,10 @@ public void onChildChanged(ChangeEventType type, DocumentSnapshot snapshot,
 
     @Override
     public void onDataChanged() {
-        // No-op
     }
 
     @Override
     public void onError(FirebaseFirestoreException e) {
-        // No-op
+        Log.w(TAG, "onError", e);
     }
 }