Merge pull request #503 from astorije/astorije/expected-types

Checking that argument given to expect is of the right type when using with include

lib/chai/core/assertions.js

@@ -195,9 +195,12 @@ module.exports = function (chai, _) {
   }
 
   function include (val, msg) {
+    _.expectTypes(this, ['array', 'object', 'string']);
+
     if (msg) flag(this, 'message', msg);
     var obj = flag(this, 'object');
     var expected = false;
+
     if (_.type(obj) === 'array' && _.type(val) === 'object') {
       for (var i in obj) {
         if (_.eql(obj[i], val)) {

lib/chai/utils/expectTypes.js

@@ -0,0 +1,41 @@
+/*!
+ * Chai - expectTypes utility
+ * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
+ * MIT Licensed
+ */
+
+/**
+ * ### expectTypes(obj, types)
+ *
+ * Ensures that the object being tested against is of a valid type.
+ *
+ *     utils.expectTypes(this, ['array', 'object', 'string']);
+ *
+ * @param {Mixed} obj constructed Assertion
+ * @param {Array} type A list of allowed types for this assertion
+ * @name expectTypes
+ * @api public
+ */
+
+var AssertionError = require('assertion-error');
+var flag = require('./flag');
+var type = require('type-detect');
+
+module.exports = function (obj, types) {
+  var obj = flag(obj, 'object');
+  types = types.map(function (t) { return t.toLowerCase(); });
+  types.sort();
+
+  // Transforms ['lorem', 'ipsum'] into 'a lirum, or an ipsum'
+  var str = types.map(function (t, index) {
+    var art = ~[ 'a', 'e', 'i', 'o', 'u' ].indexOf(t.charAt(0)) ? 'an' : 'a';
+    var or = types.length > 1 && index === types.length - 1 ? 'or ' : '';
+    return or + art + ' ' + t;
+  }).join(', ');
+
+  if (!types.some(function (expected) { return type(obj) === expected; })) {
+    throw new AssertionError(
+      'object tested must be ' + str + ', but ' + type(obj) + ' given'
+    );
+  }
+};

lib/chai/utils/index.js

@@ -22,6 +22,11 @@ exports.test = require('./test');
 
 exports.type = require('type-detect');
 
+/*!
+ * expectTypes utility
+ */
+exports.expectTypes = require('./expectTypes');
+
 /*!
  * message utility
  */
@@ -123,4 +128,3 @@ exports.addChainableMethod = require('./addChainableMethod');
  */
 
 exports.overwriteChainableMethod = require('./overwriteChainableMethod');
-

test/assert.js

@@ -438,15 +438,42 @@ describe('assert', function () {
       assert.include('foobar', 'baz');
     }, "expected \'foobar\' to include \'baz\'");
 
+    err(function(){
+      assert.include(true, true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function () {
+      assert.include(42, 'bar');
+    }, "object tested must be an array, an object, or a string, but number given");
+
+    err(function(){
+      assert.include(null, 42);
+    }, "object tested must be an array, an object, or a string, but null given");
+
     err(function () {
       assert.include(undefined, 'bar');
-    }, "expected undefined to include 'bar'");
+    }, "object tested must be an array, an object, or a string, but undefined given");
   });
 
   it('notInclude', function () {
     assert.notInclude('foobar', 'baz');
     assert.notInclude([ 1, 2, 3 ], 4);
-    assert.notInclude(undefined, 'bar');
+
+    err(function(){
+      assert.notInclude(true, true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function () {
+      assert.notInclude(42, 'bar');
+    }, "object tested must be an array, an object, or a string, but number given");
+
+    err(function(){
+      assert.notInclude(null, 42);
+    }, "object tested must be an array, an object, or a string, but null given");
+
+    err(function () {
+      assert.notInclude(undefined, 'bar');
+    }, "object tested must be an array, an object, or a string, but undefined given");
 
     err(function () {
       assert.notInclude('foobar', 'bar');

test/expect.js

@@ -643,6 +643,38 @@ describe('expect', function () {
     err(function(){
       expect([{a:1},{b:2}]).to.not.include({b:2});
     }, "expected [ { a: 1 }, { b: 2 } ] to not include { b: 2 }");
+
+    err(function(){
+      expect(true).to.include(true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function(){
+      expect(42.0).to.include(42);
+    }, "object tested must be an array, an object, or a string, but number given");
+
+    err(function(){
+      expect(null).to.include(42);
+    }, "object tested must be an array, an object, or a string, but null given");
+
+    err(function(){
+      expect(undefined).to.include(42);
+    }, "object tested must be an array, an object, or a string, but undefined given");
+
+    err(function(){
+      expect(true).to.not.include(true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function(){
+      expect(42.0).to.not.include(42);
+    }, "object tested must be an array, an object, or a string, but number given");
+
+    err(function(){
+      expect(null).to.not.include(42);
+    }, "object tested must be an array, an object, or a string, but null given");
+
+    err(function(){
+      expect(undefined).to.not.include(42);
+    }, "object tested must be an array, an object, or a string, but undefined given");
   });
 
   it('keys(array|Object|arguments)', function(){

test/should.js

@@ -477,7 +477,23 @@ describe('should', function() {
 
     err(function(){
       ({a:1}).should.include({b:2});
-    }, "expected { a: 1 } to have a property 'b'")
+    }, "expected { a: 1 } to have a property 'b'");
+
+    err(function(){
+      (true).should.include(true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function(){
+      (42).should.include(4);
+    }, "object tested must be an array, an object, or a string, but number given");
+
+    err(function(){
+      (true).should.not.include(true);
+    }, "object tested must be an array, an object, or a string, but boolean given");
+
+    err(function(){
+      (42).should.not.include(4);
+    }, "object tested must be an array, an object, or a string, but number given");
   });
 
   it('keys(array|Object|arguments)', function(){