Merge pull request #31 from scotta/feature/ignore-model

Ignore logging for models in DJANGO_FSM_LOG_IGNORED_MODELS setting

Author: jacobh

README.md

@@ -51,6 +51,15 @@ StateLog.objects.all()
 # ...all recorded logs...
 ```
 
+### Disabling logging for specific models
+
+By default transitions are logged for all models. Logging can be disabled for
+specific models by adding their fully qualified name to `DJANGO_FSM_LOG_IGNORED_MODELS`.
+
+```python
+DJANGO_FSM_LOG_IGNORED_MODELS = ('poll.models.Vote')
+```
+
 ### `for_` Manager Method
 
 For convenience there is a custom `for_` manager method to easily filter on the generic foreign key

django_fsm_log/backends.py

@@ -15,6 +15,11 @@ def pre_transition_callback(*args, **kwargs):
     def post_transition_callback(*args, **kwargs):
         raise NotImplementedError
 
+    @staticmethod
+    def _get_model_qualified_name__(sender):
+        return '%s.%s' % (sender.__module__,
+                          getattr(sender, '__qualname__', sender.__name__))
+
 
 class CachedBackend(object):
 
@@ -26,6 +31,10 @@ def setup_model(model):
     @staticmethod
     def pre_transition_callback(sender, instance, name, source, target, **kwargs):
         from .models import StateLog
+
+        if BaseBackend._get_model_qualified_name__(sender) in settings.DJANGO_FSM_LOG_IGNORED_MODELS:
+            return
+
         StateLog.pending_objects.create(
             by=getattr(instance, 'by', None),
             state=target,
@@ -52,6 +61,10 @@ def pre_transition_callback(sender, **kwargs):
     @staticmethod
     def post_transition_callback(sender, instance, name, source, target, **kwargs):
         from .models import StateLog
+
+        if BaseBackend._get_model_qualified_name__(sender) in settings.DJANGO_FSM_LOG_IGNORED_MODELS:
+            return
+
         StateLog.objects.create(
             by=getattr(instance, 'by', None),
             state=target,

django_fsm_log/conf.py

@@ -5,3 +5,4 @@
 class DjangoFSMLogConf(AppConf):
     STORAGE_METHOD = 'django_fsm_log.backends.SimpleBackend'
     CACHE_BACKEND = 'default'
+    IGNORED_MODELS = []

tests/tests.py

@@ -1,4 +1,6 @@
 from unittest import skipIf
+
+from django.conf import settings
 from django.test import TestCase
 
 from django_fsm_log.models import StateLog
@@ -98,6 +100,33 @@ def test_get_display_state(self):
         self.assertNotEqual(log.get_state_display(), article.get_state_display())
 
 
+class StateLogIgnoredModelTests(TestCase):
+    def setUp(self):
+        self.article = Article.objects.create(state='draft')
+        self.user = User.objects.create_user(username='jacob', password='password')
+        settings.DJANGO_FSM_LOG_IGNORED_MODELS = ['tests.models.Article']
+
+    def tearDown(self):
+        settings.DJANGO_FSM_LOG_IGNORED_MODELS = []
+
+    def test_log_not_created_if_model_ignored(self):
+        self.assertEqual(len(StateLog.objects.all()), 0)
+
+        self.article.submit()
+        self.article.save()
+
+        self.assertEqual(len(StateLog.objects.all()), 0)
+
+    def test_log_created_on_transition_when_model_not_ignored(self):
+        settings.DJANGO_FSM_LOG_IGNORED_MODELS = ['tests.models.SomeOtherModel']
+        self.assertEqual(len(StateLog.objects.all()), 0)
+
+        self.article.submit()
+        self.article.save()
+
+        self.assertEqual(len(StateLog.objects.all()), 1)
+
+
 class StateLogManagerTests(TestCase):
     def setUp(self):
         self.article = Article.objects.create(state='draft')