First working version, extracted from django-fluent-pages

- Using same registration system
- Adapted base classes and templates to be fully generic
- Added nodetype-... class to tree view.

Author: vdboor

.gitignore

@@ -0,0 +1,11 @@
+*.pyc
+*.pyo
+*.mo
+*.db
+.idea
+.project
+.pydevproject
+.idea/workspace.xml
+.DS_Store
+dist/
+docs/_build/

LICENSE.rst

@@ -0,0 +1,17 @@
+=======
+LICENSE
+=======
+
+Copyright © 2011, Edoburu
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this software except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.rst

@@ -0,0 +1,120 @@
+django-polymorphic-tree
+=======================
+
+This is a stand alone module, which provides:
+
+  " A polymorphic structure to display content in a tree. "
+
+In other words, this module provides a node tree, where each node type can be a different model.
+This allows you to structure your site tree as you see fit. For example:
+
+* Build a tree of a root node, category nodes, leaf nodes, each with custom fields.
+
+Origin
+------
+
+This module was extracted out of django-fluent-pages_ because it turned out to serve a generic purpose.
+This was done during contact work at Leukeleu_ (also known for their involvement in django-fiber_).
+
+
+Installation
+============
+
+First install the module, preferably in a virtual environment::
+
+    pip install -e git+https://github.com/edoburu/django-polymorphic-tree.git#egg=django-polymorphic-tree
+
+The main dependencies are django-mptt_ and django-polymorphic_,
+which will be automatically installed.
+
+Configuration
+-------------
+
+Next, create a project which uses the CMS::
+
+    cd ..
+    django-admin.py startproject demo
+
+Add the following to ``settings.py``::
+
+    INSTALLED_APPS += (
+        'polymorphic_tree',
+        'polymorphic',
+        'mptt',
+    )
+
+The database can be created afterwards::
+
+    ./manage.py syncdb
+    ./manage.py runserver
+
+
+Custom node types
+-----------------
+
+The main feature of this module is the support for custom node types.
+It boils down to creating a package with 2 files:
+
+The ``models.py`` file should define the custom node type, and any fields it has::
+
+    from django.db import models
+    from django.utils.translation import ugettext_lazy as _
+    from fluent_pages.models import HtmlPage
+    from mysite.settings import RST_TEMPLATE_CHOICES
+
+
+    class CategoryNode(PolymorphicMPTTModel):
+        """
+        A page that renders RST code.
+        """
+        title = models.CharField(_("Title"), max_length=200)
+
+        class Meta:
+            verbose_name = _("Category node")
+            verbose_name_plural = _("Category node")
+
+A ``node_type_plugins.py`` file that defines the metadata, and additional methods (e.g. rendering)::
+
+    from polymorphic_tree.extensions import NodeTypePlugin, node_type_pool
+    from .models import CategoryNode
+
+
+    @node_type_pool.register
+    class CategoryNodePlugin(NodeTypePlugin):
+        model = CategoryNode
+        sort_priority = 10
+
+        def render(self, request, categorynode):
+            return 'demo'
+
+Optionally, a ``model_admin`` can also be defined, to have custom field layouts or extra functionality in the *edit* or *delete* page.
+
+Plugin configuration
+~~~~~~~~~~~~~~~~~~~~
+
+The plugin can define the following attributes:
+
+* ``model`` - the model for the page type
+* ``model_admin`` - the custom admin to use (must inherit from ``PageAdmin``)
+* ``can_have_children`` - whether the node type allows to have child nodes.
+* ``urls`` - a custom set of URL patterns for sub pages (either a module name, or ``patterns()`` result).
+* ``sort_priority`` - a sorting order in the "add page" dialog.
+
+
+Contributing
+------------
+
+This module is designed to be generic. In case there is anything you didn't like about it,
+or think it's not flexible enough, please let us know. We'd love to improve it!
+
+If you have any other valuable contribution, suggestion or idea,
+please let us know as well because we will look into it.
+Pull requests are welcome too. :-)
+
+
+.. _Leukeleu: http://www.leukeleu.nl/
+.. _django-fiber: https://github.com/ridethepony/django-fiber
+.. _django-fluent-pages: https://github.com/edoburu/django-fluent-blogs
+.. _django-mptt: https://github.com/django-mptt/django-mptt
+.. _django-polymorphic: https://github.com/chrisglass/django_polymorphic
+

