jasmine-core 6.0.0-alpha.2 → 6.0.0-beta.1

package/lib/jasmine-core/boot1.js

@@ -41,23 +41,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   const env = jasmine.getEnv();
   const urls = new jasmine.HtmlReporterV2Urls();
 
-  /**
-   * ## Reporters
-   * The `HtmlReporter` builds all of the HTML UI for the runner page. This reporter paints the dots, stars, and x's for specs, as well as all spec names and all failures (if any).
-   */
-  const htmlReporter = new jasmine.HtmlReporterV2({
-    env,
-    urls,
-    getContainer() {
-      return document.body;
-    }
-  });
-
-  /**
-   * The `jsApiReporter` also receives spec results, and is used by any environment that needs to extract the results  from JavaScript.
-   */
-  env.addReporter(jsApiReporter);
-  env.addReporter(htmlReporter);
   /**
    * Configures Jasmine based on the current set of query parameters. This
    * supports all parameters set by the HTML reporter as well as
@@ -66,18 +49,16 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    */
   env.configure(urls.configFromCurrentUrl());
 
-  /**
-   * ## Execution
-   *
-   * Replace the browser window's `onload`, ensure it's called, and then run all of the loaded specs. This includes initializing the `HtmlReporter` instance and then executing the loaded Jasmine environment. All of this will happen after all of the specs are loaded.
-   */
   const currentWindowOnload = window.onload;
-
   window.onload = function() {
     if (currentWindowOnload) {
       currentWindowOnload();
     }
-    htmlReporter.initialize();
+
+    // The HTML reporter needs to be set up here so it can access the DOM. Other
+    // reporters can be added at any time before env.execute() is called.
+    const htmlReporter = new jasmine.HtmlReporterV2({ env, urls });
+    env.addReporter(htmlReporter);
     env.execute();
   };
 })();

package/lib/jasmine-core/jasmine-html.js

