koa-compress 2.0.0 → 3.0.0

package/HISTORY.md

@@ -1,9 +1,21 @@
 
+3.0.0 / 2018-04-14
+==================
+
+ * republish 2.1.0 as it switches to async functions
+
+2.1.0 / 2018-04-13 (unpublished)
+==================
+
+ * do not compress if the response is not writable
+ * switch testing frameworks to jest
+ * implement linting
+
 1.0.8 / 2014-09-14
 ==================
 
  * bump compressible
- 
+
 1.0.7 / 2014-05-13
 ==================
 

package/README.md

@@ -1,4 +1,8 @@
-# Koa Compress [![Build Status](https://travis-ci.org/koajs/compress.png)](https://travis-ci.org/koajs/compress)
+# Koa Compress
+
+[![Build Status](https://travis-ci.org/koajs/compress.svg?branch=master)](https://travis-ci.org/koajs/compress)
+[![codecov](https://codecov.io/gh/koajs/compress/branch/master/graph/badge.svg)](https://codecov.io/gh/koajs/compress)
+[![Greenkeeper badge](https://badges.greenkeeper.io/koajs/compress.svg)](https://greenkeeper.io/)
 
 Compress middleware for Koa
 

package/index.js

@@ -1,21 +1,21 @@
-'use strict';
+'use strict'
 
 /**
  * Module dependencies.
  */
 
-var compressible = require('compressible')
-var isJSON = require('koa-is-json')
-var status = require('statuses')
-var Stream = require('stream')
-var bytes = require('bytes')
-var zlib = require('zlib')
+const compressible = require('compressible')
+const isJSON = require('koa-is-json')
+const status = require('statuses')
+const Stream = require('stream')
+const bytes = require('bytes')
+const zlib = require('zlib')
 
 /**
  * Encoding methods supported.
  */
 
-var encodingMethods = {
+const encodingMethods = {
   gzip: zlib.createGzip,
   deflate: zlib.createDeflate
 }
@@ -28,52 +28,46 @@ var encodingMethods = {
  * @api public
  */
 
-module.exports = (options) => {
-  options = options || {}
+module.exports = (options = {}) => {
+  let { filter = compressible, threshold = 1024 } = options
+  if (typeof threshold === 'string') threshold = bytes(threshold)
 
-  var filter = options.filter || compressible
+  return async (ctx, next) => {
+    ctx.vary('Accept-Encoding')
 
-  var threshold = !options.threshold ? 1024
-    : typeof options.threshold === 'number' ? options.threshold
-    : typeof options.threshold === 'string' ? bytes(options.threshold)
-    : 1024
+    await next()
 
-  return function compress(ctx, next) {
-    ctx.vary('Accept-Encoding')
+    let { body } = ctx
+    if (!body) return
+    if (ctx.res.headersSent || !ctx.writable) return
+    if (ctx.compress === false) return
+    if (ctx.request.method === 'HEAD') return
+    if (status.empty[ctx.response.status]) return
+    if (ctx.response.get('Content-Encoding')) return
+
+    // forced compression or implied
+    if (!(ctx.compress === true || filter(ctx.response.type))) return
+
+    // identity
+    const encoding = ctx.acceptsEncodings('gzip', 'deflate', 'identity')
+    if (!encoding) ctx.throw(406, 'supported encodings: gzip, deflate, identity')
+    if (encoding === 'identity') return
+
+    // json
+    if (isJSON(body)) body = ctx.body = JSON.stringify(body)
+
+    // threshold
+    if (threshold && ctx.response.length < threshold) return
+
+    ctx.set('Content-Encoding', encoding)
+    ctx.res.removeHeader('Content-Length')
+
+    const stream = ctx.body = encodingMethods[encoding](options)
 
-    return next().then(() => {
-      var body = ctx.body
-      if (!body) return
-      if (ctx.compress === false) return
-      if (ctx.request.method === 'HEAD') return
-      if (status.empty[ctx.response.status]) return
-      if (ctx.response.get('Content-Encoding')) return
-
-      // forced compression or implied
-      if (!(ctx.compress === true || filter(ctx.response.type))) return
-
-      // identity
-      var encoding = ctx.acceptsEncodings('gzip', 'deflate', 'identity')
-      if (!encoding) ctx.throw(406, 'supported encodings: gzip, deflate, identity')
-      if (encoding === 'identity') return
-
-      // json
-      if (isJSON(body)) body = ctx.body = JSON.stringify(body)
-
-      // threshold
-      if (threshold && ctx.response.length < threshold) return
-
-      ctx.set('Content-Encoding', encoding)
-      ctx.res.removeHeader('Content-Length')
-
-      var stream =
-      ctx.body = encodingMethods[encoding](options)
-
-      if (body instanceof Stream) {
-        body.pipe(stream)
-      } else {
-        stream.end(body)
-      }
-    });
-  };
+    if (body instanceof Stream) {
+      body.pipe(stream)
+    } else {
+      stream.end(body)
+    }
+  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koa-compress",
   "description": "Compress middleware for koa",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "author": {
     "name": "Jonathan Ong",
     "email": "me@jongleberry.com",
@@ -11,26 +11,35 @@
   "license": "MIT",
   "repository": "koajs/compress",
   "dependencies": {
-    "bytes": "^2.3.0",
+    "bytes": "^3.0.0",
     "compressible": "^2.0.0",
     "koa-is-json": "^1.0.0",
     "statuses": "^1.0.0"
   },
   "devDependencies": {
-    "istanbul": "^0.4.2",
-    "koa": "^2.0.0-alpha.3",
-    "mocha": "^2.4.1",
-    "should": "^3.0.0",
-    "supertest": "^1.0.0"
+    "eslint": "^4.19.0",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-config-standard-react": "^6.0.0",
+    "eslint-plugin-flowtype": "^2.46.1",
+    "eslint-plugin-import": "^2.9.0",
+    "eslint-plugin-node": "^6.0.1",
+    "eslint-plugin-promise": "^3.7.0",
+    "eslint-plugin-react": "^7.7.0",
+    "eslint-plugin-standard": "^3.0.1",
+    "jest": "^22.4.3",
+    "koa": "^2.0.1",
+    "supertest": "^3.0.0"
   },
   "scripts": {
-    "test": "NODE_ENV=test mocha --require should --reporter spec",
-    "test-cov": "NODE_ENV=test node ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha -- --require should",
-    "test-travis": "NODE_ENV=test node ./node_modules/.bin/istanbul cover ./node_modules/.bin/_mocha --report lcovonly -- --require should"
+    "eslint": "eslint --ignore-path .gitignore .",
+    "test": "jest --forceExit"
   },
   "files": [
     "index.js",
     "LICENSE",
     "HISTORY.md"
-  ]
+  ],
+  "jest": {
+    "testEnvironment": "node"
+  }
 }