Merge lp:~methanal-developers/methanal/808474-liveform-validation-error-list into lp:methanal

[Jonathan Jacobs]

[lp:~methanal-developers/methanal/808474-liveform-validation-error-list]

181. By Jonathan Jacobs on 2011-07-12

Docstring.

[Tristan Seligmann (mithrandi)]

review: Approve

=== modified file 'methanal/js/Methanal/Tests/TestUtil.js'
--- methanal/js/Methanal/Tests/TestUtil.js	2011-03-08 08:47:01 +0000
+++ methanal/js/Methanal/Tests/TestUtil.js	2011-07-12 10:29:32 +0000
@@ -517,6 +517,29 @@
         self.assertIdentical(
             Methanal.Util.unapply(f)(1, 2, 3),
             6);
+    },
+
+
+    /**
+     * Pluralise a word.
+     */
+    function test_plural(self) {
+        var plural = Methanal.Util.plural;
+        self.assertIdentical(
+            plural(1, 'hammer'),
+            'hammer');
+        self.assertIdentical(
+            plural(0, 'hammer'),
+            'hammers');
+        self.assertIdentical(
+            plural(2, 'hammer'),
+            'hammers');
+        self.assertIdentical(
+            plural(-1, 'hammer'),
+            'hammers');
+        self.assertIdentical(
+            plural(2, 'fix', 'fixes'),
+            'fixes');
     });
 
 
 
=== modified file 'methanal/js/Methanal/Util.js'
--- methanal/js/Methanal/Util.js	2011-07-04 14:15:27 +0000
+++ methanal/js/Methanal/Util.js	2011-07-12 10:29:32 +0000
@@ -1373,7 +1373,8 @@
         var orientationClass = POINTER_ORIENTATIONS[self.orientation] || '';
         self.node = D('span', {'class': self.extraClassName}, [
             D('div', {'class': 'hover-tooltip ' + orientationClass}, [
-                text, D('div', {'class': 'hover-tooltip-arrow'})])]);
+                text, D('div', {'class': 'hover-tooltip-arrow'})]),
+            D('div', {'class': 'terminator'})]);
         if (self._hidden) {
             self.hide();
         }
@@ -1383,19 +1384,44 @@
 
 
 /**
- * Tooltip "pointer" (the tail end of the tooltip) orientations::
+ * Tooltip "pointer" (the tail end of the tooltip) orientations:
  *
- *     none:
+ *     - none:
  *         Tooltip has no tail.
  *
- *     left:
+ *     - left:
  *         Tail comes from the left edge.
  *
- *     bottom:
+ *     - bottom:
  *         Tail comes from the bottom edge.
+ *
+ *     - top:
+ *         Tail comes from the top edge.
  */
 Methanal.Util.Tooltip.POINTER_ORIENTATIONS = {
     'none':   '',
     'left':   'hover-tooltip-left',
     'bottom': 'hover-tooltip-bottom',
     'top':    'hover-tooltip-top'};
+
+
+
+/**
+ * Pluralise a word.
+ *
+ * @type  n: C{Number}
+ * @param n: Count.
+ *
+ * @type  word: C{String}
+ * @param word: Word to pluralise.
+ *
+ * @type  pluralForm: C{String}
+ * @param pluralForm: Plural form of L{word}, defaults to C{word + 's'}.
+ *
+ * @rtype:  C{String}
+ * @return: Plural form of C{word} it C{n} indicates it should be a plural.
+ */
+Methanal.Util.plural = function plural(n, word, pluralForm/*=undefined*/) {
+    pluralForm = pluralForm || word + 's';
+    return n == 1 ? word : pluralForm;
+};
 
=== modified file 'methanal/js/Methanal/View.js'
--- methanal/js/Methanal/View.js	2011-07-11 17:14:43 +0000
+++ methanal/js/Methanal/View.js	2011-07-12 10:29:32 +0000
@@ -443,14 +443,19 @@
             return;
         }
 
+        var invalidControls = [];
         for (var controlName in self.controls) {
             var control = self.getControl(controlName);
             if (control.active && control.error) {
-                self.setInvalid();
-                return;
+                invalidControls.push(control);
             }
         }
 
