Introduce isUndefined, deprecate defined (#93)

* feat(isUndefined): add new assetion isUndefined check if an actual value is undefined See: #89 #87 * chore: update commons package to use deprecated wrapper * deprecate(defined): add warning wrapper
sinonjs · Mar 6, 2019 · c8f8951 · c8f8951
1 parent 0f36c31
commit c8f8951
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 5 deletions.
diff --git a/lib/assertions/defined.js b/lib/assertions/defined.js
@@ -1,11 +1,18 @@
 "use strict";
 
 var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+var deprecated = require("@sinonjs/commons").deprecated;
 
 module.exports = function(referee) {
+    function definedAssert(actual) {
+        return typeof actual !== "undefined";
+    }
     referee.add("defined", {
         assert: function(actual) {
-            return typeof actual !== "undefined";
+            return deprecated.wrap(
+                definedAssert,
+                "defined is deprecated and will be removed in the future. Please use isUndefined instead."
+            )(actual);
         },
         assertMessage: "${customMessage}Expected to be defined",
         refuteMessage:

diff --git a/lib/assertions/is-undefined.js b/lib/assertions/is-undefined.js
@@ -0,0 +1,17 @@
+"use strict";
+
+var actualAndTypeOfMessageValues = require("../actual-and-type-of-message-values");
+
+module.exports = function(referee) {
+    referee.add("isUndefined", {
+        assert: function(actual) {
+            return typeof actual === "undefined";
+        },
+        assertMessage:
+            "${customMessage}Expected ${actual} (${actualType}) to be undefined",
+        refuteMessage:
+            "${customMessage}Expected ${actual} (${actualType}) not to be undefined",
+        expectation: "toBeUndefined",
+        values: actualAndTypeOfMessageValues
+    });
+};
diff --git a/lib/assertions/is-undefined.test.js b/lib/assertions/is-undefined.test.js
@@ -0,0 +1,38 @@
+"use strict";
+
+var testHelper = require("../test-helper");
+
+testHelper.assertionTests("assert", "isUndefined", function(
+    pass,
+    fail,
+    msg,
+    error
+) {
+    fail("for array", {});
+    fail("for boolean", true);
+    fail("for function", function() {});
+    fail("for null", null);
+    fail("for number", 42);
+    fail("for object", {});
+    fail("for string", "Test");
+    pass("for undefined", undefined);
+    msg(
+        "fail with descriptive message",
+        "[assert.isUndefined] Expected null (object) to be undefined",
+        null
+    );
+    msg(
+        "fail with custom message",
+        "[assert.isUndefined] fails: Expected null (object) to be undefined",
+        null,
+        "fails"
+    );
+    error(
+        "for null",
+        {
+            code: "ERR_ASSERTION",
+            operator: "assert.isUndefined"
+        },
+        null
+    );
+});
diff --git a/lib/expect.test.js b/lib/expect.test.js
@@ -1,5 +1,6 @@
 "use strict";
 
+var commons = require("@sinonjs/commons");
 var sinon = require("sinon");
 var referee = require("./referee");
 var expect = referee.expect;
@@ -11,6 +12,9 @@ describe("expect", function() {
         referee.on("pass", this.okListener);
         this.failListener = sinon.spy();
         referee.on("failure", this.failListener);
+        sinon.replace(commons.deprecated, "wrap", function(f) {
+            return f;
+        });
     });
 
     afterEach(function() {
@@ -96,6 +100,8 @@ describe("expect", function() {
         expect({}).not.toBeDate();
         expect(null).toBeDefined();
         expect(undefined).not.toBeDefined();
+        expect(undefined).toBeUndefined();
+        expect(null).not.toBeUndefined();
         expect(null).toBeNull();
         expect(42).not.toBeNull();
         expect(obj).toMatch({ id: 42 });

diff --git a/lib/referee.js b/lib/referee.js
@@ -59,6 +59,7 @@ require("./assertions/is-symbol")(referee);
 require("./assertions/is-syntax-error")(referee);
 require("./assertions/is-true")(referee);
 require("./assertions/is-type-error")(referee);
+require("./assertions/is-undefined")(referee);
 require("./assertions/is-uri-error")(referee);
 require("./assertions/is-u-int-16-array")(referee);
 require("./assertions/is-u-int-32-array")(referee);

diff --git a/lib/test-helper/index.js b/lib/test-helper/index.js
@@ -1,5 +1,6 @@
 "use strict";
 
+var commons = require("@sinonjs/commons");
 var referee = require("../referee");
 var sinon = require("sinon");
 var slice = require("@sinonjs/commons").prototypes.array.slice;
@@ -12,6 +13,9 @@ var testHelper = {
         referee.on("pass", testHelper.okListener);
         testHelper.failListener = sinon.spy();
         referee.on("failure", testHelper.failListener);
+        sinon.replace(commons.deprecated, "wrap", function(f) {
+            return f;
+        });
     },
 
     tearDown: function() {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,7 +25,7 @@
     "*.js": "eslint"
   },
   "dependencies": {
-    "@sinonjs/commons": "^1.3.0",
+    "@sinonjs/commons": "^1.4.0",
     "@sinonjs/formatio": "^3.1.0",
     "@sinonjs/samsam": "^3.0.0",
     "array-from": "2.1.1",