Adds back delete() and clear() to Record (immutable-js#1157)

This adds back the delete() and clear() methods to Record instances that set values back to the default values, in the process improving the equals() and hashCode() implementations.

Author: leebyron

__tests__/Record.ts

@@ -48,6 +48,23 @@ describe('Record', () => {
     expect(t2).toBe(t1);
   });
 
+  it('falls back to default values when deleted or cleared', () => {
+    const MyType = Record({ a: 1, b: 2, c: 3 });
+    const t1 = new MyType({ a: 10, b: 20 });
+    const t2 = new MyType({ b: 20 });
+    const t3 = t1.delete('a');
+    const t4 = t3.clear();
+
+    expect(t1.get('a')).toBe(10);
+    expect(t2.get('a')).toBe(1);
+    expect(t3.get('a')).toBe(1);
+    expect(t4.get('b')).toBe(2);
+
+    expect(t2.equals(t3)).toBe(true);
+    expect(t2.equals(t4)).toBe(false);
+    expect(t4.equals(new MyType())).toBe(true);
+  });
+
   it('is a value type and equals other similar Records', () => {
     let MyType = Record({a: 1, b: 2, c: 3});
     let t1 = MyType({ a: 10 });

__tests__/RecordJS.js

@@ -45,4 +45,20 @@ describe('Record', () => {
     expect(t.soup()).toBe(6);
     expect(t2.soup()).toBe(204);
   });
+
+  it('can be cleared', () => {
+    const MyType = Record({ a: 1, b: 2, c: 3 });
+    let t = new MyType({ c: 'cats' });
+
+    expect(t.c).toBe('cats');
+    t = t.clear();
+    expect(t.c).toBe(3);
+
+    const MyType2 = Record({ d: 4, e: 5, f: 6 });
+    let t2 = new MyType2({ d: 'dogs' });
+
+    expect(t2.d).toBe('dogs');
+    t2 = t2.clear();
+    expect(t2.d).toBe(4);
+  });
 });

dist/immutable-nonambient.d.ts

@@ -2162,6 +2162,21 @@
         ...collections: Array<Partial<T> | Iterable<[string, any]>>
       ): this;
 
+      /**
+       * Returns a new instance of this Record type with the value for the
+       * specific key set to its default value.
+       *
+       * @alias remove
+       */
+      delete<K extends keyof T>(key: K): this;
+      remove<K extends keyof T>(key: K): this;
+
+      /**
+       * Returns a new instance of this Record type with all values set
+       * to their default values.
+       */
+      clear(): this;
+
       // Deep persistent changes
 
       setIn(keyPath: Iterable<any>, value: any): this;

dist/immutable.d.ts

@@ -2162,6 +2162,21 @@ declare module Immutable {
         ...collections: Array<Partial<T> | Iterable<[string, any]>>
       ): this;
 
+      /**
+       * Returns a new instance of this Record type with the value for the
+       * specific key set to its default value.
+       *
+       * @alias remove
+       */
+      delete<K extends keyof T>(key: K): this;
+      remove<K extends keyof T>(key: K): this;
+
+      /**
+       * Returns a new instance of this Record type with all values set
+       * to their default values.
+       */
+      clear(): this;
+
       // Deep persistent changes
 
       setIn(keyPath: Iterable<any>, value: any): this;

dist/immutable.js

