Add enumerableProperty assertion.

chaijs · Mar 25, 2015 · a75fdfa · a75fdfa
1 parent 1abc384
commit a75fdfa
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 1 deletion.
diff --git a/lib/chai/core/assertions.js b/lib/chai/core/assertions.js
@@ -888,6 +888,34 @@ module.exports = function (chai, _) {
   Assertion.addMethod('ownProperty', assertOwnProperty);
   Assertion.addMethod('haveOwnProperty', assertOwnProperty);
 
+  /**
+   * ### .enumerableProperty(name)
+   *
+   * Asserts that the target has an enumerable property `name`.
+   *
+   *     expect('test').not.to.have.enumerableProperty('length');
+   *
+   * @name enumerableProperty
+   * @alias haveEnumerableProperty
+   * @param {String} name
+   * @param {String} message _optional_
+   * @api public
+   */
+
+  function assertEnumerableProperty (name, msg) {
+    if (msg) flag(this, 'message', msg);
+    var obj = flag(this, 'object');
+    var descriptor = Object.getOwnPropertyDescriptor(Object(obj), name);
+    this.assert(
+        descriptor && descriptor.enumerable
+      , 'expected #{this} to have enumerable property ' + _.inspect(name)
+      , 'expected #{this} not to have enumerable property ' + _.inspect(name)
+    );
+  }
+
+  Assertion.addMethod('enumerableProperty', assertEnumerableProperty);
+  Assertion.addMethod('haveEnumerableProperty', assertEnumerableProperty);
+
   /**
    * ### .length(value)
    *

diff --git a/test/expect.js b/test/expect.js
@@ -467,7 +467,7 @@ describe('expect', function () {
     err(function(){
       expect(deepObj).to.have.deep.property('teas[3].tea', 'bar');
     }, "expected { Object (green, teas) } to have a deep property 'teas[3].tea'");
-    
+
     var arr = [
         [ 'chai', 'matcha', 'konacha' ]
       , [ { tea: 'chai' }
@@ -531,6 +531,16 @@ describe('expect', function () {
     }, "blah: expected { length: 12 } to not have own property 'length'");
   });
 
+  it('enumerableProperty(name)', function(){
+    expect('test').not.to.have.enumerableProperty('length');
+    expect('test').not.to.haveEnumerableProperty('length');
+    expect({ length: 12 }).to.have.enumerableProperty('length');
+
+    err(function(){
+      expect({ length: 12 }).not.to.have.enumerableProperty('length', 'blah');
+    }, "blah: expected { length: 12 } not to have enumerable property 'length'");
+  });
+
   it('string()', function(){
     expect('foobar').to.have.string('bar');
     expect('foobar').to.have.string('foo');

diff --git a/test/should.js b/test/should.js
@@ -396,6 +396,16 @@ describe('should', function() {
     }, "blah: expected { length: 12 } to not have own property 'length'");
   });
 
+  it('enumerableProperty(name)', function(){
+    'test'.should.not.have.enumerableProperty('length');
+    'test'.should.not.haveEnumerableProperty('length');
+    ({ length: 12 }).should.have.enumerableProperty('length');
+
+    err(function(){
+      ({ length: 12 }).should.not.have.enumerableProperty('length', 'blah');
+    }, "blah: expected { length: 12 } not to have enumerable property 'length'");
+  });
+
   it('string()', function(){
     'foobar'.should.contain.string('bar');
     'foobar'.should.contain.string('foo');