debug-fabulous 0.1.1 → 1.1.0

package/README.md

@@ -1,18 +1,30 @@
-## debug-fabulous [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url]
+# debug-fabulous [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url]
 
 ## Install
+
 `npm install --save debug-fabulous`
 
-# Purpose
+## Purpose:
 
 Wrapper / Extension around [visionmedia's debug](https://github.com/visionmedia/debug) to allow lazy evaluation of debugging via closure handling.
 
-This library essentially wraps two things:
+## Why would I consider using this library?
+
+The main utilities added to this library is lazy log level evaluation. This allows whatever logged strings to only be created and evaluated if a log level is active. This can considerably reduce the amount of memory used in logging when you are not using.
+
+With this in mind, there are no excuses to not log anything and everything as performance can be kept in check easily (via log levels).
+
+### Proof
+
+For analysis of the performance results are in [perfWith.out](./test/perf/perfWith.out) and [perfWithout.out](./test/perf/perfWithout.out).
+
+In summary, the tests using this library are using 3 times less memory for the same logging statements (when the log levels are disabled).
+
+## This library essentially wraps two things:
 
 - [lazy-eval](./src/lazy-eval.js): debug closure handling
 - [spawn](./src/spawn.js): spawns off existing namespaces for a sub namespace.
 
-
 ## Example:
 
 For usage see the [tests](./test) or the example below.
@@ -23,7 +35,8 @@ var debug = require('')();
 // debug.save('namespace');
 // debug.enable(debug.load())
 debug = debug('namespace'); // debugger in the namespace
-debug(function(){return 'ya something to log' + someLargeHarryString;});
+debug(function(){return 'something to log' + someLargeHarryString;});
+debug(() => 'something to log ${someLargeHarryString}');
 debug('small out'); // prints namespace small out
 var childDbg = debug.spawn('child'); // debugger in the namespace:child
 childDbg('small out'); // prints namespace:child small out

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "debug-fabulous",
-  "version": "0.1.1",
+  "version": "1.1.0",
   "description": "visionmedia debug extensions rolled into one",
   "main": "index.js",
   "scripts": {
@@ -20,15 +20,16 @@
   "author": "Nicholas McCready",
   "license": "MIT",
   "dependencies": {
-    "debug": "2.3.0",
-    "memoizee": "^0.4.5",
-    "object-assign": "4.1.0"
+    "debug": "3.X",
+    "memoizee": "0.4.X",
+    "object-assign": "4.X"
   },
   "devDependencies": {
-    "chai": "3.X",
-    "eslint": "3.X",
+    "JSONStream": "1.X",
+    "chai": "4.X",
+    "eslint": "4.X",
     "hook-std": "0.X",
-    "memwatch-next": "^0.3.0",
-    "mocha": "3.X"
+    "memwatch-next": "0.3.X",
+    "mocha": "4.X"
   }
 }

package/src/lazy-eval.js

@@ -16,28 +16,24 @@ function _resolveOutput(func, bindThis) {
   objectAssign(wrapped, func);
 
   return wrapped;
-};
-
+}
 
 function wrapEval(_debug) {
-
   var debugOrig = _debug;
-  var noop = function(){};
 
   function debug(namespace) {
-
+    function noop() {}
     var instance = debugOrig(namespace);
-
-    // if we're not enabled then don't attempt to log anything
-    // if a debug namespace wraps its debug in a closure then it never allocates anything but the function itself
-    if (!instance.enabled){
+    /*
+      If we're not enabled then don't attempt to log anything.
+      Therefore when a  debug namespace wraps its debug in a
+      closure then it never allocates anything but the function itself
+    */
+    if (!instance.enabled) {
       objectAssign(noop, instance);
-      instance = noop;
-    }
-    else {
-      instance = _resolveOutput(instance);
+      return noop;
     }
-    return instance;
+    return _resolveOutput(instance);
   }
 
   var debugMemoized = memoize(debug);

package/src/spawn.js

@@ -1,5 +1,4 @@
 function spawnFactory(_namespace, _debugFabFactory) {
-  var memoize = require('memoizee');
   var namespace = _namespace || '';
   var debugFabFactory = _debugFabFactory;
 
@@ -7,6 +6,13 @@ function spawnFactory(_namespace, _debugFabFactory) {
     debugFabFactory = require('./debugFabFactory')();
   }
 
+  function spawn(ns) {
+    // this is this.debug (from Debugger)
+    var dbg = new Debugger(this.namespace, ns);
+
+    return dbg.debug;
+  };
+
   function Debugger(_base, _ns){
     var base = _base || '';
     var ns = _ns || '';
@@ -15,17 +21,9 @@ function spawnFactory(_namespace, _debugFabFactory) {
     var debug = debugFabFactory(newNs);
 
     this.debug = debug;
-    this.debug.spawn = this.spawn;
+    this.debug.spawn = spawn;
   }
 
-  Debugger.prototype.spawn = function(ns) {
-    var dbg = new Debugger(this.namespace, ns);
-
-    return dbg.debug;
-  };
-
-  Debugger.prototype.spawn = memoize(Debugger.prototype.spawn);
-
   var rootDebug = (new Debugger(namespace)).debug;
 
   return rootDebug;