Changeset 50:a37c65be8203 for wokkel

Timestamp:

Jan 12, 2009, 9:10:58 PM (13 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@158

Message:

Selectively render Data Forms fields depending on form type.

Author: ralphm.
Reviewer: tofu.
Fixes #40.

Location:

wokkel

Files:

• data_form.py (modified) (5 diffs)
• test/test_data_form.py (modified) (3 diffs)

wokkel/data_form.py

@@ -1 +1 @@
 # -*- test-case-name: wokkel.test.test_data_form -*-
 #
-# Copyright (c) 2003-2008 Ralph Meijer
+# Copyright (c) 2003-2009 Ralph Meijer
 # See LICENSE for details.
 
@@ -229 +229 @@
             self.values = newValues
 
-    def toElement(self):
+    def toElement(self, asForm=False):
         """
         Return the DOM representation of this Field.
@@ -239 +239 @@
 
         field = domish.Element((NS_X_DATA, 'field'))
-        field['type'] = self.fieldType
+
+        if asForm or self.fieldType != 'text-single':
+            field['type'] = self.fieldType
 
         if self.var is not None:
@@ -249 +251 @@
             field.addElement('value', content=value)
 
-        if self.fieldType in ('list-single', 'list-multi'):
-            for option in self.options:
-                field.addChild(option.toElement())
-
-        if self.label is not None:
-            field['label'] = self.label
-
-        if self.desc is not None:
-            field.addElement('desc', content=self.desc)
-
-        if self.required:
-            field.addElement('required')
+        if asForm:
+            if self.fieldType in ('list-single', 'list-multi'):
+                for option in self.options:
+                    field.addChild(option.toElement())
+
+            if self.label is not None:
+                field['label'] = self.label
+
+            if self.desc is not None:
+                field.addElement('desc', content=self.desc)
+
+            if self.required:
+                field.addElement('required')
 
         return field
@@ -425 +428 @@
 
         for field in self.fieldList:
-            form.addChild(field.toElement())
+            form.addChild(field.toElement(self.formType=='form'))
 
         return form

wokkel/test/test_data_form.py

@@ -1 @@
-# Copyright (c) 2003-2008 Ralph Meijer
+# Copyright (c) 2003-2009 Ralph Meijer
 # See LICENSE for details.
 
@@ -38 +38 @@
 
     def test_basic(self):
+        """
+        Test basic field initialization.
+        """
         field = Field(var='test')
         self.assertEqual('text-single', field.fieldType)
         self.assertEqual('test', field.var)
 
+
+    def test_noFieldName(self):
+        field = Field()
+        self.assertRaises(FieldNameRequiredError, field.toElement)
+
+
+    def test_toElement(self):
+        """
+        Test rendering to a DOM.
+        """
+        field = Field(var='test')
         element = field.toElement()
 
@@ -47 +61 @@
         self.assertEquals('field', element.name)
         self.assertEquals(NS_X_DATA, element.uri)
-        self.assertEquals('text-single', element['type'])
+        self.assertEquals('text-single',
+                          element.getAttribute('type', 'text-single'))
         self.assertEquals('test', element['var'])
         self.assertEquals([], element.children)
 
 
-    def test_noFieldName(self):
-        field = Field()
-        self.assertRaises(FieldNameRequiredError, field.toElement)
+    def test_toElementTypeNotListSingle(self):
+        """
+        Always render the field type, if different from list-single.
+        """
+        field = Field('hidden', var='test')
+        element = field.toElement()
+
+        self.assertEquals('hidden', element.getAttribute('type'))
+
+
+    def test_toElementAsForm(self):
+        """
+        Always render the field type, if asForm is True.
+        """
+        field = Field(var='test')
+        element = field.toElement(True)
+
+        self.assertEquals('text-single', element.getAttribute('type'))
+
+
+    def test_toElementOptions(self):
+        """
+        Test rendering to a DOM with options.
+        """
+        field = Field('list-single', var='test')
+        field.options = [Option(u'option1'), Option(u'option2')]
+        element = field.toElement(True)
+
+        self.assertEqual(2, len(element.children))
+
+
+    def test_toElementLabel(self):
+        """
+        Test rendering to a DOM with a label.
+        """
+        field = Field(var='test', label=u'my label')
+        element = field.toElement(True)
+
+        self.assertEqual(u'my label', element.getAttribute('label'))
+
+
+    def test_toElementDescription(self):
+        """
+        Test rendering to a DOM with options.
+        """
+        field = Field(var='test', desc=u'My desc')
+        element = field.toElement(True)
+
+        self.assertEqual(1, len(element.children))
+        child = element.children[0]
+        self.assertEqual('desc', child.name)
+        self.assertEqual(NS_X_DATA, child.uri)
+        self.assertEqual(u'My desc', unicode(child))
+
+
+    def test_toElementRequired(self):
+        """
+        Test rendering to a DOM with options.
+        """
+        field = Field(var='test', required=True)
+        element = field.toElement(True)
+
+        self.assertEqual(1, len(element.children))
+        child = element.children[0]
+        self.assertEqual('required', child.name)
+        self.assertEqual(NS_X_DATA, child.uri)