Merge pull request #17 from fastify/next

Prepare fastify-caching master for v2

Author: cemremengu

.gitignore

@@ -45,3 +45,7 @@ profile-*
 
 # VS Code
 .vscode/
+
+# lock files
+package-lock.json
+yarn.lock

.travis.yml

@@ -1,7 +1,8 @@
 language: node_js
 
 node_js:
-  - "9"
+  - "11"
+  - "10"
   - "8"
   - "6"
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 James Sumners <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Readme.md

@@ -1,8 +1,12 @@
 # fastify-caching
 
+[![Greenkeeper badge](https://badges.greenkeeper.io/fastify/fastify-caching.svg)](https://greenkeeper.io/) [![Build Status](https://travis-ci.org/fastify/fastify-caching.svg?branch=master)](https://travis-ci.org/fastify/fastify-caching)
+
 *fastify-caching* is a plugin for the [Fastify](http://fastify.io/) framework
 that provides mechanisms for manipulating HTTP cache headers according to
-[RFC 2616 §14.9](https://tools.ietf.org/html/rfc2616#section-14.9).
+[RFC 2616 §14.9](https://tools.ietf.org/html/rfc2616#section-14.9). 
+
+Supports Fastify versions ^1.0.0.
 
 This plugin fully supports Fastify's encapsulation. Therefore, routes that
 should have differing cache settings should be registered within different

package.json

@@ -4,9 +4,9 @@
   "description": "A plugin for Fastify to enable management of cache control headers",
   "main": "plugin.js",
   "scripts": {
-    "test": "tap 'test/**/*.test.js'",
-    "test-ci": "tap --cov 'test/**/*.test.js'",
-    "lint": "standard | snazzy",
+    "test": "tap test/*.test.js",
+    "test-ci": "tap --cov test/*.test.js",
+    "lint": "standard --verbose | snazzy",
     "lint-ci": "standard"
   },
   "precommit": [
@@ -29,15 +29,15 @@
   },
   "homepage": "https://github.com/fastify/fastify-caching#readme",
   "devDependencies": {
-    "fastify": "^1.1.0",
+    "fastify": "^1.13.0",
     "pre-commit": "^1.2.2",
-    "snazzy": "^7.1.1",
-    "standard": "^11.0.0",
-    "tap": "^11.1.1"
+    "snazzy": "^8.0.0",
+    "standard": "^12.0.1",
+    "tap": "^12.1.0"
   },
   "dependencies": {
     "abstract-cache": "^1.0.1",
-    "fastify-plugin": "^0.2.2",
+    "fastify-plugin": "^1.2.1",
     "uid-safe": "^2.1.5"
   }
 }

plugin.js

@@ -30,7 +30,7 @@ function etag (value, lifetime) {
 function etagHandleRequest (req, res, next) {
   if (!req.headers['if-none-match']) return next()
   const etag = req.headers['if-none-match']
-  this.cache.get({id: etag, segment: this.cacheSegment}, (err, cached) => {
+  this.cache.get({ id: etag, segment: this.cacheSegment }, (err, cached) => {
     if (err) return next(err)
     if (cached && cached.item) {
       res.statusCode = 304
@@ -44,7 +44,7 @@ function etagOnSend (fastifyRequest, fastifyReply, payload, next) {
   const etag = fastifyReply.getHeader('etag')
   if (!etag || !fastifyReply._etagLife) return next()
   this.cache.set(
-    {id: etag, segment: this.cacheSegment},
+    { id: etag, segment: this.cacheSegment },
     true,
     fastifyReply._etagLife,
     next
@@ -86,7 +86,7 @@ function fastifyCachingPlugin (instance, options, next) {
 }
 
 module.exports = fp(fastifyCachingPlugin, {
-  fastify: '^1.1.0',
+  fastify: '^1.0.0',
   name: 'fastify-caching'
 })
 

test/cache.test.js

@@ -23,7 +23,7 @@ test('cache is usable', (t) => {
   instance.register(plugin)
 
   instance.get('/one', (req, reply) => {
-    instance.cache.set('one', {one: true}, 100, (err) => {
+    instance.cache.set('one', { one: true }, 100, (err) => {
       if (err) return reply.send(err)
       reply.redirect('/two')
     })
@@ -32,7 +32,7 @@ test('cache is usable', (t) => {
   instance.get('/two', (req, reply) => {
     instance.cache.get('one', (err, obj) => {
       if (err) t.threw(err)
-      t.deepEqual(obj.item, {one: true})
+      t.deepEqual(obj.item, { one: true })
       reply.send()
     })
   })
@@ -60,7 +60,7 @@ test('etags get stored in cache', (t) => {
   instance.get('/one', (req, reply) => {
     reply
       .etag('123456')
-      .send({hello: 'world'})
+      .send({ hello: 'world' })
   })
 
   instance.listen(0, (err) => {
@@ -96,7 +96,7 @@ test('etag cache life is customizable', (t) => {
   instance.get('/one', function (req, reply) {
     reply
       .etag('123456', 50)
-      .send({hello: 'world'})
+      .send({ hello: 'world' })
   })
 
   instance.listen(0, (err) => {

test/headers.test.js

@@ -47,9 +47,9 @@ test('decorators add headers', (t) => {
 test('sets no-cache header', (t) => {
   t.plan(2)
   const instance = fastify()
-  instance.register(plugin, {privacy: plugin.privacy.NOCACHE})
+  instance.register(plugin, { privacy: plugin.privacy.NOCACHE })
   instance.get('/', (req, reply) => {
-    reply.send({hello: 'world'})
+    reply.send({ hello: 'world' })
   })
   instance.listen(0, (err) => {
     if (err) t.threw(err)
@@ -73,7 +73,7 @@ test('sets private with max-age header', (t) => {
   }
   instance.register(plugin, opts)
   instance.get('/', (req, reply) => {
-    reply.send({hello: 'world'})
+    reply.send({ hello: 'world' })
   })
   instance.listen(0, (err) => {
     if (err) t.threw(err)
@@ -91,9 +91,9 @@ test('sets private with max-age header', (t) => {
 test('sets no-store with max-age header', (t) => {
   t.plan(2)
   const instance = fastify()
-  instance.register(plugin, {privacy: 'no-store', expiresIn: 300})
+  instance.register(plugin, { privacy: 'no-store', expiresIn: 300 })
   instance.get('/', (req, reply) => {
-    reply.send({hello: 'world'})
+    reply.send({ hello: 'world' })
   })
   instance.listen(0, (err) => {
     if (err) t.threw(err)
@@ -112,11 +112,11 @@ test('sets the expires header', (t) => {
   t.plan(2)
   const now = new Date()
   const instance = fastify()
-  instance.register(plugin, {privacy: plugin.privacy.NOCACHE})
+  instance.register(plugin, { privacy: plugin.privacy.NOCACHE })
   instance.get('/', (req, reply) => {
     reply
       .expires(now)
-      .send({hello: 'world'})
+      .send({ hello: 'world' })
   })
   instance.listen(0, (err) => {
     if (err) t.threw(err)