xcraft-core-utils 4.3.5 → 4.3.8

package/lib/file-crypto.js

@@ -1,41 +1,41 @@
-'use strict';
-
-const watt = require('gigawatts');
-const crypto = require('crypto');
-const fs = require('fs');
-
-/**
- * Compute the checksum of the file given as parameter using a specified algorithm.
- *
- * @param {string} filePath - The file path.
- * @param {Object} options - Options.
- * @param {string} options.algorithm - For possible values, see https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options
- * @param {string} options.encoding - (optional) Hash encoding.
- * @returns {string} The file checksum.
- */
-exports.fileChecksum = watt(function* (filePath, options, next) {
-  if (!options) {
-    options = {};
-  }
-  if (!options.algorithm) {
-    options.algorithm = 'sha1';
-  }
-  if (!options.encoding) {
-    options.encoding = 'hex';
-  }
-
-  const stat = yield fs.stat(filePath, next);
-  if (!stat.isFile()) {
-    throw new Error(`${filePath} is not a file`);
-  }
-
-  const hash = crypto.createHash(options.algorithm);
-  hash.setEncoding(options.encoding);
-
-  const fileStream = fs.createReadStream(filePath);
-  fileStream.pipe(hash, {end: false});
-  yield fileStream.once('end', next);
-
-  hash.end();
-  return hash.read();
-});
+'use strict';
+
+const watt = require('gigawatts');
+const crypto = require('crypto');
+const fs = require('fs');
+
+/**
+ * Compute the checksum of the file given as parameter using a specified algorithm.
+ *
+ * @param {string} filePath - The file path.
+ * @param {Object} options - Options.
+ * @param {string} options.algorithm - For possible values, see https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm_options
+ * @param {string} options.encoding - (optional) Hash encoding.
+ * @returns {string} The file checksum.
+ */
+exports.fileChecksum = watt(function* (filePath, options, next) {
+  if (!options) {
+    options = {};
+  }
+  if (!options.algorithm) {
+    options.algorithm = 'sha1';
+  }
+  if (!options.encoding) {
+    options.encoding = 'hex';
+  }
+
+  const stat = yield fs.stat(filePath, next);
+  if (!stat.isFile()) {
+    throw new Error(`${filePath} is not a file`);
+  }
+
+  const hash = crypto.createHash(options.algorithm);
+  hash.setEncoding(options.encoding);
+
+  const fileStream = fs.createReadStream(filePath);
+  fileStream.pipe(hash, {end: false});
+  yield fileStream.once('end', next);
+
+  hash.end();
+  return hash.read();
+});

package/lib/files.js

