chai 5.0.2 → 5.1.0

package/lib/chai/assertion.js

@@ -9,7 +9,7 @@ import {config} from './config.js';
 import {AssertionError} from 'assertion-error';
 import * as util from './utils/index.js';
 
-/*!
+/**
  * Assertion Constructor
  *
  * Creates object for chaining.
@@ -147,14 +147,13 @@ Assertion.prototype.assert = function (expr, msg, negateMsg, expected, _actual,
   }
 };
 
-/*!
+/**
  * ### ._obj
  *
  * Quick reference to stored `actual` value for plugin developers.
  *
  * @api private
  */
-
 Object.defineProperty(Assertion.prototype, '_obj',
   { get: function () {
       return util.flag(this, 'object');

package/lib/chai/core/assertions.js

@@ -3037,7 +3037,9 @@ Assertion.addMethod('closeTo', closeTo);
 Assertion.addMethod('approximately', closeTo);
 
 // Note: Duplicates are ignored if testing for inclusion instead of sameness.
-function isSubsetOf(subset, superset, cmp, contains, ordered) {
+function isSubsetOf(_subset, _superset, cmp, contains, ordered) {
+  let superset = Array.from(_superset);
+  let subset = Array.from(_subset);
   if (!contains) {
     if (subset.length !== superset.length) return false;
     superset = superset.slice();
@@ -3133,15 +3135,14 @@ function isSubsetOf(subset, superset, cmp, contains, ordered) {
  * @namespace BDD
  * @api public
  */
-
 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('array');
-  new Assertion(subset, flagMsg, ssfi, true).to.be.an('array');
+  new Assertion(obj, flagMsg, ssfi, true).to.be.iterable;
+  new Assertion(subset, flagMsg, ssfi, true).to.be.iterable;
 
   var contains = flag(this, 'contains');
   var ordered = flag(this, 'ordered');
@@ -3170,6 +3171,39 @@ Assertion.addMethod('members', function (subset, msg) {
   );
 });
 
+/**
+ * ### .iterable
+ *
+ * Asserts that the target is an iterable, which means that it has a iterator.
+ *
+ *     expect([1, 2]).to.be.iterable;
+ *     expect("foobar").to.be.iterable;
+ *
+ * Add `.not` earlier in the chain to negate `.iterable`.
+ *
+ *     expect(1).to.not.be.iterable;
+ *     expect(true).to.not.be.iterable;
+ *
+ * A custom error message can be given as the second argument to `expect`.
+ *
+ *     expect(1, 'nooo why fail??').to.be.iterable;
+ *
+ * @name iterable
+ * @namespace BDD
+ * @api public
+ */
+Assertion.addProperty('iterable', function(msg) {
+  if (msg) flag(this, 'message', msg);
+  var obj = flag(this, 'object');
+
+  this.assert(
+    obj != undefined && obj[Symbol.iterator]
+    , 'expected #{this} to be an iterable'
+    , 'expected #{this} to not be an iterable'
+    , obj
+  );
+});
+
 /**
  * ### .oneOf(list[, msg])
  *