Merge pull request #3 from goenning/master

unit tests, linter, api change, pg & redis providers (draft), updated ui and more

Author: goenning

.DS_Store

@@ -0,0 +1,2 @@
+ui
+coverage

.eslintignore

@@ -0,0 +1,14 @@
+{
+  "extends": "eslint:recommended",
+  "env": {
+    "node":  true,
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "semi": [2, "always"],
+    "no-unused-vars": ["error", { "vars": "all", "args": "none" }],
+    "quotes": ["error", "single", { "avoidEscape": true } ],
+    "space-before-function-paren": ["error", "never"]
+  }
+}

.eslintrc.json

@@ -0,0 +1,18 @@
+logs
+*.log
+npm-debug.log*
+pids
+*.pid
+*.seed
+*.rdb
+*.DS_STORE
+lib-cov
+coverage
+.nyc_output
+.grunt
+.lock-wscript
+build/Release
+node_modules
+jspm_packages
+.npm
+.node_repl_history

.gitignore

@@ -1,3 +1,3 @@
 [submodule "ui"]
 	path = ui
-	url = git@github.com:MiniProfiler/ui.git
+	url = https://github.com/MiniProfiler/ui.git

.gitmodules

@@ -0,0 +1,18 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+  - "stable"
+
+before_script:
+  - npm run lint
+
+after_script:
+  - npm run coverage
+  - npm run update-coveralls
+  - npm run check-coverage
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change

.travis.yml

@@ -1,23 +1,72 @@
+##### `The project is still under development, the API will change! Use with caution. NPM package is currently outdated.`
+
 # node-miniprofiler
 
 Node.js implementation of Stack Exchange's MiniProfiler
 
-### This is working but not yet considered production ready. Use with caution.
+[![Build](https://travis-ci.org/goenning/miniprofiler-node.svg)](https://travis-ci.org/goenning/miniprofiler-node)
+[![Coverage](https://coveralls.io/repos/github/goenning/miniprofiler-node/badge.svg?branch=master)](https://coveralls.io/github/goenning/miniprofiler-node?branch=master)
+![Dependencies](https://david-dm.org/goenning/miniprofiler-node.svg)
+![devDependencies](https://david-dm.org/goenning/miniprofiler-node/dev-status.svg#info=devDependencies)
+
+## Installation (via [npm](https://npmjs.org/package/miniprofiler))
+
+```bash
+$ npm install miniprofiler
+```
+
+## Usage
+
+### Simple usage using express.js
+
+`server.js`
+
+```javascript
+var express = require('express')
+  , miniprofiler = require('miniprofiler')
+  , app = express();
+
+app.set('view engine', 'pug');
+app.use(miniprofiler.profile());
+
+app.get('/', function(req, res) {
+  req.miniprofiler.step('Step 1', function() {
+    req.miniprofiler.step('Step 2', function() {
+      res.render('home');
+    });
+  });
+});
+
+app.listen(8080);
+```
+
+`home.pug`
 
-# requirements
+```javascript
+doctype html
+html
+  head
+    title MiniProfiler Node.js Example
+  body
+    h1 Home Page
+    | !{miniprofiler.include()}
+```
 
-Currently requires express and connect to run, because it uses `res.on('header', f)` to trigger storing of data, which is a connect thing.
+When visiting `localhost:8080`, you should see this.
 
-# usage
+![](/examples/images/example0.png)
 
-Clone this repo into your project's node_modules directory. You can also install from npm, but the package may be outdated: https://www.npmjs.org/package/miniprofiler.
+See [examples/express.js](/examples/express.js) for more examples.
 
-Then see [connect_test.js](https://github.com/MiniProfiler/node/blob/master/connect_test.js) for example use.
+![](/examples/images/example1.png)
+![](/examples/images/example2.png)
 
 # Want to help?
 
-Things that need doing:
+Things to do:
 
-- remove dependency from express and connect
+- support major web frameworks like: Express, Hapi, koa.js, Sails.js
+- add examples for every web frameworks
 - storing of client timings on first result postback (there's a todo in the `results` function about where to do this)
 - document more things
+- add providers for pg, mongodb, mysql, redis and more

README.md

@@ -0,0 +1,71 @@
+var miniprofiler = require('../lib/miniprofiler.js');
+var pg = require('pg');
+var redis = require('redis');
+
+var express = require('express');
+var connString = 'postgres://postgres:postgres@localhost/miniprofiler';
+
+var app = express();
+app.use(miniprofiler.express());
+app.use(miniprofiler.for.pg(pg));
+app.use(miniprofiler.for.redis(redis));
+
+app.set('view engine', 'pug');
+app.set('views', './examples/views');
+
+app.get('/', function(req, res) {
+  req.miniprofiler.step('Step 1', function() {
+    req.miniprofiler.step('Step 2', function() {
+      res.render('home');
+    });
+  });
+});
+
+app.get('/js-sleep', function(req, res) {
+	req.miniprofiler.timeQuery('custom', 'Sleeping...', setTimeout, function() {
+		res.send();
+	}, 300);
+});
+
+app.get('/redis-set-get', function(req, res) {
+	var redisClient = redis.createClient();
+  redisClient.set('customer', '[email protected]', function() {
+    redisClient.get('customer', function(err, reply) {
+      res.render('home');
+    });
+  });
+});
+
+app.get('/pg-sleep', function(req, res) {
+	pg.connect(connString, function(err, pgClient, done) {
+		pgClient.query('SELECT pg_sleep(1)', [], function(err, result) {
+      done();
+      res.render('home');
+		});
+	});
+});
+
+app.get('/all', function(req, res) {
+	var redisClient = redis.createClient();
+  req.miniprofiler.step('Waiting 1 second', function() {
+
+    pg.connect(connString, function(err, pgClient, done) {
+      pgClient.query('SELECT pg_sleep(1)', [ ], function(err, result) {
+
+        req.miniprofiler.step('Get from cache', function() {
+
+          redisClient.set('customer', '[email protected]', function() {
+            redisClient.get('key', function(err, reply) {
+              res.render('home');
+            });
+          });
+
+        });
+
+      });
+    });
+
+  });
+});
+
+app.listen(8080);

connect_test.js

@@ -0,0 +1,12 @@
+var http = require('http');
+var miniprofiler = require('../lib/miniprofiler.js');
+
+var profile = miniprofiler.profile();
+
+http.createServer(function(req, res) {
+  profile(req, res, function() {
+    req.miniprofiler.step('Step 1', function(){
+      res.end('home');
+    });
+  });
+}).listen(8080);