Clarified error messages and docstrings in models/nodes.py. Removed an extraneous...

[philo.git] / models / nodes.py

diff --git a/models/nodes.py b/models/nodes.py
index ae2e081..526400c 100644 (file)
--- a/models/nodes.py
+++ b/models/nodes.py
@@ -3,15 +3,16 @@ from django.contrib.contenttypes.models import ContentType
 from django.contrib.contenttypes import generic
 from django.contrib.sites.models import Site
 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect
 from django.contrib.contenttypes import generic
 from django.contrib.sites.models import Site
 from django.http import HttpResponse, HttpResponseServerError, HttpResponseRedirect

+from django.core.exceptions import ViewDoesNotExist

 from django.core.servers.basehttp import FileWrapper
 from django.core.servers.basehttp import FileWrapper

-from django.core.urlresolvers import resolve, clear_url_caches
+from django.core.urlresolvers import resolve, clear_url_caches, reverse, NoReverseMatch

 from django.template import add_to_builtins as register_templatetags
 from inspect import getargspec
 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
 from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model
 from philo.utils import ContentTypeSubclassLimiter
 from philo.validators import RedirectValidator
 from django.template import add_to_builtins as register_templatetags
 from inspect import getargspec
 from philo.exceptions import MIDDLEWARE_NOT_CONFIGURED
 from philo.models.base import TreeEntity, Entity, QuerySetMapper, register_value_model
 from philo.utils import ContentTypeSubclassLimiter
 from philo.validators import RedirectValidator

-from philo.exceptions import ViewDoesNotProvideSubpaths, AncestorDoesNotExist
+from philo.exceptions import ViewCanNotProvideSubpath, ViewDoesNotProvideSubpaths, AncestorDoesNotExist

 from philo.signals import view_about_to_render, view_finished_rendering
 
 
 from philo.signals import view_about_to_render, view_finished_rendering
 
 


@@ -33,10 +34,18 @@ class Node(TreeEntity):
                return self.view.render_to_response(request, extra_context)
        
        def get_absolute_url(self):
                return self.view.render_to_response(request, extra_context)
        
        def get_absolute_url(self):

-               root = Site.objects.get_current().root_node

                try:
                try:

-                       return '/%s' % self.get_path(root=root)
-               except AncestorDoesNotExist:
+                       root = Site.objects.get_current().root_node
+               except Site.DoesNotExist:
+                       root = None
+               
+               try:
+                       path = self.get_path(root=root)
+                       if path:
+                               path += '/'
+                       root_url = reverse('philo-root')
+                       return '%s%s' % (root_url, path)
+               except AncestorDoesNotExist, ViewDoesNotExist:

                        return None
        
        class Meta:
                        return None
        
        class Meta:


@@ -53,7 +62,18 @@ class View(Entity):
        accepts_subpath = False
        
        def get_subpath(self, obj):
        accepts_subpath = False
        
        def get_subpath(self, obj):

-               raise ViewDoesNotProvideSubpaths
+               if not self.accepts_subpath:
+                       raise ViewDoesNotProvideSubpaths
+               
+               view_name, args, kwargs = self.get_reverse_params(obj)
+               try:
+                       return reverse(view_name, args=args, kwargs=kwargs, urlconf=self)
+               except NoReverseMatch:
+                       raise ViewCanNotProvideSubpath
+       
+       def get_reverse_params(self, obj):
+               """This method should return a view_name, args, kwargs tuple suitable for reversing a url for the given obj using self as the urlconf."""
+               raise NotImplementedError("View subclasses must implement get_reverse_params to support subpaths.")

        
        def attributes_with_node(self, node):
                return QuerySetMapper(self.attribute_set, passthrough=node.attributes)
        
        def attributes_with_node(self, node):
                return QuerySetMapper(self.attribute_set, passthrough=node.attributes)


@@ -69,7 +89,7 @@ class View(Entity):
                return response
        
        def actually_render_to_response(self, request, extra_context=None):
                return response
        
        def actually_render_to_response(self, request, extra_context=None):

-               raise NotImplementedError('View subclasses must implement render_to_response.')
+               raise NotImplementedError('View subclasses must implement actually_render_to_response.')

        
        class Meta:
                abstract = True
        
        class Meta:
                abstract = True


@@ -81,7 +101,9 @@ _view_content_type_limiter.cls = View
 class MultiView(View):
        accepts_subpath = True
        
 class MultiView(View):
        accepts_subpath = True
        

-       urlpatterns = []
+       @property
+       def urlpatterns(self):
+               raise NotImplementedError("MultiView subclasses must implement urlpatterns.")

        
        def actually_render_to_response(self, request, extra_context=None):
                clear_url_caches()
        
        def actually_render_to_response(self, request, extra_context=None):
                clear_url_caches()


@@ -97,6 +119,39 @@ class MultiView(View):
                        kwargs['extra_context'] = extra_context
                return view(request, *args, **kwargs)
        
                        kwargs['extra_context'] = extra_context
                return view(request, *args, **kwargs)
        

+       def reverse(self, view_name, args=None, kwargs=None, node=None):
+               """Shortcut method to handle the common pattern of getting the absolute url for a multiview's
+               subpaths."""
+               subpath = reverse(view_name, urlconf=self, args=args or [], kwargs=kwargs or {})
+               if node is not None:
+                       return '/%s/%s/' % (node.get_absolute_url().strip('/'), subpath.strip('/'))
+               return subpath
+       
+       def get_context(self):
+               """Hook for providing instance-specific context - such as the value of a Field - to all views."""
+               return {}
+       
+       def basic_view(self, field_name):
+               """
+               Given the name of a field on ``self``, accesses the value of
+               that field and treats it as a ``View`` instance. Creates a
+               basic context based on self.get_context() and any extra_context
+               that was passed in, then calls the ``View`` instance's
+               render_to_response() method. This method is meant to be called
+               to return a view function appropriate for urlpatterns.
+               """
+               field = self._meta.get_field(field_name)
+               view = getattr(self, field.name, None)
+               
+               def inner(request, extra_context=None, **kwargs):
+                       if not view:
+                               raise Http404
+                       context = self.get_context()
+                       context.update(extra_context or {})
+                       return view.render_to_response(request, extra_context=context)
+               
+               return inner
+       

        class Meta:
                abstract = True
 
        class Meta:
                abstract = True
 


@@ -118,7 +173,6 @@ class Redirect(View):
                app_label = 'philo'
 
 
                app_label = 'philo'
 
 

-# Why does this exist?

 class File(View):
        """ For storing arbitrary files """
        
 class File(View):
        """ For storing arbitrary files """