@@ -1,144 +1,144 @@
-'use strict';
-
-const path = require('path');
-
-const exts = {
-  '.aif': 'AIF audio file',
-  '.cda': 'CD audio track file',
-  '.mid': 'MIDI audio file',
-  '.mp3': 'MP3 audio file',
-  '.mpa': 'MPEG2 audio file',
-  '.ogg': 'Ogg Vorbis audio file',
-  '.wav': 'WAV file',
-  '.wma': 'WMA audio file',
-  '.wpl': 'Windows Media Player playlist',
-  '.7z': '7Zip compressed file',
-  '.arj': 'ARJ compressed file',
-  '.deb': 'Debian software package file',
-  '.pkg': 'Package file',
-  '.rar': 'RAR file',
-  '.rpm': 'Red Hat Package Manager',
-  '.tar.gz': 'Tarball compressed file',
-  '.z': 'Z compressed file',
-  '.zip': 'Zip compressed file',
-  '.bin': 'Binary disc image',
-  '.dmg': 'macOS X disk image',
-  '.iso': 'ISO disc image',
-  '.toast': 'Toast disc image',
-  '.vcd': 'Virtual CD',
-  '.csv': 'Comma separated value file',
-  '.dat': 'Data file',
-  '.db': 'Database file',
-  '.dbf': 'Database file',
-  '.log': 'Log file',
-  '.mdb': 'Microsoft Access database file',
-  '.sav': 'Save file',
-  '.sql': 'SQL database file',
-  '.tar': 'Linux / Unix tarball file archive',
-  '.xml': 'XML file',
-  '.apk': 'Android package file',
-  '.bat': 'Batch file',
-  '.cgi': 'Perl script file',
-  '.pl': 'Perl script file',
-  '.com': 'MSDOS command file',
-  '.exe': 'Executable file',
-  '.gadget': 'Windows gadget',
-  '.jar': 'Java Archive file',
-  '.py': 'Python file',
-  '.wsf': 'Windows Script File',
-  '.fnt': 'Windows font file',
-  '.fon': 'Generic font file',
-  '.otf': 'Open type font file',
-  '.ttf': 'TrueType font file',
-  '.ai': 'Adobe Illustrator file',
-  '.bmp': 'Bitmap image',
-  '.gif': 'GIF image',
-  '.ico': 'Icon file',
-  '.jpeg': 'JPEG image',
-  '.jpg': 'JPEG image',
-  '.png': 'PNG image',
-  '.ps': 'PostScript file',
-  '.psd': 'PSD image',
-  '.svg': 'Scalable Vector Graphics file',
-  '.tif': 'TIFF image',
-  '.tiff': 'TIFF image',
-  '.asp': 'Active Server Page file',
-  '.aspx': 'Active Server Page file',
-  '.cer': 'Internet security certificate',
-  '.cfm': 'ColdFusion Markup file',
-  '.css': 'Cascading Style Sheet file',
-  '.htm ': 'HTML file',
-  '.html': 'HTML file',
-  '.js': 'JavaScript file',
-  '.jsp': 'Java Server Page file',
-  '.part': 'Partially downloaded file',
-  '.php': 'PHP file',
-  '.rss': 'RSS file',
-  '.xhtml': 'XHTML file',
-  '.key': 'Keynote presentation',
-  '.odp': 'OpenOffice Impress presentation file',
-  '.pps': 'PowerPoint slide show',
-  '.ppt': 'PowerPoint presentation',
-  '.pptx': 'PowerPoint Open XML presentation',
-  '.c': 'C and C++ source code file',
-  '.class': 'Java class file',
-  '.cpp': 'C++ source code file',
-  '.cs': 'Visual C# source code file',
-  '.h': 'C, C++, and Objective C header file',
-  '.java': 'Java Source code file',
-  '.sh': 'Bash shell script',
-  '.swift': 'Swift source code file',
-  '.vb': 'Visual Basic file',
-  '.ods': 'OpenOffice Calc spreadsheet file',
-  '.xlr': 'Microsoft Works spreadsheet file',
-  '.xls': 'Microsoft Excel file',
-  '.xlsx': 'Microsoft Excel Open XML spreadsheet file',
-  '.bak': 'Backup file',
-  '.cab': 'Windows Cabinet file',
-  '.cfg': 'Configuration file',
-  '.cpl': 'Windows Control panel file',
-  '.cur': 'Windows cursor file',
-  '.dll': 'DLL file',
-  '.dmp': 'Dump file',
-  '.drv': 'Device driver file',
-  '.icns': 'macOS X icon resource file',
-  '.ini': 'Initialization file',
-  '.lnk': 'Windows shortcut file',
-  '.msi': 'Windows installer package',
-  '.sys': 'Windows system file',
-  '.tmp': 'Temporary file',
-  '.3g2': '3GPP2 multimedia file',
-  '.3gp': '3GPP multimedia file',
-  '.avi': 'AVI file',
-  '.flv': 'Adobe Flash file',
-  '.h264': 'H.264 video file',
-  '.m4v': 'Apple MP4 video file',
-  '.mkv': 'Matroska Multimedia Container',
-  '.mov': 'Apple QuickTime movie file',
-  '.mp4': 'MPEG4 video file',
-  '.mpg': 'MPEG video file',
-  '.mpeg': 'MPEG video file',
-  '.rm': 'RealMedia file',
-  '.swf': 'Shockwave flash file',
-  '.vob': 'DVD Video Object',
-  '.wmv': 'Windows Media Video file',
-  '.doc': 'Microsoft Word file',
-  '.docx': 'Microsoft Word file',
-  '.odt': 'OpenOffice Writer document file',
-  '.pdf': 'PDF file',
-  '.rtf': 'Rich Text Format',
-  '.tex': 'A LaTeX document file',
-  '.txt': 'Plain text file',
-  '.wks': 'Microsoft Works file',
-  '.wps': 'Microsoft Works file',
-  '.wpd': 'WordPerfect document',
-};
-
-exports.getFileFilter = function (filePath) {
-  const ext = path.extname(filePath);
-  const found = exts[ext];
-  if (found) {
-    return {name: found, extensions: [ext]};
-  }
-  return {name: '?', extensions: [ext]};
-};
+'use strict';
+
+const path = require('path');
+
+const exts = {
+  '.aif': 'AIF audio file',
+  '.cda': 'CD audio track file',
+  '.mid': 'MIDI audio file',
+  '.mp3': 'MP3 audio file',
+  '.mpa': 'MPEG2 audio file',
+  '.ogg': 'Ogg Vorbis audio file',
+  '.wav': 'WAV file',
+  '.wma': 'WMA audio file',
+  '.wpl': 'Windows Media Player playlist',
+  '.7z': '7Zip compressed file',
+  '.arj': 'ARJ compressed file',
+  '.deb': 'Debian software package file',
+  '.pkg': 'Package file',
+  '.rar': 'RAR file',
+  '.rpm': 'Red Hat Package Manager',
+  '.tar.gz': 'Tarball compressed file',
+  '.z': 'Z compressed file',
+  '.zip': 'Zip compressed file',
+  '.bin': 'Binary disc image',
+  '.dmg': 'macOS X disk image',
+  '.iso': 'ISO disc image',
+  '.toast': 'Toast disc image',
+  '.vcd': 'Virtual CD',
+  '.csv': 'Comma separated value file',
+  '.dat': 'Data file',
+  '.db': 'Database file',
+  '.dbf': 'Database file',
+  '.log': 'Log file',
+  '.mdb': 'Microsoft Access database file',
+  '.sav': 'Save file',
+  '.sql': 'SQL database file',
+  '.tar': 'Linux / Unix tarball file archive',
+  '.xml': 'XML file',
+  '.apk': 'Android package file',
+  '.bat': 'Batch file',
+  '.cgi': 'Perl script file',
+  '.pl': 'Perl script file',
+  '.com': 'MSDOS command file',
+  '.exe': 'Executable file',
+  '.gadget': 'Windows gadget',
+  '.jar': 'Java Archive file',
+  '.py': 'Python file',
+  '.wsf': 'Windows Script File',
+  '.fnt': 'Windows font file',
+  '.fon': 'Generic font file',
+  '.otf': 'Open type font file',
+  '.ttf': 'TrueType font file',
+  '.ai': 'Adobe Illustrator file',
+  '.bmp': 'Bitmap image',
+  '.gif': 'GIF image',
+  '.ico': 'Icon file',
+  '.jpeg': 'JPEG image',
+  '.jpg': 'JPEG image',
+  '.png': 'PNG image',
+  '.ps': 'PostScript file',
+  '.psd': 'PSD image',
+  '.svg': 'Scalable Vector Graphics file',
+  '.tif': 'TIFF image',
+  '.tiff': 'TIFF image',
+  '.asp': 'Active Server Page file',
+  '.aspx': 'Active Server Page file',
+  '.cer': 'Internet security certificate',
+  '.cfm': 'ColdFusion Markup file',
+  '.css': 'Cascading Style Sheet file',
+  '.htm ': 'HTML file',
+  '.html': 'HTML file',
+  '.js': 'JavaScript file',
+  '.jsp': 'Java Server Page file',
+  '.part': 'Partially downloaded file',
+  '.php': 'PHP file',
+  '.rss': 'RSS file',
+  '.xhtml': 'XHTML file',
+  '.key': 'Keynote presentation',
+  '.odp': 'OpenOffice Impress presentation file',
+  '.pps': 'PowerPoint slide show',
+  '.ppt': 'PowerPoint presentation',
+  '.pptx': 'PowerPoint Open XML presentation',
+  '.c': 'C and C++ source code file',
+  '.class': 'Java class file',
+  '.cpp': 'C++ source code file',
+  '.cs': 'Visual C# source code file',
+  '.h': 'C, C++, and Objective C header file',
+  '.java': 'Java Source code file',
+  '.sh': 'Bash shell script',
+  '.swift': 'Swift source code file',
+  '.vb': 'Visual Basic file',
+  '.ods': 'OpenOffice Calc spreadsheet file',
+  '.xlr': 'Microsoft Works spreadsheet file',
+  '.xls': 'Microsoft Excel file',
+  '.xlsx': 'Microsoft Excel Open XML spreadsheet file',
+  '.bak': 'Backup file',
+  '.cab': 'Windows Cabinet file',
+  '.cfg': 'Configuration file',
+  '.cpl': 'Windows Control panel file',
+  '.cur': 'Windows cursor file',
+  '.dll': 'DLL file',
+  '.dmp': 'Dump file',
+  '.drv': 'Device driver file',
+  '.icns': 'macOS X icon resource file',
+  '.ini': 'Initialization file',
+  '.lnk': 'Windows shortcut file',
+  '.msi': 'Windows installer package',
+  '.sys': 'Windows system file',
+  '.tmp': 'Temporary file',
+  '.3g2': '3GPP2 multimedia file',
+  '.3gp': '3GPP multimedia file',
+  '.avi': 'AVI file',
+  '.flv': 'Adobe Flash file',
+  '.h264': 'H.264 video file',
+  '.m4v': 'Apple MP4 video file',
+  '.mkv': 'Matroska Multimedia Container',
+  '.mov': 'Apple QuickTime movie file',
+  '.mp4': 'MPEG4 video file',
+  '.mpg': 'MPEG video file',
+  '.mpeg': 'MPEG video file',
+  '.rm': 'RealMedia file',
+  '.swf': 'Shockwave flash file',
+  '.vob': 'DVD Video Object',
+  '.wmv': 'Windows Media Video file',
+  '.doc': 'Microsoft Word file',
+  '.docx': 'Microsoft Word file',
+  '.odt': 'OpenOffice Writer document file',
+  '.pdf': 'PDF file',
+  '.rtf': 'Rich Text Format',
+  '.tex': 'A LaTeX document file',
+  '.txt': 'Plain text file',
+  '.wks': 'Microsoft Works file',
+  '.wps': 'Microsoft Works file',
+  '.wpd': 'WordPerfect document',
+};
+
+exports.getFileFilter = function (filePath) {
+  const ext = path.extname(filePath);
+  const found = exts[ext];
+  if (found) {
+    return {name: found, extensions: [ext]};
+  }
+  return {name: '?', extensions: [ext]};
+};

