Added CRUD view and template.

rattail/pyramid/templates/crud.mako

@@ -0,0 +1,20 @@
+<%inherit file="/form.mako" />
+
+<%def name="title()">${"New "+form.pretty_name if form.creating else form.pretty_name+' : '+capture(self.model_title)}</%def>
+
+<%def name="model_title()">${h.literal(str(form.fieldset.model))}</%def>
+
+<%def name="head_tags()">
+  ${parent.head_tags()}
+  <script type="text/javascript">
+    $(function() {
+        $('a.delete').click(function() {
+            if (! confirm("Do you really wish to delete this object?")) {
+                return false;
+            }
+        });
+    });
+  </script>
+</%def>
+
+${parent.body()}

rattail/pyramid/views/__init__.py

@@ -26,6 +26,8 @@
 ``rattail.pyramid.views`` -- Pyramid Views
 """
 
+from rattail.pyramid.views.crud import *
+
 
 def includeme(config):
     config.include('rattail.pyramid.views.batches')

rattail/pyramid/views/crud.py

@@ -0,0 +1,204 @@
+#!/usr/bin/env python
+# -*- coding: utf-8  -*-
+################################################################################
+#
+#  Rattail -- Retail Software Framework
+#  Copyright © 2010-2012 Lance Edgar
+#
+#  This file is part of Rattail.
+#
+#  Rattail is free software: you can redistribute it and/or modify it under the
+#  terms of the GNU Affero General Public License as published by the Free
+#  Software Foundation, either version 3 of the License, or (at your option)
+#  any later version.
+#
+#  Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
+#  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+#  FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for
+#  more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with Rattail.  If not, see <http://www.gnu.org/licenses/>.
+#
+################################################################################
+
+"""
+``rattail.pyramid.views.crud`` -- CRUD View
+"""
+
+from pyramid.httpexceptions import HTTPFound
+
+import formalchemy
+
+from edbob.pyramid import Session
+from edbob.pyramid.forms.formalchemy import AlchemyForm
+from edbob.pyramid.views.core import View
+from edbob.util import requires_impl, prettify
+
+
+__all__ = ['CrudView']
+
+
+class CrudView(View):
+
+    readonly = False
+    allow_successive_creates = False
+    update_cancel_route = None
+
+    @property
+    @requires_impl(is_property=True)
+    def mapped_class(self):
+        pass
+
+    @property
+    def pretty_name(self):
+        return self.mapped_class.__name__
+
+    @property
+    @requires_impl(is_property=True)
+    def home_route(self):
+        pass
+
+    @property
+    def home_url(self):
+        return self.request.route_url(self.home_route)
+
+    @property
+    def cancel_route(self):
+        return self.home_route
+
+    @property
+    def cancel_url(self):
+        return self.request.route_url(self.cancel_route)
+
+    def make_fieldset(self, model, **kwargs):
+        kwargs.setdefault('session', Session())
+        kwargs.setdefault('request', self.request)
+        fieldset = formalchemy.FieldSet(model, **kwargs)
+        fieldset.prettify = prettify
+        return fieldset
+
+    def fieldset(self, model):
+        return self.make_fieldset(model)
+
+    def make_form(self, model, **kwargs):
+        self.creating = model is self.mapped_class
+        self.updating = not self.creating
+
+        fieldset = self.fieldset(model)
+        kwargs.setdefault('pretty_name', self.pretty_name)
+        kwargs.setdefault('action_url', self.request.current_route_url())
+        if self.updating and self.update_cancel_route:
+            kwargs.setdefault('cancel_url', self.request.route_url(
+                    self.update_cancel_route, uuid=model.uuid))
+        else:
+            kwargs.setdefault('cancel_url', self.cancel_url)
+        kwargs.setdefault('creating', self.creating)
+        kwargs.setdefault('updating', self.updating)
+        form = AlchemyForm(self.request, fieldset, **kwargs)
+
+        if form.creating:
+            if hasattr(self, 'create_label'):
+                form.create_label = self.create_label
+            if self.allow_successive_creates:
+                form.allow_successive_creates = True
+                if hasattr(self, 'successive_create_label'):
+                    form.successive_create_label = self.successive_create_label
+
+        return form
+
+    def form(self, model):
+        return self.make_form(model)
+
+    def crud(self, model, readonly=False):
+
+        if readonly:
+            self.readonly = True
+
+        form = self.form(model)
+        if readonly:
+            form.readonly = True
+
+        if not form.readonly and self.request.POST:
+            if form.validate():
+                form.save()
+
+                result = self.post_save(form)
+                if result:
+                    return result
+
+                if form.creating:
+                    self.flash_create(form.fieldset.model)
+                else:
+                    self.flash_update(form.fieldset.model)
+
+                if (form.creating and form.allow_successive_creates
+                    and self.request.params.get('create_and_continue')):
+                    return HTTPFound(location=self.request.current_route_url())
+
+                return HTTPFound(location=self.post_save_url(form))
+
+            self.validation_failed(form)
+
+        kwargs = self.template_kwargs(form)
+        kwargs['form'] = form
+        return kwargs
+
+    def template_kwargs(self, form):
+        return {}
+
+    def post_save(self, form):
+        pass
+
+    def post_save_url(self, form):
+        return self.home_url
+
+    def validation_failed(self, form):
+        pass
+
+    def flash_create(self, model):
+        self.request.session.flash("%s \"%s\" has been created." %
+                                   (self.pretty_name, model))
+
+    def flash_delete(self, model):
+        self.request.session.flash("%s \"%s\" has been deleted." %
+                                   (self.pretty_name, model))
+        
+    def flash_update(self, model):
+        self.request.session.flash("%s \"%s\" has been updated." %
+                                   (self.pretty_name, model))
+
+    def create(self):
+        return self.crud(self.mapped_class)
+
+    def read(self):
+        uuid = self.request.matchdict['uuid']
+        model = Session.query(self.mapped_class).get(uuid) if uuid else None
+        if not model:
+            return HTTPFound(location=self.home_url)
+        return self.crud(model, readonly=True)
+
+    def update(self):
+        uuid = self.request.matchdict['uuid']
+        model = Session.query(self.mapped_class).get(uuid) if uuid else None
+        assert model
+        return self.crud(model)
+
+    def pre_delete(self, model):
+        pass
+
+    def post_delete(self, model):
+        pass
+
+    def delete(self):
+        uuid = self.request.matchdict['uuid']
+        model = Session.query(self.mapped_class).get(uuid) if uuid else None
+        assert model
+        result = self.pre_delete(model)
+        if result:
+            return result
+        Session.delete(model)
+        Session.flush() # Don't set flash message if delete fails.
+        self.post_delete(model)
+        self.flash_delete(model)
+        return HTTPFound(location=self.home_url)