Merge pull request #57 from Saritasa/master

Fix parent field name different from 'parent'

Author: vdboor

.gitignore

@@ -13,3 +13,4 @@ dist/
 docs/_build/
 *.sqlite3
 .tox
+.python-version

.travis.yml

@@ -4,8 +4,9 @@ python:
 - '2.7'
 - '3.3'
 - '3.4'
+- '3.5'
+- '3.6'
 env:
-- PACKAGES="django>=1.6,<1.7 django-mptt<0.8"
 - PACKAGES="django>=1.7,<1.8 django-mptt<0.8"
 - PACKAGES="django>=1.8,<1.9"
 - PACKAGES="django>=1.9,<1.10"
@@ -16,6 +17,10 @@ matrix:
  env: PACKAGES="django>=1.9,<1.10"
  - python: '3.3'
  env: PACKAGES="django>=1.10,<1.11"
+ - python: '3.5'
+ env: PACKAGES="django>=1.7,<1.8 django-mptt<0.8"
+ - python: '3.6'
+ env: PACKAGES="django>=1.7,<1.8 django-mptt<0.8"
 before_install:
 - pip install codecov
 install:

README.rst

@@ -172,22 +172,65 @@ The ``child_models`` attribute defines which admin interface is loaded for the *
 The list view is still rendered by the parent admin.
 
 
+Validation
+^^^^^^^^^^
+
+When drag-n-drop nodes in tree in admin, ``clean``/``full_clean`` method is not called. To implement validation, you
+should override ``can_be_moved`` model method. Method have to return ``True`` if nothing happens and moving is allowing.
+Otherwise, ``can_be_moved`` have to raise ``ValidationError`` or ``InvalidMove`` from ``mptt.exceptions``
+
+.. code:: python
+
+ class Participant(PolymorphicMPTTModel):
+ conference = models.ForeignKey(Conference)
+ invited_by = PolymorphicTreeForeignKey(
+ 'self',
+ null=True,
+ blank=True,
+ related_name='invited',
+ verbose_name=_('Invited')
+ )
+
+ def clean(self):
+ if self.participant:
+ if self.conference != self.manager.conference:
+ raise ValidationError({
+ 'invited_by': _(
+ 'Participants have to be from the same '
+ 'conference'
+ )
+ })
+
+ def can_be_moved(self, target):
+ self.invited_by = target
+ self.clean()
+ return True
+
 Tests
 -----
 
 To run the included test suite, execute::
 
  ./runtests.py
 
-To test support for multiple Python and Django versions, run tox from the repository root::
+To test support for multiple Python and Django versions, you need to follow steps below:
 
- pip install tox
- tox
+* install project requirements in virtual environment
+* install python 2.7, 3.3, 3.4, 3.5, 3.6 python versions through pyenv (See pyenv (Linux) or Homebrew (Mac OS X).)
+* create .python-version file and add full list of installed versions with which project have to be tested, example::
 
-The Python versions need to be installed at your system. See pyenv (Linux) or Homebrew (Mac OS X).
+ 2.6.9
+ 2.7.13
+ 3.3.6
+ 3.4.5
+ 3.5.2
+ 3.6.0
+* run tox from the repository root::
 
-Python 2.6, 2.7, and 3.3 are the currently supported versions.
+ pip install tox
+ tox
 
+Python 2.7, 3.3, 3.4, 3.5 and 3.6 and django 1.7, 1.8, 1.9 and 1.10 are the currently supported versions.
 
 Todo
 ----

polymorphic_tree/admin/parentadmin.py

@@ -1,12 +1,14 @@
 import json, django
 
+from django.core.exceptions import ValidationError
 from future.builtins import str, int
 from distutils.version import StrictVersion
 from django.conf import settings
 from django.core.urlresolvers import reverse
 from django.db import transaction
 from django.http import HttpResponseNotFound, HttpResponse, HttpResponseBadRequest, HttpResponseRedirect
 from django.utils.translation import ugettext_lazy as _
+from mptt.exceptions import InvalidMove
 from polymorphic.admin import PolymorphicParentModelAdmin, PolymorphicModelChoiceForm
 from polymorphic_tree.models import PolymorphicMPTTModel
 from mptt.admin import MPTTModelAdmin
@@ -211,7 +213,7 @@ def api_node_moved_view(self, request):
  'moved_id': moved_id,
  'error': _(u'Cannot place \u2018{0}\u2019 below \u2018{1}\u2019; a {2} does not allow children!').format(moved, target, target._meta.verbose_name)
  }), content_type='application/json', status=409) # Conflict
