chai 5.0.3 → 5.1.0

package/chai.js

@@ -2810,7 +2810,9 @@ function closeTo(expected, delta, msg) {
 __name(closeTo, "closeTo");
 Assertion.addMethod("closeTo", closeTo);
 Assertion.addMethod("approximately", closeTo);
-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;
@@ -2841,8 +2843,8 @@ Assertion.addMethod("members", function(subset, msg) {
   if (msg)
     flag2(this, "message", msg);
   var obj = flag2(this, "object"), flagMsg = flag2(this, "message"), ssfi = flag2(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 = flag2(this, "contains");
   var ordered = flag2(this, "ordered");
   var subject, failMsg, failNegateMsg;
@@ -2865,6 +2867,17 @@ Assertion.addMethod("members", function(subset, msg) {
     true
   );
 });
+Assertion.addProperty("iterable", function(msg) {
+  if (msg)
+    flag2(this, "message", msg);
+  var obj = flag2(this, "object");
+  this.assert(
+    obj != void 0 && obj[Symbol.iterator],
+    "expected #{this} to be an iterable",
+    "expected #{this} to not be an iterable",
+    obj
+  );
+});
 function oneOf(list, msg) {
   if (msg)
     flag2(this, "message", msg);
@@ -3544,6 +3557,16 @@ assert.notIncludeDeepOrderedMembers = function(superset, subset, msg) {
 assert.oneOf = function(inList, list, msg) {
   new Assertion(inList, msg, assert.oneOf, true).to.be.oneOf(list);
 };
+assert.isIterable = function(obj, msg) {
+  if (obj == void 0 || !obj[Symbol.iterator]) {
+    msg = msg ? `${msg} expected ${inspect2(obj)} to be an iterable` : `expected ${inspect2(obj)} to be an iterable`;
+    throw new AssertionError(
+      msg,
+      void 0,
+      assert.isIterable
+    );
+  }
+};
 assert.changes = function(fn, obj, prop, msg) {
   if (arguments.length === 3 && typeof obj === "function") {
     msg = prop;
@@ -3737,9 +3760,6 @@ export {
  * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
  * MIT Licensed
  */
-/*!
- * Module dependencies
- */
 /*!
  * Chai - expectTypes utility
  * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
@@ -3766,52 +3786,6 @@ export {
  * Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
  * MIT Licensed
  */
-/*!
- * Assertion Constructor
- *
- * Creates object for chaining.
- *
- * `Assertion` objects contain metadata in the form of flags. Three flags can
- * be assigned during instantiation by passing arguments to this constructor:
- *
- * - `object`: This flag contains the target of the assertion. For example, in
- *   the assertion `expect(numKittens).to.equal(7);`, the `object` flag will
- *   contain `numKittens` so that the `equal` assertion can reference it when
- *   needed.
- *
- * - `message`: This flag contains an optional custom error message to be
- *   prepended to the error message that's generated by the assertion when it
- *   fails.
- *
- * - `ssfi`: This flag stands for "start stack function indicator". It
- *   contains a function reference that serves as the starting point for
- *   removing frames from the stack trace of the error that's created by the
- *   assertion when it fails. The goal is to provide a cleaner stack trace to
- *   end users by removing Chai's internal functions. Note that it only works
- *   in environments that support `Error.captureStackTrace`, and only when
- *   `Chai.config.includeStack` hasn't been set to `false`.
- *
- * - `lockSsfi`: This flag controls whether or not the given `ssfi` flag
- *   should retain its current value, even as assertions are chained off of
- *   this object. This is usually set to `true` when creating a new assertion
- *   from within another assertion. It's also temporarily set to `true` before
- *   an overwritten assertion gets called by the overwriting assertion.
- *
- * - `eql`: This flag contains the deepEqual function to be used by the assertion.
- *
- * @param {Mixed} obj target of the assertion
- * @param {String} msg (optional) custom error message
- * @param {Function} ssfi (optional) starting point for removing stack frames
- * @param {Boolean} lockSsfi (optional) whether or not the ssfi flag is locked
- * @api private
- */
-/*!
- * ### ._obj
- *
- * Quick reference to stored `actual` value for plugin developers.
- *
- * @api private
- */
 /*!
  * Chai - isProxyEnabled helper
  * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
@@ -3857,9 +3831,6 @@ export {
  * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
  * MIT Licensed
  */
-/*!
- * Module variables
- */
 /*!
  * Chai - overwriteChainableMethod utility
  * Copyright(c) 2012-2014 Jake Luer <jake@alogicalparadox.com>
@@ -3890,134 +3861,11 @@ export {
  * Copyright(c) 2011 Jake Luer <jake@alogicalparadox.com>
  * MIT Licensed
  */
-/*!
- * Dependencies that are used for multiple exports are required here only once
- */
-/*!
- * test utility
- */
-/*!
- * type utility
- */
-/*!
- * expectTypes utility
- */
-/*!
- * message utility
- */
-/*!
- * actual utility
- */
-/*!
- * Inspect util
- */
-/*!
- * Object Display util
- */
-/*!
- * Flag utility
- */
-/*!
- * Flag transferring utility
- */
-/*!
- * Deep equal utility
- */
-/*!
- * Deep path info
- */
-/*!
- * Function name
- */
-/*!
- * add Property
- */
-/*!
- * add Method
- */
-/*!
- * overwrite Property
- */
-/*!
- * overwrite Method
- */
-/*!
- * Add a chainable method
- */
-/*!
- * Overwrite chainable method
- */
-/*!
- * Compare by inspect method
- */
-/*!
- * Get own enumerable property symbols method
- */
-/*!
- * Get own enumerable properties method
- */
-/*!
- * Checks error against a given set of criteria
- */
-/*!
- * Proxify util
- */
-/*!
- * addLengthGuard util
- */
-/*!
- * isProxyEnabled helper
- */
-/*!
- * isNaN method
- */
-/*!
- * getOperator method
- */
 /*!
  * chai
  * Copyright(c) 2011-2014 Jake Luer <jake@alogicalparadox.com>
  * MIT Licensed
  */
-/*!
- * ### .ifError(object)
- *
- * Asserts if value is not a false value, and throws if it is a true value.
- * This is added to allow for chai to be a drop-in replacement for Node's
- * assert class.
- *
- *     var err = new Error('I am a custom error');
- *     assert.ifError(err); // Rethrows err!
- *
- * @name ifError
- * @param {Object} object
- * @namespace Assert
- * @api public
- */
-/*!
- * Aliases.
- */
-/*!
- * Assertion Error
- */
-/*!
- * Utility Functions
- */
-/*!
- * Configuration
- */
-/*!
- * Primary `Assertion` prototype
- */
-/*!
- * Expect interface
- */
-/*!
- * Should interface
- */
-/*!
- * Assert interface
- */
 /*! Bundled license information:
 
 deep-eql/index.js:

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])
  *