From dbe4a6792b8675c6c767946ea5ff5f3db8b35a05 Mon Sep 17 00:00:00 2001
From: Rob Raymond <rob.raymond@hp.com>
Date: Wed, 28 Aug 2013 09:05:40 -0600
Subject: [PATCH] Implement required field indicator

Change Horizon's use of forms to set 'required' css class for required fields.
Change template _form_fields.html to include Django field classes in order
to honor above setting.
Also changed horizon workflow to set "required" class on tabs of steps
that contain required fields.

Horizon CSS appends an asterisk after the field label
and tab text based on "required" classname.
The current indicator is based on review with horizon UX
people and can be customized easily.

Change-Id: I03261328d70abcefd13f609088ccb4d58ef30067
Implements: blueprint required-fields
---
 horizon/forms/base.py                                 |  2 ++
 horizon/templates/horizon/common/_form_fields.html    |  2 +-
 horizon/templates/horizon/common/_workflow.html       |  2 +-
 horizon/workflows/base.py                             | 11 +++++++++++
 .../dashboards/project/networks/workflows.py          |  6 +-----
 .../static/dashboard/less/horizon.less                |  9 +++++++++
 6 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/horizon/forms/base.py b/horizon/forms/base.py
index 2653f00377..605568a2ce 100644
--- a/horizon/forms/base.py
+++ b/horizon/forms/base.py
@@ -36,6 +36,8 @@ class SelfHandlingForm(SelfHandlingMixin, forms.Form):
     A base :class:`Form <django:django.forms.Form>` class which includes
     processing logic in its subclasses.
     """
+    required_css_class = 'required'
+
     def api_error(self, message):
         """
         Adds an error to the form's error dictionary after validation
diff --git a/horizon/templates/horizon/common/_form_fields.html b/horizon/templates/horizon/common/_form_fields.html
index 21a9abdfdd..35676142a7 100644
--- a/horizon/templates/horizon/common/_form_fields.html
+++ b/horizon/templates/horizon/common/_form_fields.html
@@ -7,7 +7,7 @@
   </div>
 {% endif %}
 {% for field in form.visible_fields %}
-  <div class="control-group form-field clearfix{% if field.errors %} error{% endif %}">
+  <div class="control-group form-field clearfix{% if field.errors %} error{% endif %} {{ field.css_classes }}">
     {{ field.label_tag }}
     {% if field.errors %}
       {% for error in field.errors %}
diff --git a/horizon/templates/horizon/common/_workflow.html b/horizon/templates/horizon/common/_workflow.html
index 4730af1bac..d2ef8b32e7 100644
--- a/horizon/templates/horizon/common/_workflow.html
+++ b/horizon/templates/horizon/common/_workflow.html
@@ -13,7 +13,7 @@
     {% block modal-body %}
       <ul class="nav nav-tabs">
         {% for step in workflow.steps %}
-        <li class="{% if entry_point == step.slug %}active{% endif %}{% if step.has_errors %} error{% endif %}">
+        <li class="{% if entry_point == step.slug %}active{% endif %}{% if step.has_errors %} error{% endif %}{% if step.has_required_fields %} required{% endif %}">
           <a href="#{{ step.get_id }}" data-toggle="tab" data-target="#{{ step.get_id }}">{{ step }}</a>
         </li>
         {% endfor %}
diff --git a/horizon/workflows/base.py b/horizon/workflows/base.py
index 7e17886807..7877bce91e 100644
--- a/horizon/workflows/base.py
+++ b/horizon/workflows/base.py
@@ -139,6 +139,7 @@ class Action(forms.Form):
                                  % self.__class__.__name__)
         self.request = request
         self._populate_choices(request, context)
+        self.required_css_class = 'required'
 
     def __unicode__(self):
         return force_unicode(self.name)
@@ -445,6 +446,16 @@ class Step(object):
         """
         self.action.add_error(message)
 
+    def has_required_fields(self):
+        """
+        Returns True if action contains any required fields
+        """
+        for key in self.contributes:
+            field = self.action.fields.get(key, None)
+            if (field and field.required):
+                return True
+        return False
+
 
 class WorkflowMetaclass(type):
     def __new__(mcs, name, bases, attrs):
diff --git a/openstack_dashboard/dashboards/project/networks/workflows.py b/openstack_dashboard/dashboards/project/networks/workflows.py
index 6e038ae382..af76fe5105 100644
--- a/openstack_dashboard/dashboards/project/networks/workflows.py
+++ b/openstack_dashboard/dashboards/project/networks/workflows.py
@@ -36,8 +36,6 @@ LOG = logging.getLogger(__name__)
 class CreateNetworkInfoAction(workflows.Action):
     net_name = forms.CharField(max_length=255,
                                label=_("Network Name"),
-                               help_text=_("Network Name. This field is "
-                                           "optional."),
                                required=False)
     admin_state = forms.BooleanField(label=_("Admin State"),
                                      initial=True, required=False)
@@ -59,8 +57,6 @@ class CreateSubnetInfoAction(workflows.Action):
                                      initial=True, required=False)
     subnet_name = forms.CharField(max_length=255,
                                   label=_("Subnet Name"),
-                                  help_text=_("Subnet Name. This field is "
-                                           "optional."),
                                   required=False)
     cidr = fields.IPField(label=_("Network Address"),
                           required=False,
@@ -72,7 +68,7 @@ class CreateSubnetInfoAction(workflows.Action):
     ip_version = forms.ChoiceField(choices=[(4, 'IPv4'), (6, 'IPv6')],
                                    label=_("IP Version"))
     gateway_ip = fields.IPField(
-                    label=_("Gateway IP (optional)"),
+                    label=_("Gateway IP"),
                     required=False,
                     initial="",
                     help_text=_("IP address of Gateway (e.g. 192.168.0.254) "
diff --git a/openstack_dashboard/static/dashboard/less/horizon.less b/openstack_dashboard/static/dashboard/less/horizon.less
index bc9415c6ae..094a3c7073 100644
--- a/openstack_dashboard/static/dashboard/less/horizon.less
+++ b/openstack_dashboard/static/dashboard/less/horizon.less
@@ -1144,6 +1144,15 @@ form div.clearfix.error {
   content: "*";
 }
 
+.nav-tabs li.required a:after,
+form .form-field.required > label:after {
+  content: "*";
+  font-weight: bold;
+  line-height: 0;
+  padding-left: 4px;
+  color: #3290c0;
+}
+
 /* Region selector in header */
 
 #region_selector {