Implement iterable assertion

chaijs · Jan 27, 2024 · 3acc615 · 3acc615
1 parent e08d796
commit 3acc615
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 19 deletions.
diff --git a/lib/chai/core/assertions.js b/lib/chai/core/assertions.js
@@ -319,6 +319,12 @@ function an (type, msg) {
       , 'expected #{this} to be ' + article + type
       , 'expected #{this} not to be ' + article + type
     );
+  } else if (type === 'iterable') {
+    this.assert(
+        typeof obj !== 'string' && obj[Symbol.iterator]
+      , 'expected #{this} to be ' + article + type
+      , 'expected #{this} not to be ' + article + type
+    );
   } else {
     this.assert(
       type === detectedType
@@ -3136,26 +3142,29 @@ function isSubsetOf(_subset, _superset, cmp, contains, ordered) {
  * @api public
  */
 
-Assertion.addMethod('members', function (subset, msg) {
+Assertion.addMethod('iterable', function(msg) {
   if (msg) flag(this, 'message', msg);
   var obj = flag(this, 'object')
     , flagMsg = flag(this, 'message')
     , ssfi = flag(this, 'ssfi');
 
-  if (!['Array', 'Set'].includes(_.type(obj))) {
-    throw new AssertionError(
-      `${flagMsg}: expected ${_.inspect(obj)} to be an iterator`,
-      undefined,
-      ssfi
-    );
-  }
-  if (!['Array', 'Set'].includes(_.type(subset))) {
+  if (typeof obj === 'string' || !obj[Symbol.iterator]) {
     throw new AssertionError(
-      `${flagMsg}: expected ${_.inspect(subset)} to be an iterator`,
+      `${flagMsg}: expected ${_.inspect(obj)} to be an iterable`,
       undefined,
       ssfi
     );
   }
+});
+
+Assertion.addMethod('members', function (subset, msg) {
+  if (msg) flag(this, 'message', msg);
+  var obj = flag(this, 'object')
+    , flagMsg = flag(this, 'message')
+    , ssfi = flag(this, 'ssfi');
+
+  new Assertion(obj, flagMsg, ssfi, true).to.be.an('iterable');
+  new Assertion(subset, flagMsg, ssfi, true).to.be.an('iterable');
 
   var contains = flag(this, 'contains');
   var ordered = flag(this, 'ordered');

diff --git a/test/assert.js b/test/assert.js
@@ -1981,11 +1981,11 @@ describe('assert', function () {
 
     err(function () {
       assert.sameMembers({}, [], 'blah');
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
 
     err(function () {
       assert.sameMembers([], {}, 'blah');
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
   });
 
   it('notSameMembers', function() {

diff --git a/test/expect.js b/test/expect.js
@@ -3508,19 +3508,19 @@ describe('expect', function () {
 
     err(function () {
       expect({}).members([], 'blah');
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
 
     err(function () {
       expect({}, 'blah').members([]);
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
 
     err(function () {
       expect([]).members({}, 'blah');
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
 
     err(function () {
       expect([], 'blah').members({});
-    }, 'blah: expected {} to be an iterator');
+    }, 'blah: expected {} to be an iterable');
   });
 
   it('deep.members', function() {

diff --git a/test/should.js b/test/should.js
@@ -2820,11 +2820,11 @@ describe('should', function() {
 
     err(function() {
       'foo'.should.include.members([12], 'blah');
-    }, "blah: expected 'foo' to be an iterator");
+    }, "blah: expected 'foo' to be an iterable");
 
     err(function() {
       [1, 2, 3].should.include.members('o', 'blah');
-    }, "blah: expected 'o' to be an iterator");
+    }, "blah: expected 'o' to be an iterable");
   });
 
   it('memberEquals', function() {
@@ -2845,7 +2845,7 @@ describe('should', function() {
 
     err(function() {
       [1, 2, 3].should.have.same.members(4, 'blah');
-    }, 'blah: expected 4 to be an iterator');
+    }, 'blah: expected 4 to be an iterable');
   });
 
   it('deep.members', function() {