unit-test-sentinel/dist/index.js

Provides a sentinel object that can contain and return arbitrary unique properties for unit tests.

"use strict";

function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = void 0;
var _util = require("util");
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
var showAs = function showAs(name) {
  return function () {
    return "\xA6\u0444.".concat(name, "\xA6");
  };
};
var sentinelError = new Error(showAs('Error')());
sentinelError.stack = null;
var chars = _toConsumableArray(Array(127 - 33).keys()).map(function (_) {
  return String.fromCharCode(33 + _);
}).join('');
var randomChar = function randomChar() {
  return chars[Math.floor(Math.random() * chars.length)];
};

/**
 * Creates an object whose purpose is to create uniquely referenced objects as its properties.
 * Useful when you want to compare stubbed values in a function call, but don't care to create any objects as locals.
 * @example
 * const ф = sentinel.create();
 * const prop1 = ф.prop;
 * const prop2 = ф.prop;
 * prop1 === prop2; // true - these will be the exact same object.
 * @returns {Sentinel.Objects}
 */
var create = function create() {
  return new Proxy({}, {
    // eslint-disable-next-line no-return-assign, no-param-reassign
    get: function get(target, name) {
      var _target$name;
      return (_target$name = target[name]) !== null && _target$name !== void 0 ? _target$name : target[name] = name === String(Error) ? sentinelError : Object.create(_defineProperty({
        constructor: {
          name: showAs(name)()
        },
        toString: showAs(name),
        inspect: showAs(name)
      }, _util.inspect.custom, showAs(name)));
    },
    set: function set(target, name, value) {
      // eslint-disable-next-line no-param-reassign
      target[name] = value;
      return true;
    }
  });
};

/**
 * Creates an object whose purpose is to create unique random strings.
 * @example
 * const ф = sentinel.random();
 * const s1 = ф.prop;
 * const s2 = ф.prop;
 * s1 === s2; // true - these will be the exact same 12-character string.
 * @returns {Sentinel.Strings}
 */
var random = function random() {
  return new Proxy({}, {
    // eslint-disable-next-line no-return-assign, no-param-reassign
    get: function get(target, name) {
      var _target$name2;
      return (_target$name2 = target[name]) !== null && _target$name2 !== void 0 ? _target$name2 : target[name] = "".concat(name, "-").concat(Array(12).fill(0).map(randomChar).join(''));
    },
    set: function set(target, name, value) {
      // eslint-disable-next-line no-param-reassign
      target[name] = value;
      return true;
    }
  });
};

/**
 * Provides factory methods for creating sentinel objects.
 * @type {Sentinel.Factory}
 */
var _default = {
  create: create,
  random: random
};
exports["default"] = _default;
module.exports = exports.default;