From c376da981ba0832a9e7cd82119e6257496de567b Mon Sep 17 00:00:00 2001 From: Carlos Mondragon Date: Tue, 7 Nov 2023 19:01:36 -0500 Subject: [PATCH 1/3] Feat: Convert some methods to static methods --- test/test.js | 18 ++++----- tools.js | 107 +++++++++++++++++++++++++++++---------------------- 2 files changed, 69 insertions(+), 56 deletions(-) diff --git a/test/test.js b/test/test.js index 70ed475..0e1ab07 100644 --- a/test/test.js +++ b/test/test.js @@ -1,5 +1,5 @@ const assert = require('assert'); -const { OpenReviewClient } = require('../index'); +const { OpenReviewClient, Tools } = require('../index'); describe('OpenReview Client', function () { this.beforeAll(async function () { @@ -531,10 +531,10 @@ describe('OpenReview Client', function () { } }; - let res = this.superClient.tools.getPreferredName(fakeProfile); + let res = Tools.getPreferredName(fakeProfile); assert.equal(res, 'AnotherFirst AnotherMiddle AnotherLast'); - res = this.superClient.tools.getPreferredName(fakeProfile, true); + res = Tools.getPreferredName(fakeProfile, true); assert.equal(res, 'AnotherLast'); }); @@ -665,19 +665,19 @@ describe('OpenReview Client', function () { }); it('should test prettyId', async function () { - let res = this.superClient.tools.prettyId('ICLR.cc/2023/Conference'); + let res = Tools.prettyId('ICLR.cc/2023/Conference'); assert.equal(res, 'ICLR 2023 Conference'); - res = this.superClient.tools.prettyId('ICLR.cc/2023/Conference/-/Blind_Submission'); + res = Tools.prettyId('ICLR.cc/2023/Conference/-/Blind_Submission'); assert.equal(res, 'ICLR 2023 Conference Blind Submission'); - res = this.superClient.tools.prettyId('ICLR.cc/2023/Conference/-/Revision'); + res = Tools.prettyId('ICLR.cc/2023/Conference/-/Revision'); assert.equal(res, 'ICLR 2023 Conference Revision'); - res = this.superClient.tools.prettyId('ICLR.cc/2023/Conference/-/Meta_Review', true); + res = Tools.prettyId('ICLR.cc/2023/Conference/-/Meta_Review', true); assert.equal(res, 'Meta Review'); - res = this.superClient.tools.prettyId(''); + res = Tools.prettyId(''); assert.equal(res, ''); }); @@ -783,7 +783,7 @@ describe('OpenReview Client', function () { ]; for (let i = 0; i < dblpXmls.length; i++) { - const note = this.superClient.tools.convertDblpXmlToNote(dblpXmls[i]); + const note = Tools.convertDblpXmlToNote(dblpXmls[i]); const resolvedNote = resolved[i]; if (resolvedNote.pdate) { assert.equal(note.pdate, resolvedNote.pdate); diff --git a/tools.js b/tools.js index 599696b..56b2b42 100644 --- a/tools.js +++ b/tools.js @@ -27,6 +27,21 @@ class Tools { this.subdomainsCache = {}; } + /** + * Returns the type of a variable + * + * @static + * @param {any} variable - The variable to get the type of + * @returns {string} The type of the variable + */ + static variableType(variable) { + if (variable === null) return 'null'; + if (Array.isArray(variable)) { + return 'array'; + } + return typeof variable; + } + /** * Checks if domain is a TLD * @@ -34,7 +49,7 @@ class Tools { * @param {string} domain - domain to check * @returns {boolean} true if domain is a TLD, false otherwise */ - _isTLD(domain) { + #isTLD(domain) { return isValid(domain) && !getDomain(domain); } @@ -49,10 +64,10 @@ class Tools { * * @example * - * _getSubdomains('iesl.cs.umass.edu') + * #getSubdomains('iesl.cs.umass.edu') * returns ['iesl.cs.umass.edu', 'cs.umass.edu', 'umass.edu'] */ - _getSubdomains(domain) { + #getSubdomains(domain) { if (this.subdomainsCache[domain]) { return this.subdomainsCache[domain]; } @@ -63,7 +78,7 @@ class Tools { const domains = domainComponents.map((_, index) => domainComponents.slice(index).join('.')); const validDomains = new Set(); for (const domain of domains) { - if (!this._isTLD(domain)) { + if (!this.#isTLD(domain)) { validDomains.add(this.duplicateDomains[domain] || domain); } } @@ -72,12 +87,12 @@ class Tools { return subdomains; } - _infoFunctionBuilder(policyFunction) { + #infoFunctionBuilder(policyFunction) { return (profile, nYears) => { const result = policyFunction(profile, nYears); const domains = new Set(); for (const domain of result.domains) { - const subdomains = this._getSubdomains(domain); + const subdomains = this.#getSubdomains(domain); for (const subdomain of subdomains) { domains.add(subdomain); } @@ -96,12 +111,12 @@ class Tools { /** * Splits an array into chunks of a given size. * - * @private + * @static * @param {Array} arr - Array to split. * @param {number} size - Size of the chunks. * @returns {Array} Array of chunks. */ - splitArray(arr, size) { + static splitArray(arr, size) { const result = []; for (let i = 0; i < arr.length; i += size) { result.push(arr.slice(i, i + size)); @@ -134,11 +149,12 @@ class Tools { /** * Takes an Invitation or Group ID and returns a pretty version of it. * + * @static * @param {string} id - Invitation or Group ID. * @param {boolean} onlyLast - If true, only the last part of the ID will be returned. * @returns {string} Pretty version of the ID. */ - prettyId(id, onlyLast) { + static prettyId(id, onlyLast) { if (!id) { return ''; } else if (id.indexOf('~') === 0 && id.length > 1) { @@ -219,11 +235,12 @@ class Tools { /** * Accepts an OpenReview profile object and retrieves the user's preferred name or the first listed name. * + * @static * @param {object} profile - The OpenReview profile object. * @param {boolean} [lastNameOnly=false] - A boolean indicating whether to return only the last name or the full name. * @returns {string} - The user's preferred name or the first listed name. */ - getPreferredName(profile, lastNameOnly=false) { + static getPreferredName(profile, lastNameOnly=false) { const names = profile.content.names; const preferredNames = names.filter(name => name.preferred); const preferredName = preferredNames.length > 0 ? preferredNames[0] : names[0]; @@ -424,11 +441,11 @@ class Tools { let infoFunction; if (typeof policy === 'function') { - infoFunction = this._infoFunctionBuilder(policy); + infoFunction = this.#infoFunctionBuilder(policy); } else if (policy === 'neurips') { - infoFunction = this._infoFunctionBuilder(this.getNeuripsProfileInfo); + infoFunction = this.#infoFunctionBuilder(this.getNeuripsProfileInfo); } else { - infoFunction = this._infoFunctionBuilder(this.getProfileInfo); + infoFunction = this.#infoFunctionBuilder(this.getProfileInfo); } const authorDomains = new Set(); @@ -662,43 +679,39 @@ class Tools { }; } - #variableType(variable) { - if (variable === null) return 'null'; - if (Array.isArray(variable)) { - return 'array'; - } - return typeof variable; - } - - convertDblpXmlToNote(dblpXml) { + /** + * Converts a dblp xml to a note object. + * + * @static + * @param {string} dblpXml - The dblp xml. + * @returns {object} The note object. + * + */ + static convertDblpXmlToNote(dblpXml) { const removeDigitsRegEx = /\s\d{4}$/; const removeTrailingPeriod = /\.$/; - if (!this.xmlParser) { - this.xmlParser = new XMLParser({ ignoreAttributes: false }); - } - - if (!this.entryTypes) { - this.entryTypes = [ - 'article', - 'book', - 'booklet', - 'conference', - 'inbook', - 'incollection', - 'inproceedings', - 'manual', - 'mastersthesis', - 'misc', - 'phdthesis', - 'proceedings', - 'techreport', - 'unpublished' - ]; - } + const xmlParser = new XMLParser({ ignoreAttributes: false }); + + const entryTypes = [ + 'article', + 'book', + 'booklet', + 'conference', + 'inbook', + 'incollection', + 'inproceedings', + 'manual', + 'mastersthesis', + 'misc', + 'phdthesis', + 'proceedings', + 'techreport', + 'unpublished' + ]; const getRawDataValue = rawData => { - const rawDataType = this.#variableType(rawData); + const rawDataType = this.variableType(rawData); if (rawDataType === 'object') { return rawData['#text']; } else { @@ -716,7 +729,7 @@ class Tools { const entryToData = entryElement => { const data = {}; - data.type = this.entryTypes.find(type => entryElement[type]) || 'misc'; + data.type = entryTypes.find(type => entryElement[type]) || 'misc'; const rawData = entryElement[data.type]; data.key = rawData['@_key']; data.publtype = rawData['@_publtype']; @@ -797,7 +810,7 @@ class Tools { let dblpJson; try { - dblpJson = this.xmlParser.parse(dblpXml); + dblpJson = xmlParser.parse(dblpXml); } catch (err) { throw new OpenReviewError({ message: 'Something went wrong parsing the dblp xml', From c3ea3f60250704f49f96c3ab5396dc1db3431676 Mon Sep 17 00:00:00 2001 From: Carlos Mondragon Date: Tue, 7 Nov 2023 19:02:18 -0500 Subject: [PATCH 2/3] Chore: Increase package version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 065777f..46449ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@openreview/client", - "version": "0.0.19", + "version": "0.0.20", "description": "Node.js client library for OpenReview's academic publishing API", "main": "index.js", "scripts": { From 4b77076c123967a0fbefc7747f637a2d12dd6904 Mon Sep 17 00:00:00 2001 From: Carlos Mondragon Date: Tue, 7 Nov 2023 19:02:33 -0500 Subject: [PATCH 3/3] Feat: Call static methods --- index.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.js b/index.js index 7afea47..e617413 100644 --- a/index.js +++ b/index.js @@ -338,7 +338,7 @@ class OpenReviewClient { if (emails) { const fullResponse = { profiles: [], count: 0 }; - const batches = this.tools.splitArray(emails, this.RESPONSE_SIZE); + const batches = Tools.splitArray(emails, this.RESPONSE_SIZE); let data; for (let emailBatch of batches) { data = await this._handleResponse(fetch(this.profilesSearchUrl, { @@ -380,7 +380,7 @@ class OpenReviewClient { if (ids) { const fullResponse = { profiles: [], count: 0 }; - const batches = this.tools.splitArray(ids, this.RESPONSE_SIZE); + const batches = Tools.splitArray(ids, this.RESPONSE_SIZE); let data; for (let batch of batches) { data = await this._handleResponse(fetch(this.profilesSearchUrl, { @@ -1574,4 +1574,4 @@ class OpenReviewClient { } -module.exports = { OpenReviewClient }; +module.exports = { OpenReviewClient, Tools };