Changeset 231

Timestamp:

07/04/06 09:53:31 (3 years ago)

Author:

matt

Message:

Merge -r204:228 fieldgroups to trunk.

The fieldgroups branch introduces groups of fields. A Group is really just a
(dotted) namespace in the Form's data dictionary and a <fieldset> in the HTML.

See the ChangeLog? and examples for more information.

Files:

• trunk/ChangeLog (modified) (1 diff)
• trunk/formal/__init__.py (modified) (2 diffs)
• trunk/formal/examples/group.py (copied) (copied from branches/fieldgroups/formal/examples/group.py) (1 diff)
• trunk/formal/examples/hidden.py (copied) (copied from branches/fieldgroups/formal/examples/hidden.py)
• trunk/formal/examples/main.py (modified) (2 diffs)
• trunk/formal/form.py (modified) (14 diffs)
• trunk/formal/formal.css (modified) (1 diff)
• trunk/formal/util.py (modified) (2 diffs)
• trunk/formal/widget.py (modified) (14 diffs)
• trunk/formal/widgets/multiselect.py (modified) (2 diffs)
• trunk/formal/widgets/restwidget.py (modified) (3 diffs)
• trunk/setup.py (modified) (1 diff)

trunk/ChangeLog

@@ +1 @@
+2006-07-04  Matt Goodall <matt@pollenation.net>
+
+        Added groups of fields. A Group of Fields can now be added to a Form using
+        the Form.add() method. Fields are added to the Group using the Group.add()
+        method. A Group can also be added to another Group using Group.add()
+        
+        A Group is reresented by a <fieldset> element and it completely contains
+        its Fields. A Group currently performs to validation of its own.
+
+        Each Group is named, just like a Field, and the name must be unique within
+        the context of the object it is added to (i.e. a Group of Form). The
+        effect of the Group's name is that an extra "segment" is added to the Form
+        data's dict keys to provide the namespace for Fields in a Group.
+        
+        For instance, if a Field, 'bar', is added to a Group, 'foo', and that
+        Group is then added to a Form the field's data key is 'foo.bar'.
+
+        This change introduces a new Form.add() method. It is intended to replace
+        Form.addField() although that method still exists. All Form.addField(...)
+        now does is forward the call to Form.add(formal.Field(...)).
+        Form.addField() will probably be deprecated sometime.
+
+        I may have slighty broken the default (and your) stylesheet with this
+        change because I had been using a <fieldset> immediately inside the <form>
+        element. That turns out to be unnecessary (any block element will do) so I
+        decided to use a <fieldset> only for Groups to keep the <fieldset> nesting
+        as shallow as possible.
+
-2005-12-21  Damian Staniforth <damian@pollenation.net>
-

trunk/formal/__init__.py

@@ -4 +4 @@
-
-
-8, 2
+9, 0
-version = '.'.join([str(i) for i in version_info])
-
@@ -14 +14 @@
-from formal.widgets.restwidget import *
-from formal.widgets.multiselect import *
-
+Field, Group, 
-from formal import iformal
-

trunk/formal/examples/group.py