polymorphic_tree/__init__.py

@@ -0,0 +1,11 @@
+VERSION = (0, 1, 0)
+
+# Do some sane version checking
+import django
+import mptt
+
+if django.VERSION < (1,3,0):
+    raise ImportError("At least Django 1.3.0 is required to run this application")
+
+if mptt.VERSION < (0,4,0):
+    raise ImportError("At least django-mptt 0.4.0 is required to run this application")

polymorphic_tree/admin/__init__.py

@@ -0,0 +1,7 @@
+from polymorphic_tree.admin.childadmin import PolymorphicMPTTChildModelAdmin, PolymorpicMPTTAdminForm
+from polymorphic_tree.admin.parentadmin import PolymorphicMPTTParentModelAdmin, NodeTypeChoiceForm
+
+__all__ = (
+    'PolymorphicMPTTChildModelAdmin', 'PolymorpicMPTTAdminForm',
+    'PolymorphicMPTTParentModelAdmin', 'NodeTypeChoiceForm',
+)

polymorphic_tree/admin/childadmin.py

@@ -0,0 +1,67 @@
+from django.utils.functional import lazy
+from mptt.admin import MPTTModelAdmin
+from mptt.forms import MPTTAdminForm
+from polymorphic_tree.utils.polymorphicadmin import PolymorphicChildModelAdmin
+from polymorphic_tree.models import PolymorphicMPTTModel
+
+
+class PolymorpicMPTTAdminForm(MPTTAdminForm):
+    pass
+
+
+class PolymorphicMPTTChildModelAdmin(PolymorphicChildModelAdmin, MPTTModelAdmin):
+    """
+    The internal machinery
+    The admin screen for the ``PolymorphicMPTTModel`` objects.
+    """
+    base_model = PolymorphicMPTTModel
+    base_form = PolymorpicMPTTAdminForm
+    base_fieldsets = None
+
+
+    # NOTE: list page is configured in PolymorphicMPTTParentModelAdmin
+    # as that class is used for the real admin screen in the edit/delete view.
+    # This class is only a base class for the custom node type plugins.
+
+
+    # ---- Pass parent_object to templates ----
+
+    def render_change_form(self, request, context, add=False, change=False, form_url='', obj=None):
+        # Get parent object for breadcrumb
+        parent_object = None
+        parent_id = request.REQUEST.get('parent')
+        if add and parent_id:
+            assert not self.base_model._meta.abstract, "should define {0}.base_model".format(self.__class__.__name__)
+            parent_object = self.base_model.objects.get(pk=int(parent_id))  # is polymorphic
+        elif change:
+            parent_object = obj.parent
+
+        # Pass parent object to the view.
+        # Also allows to improve the breadcrumb for example
+        context.update({
+            'parent_object': parent_object,
+            'parent_breadcrumb': lazy(lambda: list(parent_object.get_ancestors()) + [parent_object], list)() if parent_object else [],
+        })
+
+        return super(PolymorphicMPTTChildModelAdmin, self).render_change_form(request, context, add=add, change=change, form_url=form_url, obj=obj)
+
+
+    def delete_view(self, request, object_id, context=None):
+        # Get parent object for breadcrumb
+        parent_object = None
+        try:
+            assert not self.base_model._meta.abstract, "should define {0}.base_model".format(self.__class__.__name__)
+            parent_pk = self.base_model.objects.non_polymorphic().values('parent').filter(pk=int(object_id))
+            parent_object = self.base_model.objects.get(pk=parent_pk)
+        except PolymorphicMPTTModel.DoesNotExist:
+            pass
+
+        # Pass parent object to the view.
+        # Also allows to improve the breadcrumb for example
+        extra_context = {
+            'parent_object': parent_object,
+            'parent_breadcrumb': lazy(lambda: list(parent_object.get_ancestors()) + [parent_object], list)(),
+        }
+        extra_context.update(context or {})
+
+        return super(PolymorphicMPTTChildModelAdmin, self).delete_view(request, object_id, extra_context)