archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

chore(deps): nuke taffydb from orbit

Browse Source 
Even as a dev dependency, used solely to verify the correctness of its replacement, `@jsdoc/salty`, it was triggering bogus security warnings.

Fixes #2041.
This commit is contained in:
Jeff Williams 2023-03-01 07:28:32 -08:00
parent 0662bc73e3
commit 1192486324
No known key found for this signature in database
5 changed files with 102 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.renovaterc.json
View File

@ -1,7 +1,6 @@
{
"extends": ["config:base"],
"statusCheckVerify": true,
"ignoreDeps": ["taffydb"],
"automerge": true,
"automergeType": "branch",
"rangeStrategy": "bump",

4
js-green-licenses.json
View File

@ -1,6 +1,6 @@
{
"packageAllowlist": [
"argparse", // Python-2.0 licensed, which is fine but not on js-green-licenses default list
"taffydb" // MIT licensed, per its source code
// Python-2.0 licensed, which is fine but not on js-green-licenses default list
"argparse"
]
}

15
package-lock.json generated
View File

@ -39,8 +39,7 @@
"license-check-and-add": "^4.0.5",
"lodash": "^4.17.21",
"mock-fs": "^5.2.0",
"prettier": "^2.8.4",
"taffydb": "2.6.2"
"prettier": "^2.8.4"
},
"engines": {
"node": ">=v18.12.0"
@ -10510,12 +10509,6 @@
"node": ">=8.0.0"
}
},
"node_modules/taffydb": {
"version": "2.6.2",
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
"integrity": "sha512-y3JaeRSplks6NYQuCOj3ZFMO3j60rTwbuKCvZxsAraGYH2epusatvZ0baZYA01WsGqJBq/Dl6vOrMUJqyMj8kA==",
"dev": true
},
"node_modules/tar": {
"version": "6.1.11",
"resolved": "https://registry.npmjs.org/tar/-/tar-6.1.11.tgz",
@ -19153,12 +19146,6 @@
"wordwrapjs": "^4.0.0"
}
},
"taffydb": {
"version": "2.6.2",
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
"integrity": "sha512-y3JaeRSplks6NYQuCOj3ZFMO3j60rTwbuKCvZxsAraGYH2epusatvZ0baZYA01WsGqJBq/Dl6vOrMUJqyMj8kA==",
"dev": true
},
"tar": {
"version": "6.1.11",
"resolved": "https://registry.npmjs.org/tar/-/tar-6.1.11.tgz",

3
package.json
View File

@ -32,8 +32,7 @@
"license-check-and-add": "^4.0.5",
"lodash": "^4.17.21",
"mock-fs": "^5.2.0",
"prettier": "^2.8.4",
"taffydb": "2.6.2"
"prettier": "^2.8.4"
},
"type": "module",
"engines": {

245
packages/jsdoc-salty/test/specs/lib/salty.js
View File

@ -16,7 +16,6 @@
describe('@jsdoc/salty/lib/salty', () => {
const _ = require('lodash');
const Salty = require('../../../lib/salty');
const { taffy } = require('taffydb');
const data = [
{ a: 2, b: undefined, c: true },
@ -29,20 +28,12 @@ describe('@jsdoc/salty/lib/salty', () => {
{ a: 17, b: 0, c: false },
{ a: 66, c: true },
];
let saltyDB;
let taffyDB;
let db;
beforeEach(() => {
saltyDB = new Salty(_.cloneDeep(data));
taffyDB = taffy(_.cloneDeep(data));
db = new Salty(_.cloneDeep(data));
});
// To confirm that TaffyDB and Salty have equivalent behavior, run the same test for both.
function validate(f) {
f(saltyDB);
f(taffyDB);
}
it('is a constructor that returns a function', () => {
expect(new Salty()).toBeFunction();
});
@ -56,9 +47,9 @@ describe('@jsdoc/salty/lib/salty', () => {
it('sorts by a single key', () => {
// TaffyDB sorts things strangely when null or undefined values are present. Salty doesn't
// attempt to match that behavior, so we just verify that Salty does what it's supposed to.
saltyDB.sort('b');
db.sort('b');
expect(saltyDB().get()).toMatchArrayOfObjects([
expect(db().get()).toMatchArrayOfObjects([
{ a: 7, b: 'goodbye', c: false },
{ a: 100, b: 'hello', c: true },
{ a: 17, b: 0, c: false },
@ -72,43 +63,69 @@ describe('@jsdoc/salty/lib/salty', () => {
});
it('sorts by multiple keys', () => {
validate((db) => {
db.sort('a, b');
db.sort('a, b');
expect(db().get()).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 7, b: 'goodbye', c: false },
{ a: 17, b: 0, c: false },
{ a: 22, b: null, c: true },
{ a: 35, b: undefined, c: true },
{ a: 42, b: 8, c: null },
{ a: 47, b: null, c: true },
{ a: 66, c: true },
{ a: 100, b: 'hello', c: true },
]);
});
expect(db().get()).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 7, b: 'goodbye', c: false },
{ a: 17, b: 0, c: false },
{ a: 22, b: null, c: true },
{ a: 35, b: undefined, c: true },
{ a: 42, b: 8, c: null },
{ a: 47, b: null, c: true },
{ a: 66, c: true },
{ a: 100, b: 'hello', c: true },
]);
});
it('has no effect when called with a nonexistent key', () => {
validate((db) => {
db.sort('q');
db.sort('q');
expect(db().get()).toMatchArrayOfObjects(data);
});
expect(db().get()).toMatchArrayOfObjects(data);
});
it('returns true', () => {
validate((db) => {
expect(db.sort('a')).toBeTrue();
});
expect(db.sort('a')).toBeTrue();
});
});
});
describe('queries', () => {
it('returns an object with the expected methods after a query', () => {
validate((db) => {
const query = db();
const query = db();
expect(query.each).toBeFunction();
expect(query.get).toBeFunction();
expect(query.remove).toBeFunction();
});
describe('each', () => {
it('calls the function on each item if there is no selection', () => {
const result = [];
db().each((item) => result.push(item.a));
expect(result).toEqual([2, 47, 100, 7, 42, 35, 22, 17, 66]);
});
it('calls the function on selected items if there is a selection', () => {
const result = [];
db({ c: false }).each((item) => result.push(item.a));
expect(result).toEqual([7, 17]);
});
it('does not call the function if the selection is empty', () => {
const fn = jasmine.createSpy();
db({ a: 1000000000 }).each(fn);
expect(fn).not.toHaveBeenCalled();
});
it('returns an object with the expected methods', () => {
const query = db().each(() => true);
expect(query.each).toBeFunction();
expect(query.get).toBeFunction();
@ -116,164 +133,98 @@ describe('@jsdoc/salty/lib/salty', () => {
});
});
describe('each', () => {
it('calls the function on each item if there is no selection', () => {
validate((db) => {
const result = [];
db().each((item) => result.push(item.a));
expect(result).toEqual([2, 47, 100, 7, 42, 35, 22, 17, 66]);
});
});
it('calls the function on selected items if there is a selection', () => {
validate((db) => {
const result = [];
db({ c: false }).each((item) => result.push(item.a));
expect(result).toEqual([7, 17]);
});
});
it('does not call the function if the selection is empty', () => {
validate((db) => {
const fn = jasmine.createSpy();
db({ a: 1000000000 }).each(fn);
expect(fn).not.toHaveBeenCalled();
});
});
it('returns an object with the expected methods', () => {
validate((db) => {
const query = db().each(() => true);
expect(query.each).toBeFunction();
expect(query.get).toBeFunction();
expect(query.remove).toBeFunction();
});
});
});
describe('get', () => {
it('returns all items if there is no selection', () => {
validate((db) => {
expect(db().get()).toMatchArrayOfObjects(data);
});
expect(db().get()).toMatchArrayOfObjects(data);
});
it('returns the selected items when one matcher is provided', () => {
validate((db) => {
const result = db({ c: false }).get();
const result = db({ c: false }).get();
expect(result).toMatchArrayOfObjects([
{ a: 7, b: 'goodbye', c: false },
{ a: 17, b: 0, c: false },
]);
});
expect(result).toMatchArrayOfObjects([
{ a: 7, b: 'goodbye', c: false },
{ a: 17, b: 0, c: false },
]);
});
it('returns the selected items when multiple matchers are provided', () => {
validate((db) => {
const result = db({ c: false }, { b: 0 }).get();
const result = db({ c: false }, { b: 0 }).get();
expect(result).toMatchArrayOfObjects([{ a: 17, b: 0, c: false }]);
});
expect(result).toMatchArrayOfObjects([{ a: 17, b: 0, c: false }]);
});
it('returns the selected items when the matcher contains an array of values', () => {
validate((db) => {
const result = db({ a: [2, 47] }).get();
const result = db({ a: [2, 47] }).get();
expect(result).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 47, b: null, c: true },
]);
});
expect(result).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 47, b: null, c: true },
]);
});
it('returns the correct items with the special matcher for undefined values', () => {
validate((db) => {
const result = db({ b: { isUndefined: true } }).get();
const result = db({ b: { isUndefined: true } }).get();
expect(result).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 35, b: undefined, c: true },
{ a: 66, c: true },
]);
});
expect(result).toMatchArrayOfObjects([
{ a: 2, b: undefined, c: true },
{ a: 35, b: undefined, c: true },
{ a: 66, c: true },
]);
});
it('returns no items if the selection is empty', () => {
validate((db) => {
expect(db({ a: 1000000000 }).get()).toBeEmptyArray();
});
expect(db({ a: 1000000000 }).get()).toBeEmptyArray();
});
it('returns the correct items with a custom matcher function', () => {
validate((db) => {
function matcher() {
return this.a > 20; // eslint-disable-line
}
function matcher() {
return this.a > 20; // eslint-disable-line
}
expect(db(matcher).get()).toMatchArrayOfObjects([
{ a: 47, b: null, c: true },
{ a: 100, b: 'hello', c: true },
{ a: 42, b: 8, c: null },
{ a: 35, b: undefined, c: true },
{ a: 22, b: null, c: true },
{ a: 66, c: true },
]);
});
expect(db(matcher).get()).toMatchArrayOfObjects([
{ a: 47, b: null, c: true },
{ a: 100, b: 'hello', c: true },
{ a: 42, b: 8, c: null },
{ a: 35, b: undefined, c: true },
{ a: 22, b: null, c: true },
{ a: 66, c: true },
]);
});
});
describe('remove', () => {
it('deletes everything if there is no selection', () => {
validate((db) => {
db().remove();
db().remove();
expect(db().get()).toBeEmptyArray();
});
expect(db().get()).toBeEmptyArray();
});
it('deletes the selected items if there is a selection', () => {
validate((db) => {
db({ c: true }).remove();
db({ c: true }).remove();
expect(db().get()).toMatchArrayOfObjects([
{ a: 7, b: 'goodbye', c: false },
{ a: 42, b: 8, c: null },
{ a: 17, b: 0, c: false },
]);
});
expect(db().get()).toMatchArrayOfObjects([
{ a: 7, b: 'goodbye', c: false },
{ a: 42, b: 8, c: null },
{ a: 17, b: 0, c: false },
]);
});
it('deletes nothing if the selection is empty', () => {
validate((db) => {
db({ a: 846 }).remove();
db({ a: 846 }).remove();
expect(db().get()).toMatchArrayOfObjects(data);
});
expect(db().get()).toMatchArrayOfObjects(data);
});
it('removes the selected items from the active selection', () => {
validate((db) => {
const db2 = db({ a: 7 });
const db2 = db({ a: 7 });
db2.remove();
db2.remove();
expect(db2.get()).toBeEmptyArray();
});
expect(db2.get()).toBeEmptyArray();
});
it('returns the number of removed items', () => {
validate((db) => {
expect(db({ c: true }).remove()).toBe(6);
});
expect(db({ c: true }).remove()).toBe(6);
});
});
});