@@ -309,12 +309,14 @@ jasmineRequire.HtmlSpecFilter = function(j$) {
    * @deprecated Use {@link HtmlReporterV2Urls} instead.
    */
   function HtmlSpecFilter(options) {
-    j$.getEnv().deprecated(
+    const env = options?.env ?? j$.getEnv();
+    env.deprecated(
       'HtmlReporter and HtmlSpecFilter are deprecated. Use HtmlReporterV2 instead.'
     );
 
     const filterString =
       options &&
+      options.filterString &&
       options.filterString() &&
       options.filterString().replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
     const filterPattern = new RegExp(filterString);
@@ -472,45 +474,6 @@ jasmineRequire.AlertsView = function(j$) {
       );
     }
 
-    // TODO: remove this once HtmlReporterV2 doesn't use it
-    addFailureToggle(onClickFailures, onClickSpecList) {
-      const failuresLink = createDom(
-        'a',
-        { className: 'jasmine-failures-menu', href: '#' },
-        'Failures'
-      );
-      let specListLink = createDom(
-        'a',
-        { className: 'jasmine-spec-list-menu', href: '#' },
-        'Spec List'
-      );
-
-      failuresLink.onclick = function() {
-        onClickFailures();
-        return false;
-      };
-
-      specListLink.onclick = function() {
-        onClickSpecList();
-        return false;
-      };
-
-      this.rootEl.appendChild(
-        createDom(
-          'span',
-          { className: 'jasmine-menu jasmine-bar jasmine-spec-list' },
-          [createDom('span', {}, 'Spec List | '), failuresLink]
-        )
-      );
-      this.rootEl.appendChild(
-        createDom(
-          'span',
-          { className: 'jasmine-menu jasmine-bar jasmine-failure-list' },
-          [specListLink, createDom('span', {}, ' | Failures ')]
-        )
-      );
-    }
-
     addGlobalFailure(failure) {
       this.#createAndAdd(
         errorBarClassName,
@@ -940,7 +903,7 @@ jasmineRequire.htmlReporterUtils = function(j$) {
     const el = document.createElement(type);
     let children;
 
-    if (j$.private.isArray(childrenArrayOrVarArgs)) {
+    if (Array.isArray(childrenArrayOrVarArgs)) {
       children = childrenArrayOrVarArgs;
     } else {
       children = [];
@@ -1007,12 +970,12 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
    * const reporter = new jasmine.HtmlReporterV2({
    *    env,
    *    urls,
-   *    getContainer: () => document.body
+   *    // container is optional and defaults to document.body.
+   *    container: someElement
    * });
    */
   class HtmlReporterV2 {
-    #env;
-    #getContainer;
+    #container;
     #queryString;
     #urlBuilder;
     #filterSpecs;
@@ -1029,9 +992,7 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
     #failures;
 
     constructor(options) {
-      this.#env = options.env;
-
-      this.#getContainer = options.getContainer;
+      this.#container = options.container || document.body;
       this.#queryString =
         options.queryString ||
         new j$.QueryString({
@@ -1044,16 +1005,8 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
         getSuiteById: id => this.#stateBuilder.suitesById[id]
       });
       this.#filterSpecs = options.urls.filteringSpecs();
-    }
 
-    /**
-     * Initializes the reporter. Should be called before {@link Env#execute}.
-     * @function
-     * @name HtmlReporter#initialize
-     */
-    initialize() {
-      this.#clearPrior();
-      this.#config = this.#env ? this.#env.configuration() : {};
+      this.#config = options.env ? options.env.configuration() : {};
 
       this.#stateBuilder = new j$.private.ResultsStateBuilder();
 
@@ -1094,13 +1047,15 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
         this.#alerts.rootEl,
         this.#failures.rootEl
       );
-      this.#getContainer().appendChild(this.#htmlReporterMain);
+      this.#container.appendChild(this.#htmlReporterMain);
       this.#failures.show();
     }
 
     jasmineStarted(options) {
       this.#stateBuilder.jasmineStarted(options);
-      this.#progress.start(options.totalSpecsDefined);
+      this.#progress.start(
+        options.totalSpecsDefined - options.numExcludedSpecs
+      );
     }
 
     suiteStarted(result) {
@@ -1185,19 +1140,11 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
     }
 
     #find(selector) {
-      return this.#getContainer().querySelector(
+      return this.#container.querySelector(
         '.jasmine_html-reporter ' + selector
       );
     }
 
-    #clearPrior() {
-      const oldReporter = this.#find('');
-
-      if (oldReporter) {
-        this.#getContainer().removeChild(oldReporter);
-      }
-    }
-
     #setMenuModeTo(mode) {
       this.#htmlReporterMain.setAttribute(
         'class',
@@ -1216,7 +1163,9 @@ jasmineRequire.HtmlReporterV2 = function(j$) {
     }
 
     specDone(result) {
-      this.rootEl.value = this.rootEl.value + 1;
+      if (result.status !== 'excluded') {
+        this.rootEl.value = this.rootEl.value + 1;
+      }
 
       if (result.status === 'failed') {
         this.rootEl.classList.add('failed');

package/lib/jasmine-core/jasmine.js

@@ -44,9 +44,14 @@ var getJasmineRequireObj = (function() {
   }
 
   getJasmineRequire().core = function(jRequire) {
-    const j$ = { private: {} };
+    const j$ = {};
+    Object.defineProperty(j$, 'private', {
+      enumerable: true,
+      value: {}
+    });
 
     jRequire.base(j$, globalThis);
+    j$.private.deprecateMonkeyPatching = jRequire.deprecateMonkeyPatching(j$);
     j$.private.util = jRequire.util(j$);
     j$.private.errors = jRequire.errors();
     j$.private.formatErrorMsg = jRequire.formatErrorMsg(j$);
@@ -56,7 +61,7 @@ var getJasmineRequireObj = (function() {
     j$.private.CallTracker = jRequire.CallTracker(j$);
     j$.private.MockDate = jRequire.MockDate(j$);
     j$.private.getStackClearer = jRequire.StackClearer(j$);
-    j$.private.Clock = jRequire.Clock();
+    j$.private.Clock = jRequire.Clock(j$);
     j$.private.DelayedFunctionScheduler = jRequire.DelayedFunctionScheduler(j$);
     j$.private.Deprecator = jRequire.Deprecator(j$);
     j$.private.Configuration = jRequire.Configuration(j$);
@@ -122,6 +127,20 @@ var getJasmineRequireObj = (function() {
     j$.private.loadedAsBrowserEsm =
       globalThis.document && !globalThis.document.currentScript;
 
+    j$.private.deprecateMonkeyPatching(j$, [
+      // These are meant to be set by users.
+      'DEFAULT_TIMEOUT_INTERVAL',
+      'MAX_PRETTY_PRINT_ARRAY_LENGTH',
+      'MAX_PRETTY_PRINT_CHARS',
+      'MAX_PRETTY_PRINT_DEPTH',
+
+      // These are part of the deprecation warning mechanism. To avoid infinite
+      // recursion, they're separately protected in a way that doesn't emit
+      // deprecation warnings.
+      'private',
+      'getEnv'
+    ]);
+
     return j$;
   };
 
@@ -246,16 +265,15 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) {
    * @function
    * @return {Env}
    */
-  j$.getEnv = function(options) {
-    const env = (j$.private.currentEnv_ =
-      j$.private.currentEnv_ || new j$.private.Env(options));
-    //jasmine. singletons in here (setTimeout blah blah).
-    return env;
-  };
-
-  j$.private.isArray = function(value) {
-    return j$.private.isA('Array', value);
-  };
+  Object.defineProperty(j$, 'getEnv', {
+    enumerable: true,
+    value: function(options) {
+      const env = (j$.private.currentEnv_ =
+        j$.private.currentEnv_ || new j$.private.Env(options));
+      //jasmine. singletons in here (setTimeout blah blah).
+      return env;
+    }
+  });
 
   j$.private.isObject = function(value) {
     return (
@@ -956,7 +974,7 @@ getJasmineRequireObj().Spec = function(j$) {
        * @property {ExpectationResult[]} passedExpectations - The list of expectations that passed during execution of this spec.
        * @property {ExpectationResult[]} deprecationWarnings - The list of deprecation warnings that occurred during execution this spec.
        * @property {String} pendingReason - If the spec is {@link pending}, this will be the reason.
-       * @property {String} status - Once the spec has completed, this string represents the pass/fail status of this spec.
+       * @property {String} status - The result of this spec. May be 'passed', 'failed', 'pending', or 'excluded'.
        * @property {number} duration - The time in ms used by the spec execution, including any before/afterEach.
        * @property {Object} properties - User-supplied properties, if any, that were set using {@link Env#setSpecProperty}
        * @property {DebugLogEntry[]|null} debugLogs - Messages, if any, that were logged using {@link jasmine.debugLog} during a failing spec.
@@ -1520,10 +1538,13 @@ getJasmineRequireObj().Env = function(j$) {
      * @param {String|Error} deprecation The deprecation message
      * @param {Object} [options] Optional extra options, as described above
      */
-    this.deprecated = function(deprecation, options) {
-      const runable = runner.currentRunable() || topSuite;
-      deprecator.addDeprecationWarning(runable, deprecation, options);
-    };
+    Object.defineProperty(this, 'deprecated', {
+      enumerable: true,
+      value: function(deprecation, options) {
+        const runable = runner.currentRunable() || topSuite;
+        deprecator.addDeprecationWarning(runable, deprecation, options);
+      }
+    });
 
     function runQueue(options) {
       options.clearStack = options.clearStack || stackClearer;
@@ -1550,7 +1571,8 @@ getJasmineRequireObj().Env = function(j$) {
       runQueue
     });
     topSuite = suiteBuilder.topSuite;
-    const deprecator = new j$.private.Deprecator(topSuite);
+    const deprecator =
+      envOptions?.deprecator ?? new j$.private.Deprecator(topSuite);
 
     /**
      * Provides the root suite, through which all suites and specs can be
@@ -2045,9 +2067,18 @@ getJasmineRequireObj().Env = function(j$) {
       }
     };
 
+    this.pp = function(value) {
+      const pp = runner.currentRunable()
+        ? runableResources.makePrettyPrinter()
+        : j$.private.basicPrettyPrinter;
+      return pp(value);
+    };
+
     this.cleanup_ = function() {
       uninstallGlobalErrors();
     };
+
+    j$.private.deprecateMonkeyPatching(this, ['deprecated']);
   }
 
   function indirectCallerFilename(depth) {
@@ -2064,11 +2095,13 @@ getJasmineRequireObj().Env = function(j$) {
 getJasmineRequireObj().JsApiReporter = function(j$) {
   'use strict';
 
+  // TODO: remove in 7.0.
   /**
    * @name jsApiReporter
    * @classdesc {@link Reporter} added by default in `boot.js` to record results for retrieval in javascript code. An instance is made available as `jsApiReporter` on the global object.
    * @class
    * @hideconstructor
+   * @deprecated In most cases jsApiReporter can simply be removed. If necessary, it can be replaced with a {@link Reporter|custom reporter}.
    */
   function JsApiReporter(options) {
     const timer = options.timer || new j$.Timer();
@@ -2295,7 +2328,7 @@ getJasmineRequireObj().ArrayContaining = function(j$) {
   }
 
   ArrayContaining.prototype.asymmetricMatch = function(other, matchersUtil) {
-    if (!j$.private.isArray(this.sample)) {
+    if (!Array.isArray(this.sample)) {
       throw new Error(
         'You must provide an array to arrayContaining, not ' +
           j$.private.basicPrettyPrinter(this.sample) +
@@ -2306,7 +2339,7 @@ getJasmineRequireObj().ArrayContaining = function(j$) {
     // If the actual parameter is not an array, we can fail immediately, since it couldn't
     // possibly be an "array containing" anything. However, we also want an empty sample
     // array to match anything, so we need to double-check we aren't in that case
-    if (!j$.private.isArray(other) && this.sample.length > 0) {
+    if (!Array.isArray(other) && this.sample.length > 0) {
       return false;
     }
 
@@ -2337,7 +2370,7 @@ getJasmineRequireObj().ArrayWithExactContents = function(j$) {
     other,
     matchersUtil
   ) {
-    if (!j$.private.isArray(this.sample)) {
+    if (!Array.isArray(this.sample)) {
       throw new Error(
         'You must provide an array to arrayWithExactContents, not ' +
           j$.private.basicPrettyPrinter(this.sample) +
@@ -2373,7 +2406,7 @@ getJasmineRequireObj().Empty = function(j$) {
   Empty.prototype.asymmetricMatch = function(other) {
     if (
       j$.private.isString(other) ||
-      j$.private.isArray(other) ||
+      Array.isArray(other) ||
       j$.private.isTypedArray(other)
     ) {
       return other.length === 0;
@@ -2488,7 +2521,7 @@ getJasmineRequireObj().NotEmpty = function(j$) {
   NotEmpty.prototype.asymmetricMatch = function(other) {
     if (
       j$.private.isString(other) ||
-      j$.private.isArray(other) ||
+      Array.isArray(other) ||
       j$.private.isTypedArray(other)
     ) {
       return other.length !== 0;
@@ -2920,7 +2953,7 @@ getJasmineRequireObj().CallTracker = function(j$) {
   return CallTracker;
 };
 
-getJasmineRequireObj().Clock = function() {
+getJasmineRequireObj().Clock = function(j$) {
   'use strict';
 
   /* global process */
@@ -3113,6 +3146,9 @@ callbacks to execute _before_ running the next one.
     clearTimeout[IsMockClockTimingFn] = true;
     setInterval[IsMockClockTimingFn] = true;
     clearInterval[IsMockClockTimingFn] = true;
+
+    j$.private.deprecateMonkeyPatching(this);
+
     return this;
 
     // Advances the Clock's time until the mode changes.
@@ -3821,6 +3857,29 @@ getJasmineRequireObj().DelayedFunctionScheduler = function(j$) {
   return DelayedFunctionScheduler;
 };
 
+getJasmineRequireObj().deprecateMonkeyPatching = function(j$) {
+  return function deprecateMonkeyPatching(obj, keysToSkip) {
+    for (const key of Object.keys(obj)) {
+      if (!keysToSkip?.includes(key)) {
+        let value = obj[key];
+
+        Object.defineProperty(obj, key, {
+          enumerable: key in obj,
+          get() {
+            return value;
+          },
+          set(newValue) {
+            j$.getEnv().deprecated(
+              'Monkey patching detected. This is not supported and will break in a future jasmine-core release.'
+            );
+            value = newValue;
+          }
+        });
+      }
+    }
+  };
+};
+
 getJasmineRequireObj().Deprecator = function(j$) {
   'use strict';
 
@@ -5288,7 +5347,7 @@ getJasmineRequireObj().MatchersUtil = function(j$) {
     this.customTesters_ = options.customTesters || [];
     /**
      * Formats a value for use in matcher failure messages and similar contexts,
-     * taking into account the current set of custom value formatters.
+     * taking into account the current set of custom object formatters.
      * @function
      * @name MatchersUtil#pp
      * @since 3.6.0
@@ -8200,7 +8259,7 @@ getJasmineRequireObj().makePrettyPrinter = function(j$) {
         } else if (
           value.toString &&
           typeof value === 'object' &&
-          !j$.private.isArray(value) &&
+          !Array.isArray(value) &&
           hasCustomToString(value)
         ) {
           try {
@@ -8212,15 +8271,12 @@ getJasmineRequireObj().makePrettyPrinter = function(j$) {
         } else if (this.seen.includes(value)) {
           this.emitScalar(
             '<circular reference: ' +
-              (j$.private.isArray(value) ? 'Array' : 'Object') +
+              (Array.isArray(value) ? 'Array' : 'Object') +
               '>'
           );
-        } else if (
-          j$.private.isArray(value) ||
-          j$.private.isA('Object', value)
-        ) {
+        } else if (Array.isArray(value) || j$.private.isA('Object', value)) {
           this.seen.push(value);
-          if (j$.private.isArray(value)) {
+          if (Array.isArray(value)) {
             this.emitArray(value);
           } else {
             this.emitObject(value);
@@ -8243,10 +8299,7 @@ getJasmineRequireObj().makePrettyPrinter = function(j$) {
     }
 
     iterateObject(obj, fn) {
-      const objKeys = j$.private.MatchersUtil.keys(
-        obj,
-        j$.private.isArray(obj)
-      );
+      const objKeys = j$.private.MatchersUtil.keys(obj, Array.isArray(obj));
       const length = Math.min(objKeys.length, j$.MAX_PRETTY_PRINT_ARRAY_LENGTH);
 
       for (let i = 0; i < length; i++) {
@@ -9371,6 +9424,7 @@ getJasmineRequireObj().interface = function(jasmine, env) {
      */
     jasmine: jasmine
   };
+  const existingKeys = Object.keys(jasmine);
 
   /**
    * Add a custom equality tester for the current scope of specs.
@@ -9500,6 +9554,21 @@ getJasmineRequireObj().interface = function(jasmine, env) {
     return env.setDefaultSpyStrategy(defaultStrategyFn);
   };
 
+  /**
+   * Formats a value for display, taking into account the current set of
+   * custom object formatters.
+   *
+   * @name jasmine.pp
+   * @function
+   * @since 6.0.0
+   * @param {*} value The value to pretty-print
+   * @return {string} The pretty-printed value
+   * @see {MatchersUtil#pp}
+   */
+  jasmine.pp = function(value) {
+    return env.pp(value);
+  };
+
   /**
    * {@link AsymmetricEqualityTester|Asymmetric equality testers} allow for
    * non-exact matching in matchers that use Jasmine's deep value equality
@@ -9522,6 +9591,8 @@ getJasmineRequireObj().interface = function(jasmine, env) {
    * @namespace asymmetricEqualityTesters
    */
 
+  jasmine.private.deprecateMonkeyPatching(jasmine, existingKeys);
+
   return jasmineInterface;
 };
 
@@ -9783,7 +9854,8 @@ getJasmineRequireObj().Runner = function(j$) {
       /**
        * Information passed to the {@link Reporter#jasmineStarted} event.
        * @typedef JasmineStartedInfo
-       * @property {Int} totalSpecsDefined - The total number of specs defined in this suite. Note that this property is not present when Jasmine is run in parallel mode.
+       * @property {int} totalSpecsDefined - The total number of specs defined in this suite. Note that this property is not present when Jasmine is run in parallel mode.
+       * @property {int} numExcludedSpecs - The number of specs that will be excluded from execution. Note that this property is not present when Jasmine is run in parallel mode.
        * @property {Order} order - Information about the ordering (random or not) of this execution of the suite. Note that this property is not present when Jasmine is run in parallel mode.
        * @property {Boolean} parallel - Whether Jasmine is being run in parallel mode.
        * @since 2.0.0
@@ -9792,6 +9864,7 @@ getJasmineRequireObj().Runner = function(j$) {
         // In parallel mode, the jasmineStarted event is separately dispatched
         // by jasmine-npm. This event only reaches reporters in non-parallel.
         totalSpecsDefined,
+        numExcludedSpecs: this.#executionTree.numExcludedSpecs(),
         order: orderForReporting(order),
         parallel: false
       });
@@ -10154,7 +10227,7 @@ getJasmineRequireObj().SpyFactory = function(j$) {
 
     this.createSpyObj = function(baseName, methodNames, propertyNames) {
       const baseNameIsCollection =
-        j$.private.isObject(baseName) || j$.private.isArray(baseName);
+        j$.private.isObject(baseName) || Array.isArray(baseName);
 
       if (baseNameIsCollection) {
         propertyNames = methodNames;
@@ -10200,7 +10273,7 @@ getJasmineRequireObj().SpyFactory = function(j$) {
 
   function normalizeKeyValues(object) {
     const result = [];
-    if (j$.private.isArray(object)) {
+    if (Array.isArray(object)) {
       for (let i = 0; i < object.length; i++) {
         result.push([object[i]]);
       }
@@ -11898,6 +11971,23 @@ getJasmineRequireObj().TreeProcessor = function(j$) {
       const nodeStats = this.#stats[node.id];
       return node.children ? !nodeStats.willExecute : nodeStats.excluded;
     }
+
+    numExcludedSpecs(node) {
+      if (!node) {
+        return this.numExcludedSpecs(this.topSuite);
+      } else if (node.children) {
+        let result = 0;
+
+        for (const child of node.children) {
+          result += this.numExcludedSpecs(child);
+        }
+
+        return result;
+      } else {
+        const nodeStats = this.#stats[node.id];
+        return nodeStats.willExecute ? 0 : 1;
+      }
+    }
   }
 
   function segmentChildren(node, orderedChildren, stats, executableIndex) {
@@ -12295,5 +12385,5 @@ getJasmineRequireObj().UserContext = function(j$) {
 };
 
 getJasmineRequireObj().version = function() {
-  return '6.0.0-alpha.2';
+  return '6.0.0-beta.1';
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jasmine-core",
   "license": "MIT",
-  "version": "6.0.0-alpha.2",
+  "version": "6.0.0-beta.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/jasmine/jasmine.git"
@@ -43,10 +43,10 @@
     "ejs": "^3.1.10",
     "eslint": "^9.24.0",
     "eslint-plugin-compat": "^6.0.2",
-    "glob": "^10.2.3",
+    "glob": "^13.0.0",
     "globals": "^16.0.0",
-    "jasmine": "github:jasmine/jasmine-npm#6.0",
-    "jasmine-browser-runner": "github:jasmine/jasmine-browser-runner#4.0",
+    "jasmine": "github:jasmine/jasmine-npm",
+    "jasmine-browser-runner": "github:jasmine/jasmine-browser-runner",
     "jsdom": "^26.0.0",
     "prettier": "1.17.1",
     "sass": "^1.58.3"