2e5c7557a9
- Breaking change: Treat callbacks to `editor.ready` as Promises, only resolving after all resolve - Breaking change: Make `editor.runCallbacks` return a `Promise` which resolves upon all callbacks resolving - Breaking change: Require `npx` (used with `babel-node`) to allow Node files for HTML building and JSDoc type checking to be expressed as ESM. - Breaking change: `addExtension` now throws upon a repeated attempt to add an already-added extension - Breaking change (storage preference cookies): Namespace the cookie as "svgeditstore" instead of just "store" - Breaking change (API): Remove `svgCanvas.rasterExport` fourth (callback) argument, collapsing fifth (options) to fourth - Breaking change (API): Remove `svgCanvas.exportPDF` third (callback) argument - Breaking change (API): `editor/contextmenu.js` `add` now throws instead of giving a console error only upon detecting a bad menuitem or preexisting context menu - Breaking change (API): Remove `svgCanvas.embedImage` second (callback) argument - Breaking change (API): Make `getHelpXML` a class instead of instance method of `RGBColor` - Breaking change (internal API): Refactor `dbox` (and `alert`/`confirm`/`process`/`prompt`/`select`) to avoid a callback argument in favor of return a Promise - Fix: Avoid running in extension `langReady` multiple times or serially - Enhancement (API): Add svgCanvas.runExtension to run just one extension and add `nameFilter` callback to `runExtensions` - Enhancement (API): Supply `$` (our wrapped jQuery) to extensions so can use its plugins, e.g., dbox with its `alert` - Enhancement: Use alert dialog in place of `alert` in webappfind - Enhancement: `editor.ready` now returns a Promise resolving when all callbacks have resolved - Enhancement: Allow `noAlert` option as part of second argument to `loadSvgString` (and `loadFromURL` and `loadFromDataURI`) to avoid UI alert (and trigger promise rejection) - Enhancement: Make `dbox` as a separate module for alert, prompt, etc. dialogs - Refactoring: Internal `PaintBox` as class; other misc. tweaks; no bitwise in canvg - Linting (ESLint): Further linting changes (for editor); rename `.eslintrc` -> `.eslintrc.json` per recommendation - Optimization: Recompress images (imageoptim-cli updated) - npm: Update devDeps - npm: Bump to 4.0.0
112 lines
4.5 KiB
JavaScript
112 lines
4.5 KiB
JavaScript
/**
|
|
* Checks that the first two arguments are equal, or are numbers close enough to be considered equal
|
|
* based on a specified maximum allowable difference.
|
|
*
|
|
* @example assert.close(3.141, Math.PI, 0.001);
|
|
*
|
|
* @param {Float} actual
|
|
* @param {Float} expected
|
|
* @param {Float} maxDifference (the maximum inclusive difference allowed between the actual and expected numbers)
|
|
* @param {string} [message] Defaults to structured message
|
|
* @returns {undefined}
|
|
*/
|
|
function close (actual, expected, maxDifference, message) {
|
|
const actualDiff = (actual === expected) ? 0 : Math.abs(actual - expected),
|
|
result = actualDiff <= maxDifference;
|
|
message = message || (actual + ' should be within ' + maxDifference + ' (inclusive) of ' + expected + (result ? '' : '. Actual: ' + actualDiff));
|
|
this.pushResult({result, actual, expected, message});
|
|
}
|
|
|
|
/**
|
|
* Checks that the first two arguments are equal, or are numbers close enough to be considered equal
|
|
* based on a specified maximum allowable difference percentage.
|
|
*
|
|
* @example assert.close.percent(155, 150, 3.4); // Difference is ~3.33%
|
|
*
|
|
* @param {Float} actual
|
|
* @param {Float} expected
|
|
* @param {Float} maxPercentDifference (the maximum inclusive difference percentage allowed between the actual and expected numbers)
|
|
* @param {string} [message] Defaults to a structured message
|
|
* @returns {undefined}
|
|
*/
|
|
function closePercent (actual, expected, maxPercentDifference, message) {
|
|
let actualDiff, result;
|
|
if (actual === expected) {
|
|
actualDiff = 0;
|
|
result = actualDiff <= maxPercentDifference;
|
|
} else if (actual !== 0 && expected !== 0 && expected !== Infinity && expected !== -Infinity) {
|
|
actualDiff = Math.abs(100 * (actual - expected) / expected);
|
|
result = actualDiff <= maxPercentDifference;
|
|
} else {
|
|
// Dividing by zero (0)! Should return `false` unless the max percentage was `Infinity`
|
|
actualDiff = Infinity;
|
|
result = maxPercentDifference === Infinity;
|
|
}
|
|
message = message || (actual + ' should be within ' + maxPercentDifference + '% (inclusive) of ' + expected + (result ? '' : '. Actual: ' + actualDiff + '%'));
|
|
|
|
this.pushResult(result, actual, expected, message);
|
|
}
|
|
|
|
/**
|
|
* Checks that the first two arguments are numbers with differences greater than the specified
|
|
* minimum difference.
|
|
*
|
|
* @example assert.notClose(3.1, Math.PI, 0.001);
|
|
*
|
|
* @param {Float} actual
|
|
* @param {Float} expected
|
|
* @param {Float} minDifference (the minimum exclusive difference allowed between the actual and expected numbers)
|
|
* @param {string} [message] Defaults to structured message
|
|
* @returns {undefined}
|
|
*/
|
|
function notClose (actual, expected, minDifference, message) {
|
|
const actualDiff = Math.abs(actual - expected),
|
|
result = actualDiff > minDifference;
|
|
message = message || (actual + ' should not be within ' + minDifference + ' (exclusive) of ' + expected + (result ? '' : '. Actual: ' + actualDiff));
|
|
this.pushResult(result, actual, expected, message);
|
|
}
|
|
|
|
/**
|
|
* Checks that the first two arguments are numbers with differences greater than the specified
|
|
* minimum difference percentage.
|
|
*
|
|
* @example assert.notClose.percent(156, 150, 3.5); // Difference is 4.0%
|
|
*
|
|
* @param {Float} actual
|
|
* @param {Float} expected
|
|
* @param {Float} minPercentDifference (the minimum exclusive difference percentage allowed between the actual and expected numbers)
|
|
* @param {string} [message] Defaults to a structured message
|
|
* @returns {undefined}
|
|
*/
|
|
function notClosePercent (actual, expected, minPercentDifference, message) {
|
|
let actualDiff, result;
|
|
if (actual === expected) {
|
|
actualDiff = 0;
|
|
result = actualDiff > minPercentDifference;
|
|
} else if (actual !== 0 && expected !== 0 && expected !== Infinity && expected !== -Infinity) {
|
|
actualDiff = Math.abs(100 * (actual - expected) / expected);
|
|
result = actualDiff > minPercentDifference;
|
|
} else {
|
|
// Dividing by zero (0)! Should only return `true` if the min percentage was `Infinity`
|
|
actualDiff = Infinity;
|
|
result = minPercentDifference !== Infinity;
|
|
}
|
|
message = message || (actual + ' should not be within ' + minPercentDifference + '% (exclusive) of ' + expected + (result ? '' : '. Actual: ' + actualDiff + '%'));
|
|
|
|
this.pushResult({result, actual, expected, message});
|
|
}
|
|
|
|
/**
|
|
* @param {external:qunit} QUnit
|
|
* @returns {external:qunit} The same instance passed in after extending
|
|
*/
|
|
export default function extend (QUnit) {
|
|
QUnit.extend(QUnit.assert, {
|
|
close,
|
|
closePercent,
|
|
notClose,
|
|
notClosePercent
|
|
});
|
|
return QUnit;
|
|
}
|