package/lib/job-queue.js

@@ -1,114 +1,113 @@
-'use strict';
-
-const moduleName = 'job-queue';
-const clc = require('cli-color');
-const watt = require('gigawatts');
-const {locks} = require('xcraft-core-utils');
-const runner = require('./runnerInstance.js');
-const throttle = require('lodash/throttle');
-const defaultOptions = {
-  priorityGroup: 'default',
-  waitOn: [], //groups to wait
-  waitDelay: 50,
-  maxAttempt: 100,
-  useLogger: false,
-};
-class JobQueue {
-  constructor(name, runner, parallelLimit, options) {
-    //override default options
-    if (!options) {
-      options = defaultOptions;
-    } else {
-      options = {...defaultOptions, ...options};
-    }
-
-    this.log =
-      options.useLogger && require('xcraft-core-log')(`${moduleName}`, null);
-    this.name = name;
-    this.priorityGroup = options.priorityGroup;
-    this.waitOn = options.waitOn;
-    this.maxAttempt = options.maxAttempt;
-    this.attempt = 0;
-    this.waitDelay = options.waitDelay;
-    this.channel = name.toLowerCase().replace(/\.|\[|\//g, '-');
-    this.runner = watt(function* (...args) {
-      this.running++;
-      this.runningSamples++;
-      yield* runner(...args);
-    });
-    this.parallelLimit = parallelLimit;
-    this.waiting = new Map();
-    this.running = 0;
-    this.runningSamples = 0;
-    this._mutex = new locks.Mutex();
-    const busClient = require('xcraft-core-busclient').getGlobal();
-    this.resp = busClient.newResponse('job-queue', 'token');
-    watt.wrapAll(this);
-    this.notify = throttle(this._notify, 500).bind(this);
-  }
-
-  get maxAttemptReached() {
-    return this.attempt >= this.maxAttempt;
-  }
-
-  _notify(runningSamples) {
-    this.resp.events.send('<job-queue.sampled>', {
-      channel: this.channel,
-      sample: runningSamples,
-      current: 0,
-      total: 0,
-    });
-    this.runningSamples = 0;
-  }
-
-  _log() {
-    if (!this.log) {
-      return;
-    }
-
-    const msg = `«${clc.blackBright.bold(this.name)}» waiting:${
-      this.waiting.size
-    } running:${this.running}`;
-    this.log.info(msg);
-  }
-
-  _dbg(debugMessage) {
-    if (!this.log) {
-      return;
-    }
-
-    const msg = `«${clc.blackBright.bold(this.name)}» ${debugMessage}`;
-    this.log.dbg(msg);
-  }
-
-  err(ex) {
-    const msg = `«${clc.blackBright.bold(this.name)}» ${
-      ex.stack || ex.message || ex
-    }`;
-
-    if (!this.log) {
-      console.error(msg);
-      return;
-    }
-
-    this.log.err(msg);
-  }
-
-  push(job) {
-    try {
-      this.waiting.set(job.id, job);
-    } finally {
-      //launch macro-task
-      setTimeout(runner.instance.run, 0, this);
-    }
-  }
-
-  dispose() {
-    this.notify(0);
-    this.resp.events.send('<job-queue.disposed>', {
-      channel: this.channel,
-    });
-  }
-}
-
-module.exports = JobQueue;
+'use strict';
+
+const moduleName = 'job-queue';
+const clc = require('cli-color');
+const watt = require('gigawatts');
+const {locks} = require('xcraft-core-utils');
+const runner = require('./runnerInstance.js');
+const throttle = require('lodash/throttle');
+const defaultOptions = {
+  priorityGroup: 'default',
+  waitOn: [], //groups to wait
+  waitDelay: 50,
+  maxAttempt: 100,
+  useLogger: false,
+};
+class JobQueue {
+  constructor(name, runner, parallelLimit, options) {
+    //override default options
+    if (!options) {
+      options = defaultOptions;
+    } else {
+      options = {...defaultOptions, ...options};
+    }
+
+    this.log =
+      options.useLogger && require('xcraft-core-log')(`${moduleName}`, null);
+    this.name = name;
+    this.priorityGroup = options.priorityGroup;
+    this.waitOn = options.waitOn;
+    this.maxAttempt = options.maxAttempt;
+    this.attempt = 0;
+    this.waitDelay = options.waitDelay;
+    this.channel = name.toLowerCase().replace(/\.|\[|\//g, '-');
+    this.runner = watt(function* (...args) {
+      this.runningSamples++;
+      yield* runner(...args);
+    });
+    this.parallelLimit = parallelLimit;
+    this.waiting = new Map();
+    this.running = 0;
+    this.runningSamples = 0;
+    this._mutex = new locks.Mutex();
+    const busClient = require('xcraft-core-busclient').getGlobal();
+    this.resp = busClient.newResponse('job-queue', 'token');
+    watt.wrapAll(this);
+    this.notify = throttle(this._notify, 500).bind(this);
+  }
+
+  get maxAttemptReached() {
+    return this.attempt >= this.maxAttempt;
+  }
+
+  _notify(runningSamples) {
+    this.resp.events.send('<job-queue.sampled>', {
+      channel: this.channel,
+      sample: runningSamples,
+      current: 0,
+      total: 0,
+    });
+    this.runningSamples = 0;
+  }
+
+  _log() {
+    if (!this.log) {
+      return;
+    }
+
+    const msg = `«${clc.blackBright.bold(this.name)}» waiting:${
+      this.waiting.size
+    } running:${this.running}`;
+    this.log.info(msg);
+  }
+
+  _dbg(debugMessage) {
+    if (!this.log) {
+      return;
+    }
+
+    const msg = `«${clc.blackBright.bold(this.name)}» ${debugMessage}`;
+    this.log.dbg(msg);
+  }
+
+  err(ex) {
+    const msg = `«${clc.blackBright.bold(this.name)}» ${
+      ex.stack || ex.message || ex
+    }`;
+
+    if (!this.log) {
+      console.error(msg);
+      return;
+    }
+
+    this.log.err(msg);
+  }
+
+  push(job) {
+    try {
+      this.waiting.set(job.id, job);
+    } finally {
+      //launch macro-task
+      setTimeout(runner.instance.run, 0, this);
+    }
+  }
+
+  dispose() {
+    this.notify(0);
+    this.resp.events.send('<job-queue.disposed>', {
+      channel: this.channel,
+    });
+  }
+}
+
+module.exports = JobQueue;

package/lib/js.js

@@ -1,14 +1,14 @@
-'use strict';
-
-exports.isFunction = function (fn) {
-  return typeof fn === 'function';
-};
-
-exports.isGenerator = function (fn) {
-  return (
-    fn &&
-    exports.isFunction(fn) &&
-    fn.constructor &&
-    fn.constructor.name === 'GeneratorFunction'
-  );
-};
+'use strict';
+
+exports.isFunction = function (fn) {
+  return typeof fn === 'function';
+};
+
+exports.isGenerator = function (fn) {
+  return (
+    fn &&
+    exports.isFunction(fn) &&
+    fn.constructor &&
+    fn.constructor.name === 'GeneratorFunction'
+  );
+};

package/lib/json.js

@@ -1,12 +1,12 @@
-'use strict';
-
-var fs = require('fs');
-
-exports.fromFile = function (jsonFile) {
-  var data = fs.readFileSync(jsonFile, 'utf8');
-  return JSON.parse(data);
-};
-
-exports.toFile = function (json, destFile) {
-  fs.writeFileSync(destFile, JSON.stringify(json), 'utf8');
-};
+'use strict';
+
+var fs = require('fs');
+
+exports.fromFile = function (jsonFile) {
+  var data = fs.readFileSync(jsonFile, 'utf8');
+  return JSON.parse(data);
+};
+
+exports.toFile = function (json, destFile) {
+  fs.writeFileSync(destFile, JSON.stringify(json), 'utf8');
+};