- if moved.parent_id != previous_parent_id:
+ if getattr(moved, '{}_id'.format(moved._mptt_meta.parent_attr)) != previous_parent_id:
  return HttpResponse(json.dumps({
  'action': 'reload',
  'error': 'Client seems to be out-of-sync, please reload!'
@@ -222,6 +224,20 @@ def api_node_moved_view(self, request):
  'before': 'left',
  'after': 'right',
  }[position]
+ try:
+ moved.can_be_moved(target)
+ except ValidationError as e:
+ return HttpResponse(json.dumps({
+ 'action': 'reject',
+ 'moved_id': moved_id,
+ 'error': '\n'.join(e.messages)
+ }), content_type='application/json', status=400)
+ except InvalidMove as e:
+ return HttpResponse(json.dumps({
+ 'action': 'reject',
+ 'moved_id': moved_id,
+ 'error': str(e)
+ }), content_type='application/json', status=400)
  moved.move_to(target, mptt_position)
 
  # Some packages depend on calling .save() or post_save signal after updating a model.

polymorphic_tree/models.py

@@ -111,6 +111,20 @@ def get_ancestors_of_type(self, model, ascending=False, include_self=False):
  """
  return self.get_ancestors(ascending=ascending, include_self=include_self).instance_of(model)
 
+ def can_be_moved(self, target):
+ """Can move be finished
+
+ Method have to be redefined in inherited model to define cases when
+ node can be moved. If method is not redefined moving always allows
+
+ To deny move, this method have to be raised ``ValidationError`` or
+ ``InvalidMove`` from ``mptt.exceptions``
+
+ Args:
+ target (PolymorphicMPTTModel): future parent of node
+ """
+ pass
+
 
 if django.VERSION < (1,7):
  # South integration

polymorphic_tree/tests/admin.py

@@ -0,0 +1,25 @@
+from polymorphic_tree.admin import (PolymorphicMPTTChildModelAdmin,
+ PolymorphicMPTTParentModelAdmin)
+from polymorphic_tree.tests.models import ModelWithCustomParentName
+
+
+class BaseChildAdmin(PolymorphicMPTTChildModelAdmin):
+ """Test child admin"""
+ GENERAL_FIELDSET = (None, {
+ 'fields': ('chief', 'field5'),
+ })
+
+ base_model = ModelWithCustomParentName
+ base_fieldsets = (
+ GENERAL_FIELDSET,
+ )
+
+
+class TreeNodeParentAdmin(PolymorphicMPTTParentModelAdmin):
+ """Test parent admin"""
+ base_model = ModelWithCustomParentName
+ child_models = (
+ (ModelWithCustomParentName, BaseChildAdmin),
+ )
+
+ list_display = ('field5', 'actions_column',)

polymorphic_tree/tests/models.py

@@ -1,4 +1,6 @@
+from django.core.exceptions import ValidationError
 from django.db import models
+from mptt.exceptions import InvalidMove
 
 from polymorphic.showfields import ShowFieldContent
 from polymorphic_tree.models import PolymorphicMPTTModel, PolymorphicTreeForeignKey
@@ -46,3 +48,81 @@ class ModelX(Base):
 
 class ModelY(Base):
  field_y = models.CharField(max_length=10)
+
+
+class ModelWithCustomParentName(PolymorphicMPTTModel):
+ """Model with custom parent name
+
+ A model where ``PolymorphicTreeForeignKey`` attribute has not ``parent``
+ name, but ``chief``
+
+ Attributes:
+ chief (ModelWithCustomParentName): parent
+ field5 (str): test field
+ """
+ chief = PolymorphicTreeForeignKey('self',
+ blank=True,
+ null=True,
+ related_name='subordinate',
+ verbose_name='Chief')
+ field5 = models.CharField(max_length=10)
+
+ class MPTTMeta:
+ parent_attr = 'chief'
+
+ def __str__(self):
+ return self.field5
+
+
+class ModelWithValidation(PolymorphicMPTTModel):
+ """Model with custom validation
+
+ A model with redefined ``clean`` and ``can_be_moved`` methods
+
+ ``clean`` method always raises ``ValidationError``
+ ``can_be_moved`` always calls ``clean``
+
+ Attributes:
+ parent (ModelWithValidation): parent
+ field6 (str): test field
+ """
+
+ parent = PolymorphicTreeForeignKey('self',
+ blank=True,
+ null=True,
+ related_name='children')
+
+ field6 = models.CharField(max_length=10)
+
+ def clean(self):
+ """Raise validation error"""
+ raise ValidationError({
+ 'parent': 'There is something with parent field'
+ })
+
+ def can_be_moved(self, target):
+ """Execute ``clean``"""
+ self.clean()
+
+
+class ModelWithInvalidMove(PolymorphicMPTTModel):
+ """Model with custom validation
+
+ A model with redefined only ``can_be_moved`` method which always raises
+ ``InvalidMove``
+
+ Attributes:
+ parent (ModelWithValidation): parent
+ field7 (str): test field
+ """
+
+ parent = PolymorphicTreeForeignKey('self',
+ blank=True,
+ null=True,
+ related_name='children')
+
+ field7 = models.CharField(max_length=10)
+
+ def can_be_moved(self, target):
+ """Raise ``InvalidMove``"""
+ raise InvalidMove('Invalid move')