From 4bee785ba559418d568676088338d7d50195b0c7 Mon Sep 17 00:00:00 2001
From: Elias Showk <eshowk@entrouvert.com>
Date: Fri, 4 May 2018 18:58:01 +0200
Subject: [PATCH] forms: use a template to render checkboxes widgets (#23413)

---
 tests/test_widgets.py                         | 30 ++++++++++++
 wcs/qommon/form.py                            | 47 ++++++++++---------
 .../qommon/forms/widgets/checkboxes.html      | 18 +++++++
 3 files changed, 73 insertions(+), 22 deletions(-)
 create mode 100644 wcs/qommon/templates/qommon/forms/widgets/checkboxes.html

diff --git a/tests/test_widgets.py b/tests/test_widgets.py
index b58e6a32..ab7dd999 100644
--- a/tests/test_widgets.py
+++ b/tests/test_widgets.py
@@ -2,6 +2,7 @@ import datetime
 import sys
 import shutil
 import copy
+import collections
 
 from quixote import cleanup
 from quixote.http_request import parse_query
@@ -412,6 +413,35 @@ def test_checkboxes_widget():
     assert widget.parse() == ['pear', 'peach']
 
 
+def test_checkboxes_widget_submission_with_options():
+    test_dt = datetime.datetime.now()
+    widget = CheckboxesWidget('test',
+        options_with_attributes=[
+            ('apple', 'Apple', 'apple', {'datetime': test_dt}),
+            ('pear', 'Pear', 'pear', {'datetime': test_dt}),
+            ('peach', 'Peach', 'peach', {'datetime': test_dt})])
+    mock_form_submission(req, widget, {'test$elementpeach': ['yes'], 'test$elementpear': ['yes']})
+    assert widget.parse() == ['pear', 'peach']
+
+
+def test_checkboxes_get_options():
+    test_dt = datetime.datetime.now()
+    any_info = 'any extra info'
+    widget = CheckboxesWidget('test',
+        options_with_attributes=[
+            ('apple', 'Apple', 'apple', {'datetime': test_dt, 'any_info': any_info}),
+            ('pear', 'Pear', 'pear', {'datetime': test_dt}),
+            ('peach', 'Peach', 'peach', {'datetime': test_dt})])
+    assert isinstance(widget.get_options(), collections.Iterator)
+    iter_options = list(widget.get_options())
+    assert len(iter_options) == 3
+    for option in iter_options:
+        assert isinstance(option, dict)
+        assert isinstance(option['options'], dict)
+        assert option['options']['datetime'] == test_dt
+
+    assert iter_options[0]['options']['any_info'] == any_info
+
 def test_composite_widget():
     widget = CompositeWidget('compotest')
     widget.add(StringWidget, name='str1')
diff --git a/wcs/qommon/form.py b/wcs/qommon/form.py
index 49df467e..45176c59 100644
--- a/wcs/qommon/form.py
+++ b/wcs/qommon/form.py
@@ -1109,28 +1109,31 @@ class CheckboxesWidget(CompositeWidget):
     def has_error(self, request=None):
         return Widget.has_error(self, request=request)
 
-    def render_content(self):
-        r = TemplateIO(html=True)
-        if self.inline:
-            r += htmltext('<ul class="inline">')
-        else:
-            r += htmltext('<ul>')
-        for widget in self.get_widgets():
-            if widget.attrs and 'disabled' in widget.attrs:
-                r += htmltext('<li class="disabled"><label>')
-            else:
-                r += htmltext('<li><label>')
-            if self.readonly:
-                widget.attrs['disabled'] = 'disabled'
-                if widget.value:
-                    r += htmltext('<input type="hidden" name="%s" value="yes" >') % widget.name
-                widget.name = widget.name + 'xx'
-            r += widget.render_content()
-            r += htmltext('<span>%s</span>') % widget.title
-            r += htmltext('</label>')
-            r += htmltext('</li>')
-        r += htmltext('</ul>')
-        return r.getvalue()
+    def get_options(self):
+        '''yield dict with options containing widget data and extra informations
+        '''
+        for idx, widget in enumerate(self.get_widgets()):
+            attrs = {'id': 'form_' + widget.name}
+            if widget.required:
+                attrs['aria-required'] = 'true'
+
+            if widget.attrs:
+                attrs.update(widget.attrs)
+
+            option = {
+                'name': widget.name,
+                'value': 'yes',
+                'title': widget.title,
+                'attrs': attrs,
+                'checked': True if widget.value else False,
+            }
+            if widget.name in self.disabled_options:
+                option['disabled'] = 'disabled'
+            if self.options_with_attributes:
+                option['options'] = self.options_with_attributes[idx][-1]
+
+            yield option
+
 
 class ValidatedStringWidget(StringWidget):
     '''StringWidget which checks the value entered is correct according to a regex'''
diff --git a/wcs/qommon/templates/qommon/forms/widgets/checkboxes.html b/wcs/qommon/templates/qommon/forms/widgets/checkboxes.html
new file mode 100644
index 00000000..17815374
--- /dev/null
+++ b/wcs/qommon/templates/qommon/forms/widgets/checkboxes.html
@@ -0,0 +1,18 @@
+{% extends "qommon/forms/widget.html" %}
+{% block widget-control %}
+<ul {% if widget.inline %}class="inline"{% endif %}>
+  {% for option in widget.get_options %}
+    <li {% if "disabled" in option %}class="disabled"{% endif %}>
+      <label>
+        {% if widget.readonly or "disabled" in option %}
+        <input type="hidden" name="{{option.name}}" value="yes" >
+        {% endif %}
+        <input type="checkbox" value="yes" name="{{option.name}}{% if widget.readonly %}xx{% endif %}"
+        {% if widget.readonly or "disabled" in option %}disabled{% endif %}
+        {% if option.checked %}checked="checked"{% endif %}
+        {% for key, value in option.attrs.items %}{{key}}="{{value}}"{% endfor %}
+        ><span>{{ option.title }}</span></label>
+    </li>
+  {% endfor %}
+</ul>
+{% endblock %}
\ No newline at end of file
-- 
2.17.0