Merge pull request #1 from fastify/first-implementation

First implementation

Author: delvedor

README.md

@@ -1,2 +1,59 @@
 # point-of-view
-Template plugin for Fastify
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+ [![Build Status](https://travis-ci.org/fastify/point-of-view.svg?branch=master)](https://travis-ci.org/fastify/point-of-view)
+
+Templates rendering plugin support for Fastify.
+
+`point-of-view` decorates the reply interface with the `view` method for manage view engines that can be used to render templates responses.
+
+Currently supports the following templates engines:
+- [`ejs`](http://www.embeddedjs.com/)
+- [`pug`](https://pugjs.org/api/getting-started.html)
+- [`handlebars`](http://handlebarsjs.com/)
+
+In `production` mode, `point-of-view` will heavily cache the templates file and functions, while in `development` will reload every time the template file and function.
+## Install
+
+```
+npm install point-of-view --save
+```
+<a name="usage"></a>
+## Usage
+```js
+const fastify = require('fastify')()
+
+fastify.register(require('point-of-view'), {
+  engine: {
+    ejs: require('ejs')
+  }
+})
+
+fastify.get('/', (req, reply) => {
+  reply.view('/templates/index.ejs', { text: 'text' })
+})
+
+fastify.listen(3000, err => {
+  if (err) throw err
+  console.log(`server listening on ${fastify.server.address().port}`)
+})
+```
+
+If you want to set a fixed templates folder, or pass some options to the template engines:
+```js
+fastify.register(require('point-of-view'), {
+  engine: {
+    ejs: require('ejs')
+  },
+  templates: '/templates',
+  options: {}
+})
+```
+## Acknowledgements
+
+This project is kindly sponsored by:
+- [nearForm](http://nearform.com)
+- [LetzDoIt](http://www.letzdoitapp.com/)
+
+## License
+
+Licensed under [MIT](./LICENSE).

example.js

@@ -0,0 +1,18 @@
+'use strict'
+
+const fastify = require('fastify')()
+
+fastify.register(require('./index'), {
+  engine: {
+    ejs: require('ejs')
+  }
+})
+
+fastify.get('/', (req, reply) => {
+  reply.view('/templates/index.ejs', { text: 'text' })
+})
+
+fastify.listen(3000, err => {
+  if (err) throw err
+  console.log(`server listening on ${fastify.server.address().port}`)
+})

index.js

@@ -0,0 +1,60 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+const fs = require('fs')
+const path = require('path')
+const HLRU = require('hashlru')
+const supportedEngines = ['ejs', 'pug', 'handlebars']
+
+function fastifyView (fastify, opts, next) {
+  fastify.decorateReply('view', view)
+
+  if (!opts.engine) {
+    next(new Error('Missing engine'))
+    return
+  }
+
+  const type = Object.keys(opts.engine)[0]
+  if (supportedEngines.indexOf(type) === -1) {
+    next(new Error(`'${type}' not yet supported, PR? :)`))
+    return
+  }
+
+  const engine = opts.engine[type]
+  const options = opts.options || {}
+  const templatesDir = path.join(process.cwd(), opts.templates || './')
+  const lru = HLRU(opts.maxCache || 100)
+  const prod = process.env.NODE_ENV === 'production'
+
+  function view (page, data) {
+    if (!page || !data) {
+      this.send(new Error('Missing data'))
+      return
+    }
+
+    const toHtml = lru.get(page)
+
+    if (toHtml && prod) {
+      this.header('Content-Type', 'text/html').send(toHtml(data))
+      return
+    }
+
+    fs.readFile(path.join(templatesDir, page), 'utf8', readCallback(this, page, data))
+  }
+
+  function readCallback (that, page, data) {
+    return function _readCallback (err, html) {
+      if (err) {
+        that.send(err)
+        return
+      }
+
+      lru.set(page, engine.compile(html, options))
+      that.header('Content-Type', 'text/html').send(lru.get(page)(data))
+    }
+  }
+
+  next()
+}
+
+module.exports = fp(fastifyView, '>=0.13.1')

package.json

@@ -0,0 +1,42 @@
+{
+  "name": "point-of-view",
+  "version": "0.1.0",
+  "description": "Template plugin for Fastify",
+  "main": "index.js",
+  "scripts": {
+    "test": "standard && tap test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fastify/point-of-view.git"
+  },
+  "keywords": [
+    "fastify",
+    "template",
+    "view",
+    "speed",
+    "ejs",
+    "pug",
+    "handlebars"
+  ],
+  "author": "Tomas Della Vedova - @delvedor (http://delved.org)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fastify/point-of-view/issues"
+  },
+  "homepage": "https://github.com/fastify/point-of-view#readme",
+  "dependencies": {
+    "fastify-plugin": "^0.1.0",
+    "hashlru": "^2.1.0"
+  },
+  "devDependencies": {
+    "ejs": "^2.5.6",
+    "fastify": "^0.13.1",
+    "handlebars": "^4.0.6",
+    "pre-commit": "^1.2.2",
+    "pug": "^2.0.0-beta11",
+    "request": "^2.81.0",
+    "standard": "^9.0.2",
+    "tap": "^10.3.0"
+  }
+}

templates/index.ejs

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head></head>
+  <body>
+    <p><%= text %></p>
+  </body>
+</html>

templates/index.html

@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head></head>
+  <body>
+    <p>{{ text }}</p>
+  </body>
+</html>

templates/index.pug

@@ -0,0 +1,5 @@
+doctype html
+html
+  head
+  body
+    p #{text}