chore: Use spire

Author: danez

.eslintignore

@@ -0,0 +1,2 @@
+// This file was created by spire-plugin-eslint for editor support
+module.exports = require('@researchgate/spire-config/eslint/node');

.eslintrc

@@ -4,7 +4,14 @@ node_js:
   - "10"
   - "8"
 script:
-  - yarn lint
-  - yarn test:coverage
+  - yarn test --coverage
 after_success:
   - bash <(curl -s https://codecov.io/bash) -f coverage/coverage-final.json
+jobs:
+  include:
+    - stage: test
+      node_js: lts/*
+      name: "Codestyle"
+      script:
+        - yarn lint
+      after_success: skip

.eslintrc.js

@@ -1,52 +1,53 @@
 # Change Log
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+All notable changes to this project will be documented in this file. See
+[standard-version](https://github.com/conventional-changelog/standard-version)
+for commit guidelines.
 
 <a name="2.0.0"></a>
-# [2.0.0](https://github.com/researchgate/node-file-processor/compare/v1.2.0...v2.0.0) (2018-03-21)
 
+# [2.0.0](https://github.com/researchgate/node-file-processor/compare/v1.2.0...v2.0.0) (2018-03-21)
 
 ### Features
 
-* Add keepAlive option ([f9fb05a](https://github.com/researchgate/node-file-processor/commit/f9fb05a))
-
+- Add keepAlive option
+  ([f9fb05a](https://github.com/researchgate/node-file-processor/commit/f9fb05a))
 
 ### BREAKING CHANGES
 
-* worker-farm options are moved to `options.worker` key.
-* abort method renamed to destroy.
-
-
+- worker-farm options are moved to `options.worker` key.
+- abort method renamed to destroy.
 
 <a name="1.2.0"></a>
-# [1.2.0](https://github.com/researchgate/node-file-processor/compare/v1.1.0...v1.2.0) (2018-01-05)
 
+# [1.2.0](https://github.com/researchgate/node-file-processor/compare/v1.1.0...v1.2.0) (2018-01-05)
 
 ### Bug Fixes
 
-* Exit immediately if an error happened ([#7](https://github.com/researchgate/node-file-processor/issues/7)) ([b41e656](https://github.com/researchgate/node-file-processor/commit/b41e656))
-
+- Exit immediately if an error happened
+  ([#7](https://github.com/researchgate/node-file-processor/issues/7))
+  ([b41e656](https://github.com/researchgate/node-file-processor/commit/b41e656))
 
 ### Features
 
-* **worker-farm:** Allow to pass-through options to worker-farm ([#6](https://github.com/researchgate/node-file-processor/issues/6)) ([64fb20d](https://github.com/researchgate/node-file-processor/commit/64fb20d))
-
-
+- **worker-farm:** Allow to pass-through options to worker-farm
+  ([#6](https://github.com/researchgate/node-file-processor/issues/6))
+  ([64fb20d](https://github.com/researchgate/node-file-processor/commit/64fb20d))
 
 <a name="1.1.0"></a>
-# [1.1.0](https://github.com/researchgate/node-file-processor/compare/v1.0.0...v1.1.0) (2017-08-11)
 
+# [1.1.0](https://github.com/researchgate/node-file-processor/compare/v1.0.0...v1.1.0) (2017-08-11)
 
 ### Features
 
-* Support multiple paths ([3bc826e](https://github.com/researchgate/node-file-processor/commit/3bc826e))
-
-
+- Support multiple paths
+  ([3bc826e](https://github.com/researchgate/node-file-processor/commit/3bc826e))
 
 <a name="1.0.0"></a>
-# 1.0.0 (2017-08-09)
 
+# 1.0.0 (2017-08-09)
 
 ### Features
 
-* Implement library ([815824e](https://github.com/researchgate/node-file-processor/commit/815824e))
+- Implement library
+  ([815824e](https://github.com/researchgate/node-file-processor/commit/815824e))

.travis.yml

@@ -16,12 +16,11 @@ Must export single function, accepting `fileName` and `callback`. This function
 must process the file and call the `callback` when it is done. Function can be
 asynchronous.
 
-
 ```js
 module.exports = function (fileName, callback) {
-    const result = doExpensiveProcessing(fileName);
-    callback(null, result); 
-}
+  const result = doExpensiveProcessing(fileName);
+  callback(null, result);
+};
 ```
 
 ### Main module
@@ -33,47 +32,43 @@ worker module.
 ```js
 const FileProcessor = require('@researchgate/file-processor');
 const processor = new FileProcessor(
-    [
-        'path/to/some/files/*.txt',
-        'some/other/path/*.js',
-    ],
-    require.resolve('./worker')
+  ['path/to/some/files/*.txt', 'some/other/path/*.js'],
+  require.resolve('./worker')
 );
 
 processor.on('processed', (fileName, result) => {
-    console.log(`result for ${fileName}: ${result}`);
+  console.log(`result for ${fileName}: ${result}`);
 });
 ```
 
 `FileProcessor` instace emits following events:
 
-* `queued` - file is queued for processing.
-  
-  Arguments:
+- `queued` - file is queued for processing.
 
-    * `fileName`
+  Arguments:
 
+  - `fileName`
 
 * `processed` - file is successfully processed by worker.
 
   Arguments:
 
-    * `fileName`
-    * `result` - the result, returned by worker module 
+  - `fileName`
+  - `result` - the result, returned by worker module
 
 * `error` - worker failed to process the file
 
   Arguments:
 
-    * `error`
+  - `error`
 
 * `allQueued` - all files, matching the pattern are queued for processing.
 
   Arguments:
 
-    * `stats` - object with the following field
-      
-      * `queuedCount` - total number of queued files
-      * `processedCount` - total number of files which are already processed
+  - `stats` - object with the following field
+
+    - `queuedCount` - total number of queued files
+    - `processedCount` - total number of files which are already processed
 
 * `end` - all files are processed.

CHANGELOG.md

@@ -1,59 +1,61 @@
+'use strict';
+
 const { EventEmitter } = require('events');
 const globStream = require('glob-stream');
 const workerFarm = require('worker-farm');
 
 class FileProcessor extends EventEmitter {
-    constructor(globPattern, worker, options) {
-        super();
-        options = options || {};
-        const glob = (this.glob = globStream(globPattern));
-        const workers = (this.workers = workerFarm(options.worker || {}, worker));
-
-        let allQueued = false;
-        let errorHappened = false;
-        let queuedCount = 0;
-        let processedCount = 0;
-
-        const checkForEnd = () => {
-            if (errorHappened || (allQueued && queuedCount === processedCount)) {
-                if (!options.keepAlive) {
-                    workerFarm.end(workers);
-                }
-                if (!errorHappened) this.emit('end');
-            }
-        };
-
-        glob.on('data', ({ path }) => {
-            queuedCount++;
-            this.emit('queued', path);
-            this.process(path, (err, result) => {
-                processedCount++;
-                if (err) {
-                    errorHappened = true;
-                    this.emit('error', err);
-                } else {
-                    this.emit('processed', path, result);
-                }
-
-                checkForEnd();
-            });
-        });
-
-        glob.on('end', () => {
-            allQueued = true;
-            this.emit('allQueued', { queuedCount, processedCount });
-            checkForEnd();
-        });
-    }
-
-    process(path, callback) {
-        this.workers(path, callback);
-    }
-
-    destroy(callback) {
-        this.glob.destroy();
-        workerFarm.end(this.workers, callback);
-    }
+  constructor(globPattern, worker, options) {
+    super();
+    options = options || {};
+    const glob = (this.glob = globStream(globPattern));
+    const workers = (this.workers = workerFarm(options.worker || {}, worker));
+
+    let allQueued = false;
+    let errorHappened = false;
+    let queuedCount = 0;
+    let processedCount = 0;
+
+    const checkForEnd = () => {
+      if (errorHappened || (allQueued && queuedCount === processedCount)) {
+        if (!options.keepAlive) {
+          workerFarm.end(workers);
+        }
+        if (!errorHappened) this.emit('end');
+      }
+    };
+
+    glob.on('data', ({ path }) => {
+      queuedCount++;
+      this.emit('queued', path);
+      this.process(path, (err, result) => {
+        processedCount++;
+        if (err) {
+          errorHappened = true;
+          this.emit('error', err);
+        } else {
+          this.emit('processed', path, result);
+        }
+
+        checkForEnd();
+      });
+    });
+
+    glob.on('end', () => {
+      allQueued = true;
+      this.emit('allQueued', { queuedCount, processedCount });
+      checkForEnd();
+    });
+  }
+
+  process(path, callback) {
+    this.workers(path, callback);
+  }
+
+  destroy(callback) {
+    this.glob.destroy();
+    workerFarm.end(this.workers, callback);
+  }
 }
 
 module.exports = FileProcessor;

README.md

@@ -3,49 +3,43 @@
   "version": "2.0.0",
   "description": "Run parallel tasks on a multiple files",
   "main": "index.js",
+  "author": "Sergey Tatarintsev <sergey.tatarintsev@researchgate.net> (https://github.com/SevInf)",
+  "license": "MIT",
+  "repository": "researchgate/node-file-processor",
   "scripts": {
-    "test": "jest",
-    "test:coverage": "jest --coverage",
-    "lint": "eslint .",
-    "precommit": "yarn lint && lint-staged",
-    "release": "standard-version"
+    "test": "spire test",
+    "lint": "spire lint",
+    "release": "spire release"
   },
   "files": [
     "index.js"
   ],
-  "lint-staged": {
-    "*.js": [
-      "prettier --single-quote --write --tab-width 4 --trailing-comma es5 --print-width 120",
-      "git add"
-    ]
-  },
-  "jest":{
-    "testEnvironment": "node",
-    "testRegex": "/test/[^/]+\\.js$"
-  },
-  "author": "Sergey Tatarintsev <sergey.tatarintsev@researchgate.net> (https://github.com/SevInf)",
-  "license": "MIT",
   "dependencies": {
     "glob-stream": "^6.1.0",
     "worker-farm": "^1.4.1"
   },
   "devDependencies": {
-    "eslint": "6.8.0",
-    "husky": "3.1.0",
-    "jest": "24.9.0",
-    "lint-staged": "9.5.0",
-    "prettier": "1.19.1",
-    "standard-version": "7.0.0"
-  },
-  "directories": {
-    "test": "test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/researchgate/node-file-processor.git"
+    "@researchgate/spire-config": "4.0.2",
+    "spire": "2.1.4",
+    "spire-plugin-semantic-release": "2.0.2"
+  },
+  "spire": {
+    "extends": [
+      [
+        "@researchgate/spire-config",
+        {
+          "eslint": "node",
+          "jest": "base"
+        }
+      ]
+    ],
+    "plugins": [
+      "spire-plugin-semantic-release"
+    ]
   },
-  "bugs": {
-    "url": "https://github.com/researchgate/node-file-processor/issues"
+  "jest": {
+    "preset": "@researchgate/jest-preset-base",
+    "testEnvironment": "node"
   },
-  "homepage": "https://github.com/researchgate/node-file-processor#readme"
+  "prettier": "@researchgate/prettier-config"
 }

index.js

@@ -2,11 +2,5 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": ["@researchgate:lib"],
   "automergeType": "branch",
-  "labels": ["dependencies"],
-  "lockFileMaintenance": {
-    "enabled": true,
-    "automerge":true,
-    "automergeType":"branch",
-    "extends": "schedule:weekly"
-  }
+  "labels": ["dependencies"]
 }

package.json

@@ -0,0 +1,25 @@
+'use strict';
+
+const path = require('path');
+const workerPath = require.resolve('./workers/error-worker');
+const FileProcessor = require('..');
+
+const examplePath = (fileName) => path.join(__dirname, 'example', fileName);
+const pattern = examplePath('*.txt');
+
+describe('fails', () => {
+  let fileProcessor = null;
+  beforeEach(() => {
+    fileProcessor = new FileProcessor(pattern, workerPath);
+  });
+
+  test('reports error in worker', () => {
+    expect.assertions(1);
+    return new Promise((resolve) => {
+      fileProcessor.on('error', (err) => {
+        expect(err).toEqual(new Error('Not today'));
+        resolve();
+      });
+    });
+  });
+});

renovate.json

@@ -0,0 +1,114 @@
+'use strict';
+
+const path = require('path');
+const workerPath = require.resolve('./workers/worker');
+const FileProcessor = require('..');
+
+const examplePath = (fileName) => path.join(__dirname, 'example', fileName);
+const pattern = examplePath('*.txt');
+
+describe('success', () => {
+  let fileProcessor = null;
+  beforeEach(() => {
+    fileProcessor = new FileProcessor(pattern, workerPath);
+  });
+
+  test('queued', () => {
+    expect.assertions(3);
+    const handler = jest.fn();
+    fileProcessor.on('queued', handler);
+    return new Promise((resolve) => {
+      fileProcessor.on('end', () => {
+        expect(handler).toHaveBeenCalledWith(examplePath('1.txt'));
+        expect(handler).toHaveBeenCalledWith(examplePath('2.txt'));
+        expect(handler).toHaveBeenCalledWith(examplePath('3.txt'));
+        resolve();
+      });
+    });
+  });
+
+  test('processed', () => {
+    expect.assertions(3);
+    const handler = jest.fn();
+    fileProcessor.on('processed', handler);
+    return new Promise((resolve) => {
+      fileProcessor.on('end', () => {
+        expect(handler).toHaveBeenCalledWith(examplePath('1.txt'), 'a');
+        expect(handler).toHaveBeenCalledWith(examplePath('2.txt'), 'b');
+        expect(handler).toHaveBeenCalledWith(examplePath('3.txt'), 'c');
+        resolve();
+      });
+    });
+  });
+
+  test('allQueued', () => {
+    expect.assertions(1);
+    const handler = jest.fn();
+    fileProcessor.on('allQueued', handler);
+    return new Promise((resolve) => {
+      fileProcessor.on('end', () => {
+        expect(handler).toHaveBeenCalledWith(
+          expect.objectContaining({
+            queuedCount: 3,
+            processedCount: expect.any(Number),
+          })
+        );
+        resolve();
+      });
+    });
+  });
+
+  test('destroy', () => {
+    return new Promise((resolve) => {
+      fileProcessor.destroy(resolve);
+    });
+  });
+
+  test('multiple paths', () => {
+    fileProcessor = new FileProcessor(
+      [examplePath('1.txt'), examplePath('3.txt')],
+      workerPath
+    );
+
+    expect.assertions(3);
+    const handler = jest.fn();
+    fileProcessor.on('queued', handler);
+    return new Promise((resolve) => {
+      fileProcessor.on('end', () => {
+        expect(handler).toHaveBeenCalledWith(examplePath('1.txt'));
+        expect(handler).not.toHaveBeenCalledWith(examplePath('2.txt'));
+        expect(handler).toHaveBeenCalledWith(examplePath('3.txt'));
+        resolve();
+      });
+    });
+  });
+
+  describe('keepAlive', () => {
+    let processor;
+
+    beforeEach(() => {
+      processor = new FileProcessor(examplePath('1.txt'), workerPath, {
+        keepAlive: true,
+      });
+    });
+
+    test('allows to process more files after initial pass', () => {
+      expect.assertions(2);
+      return new Promise((resolve) => {
+        processor.on('end', () => {
+          processor.process(examplePath('2.txt'), (error, result) => {
+            expect(error).toBe(null);
+            expect(result).toEqual('b');
+            resolve();
+          });
+        });
+      });
+    });
+
+    afterEach(() => {
+      return new Promise((resolve) => {
+        processor.destroy(resolve);
+      });
+    });
+  });
+});

test/error-test.js

@@ -1,3 +1,5 @@
-module.exports = function(fileName, callback) {
-    callback(new Error('Not today'));
+'use strict';
+
+module.exports = function (fileName, callback) {
+  callback(new Error('Not today'));
 };

test/error.spec.js

@@ -1,5 +1,7 @@
+'use strict';
+
 const fs = require('fs');
 
-module.exports = function(fileName, callback) {
-    fs.readFile(fileName, 'utf8', callback);
+module.exports = function (fileName, callback) {
+  fs.readFile(fileName, 'utf8', callback);
 };