conditional indexing, close #3

Author: dethi

ChangeLog

@@ -4,3 +4,5 @@ CHANGELOG
      * Remove algolia_buildindex command. Use algolia_reindex instead.
 	 * Change settings format. Last format is still supported.
 	 * Add unit test.
+	 * Add tag capacity
+	 * Add Conditional indexing

src/models.py

@@ -25,7 +25,7 @@ class AlgoliaIndex(object):
     fields = ()
 
     # Use to specify the geo-fields that should be used for location search.
-    # The field should be a callable that returns a tuple.
+    # The attribute should be a callable that returns a tuple.
     geo_field = None
 
     # Use to specify the field that should be used for filtering by tag.
@@ -37,6 +37,10 @@ class AlgoliaIndex(object):
     # Use to specify the settings of the index.
     settings = {}
 
+    # Use to specify a callable that say if the instance should be indexed.
+    # The attribute should be a callable that returns a booleen.
+    should_index = None
+
     # Instance of the index from algoliasearch client
     __index = None
 
@@ -87,6 +91,16 @@ def __init__(self, model, client):
                 raise AlgoliaIndexError('{} is not an attribute of {}.'.format(
                     self.geo_field, model))
 
+        if self.should_index:
+            if hasattr(model, self.should_index):
+                attr = getattr(model, self.should_index)
+                if not callable(attr):
+                    raise AlgoliaIndexError('{} should be a callable.'.format(
+                        self.should_index))
+            else:
+                raise AlgoliaIndexError('{} is not an attribute of {}.'.format(
+                    self.should_index, model))
+
     def __set_index(self, client):
         '''Get an instance of Algolia Index'''
         params = getattr(settings, 'ALGOLIA', None)
@@ -154,6 +168,15 @@ def _build_object(self, instance):
 
     def update_obj_index(self, instance):
         '''Update the object.'''
+        if self.should_index:
+            attr = getattr(instance, self.should_index)
+            if not attr():
+                # Should not index, but since we don't now the state of the
+                # instance, we need to send a DELETE request to ensure that if
+                # the instance was previously indexed, it will be removed.
+                self.delete_obj_index(self, instance)
+                return
+
         obj = self._build_object(instance)
         self.__index.save_object(obj)
         logger.debug('UPDATE %s FROM %s', obj['objectID'], self.model)
@@ -187,6 +210,11 @@ def reindex_all(self, batch_size=1000):
         counts = 0
         batch = []
         for instance in self.model.objects.all():
+            if self.should_index:
+                attr = getattr(instance, self.should_index)
+                if not attr():
+                    continue # should not index
+
             batch.append(self._build_object(instance))
             if len(batch) >= batch_size:
                 result = self.__tmp_index.save_objects(batch)

tests/test_engine.py

@@ -1,5 +1,4 @@
 from django.test import TestCase
-from django.db import models
 
 from django.contrib.algoliasearch import AlgoliaIndex
 from django.contrib.algoliasearch.registration import AlgoliaEngine
@@ -12,6 +11,12 @@ class EngineTestCase(TestCase):
     def setUp(self):
         self.engine = AlgoliaEngine()
 
+    def tearDown(self):
+        try:
+            self.engine.unregister(Example)
+        except RegistrationError:
+            pass
+
     def test_is_register(self):
         self.assertFalse(self.engine.is_registered(Example))
         self.engine.register(Example)