@@ -24 +24 @@
-
-        form = formal.Form()
-Field('before', formal.String(
+(formal.Field('before', formal.String()
-        form.add(makePersonGroup('me'))
-        form.add(makePersonGroup('you'))
-Field('after', formal.String(
+(formal.Field('after', formal.String()
-        form.addAction(self.submitted)
-

trunk/formal/examples/main.py

@@ -14 +14 @@
-    'formal.examples.missing.MissingFormPage',
-    'formal.examples.prepopulate.PrepopulateFormPage',
+    'formal.examples.group.GroupFormPage',
-    'formal.examples.fileupload.FileUploadFormPage',
-    'formal.examples.smartupload.SmartUploadFormPage',
@@ -22 +23 @@
-    'formal.examples.restwidget.ReSTWidgetFormPage',
-    'formal.examples.nofields.NoFieldsFormPage',
+    'formal.examples.hidden.HiddenFieldsFormPage',
-    ]
-

trunk/formal/form.py

@@ -6 +6 @@
-from twisted.internet import defer
-from twisted.python.components import registerAdapter
-
+rend, 
-from nevow.util import getPOSTCharset
-from formal import iformal, util, validation
@@ -71 +71 @@
-
-
+
+class Field(object):
+
+
+    itemParent = None
+
+
+    def __init__(self, name, type, widgetFactory=None, label=None,
+            description=None, cssClass=None):
+        if not util.validIdentifier(name):
+            raise ValueError('%r is an invalid field name'%name)
+        if label is None:
+            label = util.titleFromName(name)
+        if widgetFactory is None:
+            widgetFactory = iformal.IWidget
+        self.name = name
+        self.type = type
+        self.widgetFactory = widgetFactory
+        self.label = label
+        self.description = description
+        self.cssClass = cssClass
+
+
+    def setItemParent(self, itemParent):
+        self.itemParent = itemParent
+
+
+    def _getKey(self):
+        parts = [self.name]
+        parent = self.itemParent
+        while parent is not None:
+            parts.append(parent.name)
+            parent = parent.itemParent
+        parts.reverse()
+        return '.'.join(parts)
+
+
+    key = property(_getKey)
+
+
+    def makeWidget(self):
+        return self.widgetFactory(self.type)
+
+
+    def process(self, ctx, form, args, errors):
+
+        # If the type is immutable then copy the original value to args in case
+        # another validation error causes this field to be re-rendered.
+        if self.type.immutable:
+            args[self.key] = form.data.get(self.key)
+            return
+
+        # Process the input using the widget, storing the data back on the form.
+        try:
+            form.data[self.key] = self.makeWidget().processInput(ctx, self.key, args)
+        except validation.FieldError, e:
+            if e.fieldName is None:
+                e.fieldName = self.key
+            errors.add(e)
+
+
+
+class FieldFragment(rend.Fragment):
+    implements(inevow.IRenderer)
+
+
+    docFactory = loaders.stan(
+        T.div(id=T.slot('fieldId'), _class=T.slot('class'),
+                render=T.directive('field'))[
+            T.label(_class='label', _for=T.slot('id'))[T.slot('label')],
+            T.div(_class='inputs')[T.slot('inputs')],
+            T.slot('description'),
+            T.slot('message'),
+            ])
+
+
+    hiddenDocFactory = loaders.stan(
+            T.invisible(render=T.directive('field'))[T.slot('inputs')])
+
+
+    def __init__(self, field):
+        self.field = field
+        # Nasty hack to work out if this is a hidden field. Keep the widget
+        # for later anyway.
+        self.widget = field.makeWidget()
+        if getattr(self.widget, 'inputType', None) == 'hidden':
+            self.docFactory = self.hiddenDocFactory
+
+
+    def render_field(self, ctx, data):
+
+        # The field we're rendering
+        field = self.field
+
+        # Get stuff from the context
+        formData = iformal.IFormData(ctx)
+        formErrors = iformal.IFormErrors(ctx, None)
+
+        # Find any error
+        if formErrors is None:
+            error = None
+        else:
+            error = formErrors.getFieldError(field.key)
+
+        # Build the error message
+        if error is None:
+            message = ''
+        else:
+            message = T.div(class_='message')[error.message]
+
+        # Create the widget (it's created in __init__ as a hack)
+        widget = self.widget
+
+        # Build the list of CSS classes
+        classes = [
+            'field',
+            field.type.__class__.__name__.lower(),
+            widget.__class__.__name__.lower(),
+            ]
+        if field.type.required:
+            classes.append('required')
+        if field.cssClass:
+            classes.append(field.cssClass)
+        if error:
+            classes.append('error')
+
+        # Create the widget and decide the method that should be called
+        if field.type.immutable:
+            render = widget.renderImmutable
+        else:
+            render = widget.render
+
+        # Fill the slots
+        ctx.tag.fillSlots('id', util.render_cssid(field.key))
+        ctx.tag.fillSlots('fieldId', [util.render_cssid(field.key), '-field'])
+        ctx.tag.fillSlots('class', ' '.join(classes))
+        ctx.tag.fillSlots('label', field.label)
+        ctx.tag.fillSlots('inputs', render(ctx, field.key, formData,
+            formErrors))
+        ctx.tag.fillSlots('message', message)
+        ctx.tag.fillSlots('description',
+                T.div(class_='description')[field.description or ''])
+
+        return ctx.tag
+
+
+
+registerAdapter(FieldFragment, Field, inevow.IRenderer)
+
+
+
+class Group(object):
+
+
+    itemParent = None
+
+
+    def __init__(self, name, label=None, description=None):
+        if label is None:
+            label = util.titleFromName(name)
+        self.name = name
+        self.label = label
+        self.description = description
+        self.items = FormItems(self)
+        # Forward to FormItems methods
+        self.add = self.items.add
+        self.getItemByName = self.items.getItemByName
+
+
+    def setItemParent(self, itemParent):
+        self.itemParent = itemParent
+
+
+    def process(self, ctx, form, args, errors):
+        for item in self.items:
+            item.process(ctx, form, args, errors)
+
+
+
+class GroupFragment(rend.Fragment):
+
+
+    docFactory = loaders.stan(
+            T.fieldset(id=T.slot('id'), render=T.directive('group'))[
+                T.legend[T.slot('label')],
+                T.div(class_='description')[T.slot('description')],
+                T.slot('items'),
+                ]
+            )
+
+
+    def __init__(self, group):
+        super(GroupFragment, self).__init__()
+        self.group = group
+
+
+    def render_group(self, ctx, data):
+        group = self.group
+        ctx.tag.fillSlots('id', util.render_cssid(group.name))
+        ctx.tag.fillSlots('label', group.label)
+        ctx.tag.fillSlots('description', group.description or '')
+        ctx.tag.fillSlots('items', [inevow.IRenderer(item) for item in
+                group.items])
+        return ctx.tag
+
+
+
+registerAdapter(GroupFragment, Group, inevow.IRenderer)
+
+
+
-class Form(object):
-
@@ -77 +288 @@
-    callback = None
-    actions = None
-    widgets = None
-
-    def __init__(self, callback=None):
@@ -84 +294 @@
-        self.resourceManager = ResourceManager()
-        self.data = {}
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
-    def addAction(self, callback, name="submit", validate=True, label=None):
@@ -105 +310 @@
-        self.actions.append( Action(callback, name, validate, label) )
-
-    def getField(self,fieldName):
-        for name, type, label, description, cssClass in self.items:
-            if name == fieldName:
-                return (name, type, label, description, cssClass)
-        else:
-            return None
-            
-
-    def widgetForItem(self, itemName):
-
-        for name, type, label, description, cssClass in self.items:
-            if name == itemName:
-                break
-        else:
-            raise KeyError()
-
-        if self.widgets is not None:
-            try:
-                widgetFactory = self.widgets[name]
-            except KeyError:
-                pass
-            else:
-                return widgetFactory(type)
-
-        return iformal.IWidget(type)
-
-    def process(self, ctx):
-
@@ -138 +317 @@
-        # Decode the request arg names
-        charset = getPOSTCharset(ctx)
-
-
-
-
-
-
-
-
-
-
-
+
-
-        # Find the callback to use, defaulting to the form default
@@ -170 +339 @@
-
-        # Iterate the items and collect the form data and/or errors.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-            return errors
-
@@ -192 +350 @@
-            return r
-
-
+self.
-        d.addCallback( _clearUpResources )
-        d.addErrback(self._cbFormProcessingFailed, ctx)
@@ -203 +361 @@
-        errors.add(failure.value)
-        return errors
+
+
+
+class FormItems(object):
+    """
+    A managed collection of form items.
+    """
+
+
+    def __init__(self, itemParent):
+        self.items = []
+        self.itemParent = itemParent
+
+
+    def __iter__(self):
+        return iter(self.items)
+
+
+    def add(self, item):
+        # Check the item name is unique
+        if item.name in [i.name for i in self.items]:
+            raise ValueError('Item named %r already added to %r' %
+                    (item.name, self))
+        # Add to child items and set self the parent
+        self.items.append(item)
+        item.setItemParent(self.itemParent)
+
+
+    def getItemByName(self, name):
+        name = name.split('.', 1)
+        if len(name) == 1:
+            name, rest = name[0], None
+        else:
+            name, rest = name[0], name[1]
+        for item in self.items:
+            if item.name == name:
+                if rest is None:
+                    return item
+                return item.getItemByName(rest)
+        raise KeyError("No item called %r" % name)
+
-
-
@@ -246 +445 @@
-    def _fileFromWidget(self, form, ctx, segments):
-        ctx.remember(form, iformal.IForm)
-widgetForItem(segments[0]
+getItemByName(segments[0]).makeWidget(
-        return widget.getResource(ctx, segments[0], segments[1:])
-
@@ -413 +612 @@
-
-    loader = loaders.stan(
-
-
+
+
+
+
-                T.input(type='hidden', name='_charset_'),
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-                T.div(class_='actions')[
-a
+formA
-                    ],
-                ],
@@ -442 +633 @@
-    def rend(self, ctx, data):
-        tag = T.invisible[self.loader.load()]
-
-
-
-
-
-
-
+
+
+
+
+
+
-        return tag
-
@@ -464 +654 @@
-        for error in errors:
-            if isinstance(error, validation.FieldError):
-name, type, label, description, cssClass = self.original.getField
-
+item = self.original.getItemByName
+item.
-        return T.div(class_='errors')[ T.p['Please correct the following errors:'], errorList ]
-
@@ -472 +662 @@
-            yield ''
-            return
-        itemPattern = inevow.IQ(ctx).patternGenerator('item')
-        for item in self.original.items:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
-    def _renderActions(self, ctx, data):

trunk/formal/formal.css

@@ -2 +2 @@
-  border: 1px solid #ccc;
-  padding: 5px;
-}
-
-.nevow-form fieldset {
-  margin: 0;
-  border: 0;
-  padding: 0;
-}
-

trunk/formal/util.py

@@ -1 +1 @@
-import re
-from zope.interface import implements
-
+, tags
-from formal import iformal
-
@@ -30 +30 @@
-
-    return ''.join(_())
+
+
+def render_cssid(fieldKey, *extras):
+    """
+    Render the CSS id for the form field's key.
+    """
+    l = [tags.slot('formName'), '-', '-'.join(fieldKey.split('.'))]
+    for extra in extras:
+        l.append('-')
+        l.append(extra)
+    return l
-
-

trunk/formal/widget.py

@@ -8 +8 @@
-from nevow.i18n import _
-from formal import converters, iformal, validation
-keyto
+render_
-from formal.form import widgetResourceURL, widgetResourceURLFromContext
-from zope.interface import implements
@@ -33 +33 @@
-
-    def _renderTag(self, ctx, key, value, readonly):
-keytocssid(ctx.
+render_cssid(
-        if readonly:
-            tag(class_='readonly', readonly='readonly')
@@ -69 +69 @@
-
-    def _renderTag(self, ctx, key, value, disabled):
-keytocssid(ctx.
+render_cssid(
-        if value == 'True':
-            tag(checked='checked')
@@ -124 +124 @@
-
-    def _renderTag(self, ctx, key, value, readonly):
-keytocssid(ctx.
+render_cssid(
-        if readonly:
-            tag(class_='readonly', readonly='readonly')
@@ -161 +161 @@
-            values = ('', '')
-        return [
-keytocssid(ctx.
+render_cssid(
-            T.br,
-'%s__confirm'%keytocssid(ctx.key
-'%s__confirm'%keytocssid(ctx.key
+render_cssid(key, 'confirm'
+render_cssid(key, 'confirm'
-            ]
-
@@ -170 +170 @@
-        values = ('', '')
-        return [
-keytocssid(ctx.
+render_cssid(
-            T.br,
-
-
+
+
+
-        ]
-
@@ -249 +250 @@
-                yield option
-
-keytocssid(ctx.
+render_cssid(
-        if disabled:
-            tag(class_='disabled', disabled='disabled')
@@ -355 +356 @@
-        tag = T.invisible[self.template.load(ctx)]
-        tag.fillSlots('key', key)
-keytocssid(ctx.
+render_cssid(
-        tag.fillSlots('options', optionTags)
-        tag.fillSlots('otherValue', otherValue)
@@ -383 +384 @@
-
-        def renderOption(ctx, itemKey, itemLabel, num, selected):
-(keytocssid(ctx.key),'-',
+render_cssid(key, 
-            tag = T.input(name=key, type='radio', id=cssid, value=itemKey)
-            if selected:
@@ -632 +633 @@
-                optLabel = iformal.ILabel(item).label()
-                optValue = converter.fromType(optValue)
-
-
+
+
+
-                if optValue in values:
-                    checkbox = checkbox(checked='checked')
@@ -683 +685 @@
-
-    def _renderTag(self, ctx, key, disabled):
-keytocssid(ctx.
+render_cssid(
-        if disabled:
-            tag(class_='disabled', disabled='disabled')
@@ -733 +735 @@
-
-        yield T.input(name=namer('value'),value=value,type='hidden')
-keytocssid(ctx.
+render_cssid(
-        if disabled:
-            tag(class_='disabled', disabled='disabled')
@@ -863 +865 @@
-            yield T.p[T.strong['Nothing uploaded']]
-
-keytocssid(ctx.
+render_cssid(
-
-        # Id of uploaded file in the resource manager
@@ -983 +985 @@
-        else:
-            value = iformal.IStringConvertible(self.original).fromType(args.get(key))
-keytocssid(ctx.
+render_cssid(
-
-    def renderImmutable(self, ctx, key, args, errors):

trunk/formal/widgets/multiselect.py

@@ -2 +2 @@
-from nevow import tags as T
-from formal import iformal
-keyto
+render_
-
-_UNSET = object()
@@ -73 +73 @@
-                yield option
-
-keytocssid(ctx.
+render_cssid(
-
-        if disabled:

trunk/formal/widgets/restwidget.py

@@ -5 +5 @@
-from nevow import inevow, loaders, rend, tags as T
-from formal import iformal, widget
-keyto
+render_
-from formal.form import widgetResourceURLFromContext
-
@@ -25 +25 @@
-    def _renderTag(self, ctx, key, value, readonly):
-        tag=T.invisible()
-keytocssid(ctx.
+render_cssid(
-        if readonly:
-            ta(class_='readonly', readonly='readonly')
@@ -37 +37 @@
-            else:
-                form = iformal.IForm( ctx )
-keytocssid(ctx.
-srcId + '-preview-div'
-srcId + '-preview-frame'
+render_cssid(
+render_cssid(key, 'preview-div')
+render_cssid(key, 'preview-frame')
-                targetURL = widgetResourceURLFromContext(ctx, form.name).child(key).child( srcId )
-                tag[T.br()]
-
+
+
+
-                tag[T.div(id=previewDiv, class_="preview-hidden")[
-                        T.iframe(class_="preview-frame", name=frameId, id=frameId),
-                        T.br(),
-Click="return Forms.Util.previewHide('%s');"%(previewDiv)
+click=["return Forms.Util.previewHide('", previewDiv, "');"]
-                    ]
-                ]

trunk/setup.py

@@ -3 +3 @@
-setup(
-    name='formal',
-8.2
+9
-    description='HTML forms framework for Nevow',
-    author='Matt Goodall',