feat(form): add ability to reset a form to its pristine state

Author: pkozlowski-opensource

src/ng/directive/form.js

@@ -5,7 +5,8 @@ var nullFormCtrl = {
   $addControl: noop,
   $removeControl: noop,
   $setValidity: noop,
-  $setDirty: noop
+  $setDirty: noop,
+  $setPristine: noop
 };
 
 /**
@@ -119,6 +120,31 @@ function FormController(element, attrs) {
     form.$pristine = false;
   };
 
+  /**
+   * @ngdoc function
+   * @name ng.directive:form.FormController#$setPristine
+   * @methodOf ng.directive:form.FormController
+   *
+   * @description
+   * Sets the form to its pristine state.
+   *
+   * This method can be called to remove the 'ng-dirty' class and set the form to its pristine
+   * state (ng-pristine class). Calling this method will also affect all the controls contained in
+   * this form.
+   *
+   * Setting a form back to a pristine state is often useful when we want to 'reuse' a form after
+   * saving or resetting it.
+   */
+  form.$setPristine = function () {
+    element.removeClass(DIRTY_CLASS).addClass(PRISTINE_CLASS);
+    form.$dirty = false;
+    form.$pristine = true;
+    angular.forEach(form, function(value, key) {
+      if (value.$name && value.$setPristine) {
+        value.$setPristine();
+      }
+    });
+  };
 }
 
 

src/ng/directive/input.js

@@ -947,6 +947,22 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
     parentForm.$setValidity(validationErrorKey, isValid, this);
   };
 
+  /**
+   * @ngdoc function
+   * @name ng.directive:ngModel.NgModelController#$setPristine
+   * @methodOf ng.directive:ngModel.NgModelController
+   *
+   * @description
+   * Sets the control to its pristine state.
+   *
+   * This method can be called to remove the 'ng-dirty' class and set the control to its pristine
+   * state (ng-pristine class).
+   */
+  this.$setPristine = function () {
+    this.$dirty = false;
+    this.$pristine = true;
+    $element.removeClass(DIRTY_CLASS).addClass(PRISTINE_CLASS);
+  }
 
   /**
    * @ngdoc function

test/ng/directive/formSpec.js

@@ -327,4 +327,30 @@ describe('form', function() {
       expect(doc).toBeDirty();
     });
   });
+
+  describe('set pristine state', function() {
+
+    beforeEach(function() {
+      doc = $compile(
+        '<form name="form">' +
+          '<input ng-model="name" name="name" store-model-ctrl/>' +
+          '</form>')(scope);
+
+      scope.$digest();
+    });
+
+    it('should set form and controls to the pristine state', function() {
+
+      var form = scope.form, input = doc.find('input').eq(0)
+
+      control.$setViewValue('');
+      scope.$apply();
+      expect(doc).toBeDirty();
+
+      form.$setPristine();
+      expect(doc).toBePristine();
+      expect(input).toBePristine();
+      expect(control.$pristine).toBeTruthy();
+    });
+  });
 });

test/ng/directive/inputSpec.js

@@ -117,6 +117,18 @@ describe('NgModelController', function() {
     });
   });
 
+  describe('setPristine', function() {
+
+    it('should set control to its pristine state', function() {
+      ctrl.$setViewValue('edit');
+      expect(ctrl.$dirty).toBe(true);
+      expect(ctrl.$pristine).toBe(false);
+
+      ctrl.$setPristine();
+      expect(ctrl.$dirty).toBe(false);
+      expect(ctrl.$pristine).toBe(true);
+    });
+  });
 
   describe('view -> model', function() {