bfj 6.1.1 → 7.0.2

package/.eslintrc

@@ -1,6 +1,8 @@
 env:
   es6: true
   node: true
+parserOptions:
+  ecmaVersion: 2018
 rules:
   accessor-pairs: [ 2, { "setWithoutGet": true } ]
   array-bracket-spacing: [ 2, "always" ]

package/.gitlab-ci.yml

@@ -12,10 +12,6 @@ before_script:
     - npm run lint
     - npm test
 
-test:node6:
-  image: node:6
-  <<: *npm_test
-
 test:node8:
   image: node:8
   <<: *npm_test
@@ -23,3 +19,7 @@ test:node8:
 test:node10:
   image: node:10
   <<: *npm_test
+
+test:node12:
+  image: node:12
+  <<: *npm_test

package/HISTORY.md

@@ -1,5 +1,47 @@
 # History
 
+## 7.0.2
+
+### Other changes
+
+* package: update dependencies (cf82fd4)
+
+## 7.0.1
+
+### Bug fixes
+
+* match: prevent mismatched properties when minDepth is set (4efaf1a)
+
+## 7.0.0
+
+### Breaking changes
+
+* package: limit to node 8+ (cc42139)
+
+### New features
+
+* match: support minDepth option to improve performance (6d79fe4)
+
+### Refactorings
+
+* code: prefer spread syntax to Object.assign (5544086)
+* code: prefer Object.entries to iterate keys and values (d101317)
+
+### Other changes
+
+* package: test in node 12 (9bf4e6b)
+* git: ignore test/*.json (e87eaf7)
+
+## 6.1.2
+
+### Bug fixes
+
+* eventify: escape object keys (910ad08)
+
+### Other changes
+
+* package: update deps (aafb4ff)
+
 ## 6.1.1
 
 ### Bug fixes

package/README.md

@@ -280,6 +280,17 @@ Predicate functions will be called with three arguments:
 If the result of the predicate is a truthy value
 then the item will be deemed a match.
 
+In addition to the regular options
+accepted by other parsing functions,
+you can also specify `minDepth`
+to only apply the selector
+to certain depths.
+This can improve performance
+and memory usage,
+if you know that
+you're not interested in
+parsing top-level items.
+
 If there are any syntax errors in the JSON,
 a `dataError` event will be emitted.
 If any other errors occur,
@@ -921,21 +932,18 @@ with the command
 
 ## What versions of Node.js does it support?
 
-As of [version `3.0.0`](HISTORY.md#300),
+As of [version `7.0.0`](HISTORY.md#700),
+only Node.js versions 8 or greater
+are supported.
+
+Between versions [`3.0.0`](HISTORY.md#300)
+and [`6.1.2`](HISTORY.md#612),
 only Node.js versions 6 or greater
-are supported
-because of the dependency
-on [Hoopy](https://gitlab.com/philbooth/hoopy).
-Previous versions supported
-node 4 and later.
-
-A separate `node-4` branch was maintained
-until version `5.4.1`,
-which had feature parity version-for-version
-with releases from `master`.
-Releases from the `node-4` branch
-are available in npm
-under the package name [`bfj-node4`](https://www.npmjs.com/package/bfj-node4).
+were supported.
+
+Until [version `2.1.2`](HISTORY.md#212),
+only Node.js versions 4 or greater
+were supported.
 
 ## What license is it released under?
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bfj",
-  "version": "6.1.1",
+  "version": "7.0.2",
   "description": "Big-friendly JSON. Asynchronous streaming functions for large JSON data sets.",
   "homepage": "https://gitlab.com/philbooth/bfj",
   "bugs": "https://gitlab.com/philbooth/bfj/issues",
@@ -26,22 +26,22 @@
     "url": "https://gitlab.com/philbooth/bfj.git"
   },
   "engines": {
-    "node": ">= 6.0.0"
+    "node": ">= 8.0.0"
   },
   "dependencies": {
-    "bluebird": "^3.5.1",
-    "check-types": "^7.3.0",
-    "hoopy": "^0.1.2",
-    "tryer": "^1.0.0"
+    "bluebird": "^3.5.5",
+    "check-types": "^11.1.1",
+    "hoopy": "^0.1.4",
+    "tryer": "^1.0.1"
   },
   "devDependencies": {
-    "chai": "4.1.x",
-    "eslint": "4.19.x",
-    "mocha": "5.0.x",
-    "please-release-me": "^2.0.2",
-    "proxyquire": "1.8.x",
-    "request": "2.85.x",
-    "spooks": "2.0.x"
+    "chai": "^4.2.0",
+    "eslint": "^6.0.1",
+    "mocha": "^6.1.4",
+    "please-release-me": "^2.1.2",
+    "proxyquire": "^2.1.0",
+    "request": "^2.88.0",
+    "spooks": "^2.0.0"
   },
   "scripts": {
     "lint": "eslint src",

package/src/datastream.js

@@ -13,5 +13,5 @@ function DataStream (read, options) {
     return new DataStream(read, options)
   }
 
-  return BfjStream.call(this, read, Object.assign({ objectMode: true }, options))
+  return BfjStream.call(this, read, { ...options, objectMode: true })
 }

package/src/eventify.js

@@ -140,7 +140,7 @@ function eventify (data, options = {}) {
       return Promise.resolve(datum)
     }
 
-    if (check.instanceStrict(datum, Promise)) {
+    if (check.thenable(datum)) {
       return coerceThing(datum, 'promises', coercePromise).then(coerce)
     }
 
@@ -297,7 +297,7 @@ function eventify (data, options = {}) {
         return Promise.resolve()
       }
 
-      return emit(events.property, key)
+      return emit(events.property, escapeString(key))
         .then(() => proceed(item))
     })
   }

package/src/jsonstream.js

@@ -13,5 +13,5 @@ function JsonStream (read, options) {
     return new JsonStream(read, options)
   }
 
-  return BfjStream.call(this, read, Object.assign({ encoding: 'utf8' }, options))
+  return BfjStream.call(this, read, { ...options, encoding: 'utf8' })
 }

package/src/match.js

@@ -25,6 +25,11 @@ module.exports = match
  *                        passed, both the key and the value are passed to it as
  *                        arguments.
  *
+ * @option minDepth:      Number indicating the minimum depth to apply the selector
+ *                        to. The default is `0`, but setting it to a higher value
+ *                        can improve performance and reduce memory usage by
+ *                        eliminating the need to actualise top-level items.
+ *
  * @option numbers:       Boolean, indicating whether numerical keys (e.g. array
  *                        indices) should be coerced to strings before testing the
  *                        match. Only applies if the `selector` argument is a string
@@ -62,6 +67,9 @@ function match (stream, selector, options = {}) {
   let length = 0
   let index = 0
 
+  const minDepth = options.minDepth || 0
+  check.assert.greaterOrEqual(minDepth, 0)
+
   if (check.function(selector)) {
     selectorFunction = selector
     selector = null
@@ -152,6 +160,10 @@ function match (stream, selector, options = {}) {
   }
 
   function property (name) {
+    if (scopes.length < minDepth) {
+      return
+    }
+
     properties.push(name)
   }
 
@@ -162,6 +174,10 @@ function match (stream, selector, options = {}) {
   function value (v) {
     let key
 
+    if (scopes.length < minDepth) {
+      return
+    }
+
     if (scopes.length > 0) {
       const scope = scopes[scopes.length - 1]
 

package/src/parse.js

@@ -161,8 +161,8 @@ function parse (stream, options = {}) {
 
   function transform (obj, key) {
     if (obj && typeof obj === 'object') {
-      Object.keys(obj).forEach(childKey => {
-        obj[childKey] = transform(obj[childKey], childKey)
+      Object.entries(obj).forEach(([ k, v ]) => {
+        obj[k] = transform(v, k)
       })
     }
 

package/src/read.js

@@ -22,5 +22,5 @@ module.exports = read
  * @option Promise:   The promise constructor to use, defaults to bluebird.
  **/
 function read (path, options) {
-  return parse(fs.createReadStream(path, options), Object.assign({}, options, { ndjson: false }))
+  return parse(fs.createReadStream(path, options), { ...options, ndjson: false })
 }

package/src/unpipe.js

@@ -29,7 +29,7 @@ function unpipe (callback, options) {
 
   const jsonstream = new stream.PassThrough()
 
-  parse(jsonstream, Object.assign({}, options, { ndjson: false }))
+  parse(jsonstream, { ...options, ndjson: false })
     .then(data => callback(null, data))
     .catch(error => callback(error))
 

package/test/integration.js

@@ -229,7 +229,11 @@ suite('integration:', () => {
         }))
         results = []
         errors = []
-        const datastream = bfj.match(fs.createReadStream(file), (k, v) => k === 'baz' || v === 'blee')
+        const datastream = bfj.match(
+          fs.createReadStream(file),
+          (k, v) => k === 'baz' || v === 'blee',
+          { minDepth: 1 }
+        )
         datastream.on('data', item => results.push(item))
         datastream.on('error', error => errors.push(error))
         datastream.on('end', done)