Clarify behavior of indexing: 'depth'.

Fixes #39

README.md

@@ -69,7 +69,9 @@ Options are:
 * `indexing`: it can be either `insertion` (default) or `depth`;
   if set to `insertion`, it will try to match entries in insertion order;
   if set to `depth`, it will try to match entries with the most
-  properties first.
+  properties first. Depth indexing is guaranteed if the patterns
+overlaps. If multiple matching patterns overlaps it checks on the
+first overlapping group of patterns that matches.
 
 -------------------------------------------------------
 <a name="add"></a>

bloomrun.js

@@ -68,7 +68,7 @@ BloomRun.prototype.add = function (pattern, payload) {
     return this
   }
 
-  var buckets = matchingBuckets(this._buckets, pattern)
+  var buckets = matchingBuckets(this._buckets, pattern, null, this._isDeep)
   var bucket
   var properties = this._properties
 
@@ -95,7 +95,7 @@ BloomRun.prototype.add = function (pattern, payload) {
 }
 
 BloomRun.prototype.remove = function (pattern, payload) {
-  var matches = matchingBuckets(this._buckets, pattern)
+  var matches = matchingBuckets(this._buckets, pattern, null, this._isDeep)
   payload = payload || null
 
   if (matches.length > 0) {

lib/iterator.js

@@ -17,7 +17,7 @@ function Iterator (parent, obj, opts) {
     if (onlyRegex(obj)) {
       this.buckets = parent._buckets
     } else {
-      this.buckets = matchingBuckets(parent._buckets, obj, parent._properties)
+      this.buckets = matchingBuckets(parent._buckets, obj, parent._properties, parent._isDeep)
     }
   } else {
     this.buckets = parent._buckets

lib/matchingBuckets.js

@@ -2,7 +2,7 @@
 
 var genKeys = require('./genKeys.js')
 
-function matchingBuckets (buckets, pattern, set) {
+function matchingBuckets (buckets, pattern, set, isDeep) {
   var keys = genKeys(pattern, set)
   var acc = []
 
@@ -11,7 +11,7 @@ function matchingBuckets (buckets, pattern, set) {
       if (buckets[b].filter.test(keys[i])) {
         acc.push(buckets[b])
         break
-      } else if (set) {
+      } else if (set && !isDeep) {
         // if there are known properties, we can be 100% sure
         // that if a bloom filter returns false, then we don't need
         // to test the other keys

test.js

@@ -473,3 +473,26 @@ test('mad string equality', function (t) {
   t.deepEqual(instance.lookup({ to: '1', some: 'pattern' }), 'first')
   t.deepEqual(instance.lookup({ to: '2', some: 'pattern' }), 'second')
 })
+
+test('List matches partially, regardless of key order (1)', function (t) {
+  t.plan(1)
+  var instance = bloomrun({ indexing: 'depth' })
+
+  instance.add({ c: 'CCC' }, 1)
+  instance.add({ b: 'BBB' }, 2)
+  instance.add({ a: 'AAA', b: 'BBB', c: 'CCC' }, 3)
+  instance.add({ a: 'AAA' }, 4)
+
+  t.deepEqual(instance.list({ a: 'AAA', b: 'BBB', c: 'CCC', d: 'DDD' }), [3, 1, 4, 2])
+})
+
+test('List matches partially, regardless of key order (2)', function (t) {
+  t.plan(1)
+  var instance = bloomrun({ indexing: 'depth' })
+
+  instance.add({ c: 'CCC' }, 2)
+  instance.add({ c: 'CCC', d: 'DDD' }, 1)
+  instance.add({ a: 'AAA' }, 3)
+
+  t.deepEqual(instance.list({ a: 'AAA', b: 'BBB', c: 'CCC', d: 'DDD' }), [1, 2, 3])
+})