Merge pull request #189 from jkeen/main

Add #removeError and #removeErrors to BufferedChangeset

Author: knownasilya

README.md

@@ -145,6 +145,8 @@ export default class FormComponent {
   + [`validate`](#validate)
   + [`addError`](#adderror)
   + [`pushErrors`](#pusherrors)
+  + [`removeError`](#removeerror)
+  + [`removeErrors`](#removeerrors)
   + [`snapshot`](#snapshot)
   + [`restore`](#restore)
   + [`cast`](#cast)
@@ -654,6 +656,25 @@ Manually push errors to the changeset.
 changeset.pushErrors('age', 'Too short', 'Not a valid number', 'Must be greater than 18');
 changeset.pushErrors('dogYears.age', 'Too short', 'Not a valid number', 'Must be greater than 2.5');
 ```
+#### `removeError`
+
+Manually remove an error from the changeset.
+
+```js
+changeset.removeError('email');
+```
+Removes an error without having to rollback the property.
+
+**[⬆️ back to top](#api)**
+
+#### `removeErrors`
+
+Manually remove an error from the changeset.
+
+```js
+changeset.removeErrors()
+```
+Removes all the errors without having to rollback properties.
 
 **[⬆️ back to top](#api)**
 

src/index.ts

@@ -644,6 +644,35 @@ export class BufferedChangeset implements IChangeset {
     return error;
   }
 
+  /**
+   * Manually remove an error from the changeset.
+   *
+   * @method removeError
+   */
+  removeError(key: string): this {
+    if (key) {
+      this._notifyVirtualProperties([key]);
+      // @tracked
+      this[ERRORS] = this._deleteKey(ERRORS, key) as Errors<any>;
+      this[ERRORS_CACHE] = this[ERRORS];
+    } else {
+      this._notifyVirtualProperties();
+      this[ERRORS] = {};
+      this[ERRORS_CACHE] = this[ERRORS];
+    }
+
+    return this;
+  }
+
+  /**
+   * @method removeErrors
+   */
+  removeErrors() {
+    // @tracked
+    this[ERRORS] = {};
+    this[ERRORS_CACHE] = this[ERRORS];
+  }
+
   /**
    * Manually push multiple errors to the changeset as an array.
    * key maybe in form 'name.short' so need to go deep

test/index.test.ts

@@ -3188,6 +3188,104 @@ describe('Unit | Utility | changeset', () => {
     expect(dummyChangeset.isValid).toEqual(true);
   });
 
+  /**
+   * #removeError
+   */
+
+  it('#removeError removes an error from the changeset', () => {
+    let dummyChangeset = Changeset(dummyModel);
+    dummyChangeset.addError('email', {
+      value: '[email protected]',
+      validation: 'Email already taken'
+    });
+
+    expect(dummyChangeset.isInvalid).toEqual(true);
+    expect(get(dummyChangeset, 'error.email.validation')).toBe('Email already taken');
+
+    dummyChangeset.removeError('email');
+    expect(dummyChangeset.isValid).toEqual(true);
+
+    expect(get(dummyChangeset, 'error.email.validation')).toBe(undefined);
+  });
+
+  it('#removeError using an invalid key does not throw an error', () => {
+    let dummyChangeset = Changeset(dummyModel);
+    dummyChangeset.addError('email', {
+      value: '[email protected]',
+      validation: 'Email already taken'
+    });
+
+    expect(dummyChangeset.isInvalid).toEqual(true);
+    expect(get(dummyChangeset, 'error.email.validation')).toBe('Email already taken');
+
+    dummyChangeset.removeError('email');
+    dummyChangeset.removeError('foo');
+    expect(dummyChangeset.isValid).toEqual(true);
+
+    expect(get(dummyChangeset, 'error.email.validation')).toBe(undefined);
+  });
+
+  it('#removeError removing one error leaves the other', () => {
+    let dummyChangeset = Changeset(dummyModel);
+    dummyChangeset.addError('email', {
+      value: '[email protected]',
+      validation: 'Email already taken'
+    });
+    dummyChangeset.addError('age', {
+      value: '0',
+      validation: 'Age is too low'
+    });
+
+    expect(dummyChangeset.isInvalid).toEqual(true);
+    expect(get(dummyChangeset, 'error.email.validation')).toBe('Email already taken');
+    expect(get(dummyChangeset, 'error.age.validation')).toBe('Age is too low');
+
+    dummyChangeset.removeError('email');
+    expect(dummyChangeset.isValid).toEqual(false);
+
+    expect(get(dummyChangeset, 'error.email.validation')).toBe(undefined);
+    expect(get(dummyChangeset, 'error.age.validation')).toBe('Age is too low');
+  });
+
+  /**
+   * #removeErrors
+   */
+
+  it('#removeErrors removes all errors', () => {
+    let dummyChangeset = Changeset(dummyModel);
+    dummyChangeset.addError('email', {
+      value: '[email protected]',
+      validation: 'Email already taken'
+    });
+
+    dummyChangeset.addError('age', {
+      value: '0',
+      validation: 'Age is too low'
+    });
+    dummyChangeset.pushErrors('email.localPart', 'Cannot contain +');
+
+    expect(dummyChangeset.isInvalid).toEqual(true);
+    expect(get(dummyChangeset, 'error.email.validation')).toBe('Email already taken');
+    expect(get(dummyChangeset, 'error.age.validation')).toBe('Age is too low');
+    expect(get(dummyChangeset, 'error.email.localPart.validation')).toEqual(['Cannot contain +']);
+
+    dummyChangeset.removeErrors();
+    expect(dummyChangeset.isValid).toEqual(true);
+
+    expect(get(dummyChangeset, 'error.email.validation')).toBe(undefined);
+    expect(get(dummyChangeset, 'error.age.validation')).toBe(undefined);
+    expect(get(dummyChangeset, 'error.email.localPart.validation')).toBe(undefined);
+    expect(get(dummyChangeset, 'errors')).toStrictEqual([]);
+  });
+
+  it('#removeErrors succeeds even when there are no errors', () => {
+    let dummyChangeset = Changeset(dummyModel);
+    expect(dummyChangeset.isInvalid).toEqual(false);
+    dummyChangeset.removeErrors();
+    expect(dummyChangeset.isValid).toEqual(true);
+    expect(get(dummyChangeset, 'errors')).toStrictEqual([]);
+  });
+
   /**
    * #pushErrors
    */