Support for joins (#276)

* Update FirebaseArray to support joined data

* Update FirebaseRecyclerAdapter to support joined data

* Refactor setOnChangedListener

* Update FirebaseListAdapter to support joined data

* Refactor setOnChangedListener

* Update README.md

* Handle key not found at dataRef

* Handle onCancelled

* Handle onCancelled

* Handle onCancelled

* Update FirebaseArray.java

* Update FirebaseArray.java

* Update FirebaseListAdapter.java

* Update FirebaseRecyclerAdapter.java

* Update FirebaseArray.java

* Update FirebaseListAdapter.java

* Log a warning instead of exception if key is missing

* Extract indexed array into separate class

* Fix formatting

* Fix formatting

* Fix formatting

* Refactor adapters

* Fix IndexOutOfBoundsException and list item not being removed

* Make getIndexForKey available to implementations

* Code cleanup and optimizations

* Add copyright

* Update FirebaseRecyclerAdapter.java

* Re-architected IndexFirebaseArray

* Fix Intellij's annoying obsession with putting interfaces at the bottom of a class

* Update IndexFirebaseArray.java

* Fix "key not found" exception when a key from the key ref has a null value in the data ref location.

* Extract FirebaseIndexListAdapter

* Cleanup for final review

* Cleanup for final review

* Update FirebaseArray.java

* Refactoring of IndexFirebaseArray

* Update README.md

* Improved cleanup speed.

* Renames

* Handle case when dataSnapshot value is null

* Update IndexFirebaseArray.java

* Renamed to FirebaseIndexArray

* Cleanup

* Fixed condition in isMatch method

* Tweaks

* Add back supers

* Update FirebaseArray.java

* Make life compile

* Update FirebaseArray.java

* Fix package statements moving around

* Cleanup

* Add clearer error logging

* Updated documentation

* Even clearer

* Relax query requirements and remove unnecessary constructors.

* fix typo

* tests part 1

* test travis should fail

* tests part 2

* Remove unnecessary constructor

* Fix typo

* Fix nits

Author: SUPERCILEX

database/README.md

@@ -269,3 +269,22 @@ recycler.setAdapter(mAdapter);
 ```
 
 Like before, we get a custom RecyclerView populated with data from Firebase by setting the properties to the correct fields.
+
+## Using FirebaseUI with indexed data
+If your data is [properly indexed](https://firebase.google.com/docs/database/android/structure-data#best_practices_for_data_structure), change your adapter initalization like so:
+
+For a `RecyclerView`, use `FirebaseIndexRecyclerAdapter` instead of `FirebaseRecyclerAdapter`:
+```java
+new FirebaseIndexRecyclerAdapter<Chat, ChatHolder>(Chat.class,
+                                                   android.R.layout.two_line_list_item,
+                                                   ChatHolder.class,
+                                                   keyRef, // The Firebase location containing the list of keys to be found in dataRef.
+                                                   dataRef) //The Firebase location to watch for data changes. Each key key found at keyRef's location represents a list item in the RecyclerView.
+```
+
+And for a `ListView`, use `FirebaseIndexListAdapter`;
+```java
+new FirebaseIndexListAdapter<Chat>(this, Chat.class, android.R.layout.two_line_list_item, keyRef, dataRef)
+```
+
+`keyRef` is the location of your keys, and `dataRef` is the location of your data.

database/src/androidTest/java/com/firebase/ui/database/ApplicationTest.java

@@ -18,79 +18,48 @@
 import android.test.InstrumentationTestCase;
 import android.test.suitebuilder.annotation.SmallTest;
 
+import com.firebase.ui.database.utils.Bean;
 import com.google.firebase.FirebaseApp;
-import com.google.firebase.database.DatabaseError;
 import com.google.firebase.database.DatabaseReference;
 import com.google.firebase.database.FirebaseDatabase;
-import com.google.firebase.database.Query;
-
-import junit.framework.AssertionFailedError;
 
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 import java.util.concurrent.Callable;
-import java.util.concurrent.TimeUnit;
+
+import static com.firebase.ui.database.TestUtils.getAppInstance;
+import static com.firebase.ui.database.TestUtils.getBean;
+import static com.firebase.ui.database.TestUtils.runAndWaitUntil;
 
 @RunWith(AndroidJUnit4.class)
 @SmallTest
 public class FirebaseArrayOfObjectsTest extends InstrumentationTestCase {
-    public static class Bean {
-        int number;
-        String text;
-        boolean bool;
-
-        public Bean() {
-            // necessary for Jackson
-        }
-
-        public Bean(int number, String text, boolean bool) {
-            this.number = number;
-            this.text = text;
-            this.bool = bool;
-        }
-        public Bean(int index) {
-            this(index, "Text "+index, index % 2 == 0);
-        }
-
-        public int getNumber() {
-            return number;
-        }
-
-        public String getText() {
-            return text;
-        }
-
-        public boolean isBool() {
-            return bool;
-        }
-    }
-
     private DatabaseReference mRef;
     private FirebaseArray mArray;
 
     @Before
     public void setUp() throws Exception {
-        FirebaseApp app = ApplicationTest.getAppInstance(getInstrumentation().getContext());
+        FirebaseApp app = getAppInstance(getInstrumentation().getContext());
         mRef = FirebaseDatabase.getInstance(app).getReference()
                 .child("firebasearray").child("objects");
         mArray = new FirebaseArray(mRef);
         mRef.removeValue();
-        runAndWaitUntil(mArray, mRef, new Runnable() {
-                    @Override
-                    public void run() {
-                        for (int i = 1; i <= 3; i++) {
-                            mRef.push().setValue(new Bean(i, "Text " + i, i % 2 == 0 ? true : false), i);
+        runAndWaitUntil(mArray, new Runnable() {
+                            @Override
+                            public void run() {
+                                for (int i = 1; i <= 3; i++) {
+                                    mRef.push().setValue(new Bean(i, "Text " + i, i % 2 == 0), i);
+                                }
+                            }
+                        }, new Callable<Boolean>() {
+                            @Override
+                            public Boolean call() throws Exception {
+                                return mArray.getCount() == 3;
+                            }
                         }
-                    }
-                }, new Callable<Boolean>() {
-                    @Override
-                    public Boolean call() throws Exception {
-                        return mArray.getCount() == 3;
-                    }
-                }
         );
     }
 
@@ -113,7 +82,7 @@ public void testSize() throws Exception {
     @Test
     public void testPushIncreasesSize() throws Exception {
         assertEquals(3, mArray.getCount());
-        runAndWaitUntil(mArray, mRef, new Runnable() {
+        runAndWaitUntil(mArray, new Runnable() {
             public void run() {
                 mRef.push().setValue(new Bean(4));
             }
@@ -124,9 +93,10 @@ public Boolean call() throws Exception {
             }
         });
     }
+
     @Test
     public void testPushAppends() throws Exception {
-        runAndWaitUntil(mArray, mRef, new Runnable() {
+        runAndWaitUntil(mArray, new Runnable() {
             public void run() {
                 mRef.push().setValue(new Bean(4), 4);
             }
@@ -140,71 +110,32 @@ public Boolean call() throws Exception {
 
     @Test
     public void testAddValueWithPriority() throws Exception {
-        runAndWaitUntil(mArray, mRef, new Runnable() {
+        runAndWaitUntil(mArray, new Runnable() {
             public void run() {
                 mRef.push().setValue(new Bean(4), 0.5);
             }
         }, new Callable<Boolean>() {
             public Boolean call() throws Exception {
-                return mArray.getItem(3).getValue(Bean.class).getNumber() == 3 && mArray.getItem(0).getValue(Bean.class).getNumber() == 4;
+                return mArray.getItem(3).getValue(Bean.class).getNumber() == 3 && mArray.getItem(0)
+                        .getValue(Bean.class)
+                        .getNumber() == 4;
             }
         });
     }
 
     @Test
     public void testChangePriorities() throws Exception {
-        runAndWaitUntil(mArray, mRef, new Runnable() {
+        runAndWaitUntil(mArray, new Runnable() {
             public void run() {
                 mArray.getItem(2).getRef().setPriority(0.5);
             }
         }, new Callable<Boolean>() {
             public Boolean call() throws Exception {
-                return getBean(mArray, 0).getNumber() == 3 && getBean(mArray, 1).getNumber() == 1 && getBean(mArray, 2).getNumber() == 2;
+                return getBean(mArray, 0).getNumber() == 3
+                        && getBean(mArray, 1).getNumber() == 1
+                        && getBean(mArray, 2).getNumber() == 2;
                 //return isValuesEqual(mArray, new int[]{3, 1, 2});
             }
         });
     }
-
-    private static boolean isValuesEqual(FirebaseArray array, int[] expected) {
-        if (array.getCount() != expected.length) return false;
-        for (int i=0; i < array.getCount(); i++) {
-            if (!array.getItem(i).getValue(Integer.class).equals(expected[i])) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-    private Bean getBean(FirebaseArray array, int index) {
-        return array.getItem(index).getValue(Bean.class);
-    }
-
-    public static void runAndWaitUntil(final FirebaseArray array, Query ref, Runnable task, Callable<Boolean> done) throws InterruptedException {
-        final java.util.concurrent.Semaphore semaphore = new java.util.concurrent.Semaphore(0);
-        array.setOnChangedListener(new FirebaseArray.OnChangedListener() {
-            public void onChanged(EventType type, int index, int oldIndex) {
-                semaphore.release();
-            }
-
-            @Override
-            public void onCancelled(DatabaseError databaseError) {
-                throw new IllegalStateException(databaseError.toException());
-            }
-        });
-        task.run();
-        boolean isDone = false;
-        long startedAt = System.currentTimeMillis();
-        while (!isDone && System.currentTimeMillis() - startedAt < 5000) {
-            semaphore.tryAcquire(1, TimeUnit.SECONDS);
-            try {
-                isDone = done.call();
-            } catch (Exception e) {
-                e.printStackTrace();
-                // and we're not done
-            }
-        }
-        if (!isDone) {
-            throw new AssertionFailedError();
-        }
-        array.setOnChangedListener(null);
-    }}
+}