rename spec to patch

ahdinosaur · Feb 8, 2016 · 595c26a · 595c26a
1 parent bf01b0c
commit 595c26a
Show file tree

Hide file tree

Showing 16 changed files with 33 additions and 33 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -663,7 +663,7 @@ A.define(t.struct({
 You can update an immutable instance with the provided `update` function:
 
 ```js
-MyTcombType.update(instance, spec)
+MyTcombType.update(instance, patch)
 ```
 
 The following commands are compatible with the [Facebook Immutability Helpers](http://facebook.github.io/react/docs/update.html):
@@ -750,7 +750,7 @@ Immutability helper for POJOs.
 **Signature**
 
 ```js
-update(instance: Object, spec: Object) => Object
+update(instance: Object, patch: Object) => Object
 ```
 
 **Example**
@@ -763,7 +763,7 @@ t.update(x, { a: { $set: 2 } }); // => { a: 2 }, x is untouched
 **Note**. You can change the default behaviour overriding the `t.update` function:
 
 ```js
-t.update = function (instance, spec) {
+t.update = function (instance, patch) {
   // your implementation here
 };
 ```

diff --git a/index.d.ts b/index.d.ts
@@ -55,8 +55,8 @@ declare module Tcomb {
   interface UnshiftCommand { $unshift: Array<any>; }
   interface MergeCommand { $merge: Object; }
   type Command = ApplyCommand | PushCommand | RemoveCommand | SetCommand | SpliceCommand | SwapCommand | UnshiftCommand | MergeCommand;
-  type UpdateSpec = Command | {[key: string]: UpdateSpec};
-  type Update<T> = (instance: T, spec: UpdateSpec) => T;
+  type UpdatePatch = Command | {[key: string]: UpdatePatch};
+  type Update<T> = (instance: T, spec: UpdatePatch) => T;
 
   type Constructor<T> = Type<T> | Function;
 

diff --git a/lib/dict.js b/lib/dict.js
@@ -84,8 +84,8 @@ function dict(domain, codomain, name) {
     return true;
   };
 
-  Dict.update = function (instance, spec) {
-    return Dict(assert.update(instance, spec));
+  Dict.update = function (instance, patch) {
+    return Dict(assert.update(instance, patch));
   };
 
   return Dict;

diff --git a/lib/intersection.js b/lib/intersection.js
@@ -45,8 +45,8 @@ function intersection(types, name) {
     });
   };
 
-  Intersection.update = function (instance, spec) {
-    return Intersection(assert.update(instance, spec));
+  Intersection.update = function (instance, patch) {
+    return Intersection(assert.update(instance, patch));
   };
 
   return Intersection;

diff --git a/lib/list.js b/lib/list.js
@@ -70,8 +70,8 @@ function list(type, name) {
     });
   };
 
-  List.update = function (instance, spec) {
-    return List(assert.update(instance, spec));
+  List.update = function (instance, patch) {
+    return List(assert.update(instance, patch));
   };
 
   return List;

diff --git a/lib/refinement.js b/lib/refinement.js
@@ -53,8 +53,8 @@ function refinement(type, predicate, name) {
     return is(x, type) && predicate(x);
   };
 
-  Refinement.update = function (instance, spec) {
-    return Refinement(assert.update(instance, spec));
+  Refinement.update = function (instance, patch) {
+    return Refinement(assert.update(instance, patch));
   };
 
   return Refinement;

diff --git a/lib/struct.js b/lib/struct.js
@@ -89,8 +89,8 @@ function struct(props, name) {
     return x instanceof Struct;
   };
 
-  Struct.update = function (instance, spec) {
-    return new Struct(assert.update(instance, spec));
+  Struct.update = function (instance, patch) {
+    return new Struct(assert.update(instance, patch));
   };
 
   Struct.extend = function (structs, name) {

diff --git a/lib/tuple.js b/lib/tuple.js
@@ -72,8 +72,8 @@ function tuple(types, name) {
       });
   };
 
-  Tuple.update = function (instance, spec) {
-    return Tuple(assert.update(instance, spec));
+  Tuple.update = function (instance, patch) {
+    return Tuple(assert.update(instance, patch));
   };
 
   return Tuple;

diff --git a/lib/union.js b/lib/union.js
@@ -78,8 +78,8 @@ function union(types, name) {
     }
   };
 
-  Union.update = function (instance, spec) {
-    return Union(assert.update(instance, spec));
+  Union.update = function (instance, patch) {
+    return Union(assert.update(instance, patch));
   };
 
   return Union;

diff --git a/lib/update.js b/lib/update.js
@@ -18,22 +18,22 @@ function getShallowCopy(x) {
   return x;
 }
 
-function update(instance, spec) {
+function update(instance, patch) {
 
   if (process.env.NODE_ENV !== 'production') {
-    assert(isObject(spec), function () { return 'Invalid argument spec ' + assert.stringify(spec) + ' supplied to function update(instance, spec): expected an object containing commands'; });
+    assert(isObject(patch), function () { return 'Invalid argument patch ' + assert.stringify(patch) + ' supplied to function update(instance, patch): expected an object containing commands'; });
   }
 
   var value = getShallowCopy(instance);
   var isChanged = false;
-  for (var k in spec) {
-    if (spec.hasOwnProperty(k)) {
+  for (var k in patch) {
+    if (patch.hasOwnProperty(k)) {
       if (update.commands.hasOwnProperty(k)) {
-        value = update.commands[k](spec[k], value);
+        value = update.commands[k](patch[k], value);
         isChanged = true;
       }
       else {
-        var newValue = update(value[k], spec[k]);
+        var newValue = update(value[k], patch[k]);
         isChanged = isChanged || ( newValue !== value[k] );
         value[k] = newValue;
       }

diff --git a/test/dict.js b/test/dict.js
@@ -109,7 +109,7 @@ describe('t.dict(domain, codomain, [name])', function () {
 
   });
 
-  describe('update(instance, spec)', function () {
+  describe('update(instance, patch)', function () {
 
     it('should return a new instance', function () {
       var Dictionary = t.dict(t.String, t.String);

diff --git a/test/list.js b/test/list.js
@@ -118,7 +118,7 @@ describe('t.list(type, [name])', function () {
 
   });
 
-  describe('update(instance, spec)', function () {
+  describe('update(instance, patch)', function () {
 
     it('should return a new instance', function () {
       var ListOfStrings = t.list(t.String);

diff --git a/test/refinement.js b/test/refinement.js
@@ -99,7 +99,7 @@ describe('t.refinement(type, predicate, [name])', function () {
 
   });
 
-  describe('update(instance, spec)', function () {
+  describe('update(instance, patch)', function () {
 
     var Type = t.refinement(t.String, function (s) { return s.length > 2; });
     var instance = Type('abc');

diff --git a/test/tuple.js b/test/tuple.js
@@ -97,7 +97,7 @@ describe('t.tuple(types, [name])', function () {
 
   });
 
-  describe('update(instance, spec)', function () {
+  describe('update(instance, patch)', function () {
 
     it('should return a new instance', function () {
       var Tuple = t.tuple([t.String, t.Number]);

diff --git a/test/union.js b/test/union.js
@@ -174,7 +174,7 @@ describe('t.union(types, [name])', function () {
 
   });
 
-  describe('update(instance, spec)', function () {
+  describe('update(instance, patch)', function () {
 
     it('should update the right instance', function () {
       var circle = Shape.update({ center: { x: 0, y: 0 }, radius: 10 }, { radius: { $set: 15 } });

diff --git a/test/update.js b/test/update.js
@@ -3,7 +3,7 @@ var assert = require('assert');
 var t = require('../index');
 var throwsWithMessage = require('./util').throwsWithMessage;
 
-describe('t.update(instance, spec)', function () {
+describe('t.update(instance, patch)', function () {
 
   var update = t.update;
   var Tuple = t.tuple([t.String, t.Number]);
@@ -14,10 +14,10 @@ describe('t.update(instance, spec)', function () {
     y: t.Number
   });
 
-  it('should throw if spec is invalid', function () {
+  it('should throw if patch is invalid', function () {
     throwsWithMessage(function () {
       t.update({});
-    }, '[tcomb] Invalid argument spec undefined supplied to function update(instance, spec): expected an object containing commands');
+    }, '[tcomb] Invalid argument patch undefined supplied to function update(instance, patch): expected an object containing commands');
   });
 
   it('should handle $set command', function () {