logger singleton style instantiation

OakLabsInc · Jan 27, 2017 · 5747996 · 5747996
1 parent a97002e
commit 5747996
Show file tree

Hide file tree

Showing 19 changed files with 125 additions and 107 deletions.
diff --git a/.README.md b/.README.md
@@ -26,12 +26,20 @@ Head on over to the [documentation](https://oaklabsinc.github.io/oak-tools/) pag
 The logger is based off [pino](https://github.com/pinojs/pino) and has nearly the same same option parameters. The following example are the default options.
 
 ```javascript
-const Logger = require('oak-tools').logger
-let log = new Logger({
+const { logger } = require('oak-tools')
+let log = logger({
   level: 'info',
   stream: process.stdout,
   pretty: true
 })
+log.info('sup')
+log.error({
+  err: new Error('crap...')
+})
+log.debug({
+  msg: 'debug message here',
+  now: Date.now()
+})
 
 ```
 

diff --git a/README.md b/README.md
@@ -26,12 +26,20 @@ Head on over to the [documentation](https://oaklabsinc.github.io/oak-tools/) pag
 The logger is based off [pino](https://github.com/pinojs/pino) and has nearly the same same option parameters. The following example are the default options.
 
 ```javascript
-const Logger = require('oak-tools').logger
-let log = new Logger({
+const { logger } = require('oak-tools')
+let log = logger({
   level: 'info',
   stream: process.stdout,
   pretty: true
 })
+log.info('sup')
+log.error({
+  err: new Error('crap...')
+})
+log.debug({
+  msg: 'debug message here',
+  now: Date.now()
+})
 
 ```
 

diff --git a/docs/Logger.html b/docs/Logger.html
@@ -415,7 +415,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Message.html b/docs/Message.html
@@ -1309,7 +1309,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/WebSocketClient.html b/docs/WebSocketClient.html
@@ -2195,7 +2195,7 @@ <h4 class="name" id="event:ready">ready</h4>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/WebSocketServer.html b/docs/WebSocketServer.html
@@ -1308,7 +1308,7 @@ <h5>Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/global.html b/docs/global.html
@@ -512,7 +512,7 @@ <h5>Type:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -55,7 +55,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Logger.ht
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -37,51 +37,51 @@ <h1 class="page-title">index.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>
-const { join } = require('path')
-
-/**
- * oak-tools module
- * @version 0.2.0
- * @module oak-tools
- */
-
-/**
- * Logger object
- * @param {Object} options options object
- * @param {Function} callback callback function
- * @returns {Logger}
- */
-module.exports.logger = function () {
-  return require(join(__dirname, 'lib', 'logger'))
-}
-
-/**
- * Message class
- * @returns {Message}
- */
-module.exports.message = function () {
-  return require(join(__dirname, 'lib', 'message'))
-}
-
-/**
- * Starts a messaging server
- * @param {String} type Type of server
- * @returns {WebSocketServer}
- */
-module.exports.server = function (type) {
-  return require(join(__dirname, 'lib', type, 'server'))
-}
-
-/**
- * Starts a messaging client
- * @param {String} type Type of client
- * @returns {WebSocketClient}
- */
-
-module.exports.client = function (type) {
-  return require(join(__dirname, 'lib', type, 'client'))
-}
+            <pre class="prettyprint source linenums"><code>
+const { join } = require('path')
+
+/**
+ * oak-tools module
+ * @version 0.2.0
+ * @module oak-tools
+ */
+
+/**
+ * Logger object
+ * @param {Object} options options object
+ * @param {Function} callback callback function
+ * @returns {Logger}
+ */
+module.exports.logger = function () {
+  return require(join(__dirname, 'lib', 'logger')).apply(this, arguments)
+}
+
+/**
+ * Message class
+ * @returns {Message}
+ */
+module.exports.message = function () {
+  return require(join(__dirname, 'lib', 'message'))
+}
+
+/**
+ * Starts a messaging server
+ * @param {String} type Type of server
+ * @returns {WebSocketServer}
+ */
+module.exports.server = function (type) {
+  return require(join(__dirname, 'lib', type, 'server'))
+}
+
+/**
+ * Starts a messaging client
+ * @param {String} type Type of client
+ * @returns {WebSocketClient}
+ */
+
+module.exports.client = function (type) {
+  return require(join(__dirname, 'lib', type, 'client'))
+}
 </code></pre>
         </article>
     </section>
@@ -94,7 +94,7 @@ <h1 class="page-title">index.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:14:01 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/lib_logger.js.html b/docs/lib_logger.js.html
@@ -37,44 +37,44 @@ <h1 class="page-title">lib/logger.js</h1>
 
     <section>
         <article>
-            <pre class="prettyprint source linenums"><code>const pino = require('pino')
-
-/**
- * logger object
- * @typedef {Object} logger
- * @prop {Function} trace
- * @prop {Function} debug
- * @prop {Function} info
- * @prop {Function} error
- * @prop {Function} warn
- * @prop {Function} fatal
- */
-
-/**
- * Creates a logger object
- * @constructor
- * @param {Object} options options object
- * @param {String} [options.name] set the logger instance name
- * @param {String} [options.level=info] set the log level, default is info
- * @param {Object} [options.stream=stdout] outbound stream, defaults to process.stdout
- * @param {boolean} [options.pretty=false] pretty printing, defaults to false
- * @returns {logger}
- */
-function Logger ({ name = undefined, level = 'info', stream = process.stdout, pretty = false } = {}) {
-  if (pretty) {
-    let _pretty = pino.pretty()
-    _pretty.pipe(stream)
-    stream = _pretty
-  }
-
-  let _logger = pino(stream)
-  _logger.level = level
-  _logger.name = name
-
-  return _logger
-}
-
-module.exports = Logger
+            <pre class="prettyprint source linenums"><code>const pino = require('pino')
+
+/**
+ * logger object
+ * @typedef {Object} logger
+ * @prop {Function} trace
+ * @prop {Function} debug
+ * @prop {Function} info
+ * @prop {Function} error
+ * @prop {Function} warn
+ * @prop {Function} fatal
+ */
+
+/**
+ * Creates a logger object
+ * @constructor
+ * @param {Object} options options object
+ * @param {String} [options.name] set the logger instance name
+ * @param {String} [options.level=info] set the log level, default is info
+ * @param {Object} [options.stream=stdout] outbound stream, defaults to process.stdout
+ * @param {boolean} [options.pretty=false] pretty printing, defaults to false
+ * @returns {logger}
+ */
+function Logger ({ name = undefined, level = 'info', stream = process.stdout, pretty = false } = {}) {
+  if (pretty) {
+    let _pretty = pino.pretty()
+    _pretty.pipe(stream)
+    stream = _pretty
+  }
+
+  let _logger = pino(stream)
+  _logger.level = level
+  _logger.name = name
+
+  return _logger
+}
+
+module.exports = Logger
 </code></pre>
         </article>
     </section>
@@ -87,7 +87,7 @@ <h1 class="page-title">lib/logger.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:14:01 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/lib_message.js.html b/docs/lib_message.js.html
@@ -154,7 +154,7 @@ <h1 class="page-title">lib/message.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/lib_websocket_client.js.html b/docs/lib_websocket_client.js.html
@@ -273,7 +273,7 @@ <h1 class="page-title">lib/websocket/client.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/lib_websocket_server.js.html b/docs/lib_websocket_server.js.html
@@ -277,7 +277,7 @@ <h1 class="page-title">lib/websocket/server.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/module-oak-tools.html b/docs/module-oak-tools.html
@@ -744,7 +744,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 15:39:49 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/examples/websocket.server.example.js b/examples/websocket.server.example.js
@@ -1,13 +1,14 @@
 const { join } = require('path')
 const tools = require(join(__dirname, '..'))
 
-const Logger = tools.logger()
-const log = new Logger({
+const log = tools.logger({
   pretty: true
 })
 
 let Server = tools.server('websocket')
-let server = new Server()
+let server = new Server({
+  port: 5050
+})
 
 server.on('error', function (err) {
   log.error({ err })

diff --git a/index.js b/index.js
@@ -14,7 +14,7 @@ const { join } = require('path')
  * @returns {Logger}
  */
 module.exports.logger = function () {
-  return require(join(__dirname, 'lib', 'logger'))
+  return require(join(__dirname, 'lib', 'logger')).apply(this, arguments)
 }
 
 /**

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "oak-tools",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Helpful utilities for developing oak applications",
   "main": "index.js",
   "scripts": {

diff --git a/test/logger.test.js b/test/logger.test.js
@@ -4,8 +4,7 @@ const { join } = require('path')
 const Stream = require('stream')
 const async = require('async')
 const test = require('tape')
-const { logger: Logger } = require(join(__dirname, '..'))
-const logger = new Logger()
+const { logger } = require(join(__dirname, '..'))
 
 const levels = [
   'fatal',

diff --git a/test/websocket.server.test.js b/test/websocket.server.test.js
@@ -9,7 +9,9 @@ test('*** server', function (t) {
   t.plan(10)
 
   let WsServer = tools.server('websocket')
-  let server = new WsServer({}, function () {
+  let server = new WsServer({
+    port: 5000
+  }, function () {
     t.pass('server should callback when ready')
   })