closes issue #81

Author: saxix

CHANGES

@@ -1,5 +1,6 @@
 Release 1.4 (dev)
 -----------------
+* closes :issue:`81`. Add docs and check.
 * fixes :issue:`80`. (thanks Naddiseo for the useful support)
 * Django 1.11 compatibility
 * some minor support for Django 2.0

docs/api.rst

@@ -75,6 +75,10 @@ ConcurrentModelAdmin
 --------------------
 .. autoclass:: concurrency.admin.ConcurrentModelAdmin
 
+.. warning:: If you customize ``fields`` or ``fieldsets`` remember to add version field to the list. (See issue :ghissue:`81`)
+
+
+
 .. _ConcurrencyActionMixin:
 
 ConcurrencyActionMixin

docs/conf.py

@@ -58,6 +58,8 @@
 
             }
 
+github_project_url = 'https://github.com/saxix/django-concurrency'
+
 todo_include_todos = True
 
 # Add any paths that contain templates here, relative to this directory.

src/concurrency/admin.py

@@ -7,6 +7,7 @@
 
 from django.contrib import admin, messages
 from django.contrib.admin import helpers
+from django.core.checks import Error
 from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.db.models import Q
 from django.forms.formsets import (
@@ -23,6 +24,7 @@
 from concurrency.config import CONCURRENCY_LIST_EDITABLE_POLICY_ABORT_ALL, conf
 from concurrency.exceptions import RecordModifiedError
 from concurrency.forms import ConcurrentForm, VersionWidget
+from concurrency.utils import flatten
 
 ALL = object()
 
@@ -251,3 +253,31 @@ class ConcurrentModelAdmin(ConcurrencyActionMixin,
                            admin.ModelAdmin):
     form = ConcurrentForm
     formfield_overrides = {forms.VersionField: {'widget': VersionWidget}}
+
+    def check(self, **kwargs):
+        errors = []
+        if self.fields:
+            version_field = self.model._concurrencymeta.field
+            if version_field.name not in self.fields:
+                errors.append(
+                    Error(
+                        'Missed version field in {} fields definition'.format(self),
+                        hint="Please add '{}' to the 'fields' attribute".format(version_field.name),
+                        obj=None,
+                        id='concurrency.A001',
+                    )
+                )
+        if self.fieldsets:
+            version_field = self.model._concurrencymeta.field
+            fields = flatten([v['fields'] for k, v in self.fieldsets])
+
+            if version_field.name not in fields:
+                errors.append(
+                    Error(
+                        'Missed version field in {} fieldsets definition'.format(self),
+                        hint="Please add '{}' to the 'fieldsets' attribute".format(version_field.name),
+                        obj=None,
+                        id='concurrency.A002',
+                    )
+                )
+        return errors

src/concurrency/utils.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 from __future__ import absolute_import, unicode_literals
-
+import six
 import inspect
 import logging
 import warnings
@@ -183,3 +183,32 @@ def fqn(o):
     if not parts:
         raise ValueError("Invalid argument `%s`" % o)
     return ".".join(parts)
+
+
+def flatten(iterable):
+    """
+    flatten(sequence) -> list
+
+    Returns a single, flat list which contains all elements retrieved
+    from the sequence and all recursively contained sub-sequences
+    (iterables).
+
+    :param sequence: any object that implements iterable protocol (see: :ref:`typeiter`)
+    :return: list
+
+    Examples:
+
+    >>> from adminactions.utils import flatten
+    >>> [1, 2, [3,4], (5,6)]
+    [1, 2, [3, 4], (5, 6)]
+
+    >>> flatten([[[1,2,3], (42,None)], [4,5], [6], 7, (8,9,10)])
+    [1, 2, 3, 42, None, 4, 5, 6, 7, 8, 9, 10]"""
+
+    result = list()
+    for el in iterable:
+        if hasattr(el, "__iter__") and not isinstance(el, six.string_types):
+            result.extend(flatten(el))
+        else:
+            result.append(el)
+    return list(result)

tests/test_issues.py

@@ -5,6 +5,8 @@
 import pytest
 from django.contrib.admin.sites import site
 from django.contrib.auth.models import User
+from django.core.management import call_command
+from django.core.management.base import SystemCheckError
 from django.http import QueryDict
 from django.test import override_settings
 from django.test.client import RequestFactory
@@ -111,3 +113,24 @@ def test_issue_54():
 
         with pytest.raises(RecordModifiedError):
             m2.save()
+
+
+@pytest.mark.django_db()
+def test_issue_81a(monkeypatch):
+    monkeypatch.setattr('demo.admin.ActionsModelAdmin.fields', ('id',))
+    with pytest.raises(SystemCheckError) as e:
+        call_command('check')
+    assert 'concurrency.A001' in e.value.message
+
+
+@pytest.mark.django_db()
+def test_issue_81b(monkeypatch):
+    fieldsets = (
+        ('Standard info', {
+            'fields': ('id',)
+        }),
+    )
+    monkeypatch.setattr('demo.admin.ActionsModelAdmin.fieldsets', fieldsets)
+    with pytest.raises(SystemCheckError) as e:
+        call_command('check')
+    assert 'concurrency.A002' in e.value.message