+        if (invalidControls.length) {
+            self.setInvalid(invalidControls);
+            return;
+        }
+
         for (var name in self.subforms) {
             if (!self.subforms[name].valid) {
                 self.setInvalid();
@@ -958,6 +963,10 @@
  * @ivar hideModificationIndicator: Hide the modification indicator for this
  *     form? Defaults to C{false}.
  *
+ * @type hideValidationErrorIndicator: C{boolean}
+ * @ivar hideValidationErrorIndicator: Hide the validation error indicator for
+ *     this form? Defaults to C{false}.
+ *
  * @type controlNames: C{object} of C{String}
  * @ivar controlNames: Names of form inputs as a mapping
  *
@@ -986,6 +995,7 @@
         }
         self.viewOnly = args.viewOnly;
         self.hideModificationIndicator = args.hideModificationIndicator;
+        self.hideValidationErrorIndicator = args.hideValidationErrorIndicator;
         if (!(controlNames instanceof Array)) {
             throw new Error('"controlNames" must be an Array of control names');
         }
@@ -999,6 +1009,9 @@
 
     function nodeInserted(self) {
         self._formErrorNode = self.nodeById('form-error');
+        self._validationErrorTooltip = Methanal.Util.Tooltip(
+            self.node, null, 'top', 'error-tooltip submission-error-tooltip ' +
+                                    'form-validation-error-tooltip');
     },
 
 
@@ -1225,15 +1238,58 @@
     function setValid(self) {
         self.valid = true;
         self.actions.enable();
+        self._validationErrorTooltip.hide();
+    },
+
+
+    /**
+     * Create and display the form validation error tooltip if necessary.
+     */
+    function _showFormValidationErrorTooltip(self, invalidControls) {
+        if (self.hideValidationErrorIndicator) {
+            return;
+        }
+
+        function focusControl(control) {
+            return function () {
+                control.focus(true);
+                return false;
+            }
+        }
+
+        var D = Methanal.Util.DOMBuilder(self.node.ownerDocument);
+        var errors = [];
+        for (var i = 0; i < invalidControls.length; ++i) {
+            var control = invalidControls[i];
+            var label = control.label || control.name;
+            var a = D('a', {'href': '#', 'title': control.error},
+                      [label.replace(/\s/g, '\xa0')]);
+            a.onclick = focusControl(control);
+            errors.push(D('span', {}, [a, ' ']));
+        }
+
+        var numErrors = errors.length;
+        if (numErrors) {
+            var errorText = D('span', {}, [
+                D('h2', {}, [
+                    errors.length.toString() + ' validation ' +
+                    Methanal.Util.plural(numErrors, 'error')]),
+                D('p', {}, errors)]);
+            self._validationErrorTooltip.setText(errorText);
+            self._validationErrorTooltip.show();
+        }
     },
 
 
     /**
      * Disable form submission.
      */
-    function setInvalid(self) {
+    function setInvalid(self, invalidControls) {
         self.valid = false;
         self.actions.disable();
+        if (invalidControls !== undefined && invalidControls.length) {
+            self._showFormValidationErrorTooltip(invalidControls);
+        }
     });
 
 
@@ -1539,6 +1595,25 @@
 
 
     /**
+     * Give keyboard focus to the form input.
+     */
+    function focus(self, scrollIntoView/*=true*/) {
+        if (!self.inputNode) {
+            return;
+        }
+
+        if (self.inputNode.focus !== undefined) {
+            self.inputNode.focus();
+        }
+        if (scrollIntoView === undefined || scrollIntoView) {
+            if (self.inputNode.scrollIntoView) {
+                self.inputNode.scrollIntoView(true);
+            }
+        }
+    },
+
+
+    /**
      * Has this input finished loading?
      */
     function isLoaded(self) {
 
=== modified file 'methanal/view.py'
--- methanal/view.py	2011-06-12 22:16:10 +0000
+++ methanal/view.py	2011-07-12 10:29:32 +0000
@@ -240,6 +240,14 @@
     @ivar viewOnly: Flag indicating whether model values are written back when
         invoked.
 
+    @type hideModificationIndicator: C{bool}
+    @ivar hideModificationIndicator: Hide the modification indicator for this
+        form? Defaults to C{False}.
+
+    @type hideValidationErrorIndicator: C{bool}
+    @ivar hideValidationErrorIndicator: Hide the validation error indicator for
+        this form? Defaults to C{False}.
+
     @type actions: L{ActionContainer}
 
     @type doc: C{unicode}
@@ -262,6 +270,9 @@
         self.actions = actions
         self.doc = doc
 
+        self.hideModificationIndicator = False
+        self.hideValidationErrorIndicator = False
+
 
     def getInitialArguments(self):
         args = super(LiveForm, self).getInitialArguments()
@@ -269,7 +280,10 @@
 
 
     def getArgs(self):
-        return {u'viewOnly': self.viewOnly}
+        return {
+            u'viewOnly': self.viewOnly,
+            u'hideModificationIndicator': self.hideModificationIndicator,
+            u'hideValidationErrorIndicator': self.hideValidationErrorIndicator}
 
 
     @renderer