Merge branch 're2005-is-enabled-flag'

Author: justinkames

README.md

@@ -34,6 +34,13 @@ vuejs-logger is a logging library that enables logging for Vue applications. It
 logLevels :  ['debug', 'info', 'warn', 'error', 'fatal']
 ```
 
+Option to disable the logger (for using it on PRODUCTION)
+
+```js
+isEnabled : false
+```
+
+
 ## Install
 
 This project uses [node](http://nodejs.org) and [npm](https://npmjs.com). Go check them out if you don't have them locally installed!
@@ -52,8 +59,10 @@ Below you can find an example of how to use vuejs-logger :
 import VueLogger from 'vuejs-logger'
 
 const options = {
+    // optional : defaults to true if not specified
+    isEnabled: true,
     // required ['debug', 'info', 'warn', 'error', 'fatal']
-    logLevel : 'debug', 
+    logLevel : 'debug',
     // optional : defaults to false if not specified
     stringifyArguments : false,
     // optional : defaults to false if not specified

src/logger.js

@@ -1,6 +1,7 @@
 export default (function () {
 
     const defaultOptions = {
+        isEnabled: true,
         logLevel: 'debug',
         separator: '|',
         stringifyArguments: false,
@@ -14,7 +15,8 @@ export default (function () {
     function initLoggerInstance (options, logLevels) {
         const logger = {}
         logLevels.forEach(logLevel => {
-              if (logLevels.indexOf(logLevel) >= logLevels.indexOf(options.logLevel)) {
+              if (logLevels.indexOf(logLevel) >= logLevels.indexOf(options.logLevel) &&
+                  options.isEnabled) {
                   logger[logLevel] = (...args) => {
                       let methodName = getMethodName()
                       const methodNamePrefix = options.showMethodName ? methodName + ` ${options.separator} ` : ''
@@ -55,6 +57,9 @@ export default (function () {
         if (options.separator && (typeof options.separator !== 'string' || (typeof options.separator === 'string' && options.separator.length > 3))) {
             return false
         }
+        if (typeof options.isEnabled !== 'boolean') {
+            return false
+        }
         return !(options.showMethodName && typeof options.showMethodName !== 'boolean')
     }
 

test/logger.js

@@ -9,6 +9,7 @@ describe('Logger.js', () => {
     describe('getMethodName()', () => {
         it('Should show the parent function.', () => {
             const options = {
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyByDefault: false,
                 showLogLevel: false,
@@ -40,6 +41,7 @@ describe('Logger.js', () => {
 
         it('install() should work with the correct params.', () => {
             const options = {
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyByDefault: false,
                 showLogLevel: false,
@@ -100,6 +102,15 @@ describe('Logger.js', () => {
               .to
               .throw(Error, 'Provided options for vuejs-logger are not valid.')
         })
+
+        it('install() should throw an error with the an incorrect isEnabled value', () => {
+            const options = {
+                isEnabled: null
+            }
+            expect(() => { install(Vue, options) })
+                .to
+                .throw(Error, 'Provided options for vuejs-logger are not valid.')
+        })
     })
 
     describe('initLoggerInstance()', () => {
@@ -140,6 +151,7 @@ describe('Logger.js', () => {
 
         it('isValidOptions() should pass with correct options.', () => {
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyByDefault: false,
                 showLogLevel: false,
@@ -152,6 +164,7 @@ describe('Logger.js', () => {
         it('isValidOptions() should fail with incorrect options.', () => {
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyByDefault: false,
                 showLogLevel: false,
@@ -161,6 +174,7 @@ describe('Logger.js', () => {
             }, logLevels)).to.equal(false)
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyByDefault: false,
                 showLogLevel: false,
@@ -170,6 +184,7 @@ describe('Logger.js', () => {
             }, logLevels)).to.equal(false)
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyArguments: false,
                 showLogLevel: false,
@@ -179,6 +194,7 @@ describe('Logger.js', () => {
             }, logLevels)).to.equal(false)
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyArguments: 'TEST',
                 showLogLevel: false,
@@ -188,6 +204,7 @@ describe('Logger.js', () => {
             }, logLevels)).to.equal(false)
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'debug',
                 stringifyArguments: false,
                 showLogLevel: 'TEST',
@@ -197,6 +214,7 @@ describe('Logger.js', () => {
             }, logLevels)).to.equal(false)
 
             expect(isValidOptions({
+                isEnabled: true,
                 logLevel: 'TEST',
                 stringifyArguments: false,
                 showLogLevel: false,
@@ -207,13 +225,55 @@ describe('Logger.js', () => {
 
             expect(isValidOptions({
                 logLevel: 'debug',
+                isEnabled: true,
             }, logLevels)).to.equal(true)
 
             expect(isValidOptions({
+                isEnabled: '',
                 logLevel: 'debug',
                 separator: '1234',
             }, logLevels)).to.equal(false)
 
+            expect(isValidOptions({
+                isEnabled: true,
+                logLevel: 'debug',
+                stringifyArguments: false,
+                showLogLevel: false,
+                showMethodName: false,
+                separator: '|',
+                showConsoleColors: false,
+            }, logLevels)).to.equal(true)
+
+            expect(isValidOptions({
+                isEnabled: false,
+                logLevel: 'debug',
+                stringifyArguments: false,
+                showLogLevel: false,
+                showMethodName: false,
+                separator: '|',
+                showConsoleColors: false,
+            }, logLevels)).to.equal(true)
+
+            expect(isValidOptions({
+                isEnabled: '',
+                logLevel: 'debug',
+                stringifyArguments: false,
+                showLogLevel: false,
+                showMethodName: false,
+                separator: '|',
+                showConsoleColors: false,
+            }, logLevels)).to.equal(false)
+
+            expect(isValidOptions({
+                isEnabled: null,
+                logLevel: 'debug',
+                stringifyArguments: false,
+                showLogLevel: false,
+                showMethodName: false,
+                separator: '|',
+                showConsoleColors: false,
+            }, logLevels)).to.equal(false)
+
         })
     })