Merge lp:~dobey/u1db/update-13-10 into lp:u1db/stable-13-10

[dobey]

[Samuele Pedroni]

    Clarify querying of number() and bool() indexes, values for querying are always strings (atm).
    Fix code that was using sizeof of value_types like it was some sort of dynamic array len, use the explicit arity value instead.
    Be less strict about the error message we get testing failing cert verification.

[Mike McCracken (mikemc)]

review: Approve

[lp:~dobey/u1db/update-13-10]

437. By Samuele Pedroni on 2013-05-31

[Samuele Pedroni]

    Clarify querying of number() and bool() indexes, values for querying are always strings (atm).
    Fix code that was using sizeof of value_types like it was some sort of dynamic array len, use the explicit arity value instead.
    Be less strict about the error message we get testing failing cert verification.

=== modified file 'html-docs/high-level-api.rst'
--- html-docs/high-level-api.rst	2012-09-18 16:25:41 +0000
+++ html-docs/high-level-api.rst	2013-05-31 16:37:36 +0000
@@ -308,8 +308,8 @@
 Querying an index
 ^^^^^^^^^^^^^^^^^
 
-Pass an index key or a tuple of index keys (if the index is on multiple fields)
-to ``get_from_index``; the last index key in each tuple (and *only* the last
+Pass an index key or multiple index keys (if the index is on multiple fields)
+to ``get_from_index``; the last index key (and *only* the last
 one) can end with an asterisk, which matches initial substrings. So, querying
 our ``by-firstname`` index from above:
 
@@ -332,6 +332,30 @@
     >>> assert(jb.doc_id in js)
     >>> assert(jm.doc_id in js)
 
+Index key values used when querying are always strings. If querying an
+index built with ``bool()`` use the values '0' and '1' to query for
+false and true respectively. For an index built with ``number()`` turn
+key number values into strings with the appropriate left zero-padding
+(and note in particular that querying a ``number()`` index with an int
+value, such as ``db.get_from_index('by-number', 9)``, will throw an error).
+
+.. doctest ::
+
+    >>> db = u1db.open('mydb11.u1db', create=True)
+    >>> db.create_index('done', "bool(done)")
+    >>> doc1 = db.create_doc({'task': 'milk', 'done': False, 'hours': 1})
+    >>> doc2 = db.create_doc({'task': 'coding', 'done': True, 'hours': 12})
+    >>> [doc.content['task'] for doc in db.get_from_index('done', '1')]
+    [u'coding']
+    >>> db.create_index('by-hours', "number(hours, 3)")
+    >>> [doc.content['task'] for doc in db.get_from_index('by-hours', '12')]
+    []
+    >>> [doc.content['task'] for doc in db.get_from_index('by-hours', '012')]
+    [u'coding']
+    >>> [doc.content['task'] for doc in db.get_from_index('by-hours', '001')]
+    [u'milk']
+
+
 Index functions
 ^^^^^^^^^^^^^^^
 
@@ -399,4 +423,5 @@
     os.remove(os.path.join(tmp_dir, "mydb8.u1db"))
     os.remove(os.path.join(tmp_dir, "mydb9.u1db"))
     os.remove(os.path.join(tmp_dir, "mydb10.u1db"))
+    os.remove(os.path.join(tmp_dir, "mydb11.u1db"))
     os.rmdir(tmp_dir)

=== modified file 'src/u1db_query.c'
--- src/u1db_query.c	2012-10-09 20:56:28 +0000
+++ src/u1db_query.c	2013-05-31 16:37:36 +0000
@@ -18,6 +18,7 @@
 
 #include "u1db/u1db_internal.h"
 #include <sqlite3.h>
+#include <stdlib.h>
 #include <stdarg.h>
 #include <string.h>
 #include <ctype.h>
@@ -242,7 +243,7 @@
     void *function;
     char *name;
     int value_type;
-    int arity;
+    int arity;  /* negative means any N*(-arity) values are OK */
     const int *value_types;
 } OPERATIONS[] = {
     { op_lower, "lower", json_type_string, 1, JUST_EXPRESSION },
@@ -1299,7 +1300,7 @@
     char *sep = NULL;
     parse_tree *node = NULL;
     int status = U1DB_OK;
-    int i, array_size;
+    int i, cyclic_arity;
 
     sep = get_token(tokens);
     if (sep == NULL || strcmp(sep, "(") != 0) {
@@ -1346,9 +1347,9 @@
         }
     }
     i = 0;
-    array_size = sizeof(result->value_types) / sizeof(int);
+    cyclic_arity = abs(result->arity);
     for (node = result->first_child; node != NULL; node = node->next_sibling) {
-        node->arg_type = result->value_types[i % array_size];
+        node->arg_type = result->value_types[i % cyclic_arity];
         if (node->arg_type == EXPRESSION) {
             status = to_getter(node);
             if (status != U1DB_OK)

=== modified file 'u1db/tests/test_https.py'
--- u1db/tests/test_https.py	2012-10-02 13:54:36 +0000
+++ u1db/tests/test_https.py	2013-05-31 16:37:36 +0000
@@ -96,7 +96,7 @@
         try:
             remote_target.record_sync_info('other-id', 2, 'T-id')
         except ssl.SSLError, e:
-            self.assertIn("certificate verify failed", str(e))
+            self.assertIn("certificate", str(e))
         else:
             self.fail("certificate verification should have failed.")