import _extends from "@babel/runtime/helpers/extends"; import _defineProperty from "@babel/runtime/helpers/defineProperty"; function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; } function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; } /** * This file contains helper methods to create expected snapshot structures * of both instance and ES6 exports. * * The files are located here and not under /test or /tools so it's transpiled * into ES5 code under /lib and can be used straight by node.js */ import assert from 'assert'; import * as allIsFunctions from './is.js'; import { create } from '../core/create.js'; import { endsWith } from './string.js'; export function validateBundle(expectedBundleStructure, bundle) { var originalWarn = console.warn; console.warn = function () { for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) { args[_key] = arguments[_key]; } if (args.join(' ').indexOf('is moved to') !== -1 && args.join(' ').indexOf('Please use the new location instead') !== -1) { // Ignore warnings like: // Warning: math.type.isNumber is moved to math.isNumber in v6.0.0. Please use the new location instead. return; } originalWarn.apply(console, args); }; try { var issues = []; // see whether all expected functions and objects are there traverse(expectedBundleStructure, (expectedType, path) => { var actualValue = get(bundle, path); var actualType = validateTypeOf(actualValue); var message = actualType === 'undefined' ? 'Missing entry in bundle. ' + "Path: ".concat(JSON.stringify(path), ", expected type: ").concat(expectedType, ", actual type: ").concat(actualType) : 'Unexpected entry type in bundle. ' + "Path: ".concat(JSON.stringify(path), ", expected type: ").concat(expectedType, ", actual type: ").concat(actualType); if (actualType !== expectedType) { issues.push({ actualType, expectedType, message }); console.warn(message); } }); // see whether there are any functions or objects that shouldn't be there traverse(bundle, (actualValue, path) => { var actualType = validateTypeOf(actualValue); var expectedType = get(expectedBundleStructure, path) || 'undefined'; // FIXME: ugly to have these special cases if (path.join('.').indexOf('docs.') !== -1) { // ignore the contents of docs return; } if (path.join('.').indexOf('all.') !== -1) { // ignore the contents of all dependencies return; } var message = expectedType === 'undefined' ? 'Unknown entry in bundle. ' + 'Is there a new function added which is missing in this snapshot test? ' + "Path: ".concat(JSON.stringify(path), ", expected type: ").concat(expectedType, ", actual type: ").concat(actualType) : 'Unexpected entry type in bundle. ' + "Path: ".concat(JSON.stringify(path), ", expected type: ").concat(expectedType, ", actual type: ").concat(actualType); if (actualType !== expectedType) { issues.push({ actualType, expectedType, message }); console.warn(message); } }); // assert on the first issue (if any) if (issues.length > 0) { var { actualType, expectedType, message } = issues[0]; console.warn("".concat(issues.length, " bundle issues found")); assert.strictEqual(actualType, expectedType, message); } } finally { console.warn = originalWarn; } } /** * Based on an object with factory functions, create the expected * structures for ES6 export and a mathjs instance. * @param {Object} factories * @return {{expectedInstanceStructure: Object, expectedES6Structure: Object}} */ export function createSnapshotFromFactories(factories) { var math = create(factories); var allFactoryFunctions = {}; var allFunctionsConstantsClasses = {}; var allFunctionsConstants = {}; var allTransformFunctions = {}; var allDependencyCollections = {}; var allClasses = {}; var allNodeClasses = {}; Object.keys(factories).forEach(factoryName => { var factory = factories[factoryName]; var name = factory.fn; var isTransformFunction = factory.meta && factory.meta.isTransformFunction; var isClass = !isLowerCase(name[0]) && validateTypeOf(math[name]) === 'Function'; var dependenciesName = factory.fn + (isTransformFunction ? 'Transform' : '') + 'Dependencies'; allFactoryFunctions[factoryName] = 'Function'; allFunctionsConstantsClasses[name] = validateTypeOf(math[name]); allDependencyCollections[dependenciesName] = 'Object'; if (isTransformFunction) { allTransformFunctions[name] = 'Function'; } if (isClass) { if (endsWith(name, 'Node')) { allNodeClasses[name] = 'Function'; } else { allClasses[name] = 'Function'; } } else { allFunctionsConstants[name] = validateTypeOf(math[name]); } }); var embeddedDocs = {}; Object.keys(factories).forEach(factoryName => { var factory = factories[factoryName]; var name = factory.fn; if (isLowerCase(factory.fn[0])) { // ignore class names starting with upper case embeddedDocs[name] = 'Object'; } }); embeddedDocs = exclude(embeddedDocs, ['equalScalar', 'apply', 'addScalar', 'multiplyScalar', 'print', 'divideScalar', 'parse', 'compile', 'parser', 'chain', 'reviver', 'replacer']); var allTypeChecks = {}; Object.keys(allIsFunctions).forEach(name => { if (name.indexOf('is') === 0) { allTypeChecks[name] = 'Function'; } }); var allErrorClasses = { ArgumentsError: 'Function', DimensionError: 'Function', IndexError: 'Function' }; var expectedInstanceStructure = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, allFunctionsConstantsClasses), {}, { on: 'Function', off: 'Function', once: 'Function', emit: 'Function', import: 'Function', config: 'Function', create: 'Function', factory: 'Function' }, allTypeChecks), allErrorClasses), {}, { expression: { transform: _objectSpread({}, allTransformFunctions), mathWithTransform: _objectSpread(_objectSpread({}, exclude(allFunctionsConstants, ['chain'])), {}, { config: 'Function' }) } }); var expectedES6Structure = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, exclude(allFunctionsConstantsClasses, ['E', 'false', 'Infinity', 'NaN', 'null', 'PI', 'true'])), {}, { create: 'Function', config: 'Function', factory: 'Function', _true: 'boolean', _false: 'boolean', _null: 'null', _Infinity: 'number', _NaN: 'number' }, allTypeChecks), allErrorClasses), allDependencyCollections), allFactoryFunctions), {}, { docs: embeddedDocs }); return { expectedInstanceStructure, expectedES6Structure }; } export function validateTypeOf(x) { if (x && x.type === 'Unit') { return 'Unit'; } if (x && x.type === 'Complex') { return 'Complex'; } if (Array.isArray(x)) { return 'Array'; } if (x === null) { return 'null'; } if (typeof x === 'function') { return 'Function'; } if (typeof x === 'object') { return 'Object'; } return typeof x; } function traverse(obj) { var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : (value, path) => {}; var path = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : []; // FIXME: ugly to have these special cases if (path.length > 0 && path[0].indexOf('Dependencies') !== -1) { // special case for objects holding a collection of dependencies callback(obj, path); } else if (validateTypeOf(obj) === 'Array') { obj.map((item, index) => traverse(item, callback, path.concat(index))); } else if (validateTypeOf(obj) === 'Object') { Object.keys(obj).forEach(key => { // FIXME: ugly to have these special cases // ignore special case of deprecated docs if (key === 'docs' && path.join('.') === 'expression') { return; } traverse(obj[key], callback, path.concat(key)); }); } else { callback(obj, path); } } function get(object, path) { var child = object; for (var i = 0; i < path.length; i++) { var key = path[i]; child = child ? child[key] : undefined; } return child; } /** * Create a copy of the provided `object` and delete * all properties listed in `excludedProperties` * @param {Object} object * @param {string[]} excludedProperties * @return {Object} */ function exclude(object, excludedProperties) { var strippedObject = _extends({}, object); excludedProperties.forEach(excludedProperty => { delete strippedObject[excludedProperty]; }); return strippedObject; } function isLowerCase(text) { return typeof text === 'string' && text.toLowerCase() === text; }