Merge lp:~methanal-developers/methanal/track-saved-and-validity into lp:methanal

[Jonathan Jacobs]

[Tristan Seligmann (mithrandi)]

+ // An unsuccessful submissino will not remove the modified indicator.

I assume this is a typo.

review: Needs Fixing

[Jonathan Jacobs (jjacobs)]

> + // An unsuccessful submissino will not remove the modified indicator.
>
> I assume this is a typo.

Fixed.

[lp:~methanal-developers/methanal/track-saved-and-validity]

167. By Jonathan Jacobs on 2011-04-10

Fix typo.

[Tristan Seligmann (mithrandi)]

Bleh. There are conflicts with trunk, now; please resolve them so we can see what the real diff is.

review: Needs Fixing

[Jonathan Jacobs (jjacobs)]

> Bleh. There are conflicts with trunk, now; please resolve them so we can see
> what the real diff is.

Done.

[lp:~methanal-developers/methanal/track-saved-and-validity]

168. By Jonathan Jacobs on 2011-04-11

Merge trunk and resolve conflicts.

[Tristan Seligmann (mithrandi)]

review: Approve

[lp:~methanal-developers/methanal/track-saved-and-validity]

169. By Jonathan Jacobs on 2011-04-11

Fix broken test.

=== modified file 'methanal/js/Methanal/Tests/TestView.js'
--- methanal/js/Methanal/Tests/TestView.js	2011-03-31 10:46:20 +0000
+++ methanal/js/Methanal/Tests/TestView.js	2011-04-11 11:46:38 +0000
@@ -13,13 +13,11 @@
  */
 Methanal.View.LiveForm.subclass(
     Methanal.Tests.TestView, 'MockLiveForm').methods(
-    function __init__(self, controlNames, viewOnly) {
-        viewOnly = viewOnly || false;
-
+    function __init__(self, controlNames, args/*=undefined*/) {
+        args = args || {};
         var node = Nevow.Test.WidgetUtil.makeWidgetNode();
         Methanal.Tests.TestView.MockLiveForm.upcall(
-            self, '__init__', node, viewOnly, controlNames);
-
+            self, '__init__', node, args, controlNames);
         Methanal.Tests.Util.setUpForm(self);
     });
 
@@ -67,7 +65,7 @@
     /**
      * Create a C{Methanal.View.LiveForm}.
      */
