Fixed form-filler wrt checkboxes and radios, and added some tests (to be completed: <select> and <input type=radio> still don't have tests)

tbroyer · tbroyer · commit d7698cd0ad8f · 2007-07-24T08:02:52.000Z
--HG--
extra : convert_revision : svn%3Aacbfec75-9323-0410-a652-858a13e371e0/trunk%40916
diff --git a/src/html5lib/filters/formfiller.py b/src/html5lib/filters/formfiller.py
@@ -1,121 +1,121 @@
-#
-# The goal is to finally have a form filler where you pass data for
-# each form, using the algorithm for "Seeding a form with initial values"
-# See http://www.whatwg.org/specs/web-forms/current-work/#seeding
-#
-
-import _base
-
-from html5lib.constants import spaceCharacters
-spaceCharacters = u"".join(spaceCharacters)
-
-class SimpleFilter(_base.Filter):
-    def __init__(self, source, fieldStorage):
-        _base.Filter.__init__(self, source)
-        self.fieldStorage = fieldStorage
-
-    def __iter__(self):
-        field_indices = {}
-        state = None
-        field_name = None
-        for token in _base.Filter.__iter__(self):
-            type = token["type"]
-            if type in ("StartTag", "EmptyTag"):
-                name = token["name"].lower()
-                if name == "input":
-                    field_name = None
-                    field_type = None
-                    input_value_index = -1
-                    input_checked_index = -1
-                    for i,(n,v) in enumerate(token["data"]):
-                        n = n.lower()
-                        if n == "name":
-                            field_name = v.strip(spaceCharacters)
-                        elif n == "type":
-                            field_type = v.strip(spaceCharacters)
-                        elif n == "checked":
-                            input_checked_index = i
-                        elif n == "value":
-                            input_value_index = i
-
-                    value_list = self.fieldStorage.getlist(field_name)
-                    field_index = field_indices.setdefault(field_name, 0)
-                    if field_index < len(value_list):
-                        value = value_list[field_index]
-                    else:
-                        value = ""
-
-                    if type in ("checkbox", "radio"):
-                        if value_list:
-                            if token["data"][input_value_index] == value:
-                                if input_checked_index < 0:
-                                    token["data"].append((u"checked", u""))
-                                field_indices[field_name] = field_index + 1
-                            elif input_checked_index >= 0:
-                                del token["data"][input_checked_index]
-
-                    elif type not in ("button", "submit", "reset"):
-                        if input_value_index >= 0:
-                            token["data"][input_value_index] = (u"value", value)
-                        else:
-                            token["data"].append((u"value", value))
-                        field_indices[field_name] = field_index + 1
-
-                    field_type = None
-                    field_name = None
-
-                elif name == "textarea":
-                    field_type = "textarea"
-                    field_name = dict(reversed(token["data"]))["name"]
-
-                elif name == "select":
-                    field_type = "select"
-                    attributes = dict(reversed(token["data"]))
-                    field_name = attributes.get("name")
-                    is_select_multiple = "multiple" in attributes
-
-                elif state == "in_select" and field_name and name == "option":
-                    option_selected_index = -1
-                    option_value = None
-                    for i,(n,v) in enumerate(token["data"]):
-                        n = n.lower()
-                        if n == "selected":
-                            option_selected_index = i
-                        elif n == "value":
-                            option_value = v.strip(spaceCharacters)
-                    if option_value is None:
-                        raise NotImplementedError("<option>s must have a value= attribute")
-                    else:
-                        value_list = self.fieldStorage.getlist(field_name)
-                        if value_list:
-                            field_index = field_indices.setdefault(field_name, 0)
-                            if field_index < len(value_list):
-                                value = value_list[field_index]
-                            else:
-                                value = ""
-                            if option_value == value:
-                                if option_selected_index < 0:
-                                    token["data"].append((u"selected", u""))
-                                field_indices[field_name] = field_index + 1
-                            elif option_selected_index >= 0:
-                                del token["data"][option_selected_index]
-
-            elif field_type is not None and field_name and type == "EndTag":
-                name = token["name"].lower()
-                if name == "textarea":
-                    value_list = self.fieldStorage.getlist(field_name)
-                    if value_list:
-                        field_index = field_indices.setdefault(field_name, 0)
-                        if field_index < len(value_list):
-                            value = value_list[field_index]
-                        else:
-                            value = ""
-                        yield {"type": "Characters", "data": value}
-
-                field_indices[field_name] = field_index + 1
-                field_name = None
-
-            elif field_type == "textarea":
-                continue # ignore token
-
-            yield token
+#
+# The goal is to finally have a form filler where you pass data for
+# each form, using the algorithm for "Seeding a form with initial values"
+# See http://www.whatwg.org/specs/web-forms/current-work/#seeding
+#
+
+import _base
+
+from html5lib.constants import spaceCharacters
+spaceCharacters = u"".join(spaceCharacters)
+
+class SimpleFilter(_base.Filter):
+    def __init__(self, source, fieldStorage):
+        _base.Filter.__init__(self, source)
+        self.fieldStorage = fieldStorage
+
+    def __iter__(self):
+        field_indices = {}
+        state = None
+        field_name = None
+        for token in _base.Filter.__iter__(self):
+            type = token["type"]
+            if type in ("StartTag", "EmptyTag"):
+                name = token["name"].lower()
+                if name == "input":
+                    field_name = None
+                    field_type = None
+                    input_value_index = -1
+                    input_checked_index = -1
+                    for i,(n,v) in enumerate(token["data"]):
+                        n = n.lower()
+                        if n == u"name":
+                            field_name = v.strip(spaceCharacters)
+                        elif n == u"type":
+                            field_type = v.strip(spaceCharacters)
+                        elif n == u"checked":
+                            input_checked_index = i
+                        elif n == u"value":
+                            input_value_index = i
+
+                    value_list = self.fieldStorage.getlist(field_name)
+                    field_index = field_indices.setdefault(field_name, 0)
+                    if field_index < len(value_list):
+                        value = value_list[field_index]
+                    else:
+                        value = ""
+
+                    if field_type in (u"checkbox", u"radio"):
+                        if value_list:
+                            if token["data"][input_value_index][1] == value:
+                                if input_checked_index < 0:
+                                    token["data"].append((u"checked", u""))
+                                field_indices[field_name] = field_index + 1
+                            elif input_checked_index >= 0:
+                                del token["data"][input_checked_index]
+
+                    elif field_type not in (u"button", u"submit", u"reset"):
+                        if input_value_index >= 0:
+                            token["data"][input_value_index] = (u"value", value)
+                        else:
+                            token["data"].append((u"value", value))
+                        field_indices[field_name] = field_index + 1
+
+                    field_type = None
+                    field_name = None
+
+                elif name == "textarea":
+                    field_type = "textarea"
+                    field_name = dict(reversed(token["data"]))["name"]
+
+                elif name == "select":
+                    field_type = "select"
+                    attributes = dict(reversed(token["data"]))
+                    field_name = attributes.get("name")
+                    is_select_multiple = "multiple" in attributes
+
+                elif state == "in_select" and field_name and name == "option":
+                    option_selected_index = -1
+                    option_value = None
+                    for i,(n,v) in enumerate(token["data"]):
+                        n = n.lower()
+                        if n == "selected":
+                            option_selected_index = i
+                        elif n == "value":
+                            option_value = v.strip(spaceCharacters)
+                    if option_value is None:
+                        raise NotImplementedError("<option>s must have a value= attribute")
+                    else:
+                        value_list = self.fieldStorage.getlist(field_name)
+                        if value_list:
+                            field_index = field_indices.setdefault(field_name, 0)
+                            if field_index < len(value_list):
+                                value = value_list[field_index]
+                            else:
+                                value = ""
+                            if option_value == value:
+                                if option_selected_index < 0:
+                                    token["data"].append((u"selected", u""))
+                                field_indices[field_name] = field_index + 1
+                            elif option_selected_index >= 0:
+                                del token["data"][option_selected_index]
+
+            elif field_type is not None and field_name and type == "EndTag":
+                name = token["name"].lower()
+                if name == "textarea":
+                    value_list = self.fieldStorage.getlist(field_name)
+                    if value_list:
+                        field_index = field_indices.setdefault(field_name, 0)
+                        if field_index < len(value_list):
+                            value = value_list[field_index]
+                        else:
+                            value = ""
+                        yield {"type": "Characters", "data": value}
+
+                field_indices[field_name] = field_index + 1
+                field_name = None
+
+            elif field_type == "textarea":
+                continue # ignore token
+
+            yield token
diff --git a/tests/test_formfiller.py b/tests/test_formfiller.py
@@ -1,43 +1,94 @@
-import unittest
-
-from html5lib.filters.formfiller import SimpleFilter
-
-class FieldStorage(dict):
-    def getlist(self, name):
-        l = self[name]
-        if isinstance(l, list):
-            return l
-        elif isinstance(l, tuple) or hasattr(l, '__iter__'):
-            return list(l)
-        return [l]
-
-class TestCase(unittest.TestCase):
-    def runTest(self, input, formdata, expected):
-        output = list(SimpleFilter(input, formdata))
-        errorMsg = "\n".join(["\n\nInput:", str(input),
-                              "\nForm data:", str(formdata),
-                              "\nExpected:", str(expected),
-                              "\nReceived:", str(output)])
-        self.assertEquals(output, expected, errorMsg)
-
-    def testSingleTextInputWithValue(self):
-        self.runTest(
-            [{"type": u"EmptyTag", "name": u"input",
-                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", u"quux")]}],
-            FieldStorage({"foo": "bar"}),
-            [{"type": u"EmptyTag", "name": u"input",
-                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", "bar")]}])
-
-    def testSingleTextInputWithoutValue(self):
-        self.runTest(
-            [{"type": u"EmptyTag", "name": u"input",
-                "data": [(u"type", u"text"), (u"name", u"foo")]}],
-            FieldStorage({"foo": "bar"}),
-            [{"type": u"EmptyTag", "name": u"input",
-                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", "bar")]}])
-
-def main():
-    unittest.main()
-
-if __name__ == "__main__":
-    main()
+import unittest
+
+from html5lib.filters.formfiller import SimpleFilter
+
+class FieldStorage(dict):
+    def getlist(self, name):
+        l = self[name]
+        if isinstance(l, list):
+            return l
+        elif isinstance(l, tuple) or hasattr(l, '__iter__'):
+            return list(l)
+        return [l]
+
+class TestCase(unittest.TestCase):
+    def runTest(self, input, formdata, expected):
+        output = list(SimpleFilter(input, formdata))
+        errorMsg = "\n".join(["\n\nInput:", str(input),
+                              "\nForm data:", str(formdata),
+                              "\nExpected:", str(expected),
+                              "\nReceived:", str(output)])
+        self.assertEquals(output, expected, errorMsg)
+
+    def testSingleTextInputWithValue(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", u"quux")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", u"bar")]}])
+
+    def testSingleTextInputWithoutValue(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"text"), (u"name", u"foo")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"text"), (u"name", u"foo"), (u"value", u"bar")]}])
+
+    def testSingleCheckbox(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"bar")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"bar"), (u"checked", u"")]}])
+
+    def testSingleCheckboxShouldBeUnchecked(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"quux")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"quux")]}])
+
+    def testSingleCheckboxCheckedByDefault(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"bar"), (u"checked", u"")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"bar"), (u"checked", u"")]}])
+
+    def testSingleCheckboxCheckedByDefaultShouldBeUnchecked(self):
+        self.runTest(
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"quux"), (u"checked", u"")]}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"EmptyTag", "name": u"input",
+                "data": [(u"type", u"checkbox"), (u"name", u"foo"), (u"value", u"quux")]}])
+
+    def testSingleTextareaWithValue(self):
+        self.runTest(
+            [{"type": u"StartTag", "name": u"textarea", "data": [(u"name", u"foo")]},
+             {"type": u"Characters", "data": u"quux"},
+             {"type": u"EndTag", "name": u"textarea", "data": []}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"StartTag", "name": u"textarea", "data": [(u"name", u"foo")]},
+             {"type": u"Characters", "data": u"bar"},
+             {"type": u"EndTag", "name": u"textarea", "data": []}])
+
+    def testSingleTextareaWithoutValue(self):
+        self.runTest(
+            [{"type": u"StartTag", "name": u"textarea", "data": [(u"name", u"foo")]},
+             {"type": u"EndTag", "name": u"textarea", "data": []}],
+            FieldStorage({"foo": "bar"}),
+            [{"type": u"StartTag", "name": u"textarea", "data": [(u"name", u"foo")]},
+             {"type": u"Characters", "data": u"bar"},
+             {"type": u"EndTag", "name": u"textarea", "data": []}])
+
+def main():
+    unittest.main()
+
+if __name__ == "__main__":
+    main()