@@ -5234,11 +5234,11 @@ Record.prototype.toString = function toString () {
 
 Record.prototype.equals = function equals (other) {
   return this === other ||
-    (this._keys === other._keys && this._values.equals(other._values));
+    (this._keys === other._keys && recordSeq(this).equals(recordSeq(other)));
 };
 
 Record.prototype.hashCode = function hashCode () {
-  return this._values.hashCode();
+  return recordSeq(this).hashCode();
 };
 
 // @pragma Access
@@ -5271,6 +5271,15 @@ Record.prototype.set = function set (k, v) {
   return this;
 };
 
+Record.prototype.remove = function remove (k) {
+  return this.set(k);
+};
+
+Record.prototype.clear = function clear () {
+  var newValues = this._values.clear().setSize(this._keys.length);
+  return this.__ownerID ? this : makeRecord(this, newValues);
+};
+
 Record.prototype.wasAltered = function wasAltered () {
   return this._values.wasAltered();
 };
@@ -5308,6 +5317,7 @@ Record.isRecord = isRecord;
 Record.getDescriptiveName = recordName;
 var RecordPrototype = Record.prototype;
 RecordPrototype[IS_RECORD_SENTINEL] = true;
+RecordPrototype[DELETE] = RecordPrototype.remove;
 RecordPrototype.getIn = CollectionPrototype.getIn;
 RecordPrototype.hasIn = CollectionPrototype.hasIn;
 RecordPrototype.merge = MapPrototype.merge;

dist/immutable.js.flow

@@ -1091,6 +1091,10 @@ declare class RecordInstance<T: Object> {
     ...collections: Array<$Shape<T> | Iterable<[string, any]>>
   ): this;
 
+  delete<K: $Keys<T>>(key: K): this;
+  remove<K: $Keys<T>>(key: K): this;
+  clear(): this;
+
   setIn(keyPath: Iterable<any>, value: any): this;
   updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this;
   mergeIn(keyPath: Iterable<any>, ...collections: Array<any>): this;

dist/immutable.min.js

@@ -14,6 +14,7 @@ import { List } from './List';
 import { ITERATOR_SYMBOL } from './Iterator';
 import { isRecord, IS_RECORD_SENTINEL } from './Predicates';
 import { CollectionPrototype } from './CollectionImpl';
+import { DELETE } from './TrieUtils';
 
 import invariant from './utils/invariant';
 import quoteString from './utils/quoteString';
@@ -86,11 +87,11 @@ export class Record {
 
   equals(other) {
     return this === other ||
-      (this._keys === other._keys && this._values.equals(other._values));
+      (this._keys === other._keys && recordSeq(this).equals(recordSeq(other)));
   }
 
   hashCode() {
-    return this._values.hashCode();
+    return recordSeq(this).hashCode();
   }
 
   // @pragma Access
@@ -123,6 +124,15 @@ export class Record {
     return this;
   }
 
+  remove(k) {
+    return this.set(k);
+  }
+
+  clear() {
+    const newValues = this._values.clear().setSize(this._keys.length);
+    return this.__ownerID ? this : makeRecord(this, newValues);
+  }
+
   wasAltered() {
     return this._values.wasAltered();
   }
@@ -161,6 +171,7 @@ Record.isRecord = isRecord;
 Record.getDescriptiveName = recordName;
 const RecordPrototype = Record.prototype;
 RecordPrototype[IS_RECORD_SENTINEL] = true;
+RecordPrototype[DELETE] = RecordPrototype.remove;
 RecordPrototype.getIn = CollectionPrototype.getIn;
 RecordPrototype.hasIn = CollectionPrototype.hasIn;
 RecordPrototype.merge = MapPrototype.merge;

src/Record.js

@@ -2162,6 +2162,21 @@ declare module Immutable {
         ...collections: Array<Partial<T> | Iterable<[string, any]>>
       ): this;
 
+      /**
+       * Returns a new instance of this Record type with the value for the
+       * specific key set to its default value.
+       *
+       * @alias remove
+       */
+      delete<K extends keyof T>(key: K): this;
+      remove<K extends keyof T>(key: K): this;
+
+      /**
+       * Returns a new instance of this Record type with all values set
+       * to their default values.
+       */
+      clear(): this;
+
       // Deep persistent changes
 
       setIn(keyPath: Iterable<any>, value: any): this;

type-definitions/Immutable.d.ts

@@ -1091,6 +1091,10 @@ declare class RecordInstance<T: Object> {
     ...collections: Array<$Shape<T> | Iterable<[string, any]>>
   ): this;
 
+  delete<K: $Keys<T>>(key: K): this;
+  remove<K: $Keys<T>>(key: K): this;
+  clear(): this;
+
   setIn(keyPath: Iterable<any>, value: any): this;
   updateIn(keyPath: Iterable<any>, updater: (value: any) => any): this;
   mergeIn(keyPath: Iterable<any>, ...collections: Array<any>): this;