Smart Dialling v2 with phone number support

Behavior:
Use a prefix tree to cache contacts instead of an array list
Perform matches against phone numbers as well
DialpadFragment now ignores results from stale tasks where
queries no longer match
Add ability to not use default phone number for phone number
disambiguation dialog
Contacts are now ranked by the order which they were sorted
by in the ContactsProvider (affinity)
Change remapAccentedChars to always return lowercase characters to avoid
overhead of uppercase character conversion

Resource/Layout changes:
Tweak margins so that the section containing smart dial
suggestions looks cleaner
Use color resource instead of hardcoding color values
Add phone number to SmartDial items

ContentObserver:
Add a contentobserver to be notified on changes in contacts
Refactored cache to allow for forced cache refreshes
Use a single instance of SmartDialCache

Tests:
Added SmartDialTrie tests

Comments:
Comment cleanup

Change-Id: Ica2854e2845d4d75048aa1fd982f139496d21bf3

1 files changed, 195 insertions, 0 deletions

diff --git a/tests/src/com/android/dialer/dialpad/SmartDialTrieTest.java b/tests/src/com/android/dialer/dialpad/SmartDialTrieTest.java
new file mode 100644
index 000000000..0378555d0
--- /dev/null
+++ b/tests/src/com/android/dialer/dialpad/SmartDialTrieTest.java
@@ -0,0 +1,195 @@
+/*
+ * Copyright (C) 2013 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.android.dialer.dialpad;
+
+import static com.android.dialer.dialpad.SmartDialCache.ContactNumber;
+
+import com.android.dialer.dialpad.SmartDialTrie.Node;
+
+import android.test.suitebuilder.annotation.SmallTest;
+
+import junit.framework.TestCase;
+
+/**
+ * To run this test, use the command:
+ * adb shell am instrument -w -e class com.android.dialer.dialpad.SmartDialTrieTest /
+ * com.android.dialer.tests/android.test.InstrumentationTestRunner
+ */
+@SmallTest
+public class SmartDialTrieTest extends TestCase{
+
+    public void testSize() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        trie.put(new ContactNumber(0, "Jason", "0", "0", 1));
+        assertEquals(1, trie.size());
+        trie.put(new ContactNumber(1, "Mary", "0", "1", 2));
+        assertEquals(2, trie.size());
+        trie.put(new ContactNumber(2, "John", "0", "2", 3));
+        assertEquals(3, trie.size());
+    }
+
+    public void testPutForFullName() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber jasonsmith = new ContactNumber(0, "Jason Smith", "0", "0", 1);
+        final ContactNumber jasonsmitt = new ContactNumber(1, "Jason Smitt", "0", "1", 2);
+        trie.put(jasonsmith);
+        trie.put(jasonsmitt);
+        assertEquals(true, trie.getAllWithPrefix("5276676484").contains(jasonsmith));
+        assertEquals(false, trie.getAllWithPrefix("5276676484").contains(jasonsmitt));
+
+        assertEquals(false, trie.getAllWithPrefix("5276676488").contains(jasonsmith));
+        assertEquals(true, trie.getAllWithPrefix("5276676488").contains(jasonsmitt));
+
+    }
+
+    public void testPutForPartialName() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber maryjane = new ContactNumber(0, "Mary Jane", "0", "0", 1);
+        final ContactNumber sarahsmith = new ContactNumber(1, "Sarah Smith", "0", "1", 2);
+        final ContactNumber jasonsmitt = new ContactNumber(2, "Jason Smitt", "0", "2", 3);
+        trie.put(maryjane);
+        trie.put(sarahsmith);
+        trie.put(jasonsmitt);
+
+        // 6279 corresponds to mary = "Mary Jane" but not "Jason Smitt"
+        assertEquals(true, checkContains(trie, maryjane, "6279"));
+        assertEquals(false, checkContains(trie, jasonsmitt, "6279"));
+
+        // 72 corresponds to sa = "Sarah Smith" but not "Jason Smitt" or "Mary Jane"
+        assertEquals(false, checkContains(trie, maryjane, "72"));
+        assertEquals(true, checkContains(trie, sarahsmith, "72"));
+        assertEquals(false, checkContains(trie, jasonsmitt, "72"));
+
+        // 76 corresponds to sm = "Sarah Smith" and "Jason Smitt" but not "Mary Jane"
+        assertEquals(false, checkContains(trie, maryjane, "76"));
+        assertEquals(true, checkContains(trie, sarahsmith, "76"));
+        assertEquals(true, checkContains(trie, jasonsmitt, "76"));
+    }
+
+    public void testPutForNameTokens() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber jasonfwilliams = new ContactNumber(0, "Jason F. Williams", "0", "0", 1);
+        trie.put(jasonfwilliams);
+
+        // 527 corresponds to jas = "Jason"
+        assertEquals(true, checkContains(trie, jasonfwilliams, "527"));
+        // 945 corresponds to wil = "Wil"
+        assertEquals(true, checkContains(trie, jasonfwilliams, "945"));
+        // 66 doesn't match
+        assertEquals(false, checkContains(trie, jasonfwilliams, "66"));
+    }
+
+    public void testPutForInitialMatches() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber martinjuniorharry =
+                new ContactNumber(0, "Martin Jr Harry", "0", "0", 1);
+        trie.put(martinjuniorharry);
+        // 654 corresponds to mjh = "(M)artin (J)r (H)arry"
+        assertEquals(true, checkContains(trie, martinjuniorharry, "654"));
+        // The reverse (456) does not match (for now)
+        assertEquals(false, checkContains(trie, martinjuniorharry, "456"));
+        // 6542 corresponds to mjha = "(M)artin (J)r (Ha)rry"
+        assertEquals(true, checkContains(trie, martinjuniorharry, "6542"));
+        // 542 corresponds to jha = "Martin (J)r (Ha)rry"
+        assertEquals(true, checkContains(trie, martinjuniorharry, "542"));
+        // 547 doesn't match
+        assertEquals(false, checkContains(trie, martinjuniorharry, "547"));
+        // 655 doesn't match
+        assertEquals(false, checkContains(trie, martinjuniorharry, "655"));
+        // 653 doesn't match
+        assertEquals(false, checkContains(trie, martinjuniorharry, "653"));
+        // 6543 doesn't match
+        assertEquals(false, checkContains(trie, martinjuniorharry, "6543"));
+    }
+
+    public void testSeparators() {
+        SmartDialTrie trie = new SmartDialTrie();
+        String name = "Mcdonald Jamie-Cullum";
+        byte[] bytes = trie.toByteArray(name);
+        // Make sure the dash is correctly converted to a separator character
+        for (int i = 0; i < name.length(); i++) {
+            // separators at position 8 and 12
+            if (i == 8 || i == 14) {
+                assertEquals(true, bytes[i] == -1);
+            } else {
+                assertEquals(false, bytes[i] == -1);
+            }
+        }
+    }
+
+    public void testAccentedCharacters() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber reenee = new ContactNumber(0, "Reenée", "0", "0", 1);
+        final ContactNumber bronte = new ContactNumber(2, "Brontë", "0", "1", 2);
+        trie.put(reenee);
+        trie.put(bronte);
+        assertEquals(true, checkContains(trie, reenee, "733633"));
+        assertEquals(true, checkContains(trie, bronte, "276683"));
+    }
+
+    public void testPutForNumbers() {
+        final SmartDialTrie trie = new SmartDialTrie();
+        final ContactNumber contactno1 = new ContactNumber(0, "James", "510-527-2357", "0", 1);
+        trie.put(contactno1);
+        final ContactNumber contactno2 = new ContactNumber(0, "James", "77212862357", "0", 1);
+        trie.put(contactno2);
+        final ContactNumber contactno3 = new ContactNumber(0, "James", "+13684976334", "0", 1);
+        trie.put(contactno3);
+        // all phone numbers belonging to the contact should correspond to it
+        assertEquals(true, checkContains(trie, contactno1, "510"));
+        assertEquals(false, checkContains(trie, contactno1, "511"));
+        assertEquals(true, checkContains(trie, contactno2, "77212862357"));
+        assertEquals(false, checkContains(trie, contactno2, "77212862356"));
+        assertEquals(true, checkContains(trie, contactno3, "1368"));
+        assertEquals(false, checkContains(trie, contactno3, "1367"));
+
+    }
+
+    public void testNodeConstructor() {
+        final Node n = new Node();
+        // Node member variables should not be initialized by default at construction to reduce
+        // unnecessary memory usage
+        assertEquals(-1, n.getChildrenSize());
+        assertNull(n.getChild(5, false));
+        assertNull(n.getChild(0, false));
+    }
+
+    public void testNodeGetChild() {
+        final Node n = new Node();
+        // A node shouldn't contain children until getChild(index, true) is called
+        assertEquals(-1, n.getChildrenSize());
+        final Node child = n.getChild(1, true);
+        // A node should always have 10 children once the child array is created
+        assertEquals(10, n.getChildrenSize());
+        // getChild(index, true) should never return null
+        assertNotNull(child);
+    }
+
+    public void testNodeAddContact() {
+        final Node n = new Node();
+        assertNull(n.getContents());
+        final ContactNumber contact = new ContactNumber(0, "James", "510-527-2357", "0", 1);
+        final ContactNumber contactNotIn = new ContactNumber(2, "Jason Smitt", "0", "2", 3);
+        n.add(contact);
+        assertEquals(true, n.getContents().contains(contact));
+        assertEquals(false, n.getContents().contains(contactNotIn));
+    }
+
+    private boolean checkContains(SmartDialTrie trie, ContactNumber contact, CharSequence prefix) {
+        return trie.getAllWithPrefix(prefix).contains(contact);
+    }
+}