feat(engine) Add the auto-discover of the index.py files (#256)

- The `index.py` file is now auto-discovered when it exists
- A new `register` decorator is now available

close #229

Author: clemfromspace

README.md

@@ -412,4 +412,3 @@ class OverrideSettingsTestCase(TestCase):
 ```
 
 
-

algoliasearch_django/__init__.py

@@ -3,6 +3,8 @@
 http://www.algolia.com
 """
 
+from django.utils.module_loading import autodiscover_modules
+
 from . import models
 from . import registration
 from . import settings
@@ -40,4 +42,10 @@ def emit(self, record):
         pass
 
 
+def autodiscover():
+    autodiscover_modules('index')
+
+
 logging.getLogger(__name__.split('.')[0]).addHandler(NullHandler())
+
+default_app_config = 'algoliasearch_django.apps.AlgoliaConfig'

algoliasearch_django/apps.py

@@ -0,0 +1,11 @@
+from django.apps import AppConfig
+
+
+class AlgoliaConfig(AppConfig):
+    """Simple AppConfig which does not do automatic discovery."""
+
+    name = 'algoliasearch_django'
+
+    def ready(self):
+        super(AlgoliaConfig, self).ready()
+        self.module.autodiscover()

algoliasearch_django/decorators.py

@@ -0,0 +1,19 @@
+def register(model):
+    """
+    Register the given model class and wrapped AlgoliaIndex class with the Algolia engine:
+
+    @register(Author)
+    class AuthorIndex(AlgoliaIndex):
+        pass
+
+    """
+    from algoliasearch_django import AlgoliaIndex, register
+
+    def _algolia_engine_wrapper(index_class):
+        if not issubclass(index_class, AlgoliaIndex):
+            raise ValueError('Wrapped class must subclass AlgoliaIndex.')
+
+        register(model, index_class)
+
+        return index_class
+    return _algolia_engine_wrapper

tests/index.py

@@ -0,0 +1,17 @@
+from algoliasearch_django import register
+from algoliasearch_django.models import AlgoliaIndex
+from algoliasearch_django.decorators import register as register_decorator
+
+from .models import User, Website
+
+
+@register_decorator(User)
+class UserIndex(AlgoliaIndex):
+    pass
+
+
+class WebsiteIndex(AlgoliaIndex):
+    pass
+
+
+register(Website, WebsiteIndex)

tests/test_commands.py

@@ -3,8 +3,6 @@
 from django.core.management import call_command
 
 from algoliasearch_django import algolia_engine
-from algoliasearch_django import register
-from algoliasearch_django import unregister
 from algoliasearch_django import get_adapter
 from algoliasearch_django import clear_index
 
@@ -13,17 +11,10 @@
 
 
 class CommandsTestCase(TestCase):
-    @classmethod
-    def setUpClass(cls):
-        register(Website, auto_indexing=False)
-        register(User, auto_indexing=False)
-
     @classmethod
     def tearDownClass(cls):
         algolia_engine.client.delete_index(get_adapter(User).index_name)
         algolia_engine.client.delete_index(get_adapter(Website).index_name)
-        unregister(Website)
-        unregister(User)
 
     def setUp(self):
         # Create some records

tests/test_engine.py

@@ -1,5 +1,7 @@
+import six
+
 from django.conf import settings
-from django.test import TestCase, override_settings
+from django.test import TestCase
 
 from algoliasearch_django import algolia_engine
 from algoliasearch_django import AlgoliaIndex
@@ -27,6 +29,18 @@ def test_init_exception(self):
             with self.assertRaises(AlgoliaEngineError):
                 AlgoliaEngine(settings=settings.ALGOLIA)
 
+    def test_auto_discover_indexes(self):
+        """Test that the `index` module was auto-discovered and the models registered"""
+
+        six.assertCountEqual(
+            self,
+            [
+                User,  # Registered using the `register` decorator
+                Website,  # Registered using the `register` method
+            ],
+            algolia_engine.get_registered_models()
+        )
+
     def test_is_register(self):
         self.engine.register(Website)
         self.assertTrue(self.engine.is_registered(Website))
@@ -91,19 +105,3 @@ def test_unregister_exception(self):
 
         with self.assertRaises(RegistrationError):
             self.engine.unregister(Website)
-
-
-class OverrideSettingsTestCase(TestCase):
-    def setUp(self):
-        with self.settings(ALGOLIA={
-            'APPLICATION_ID': 'foo',
-            'API_KEY': 'bar',
-            'AUTO_INDEXING': False
-        }):
-            algolia_engine.reset(settings.ALGOLIA)
-
-    def tearDown(self):
-        algolia_engine.reset(settings.ALGOLIA)
-
-    def test_no_indexing(self):
-        self.assertFalse(algolia_engine.__dict__["_AlgoliaEngine__auto_indexing"], "AUTO_INDEXING should be disabled for this test.")

tests/test_signal.py

@@ -4,8 +4,6 @@
 
 from algoliasearch_django import algolia_engine
 from algoliasearch_django import get_adapter
-from algoliasearch_django import register
-from algoliasearch_django import unregister
 from algoliasearch_django import raw_search
 from algoliasearch_django import clear_index
 from algoliasearch_django import update_records
@@ -14,14 +12,10 @@
 
 
 class SignalTestCase(TestCase):
-    @classmethod
-    def setUpClass(cls):
-        register(Website)
 
     @classmethod
     def tearDownClass(cls):
         algolia_engine.client.delete_index(get_adapter(Website).index_name)
-        unregister(Website)
 
     def tearDown(self):
         clear_index(Website)

tox.ini

@@ -11,6 +11,7 @@ skip_missing_interpreters = True
 
 [testenv]
 deps =
+    six
     django17: Django>=1.7,<1.8
     django18: Django>=1.8,<1.9
     django19: Django>=1.9,<1.10