feat: support attribute for should_index

Author: PLNech

.gitignore

@@ -23,6 +23,10 @@ var/
 .installed.cfg
 *.egg
 
+# IDE Files
+*.iml
+.idea/
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

README.md

@@ -208,9 +208,18 @@ class ArticleIndex(AlgoliaIndex):
 
 ### Restrict indexing to a subset of your data
 
-You can add constraints controlling if a record must be indexed or not. `should_index` should be a callable that returns a boolean.
+You can add constraints controlling if a record must be indexed or not. `should_index` should be a boolean or a callable that returns a boolean.
 
 ```python
+# with a boolean attribute
+class Article(models.model):
+    name = models.CharField(max_length=64)
+    is_indexable = True
+
+class ArticleIndex(AlgoliaIndex):
+    should_index = "is_indexable"
+
+# with a callable returning a boolean
 class Contact(models.model):
     name = models.CharField(max_lenght=20)
     age = models.IntegerField()

src/models.py

@@ -98,8 +98,12 @@ def __init__(self, model, client):
                 if callable(attr):
                     self.should_index = attr
                 else:
-                    raise AlgoliaIndexError('{} should be a callable.'.format(
-                        self.should_index))
+                    should_index_attr_name = self.should_index
+                    if isinstance(attr, bool):
+                        self.should_index = lambda instance: getattr(instance, should_index_attr_name) is True
+                    else:
+                        raise AlgoliaIndexError('{} should be a callable or a boolean attribute.'.format(
+                            self.should_index))
             else:
                 raise AlgoliaIndexError('{} is not an attribute of {}.'.format(
                     self.should_index, model))
@@ -201,6 +205,10 @@ def update_obj_index(self, instance):
         self.__index.save_object(obj)
         logger.debug('UPDATE %s FROM %s', obj['objectID'], self.model)
 
+    def _should_index(self, instance):
+        '''Return true if the object should be indexed.'''
+        return self.should_index(instance) if self.should_index else True
+
     def delete_obj_index(self, instance):
         '''Delete the object.'''
         objectID = self.__get_objectID(instance)

tests/models.py

@@ -9,9 +9,13 @@ class Example(models.Model):
     lng = models.FloatField()
     category = []
     locations = []
+    index_me = True
 
     def location(self):
         return (self.lat, self.lng)
 
     def geolocations(self):
         return self.locations
+
+    def has_name(self):
+        return self.name is not None

tests/test_index.py

@@ -167,3 +167,32 @@ class ExampleIndex(AlgoliaIndex):
 
         with self.assertRaises(AlgoliaIndexError):
             index = ExampleIndex(Example, self.client)
+
+    def test_should_index_method(self):
+        class ExampleIndex(AlgoliaIndex):
+            fields = 'name'
+            should_index = 'has_name'
+        index = ExampleIndex(Example, self.client)
+        obj = index._build_object(self.instance)
+        self.assertTrue(index._should_index(self.instance),
+                        "We should index an instance when should_index(instance) returns True")
+
+        instance_should_not = Example(name=None)
+        obj = index._build_object(instance_should_not)
+        self.assertFalse(index._should_index(instance_should_not),
+                        "We should not index an instance when should_index(instance) returns False")
+
+    def test_should_index_attr(self):
+        class ExampleIndex(AlgoliaIndex):
+            fields = 'name'
+            should_index = 'index_me'
+        index = ExampleIndex(Example, self.client)
+        obj = index._build_object(self.instance)
+        self.assertTrue(index._should_index(self.instance),
+                        "We should index an instance when its should_index attr is True")
+
+        instance_should_not = Example()
+        instance_should_not.index_me = False
+        obj = index._build_object(instance_should_not)
+        self.assertFalse(index._should_index(instance_should_not),
+                        "We should not index an instance when its should_index attr is False")