-    function createForm(self, viewOnly, controls/*=undefined*/,
+    function createForm(self, args, controls/*=undefined*/,
                         postFormInsertion/*=undefined*/) {
         controls = controls || [];
         var controlNames = [];
@@ -75,7 +73,7 @@
             controlNames.push(controls[i].name);
         }
 
-        var form = Methanal.Tests.TestView.MockLiveForm(controlNames, viewOnly);
+        var form = Methanal.Tests.TestView.MockLiveForm(controlNames, args);
         Methanal.Tests.Util.setUpForm(form);
         Methanal.Util.nodeInserted(form);
         if (postFormInsertion) {
@@ -111,7 +109,9 @@
      */
     function test_freezeThaw(self) {
         var control = self.createControl({'name': 'a'});
-        var form = self.createForm(false, [control]);
+        var args = {
+            'viewOnly': false};
+        var form = self.createForm(args, [control]);
         form.freeze();
         self.assertIdentical(form._frozen, 1);
         form.freeze();
@@ -130,10 +130,14 @@
      * Setting the form valid / invalid enables / disables the actions.
      */
     function test_validInvalid(self) {
-        var form = self.createForm();
+        var args = {
+            'viewOnly': false};
+        var form = self.createForm(args);
         form.setValid();
+        self.assertIdentical(form.valid, true);
         self.assertIdentical(form.actions._disabled, false);
         form.setInvalid();
+        self.assertIdentical(form.valid, false);
         self.assertIdentical(form.actions._disabled, true);
     },
 
@@ -146,7 +150,9 @@
     function test_submission(self) {
         var success;
         var control = self.createControl({'name': 'a'});
-        var form = self.createForm(false, [control]);
+        var args = {
+            'viewOnly': false};
+        var form = self.createForm(args, [control]);
 
         function succeed(methodName, data) {
             self.assertIdentical(form.actions._disabled, true);
@@ -158,22 +164,20 @@
             return Divmod.Defer.fail('too bad');
         };
 
-        form.submitSuccess = function (data) {
-            self.assertIdentical(form.actions._disabled, false);
-            success = true;
-        };
-        form.submitFailure = function (error) {
-            self.assertIdentical(form.actions._disabled, false);
-            success = false;
-        };
-
         form.callRemote = succeed;
+        form.formModified(true);
+        self.assertIdentical(form.modified, true);
         form.submit();
-        self.assertIdentical(success, true);
+        self.assertIdentical(form.modified, false);
+        self.assertIdentical(form.actions._disabled, false);
 
         form.callRemote = fail;
+        form.formModified(true);
+        self.assertIdentical(form.modified, true);
         form.submit();
-        self.assertIdentical(success, false);
+        // An unsuccessful submission will not remove the modified indicator.
+        self.assertIdentical(form.modified, true);
+        self.assertIdentical(form.actions._disabled, false);
     },
 
 
@@ -251,15 +255,14 @@
      */
     function test_formModified(self) {
         var control = self.createControl({'name': 'a'});
-        var form = self.createForm(false, [control]);
+        var args = {
+            'viewOnly': false,
+            'submitted': true};
+        var form = self.createForm(args, [control]);
         var containsElementClass = Methanal.Util.containsElementClass;
-        self.assertIdentical(
-            containsElementClass(form.nodeById('modifiedIndicator'), 'hidden'),
-            true);
+        self.assertIdentical(form.modified, false)
         control.onChange();
-        self.assertIdentical(
-            containsElementClass(form.nodeById('modifiedIndicator'), 'hidden'),
-            false);
+        self.assertIdentical(form.modified, true)
     },
 
 
@@ -269,7 +272,10 @@
     function test_formLoaded(self) {
         var success = false;
         var control = self.createControl({'name': 'a'});
-        var form = self.createForm(false, [control], function (form) {
+        var args = {
+            'viewOnly': false,
+            'submitted': true};
+        var form = self.createForm(args, [control], function (form) {
             self.assertIdentical(
                 success,
                 false);

=== modified file 'methanal/js/Methanal/View.js'
--- methanal/js/Methanal/View.js	2011-03-28 13:23:01 +0000
+++ methanal/js/Methanal/View.js	2011-04-11 11:46:38 +0000
@@ -930,7 +930,7 @@
  * @type viewOnly: C{boolean}
  * @ivar viewOnly: Are form actions disabled for this form?
  *
- * @type hideModificationIndicator: C{boolean}
+ * @type hideModificationIndicator: C{Boolean}
  * @ivar hideModificationIndicator: Hide the modification indicator for this
  *     form? Defaults to C{false}.
  *
@@ -940,6 +940,14 @@
  * @type actions: L{Methanal.View.ActionContainer}
  * @ivar actions: Action container widget, this is only assigned once the action
  *     container widget's C{nodeInserted} method has been called
+ *
+ * @type modified: C{Boolean}
+ * @ivar modified: Have any inputs in this LiveForm been modified since
+ *     creation or the last successful submission?
+ *
+ * @type valid: C{Boolean}
+ * @ivar valid: Is this LiveForm currently in a valid state, i.e. no
+ *     validation errors are present? Defaults to C{true}.
  */
 Methanal.View.FormBehaviour.subclass(Methanal.View, 'LiveForm').methods(
     function __init__(self, node, args, controlNames) {
@@ -949,7 +957,8 @@
             Divmod.warn(
                 'Use an argument dictionary instead of the "viewOnly"' +
                 'boolean parameter', Divmod.DeprecationWarning);
-            args = {'viewOnly': args};
+            args = {
+                'viewOnly': args};
         }
         self.viewOnly = args.viewOnly;
         self.hideModificationIndicator = args.hideModificationIndicator;
@@ -958,6 +967,8 @@
         }
         self.controlNames = Methanal.Util.arrayToMapping(controlNames);
         self._controlNamesOrdered = controlNames;
+        self.modified = false;
+        self.valid = true;
         self.formInit();
     },
 
@@ -1162,6 +1173,7 @@
         if (!self.hideModificationIndicator) {
             self.actions.modifiedIndicator(modified);
         }
+        self.modified = modified;
     },
 
 
@@ -1175,6 +1187,7 @@
      * Enable the form for submission.
      */
     function setValid(self) {
+        self.valid = true;
         self.actions.enable();
     },
 
@@ -1183,6 +1196,7 @@
      * Disable form submission.
      */
     function setInvalid(self) {
+        self.valid = false;
         self.actions.disable();
     });