From 17ce8fd57f758951f2db8478648bf1fe58b590de Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20P=C3=A9ters?= <fpeters@entrouvert.com>
Date: Tue, 27 Oct 2015 14:07:50 +0100
Subject: [PATCH] fields: review item field to get back to previous behaviour
 (#8785)

In recent commits we tried to handle optional item field with an empty value
prepended to the list of options but while this allows the user to leave
optional fields uncompleted this is not the same behaviour we add.

Return to the previous behaviour.  The only way for an item field to be skipped
is now to be displayed as a <select> field with the hint put as the first
element.
---
 tests/test_datasource.py |  2 +-
 tests/test_fields.py     | 46 ++++++++++++++++++++++++++++++++++++++++++----
 wcs/fields.py            | 17 +++++------------
 wcs/qommon/form.py       |  2 +-
 4 files changed, 49 insertions(+), 18 deletions(-)

diff --git a/tests/test_datasource.py b/tests/test_datasource.py
index eaa4068..4a39ff6 100644
--- a/tests/test_datasource.py
+++ b/tests/test_datasource.py
@@ -211,4 +211,4 @@ def test_optional_item_field_with_data_source():
     field.add_to_form(form)
     widget = form.get_widget('f1')
     assert widget is not None
-    assert widget.options == [(None, '', 'None'), ('1', 'un', '1'), ('2', 'deux', '2')]
+    assert widget.options == [('1', 'un', '1'), ('2', 'deux', '2')]
diff --git a/tests/test_fields.py b/tests/test_fields.py
index e8e5984..99fd680 100644
--- a/tests/test_fields.py
+++ b/tests/test_fields.py
@@ -157,8 +157,7 @@ def test_item_render():
             required=False)
     form = Form()
     field.add_to_form(form)
-    assert str(form.render()).count('<option selected="selected" value="None"></option>') == 1 # None
-    assert str(form.render()).count('<option') == 4 # 3 + None as first item
+    assert str(form.render()).count('<option') == 3
 
     field = fields.ItemField(id='1', label='Foobar', items=['a', 'b', 'c'],
             required=False, hint='Bla bla bla')
@@ -175,13 +174,52 @@ def test_item_render():
     assert str(form.render()).count('<option') == 4
 
     # without any item
-    field = fields.ItemField(id='1', label='Foobar', items=[])
+    field = fields.ItemField(id='1', label='Foobar', items=None)
     form = Form()
     field.add_to_form(form)
     assert str(form.render()).count('<option') == 1
 
     # without any item and not being required
-    field = fields.ItemField(id='1', label='Foobar', items=[], required=False)
+    field = fields.ItemField(id='1', label='Foobar', items=None, required=False)
     form = Form()
     field.add_to_form(form)
     assert str(form.render()).count('<option') == 1
+
+    # without any item but with an hint
+    field = fields.ItemField(id='1', label='Foobar', items=None, hint='Bla bla bla')
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('<option value="">Bla bla bla</option>') == 1 # ---
+    assert str(form.render()).count('<option') == 1
+
+def test_item_render_as_radio():
+    field = fields.ItemField(id='1', label='Foobar', show_as_radio=True, items=['a', 'b', 'c'])
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('"radio"') == 3
+
+    field = fields.ItemField(id='1', label='Foobar', items=['a', 'b', 'c'],
+            show_as_radio=True, required=False)
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('"radio"') == 3
+
+    field = fields.ItemField(id='1', label='Foobar', items=['a', 'b', 'c'],
+            show_as_radio=True, required=False, hint='Bla bla bla')
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('"radio"') == 3
+
+    # without any item
+    field = fields.ItemField(id='1', label='Foobar', items=None,
+            show_as_radio=True)
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('"radio"') == 1
+
+    # without any item and not being required
+    field = fields.ItemField(id='1', label='Foobar', items=None,
+            required=False, show_as_radio=True)
+    form = Form()
+    field.add_to_form(form)
+    assert str(form.render()).count('"radio"') == 1
diff --git a/wcs/fields.py b/wcs/fields.py
index b90aebe..f4b8271 100644
--- a/wcs/fields.py
+++ b/wcs/fields.py
@@ -857,18 +857,11 @@ class ItemField(WidgetField):
         WidgetField.__init__(self, **kwargs)
 
     def get_options(self):
-        if not self.data_source:
-            options = self.items[:]
-        else:
-            options = data_sources.get_items(self.data_source)
-        if options and not self.required:
-            if type(options[0]) is str:
-                options[:0] = [None]
-            elif len(options[0]) == 2:
-                options[:0] = [(None, '')]
-            elif len(options[0]) == 3:
-                options[:0] = [(None, '', None)]
-        return options
+        if self.data_source:
+            return data_sources.get_items(self.data_source)
+        if self.items:
+            return self.items[:]
+        return []
 
     def perform_more_widget_changes(self, form, kwargs, edit = True):
         real_data_source = data_sources.get_real(self.data_source)
diff --git a/wcs/qommon/form.py b/wcs/qommon/form.py
index fa84468..f4bb350 100644
--- a/wcs/qommon/form.py
+++ b/wcs/qommon/form.py
@@ -1366,7 +1366,7 @@ class SingleSelectHintWidget(SingleSelectWidget):
         if not self.separate_hint() and self.hint:
             r = htmltag('option', value='', selected=None)
             tags.append(r + htmlescape(self.hint) + htmltext('</option>'))
-            if not self.required:
+            if self.options[0][0] is None:
                 # hint has been put as first element, skip the default empty
                 # value.
                 options = self.options[1:]
-- 
2.6.2