Code coverage report for console-blame/index.js

Statements: 89.29% (50 / 56)      Branches: 90% (18 / 20)      Functions: 86.67% (13 / 15)      Lines: 89.29% (50 / 56)      Ignored: 1 statement, 1 branch     

All files » console-blame/ » index.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293        1           1 26                                                                                                             1 29 14     15 1 1     15             15 15   15     1                                   4 4       15   15 3     15                                                                               15   15                     3   6                                 19     19   19             19   19   19                     19                                 19   19 8   8           8 8 8                     8 1     7   7   27 1     27     27 7     27                   35       1  
/*!
 * console-blame
 */
 
var parsetrace = require('parsetrace'),
    pad = require('pad'),
    chalk = require('chalk'),
    assign = require('object-assign'),
    format = require('util').format;
 
var trappedToString = function () {
    return '[object ConsoleBlame]';
};
 
/**
 * @example
 * ```js
 * require('console-blame')(['log']);
 *
 * console.log(123); // Will print debug message
 * console.error(123); // Will NOT print debug message
 * ```
 *
 * @example
 *
 * ```js
 * require('console-blame')(console);
 *
 * console.log(123); // Will print debug message
 * console.error(123); // Will print debug message
 * ```
 *
 * @example
 *
 * ```js
 * require('console-blame')(console, ['log', 'error']);
 *
 * console.log(123); // Will print debug message
 * console.error(123); // Will print debug message
 * ```
 *
 * @example
 *
 * ```js
 * require('console-blame')().configure({
 *    contextSize: 5,
 *    lineFormat: '%d\t%s'
 * });
 * ```
 *
 * @example
 *
 * ```js
 * var blame = require('console-blame')();
 * console.log(123); // Will print debug message
 * blame.restore();
 * console.log(123); // Will NOT print debug message
 * blame.trap();
 * console.log(123); // Will print debug message
 * ```
 *
 * @param {Object} [consoleObject=console]
 * @param {Array} [trapsList]
 * @returns {ConsoleBlame}
 * @constructor
 */
function ConsoleBlame(consoleObject, trapsList) {
    if (!(this instanceof ConsoleBlame)) {
        return new ConsoleBlame(consoleObject, trapsList);
    }
 
    if (Array.isArray(consoleObject)) {
        trapsList = consoleObject;
        consoleObject = null;
    }
 
    this.options = {
        lineFormat: '%d | %s',
        pathFormat: '%s:%d:%d',
        contextSize: 3,
        sources: true
    };
 
    this.consoleObject = consoleObject || console;
    this.capturedOriginals = {};
 
    this.trap.apply(this, trapsList);
}
 
ConsoleBlame.prototype = {
    /**
     * @example
     *
     * ```js
     * require('console-blame')().configure({
     *    contextSize: 5,
     *    lineFormat: '%d\t%s'
     * });
     * ```
     *
     * @param {Object}  [options]
     * @param {String}  [options.lineFormat]
     * @param {String}  [options.pathFormat]
     * @param {Number}  [options.contextSize] number of lines before and after target line
     * @param {Boolean} [options.sources]     print source code?
    */
    configure: function (options) {
        assign(this.options, options || {});
        return this;
    },
 
    trap: function (/*'log', 'error', ...*/) {
        var trapNames = Array.prototype.slice.call(arguments);
 
        if (trapNames.length === 0) {
            trapNames = this._getMethodsOf(this.consoleObject);
        }
 
        this._attachTraps(trapNames);
    },
 
    /**
     * Removes all traps
     *
     * @returns {ConsoleBlame}
     */
    restore: function () {
        var self = this;
 
        Object.keys(this.capturedOriginals).forEach(function (method) {
            self.consoleObject[method] = self.capturedOriginals[method];
            delete self.capturedOriginals[method];
        });
 
        return this;
    },
 
    /**
     * @example
     * ```js
     * attachTrapTo('log');
     *
     * console.log(123); // Will print debug message
     * ```
     *
     * @example
     *
     * ```js
     * attachTrapTo();
     *
     * console.log(123); // Will print debug message
     * console.error(123); // Will print debug message
     * ```
     *
     * @param {Array} trapNames
     * @returns {ConsoleBlame}
     */
    _attachTraps: function (trapNames) {
        trapNames.forEach(this._attachTrap.bind(this));
 
        return this;
    },
 
    /**
     * Returns list of functions assigned to the `object`
     *
     * @param {Object} object
     * @returns {Array}
     * @private
     */
    _getMethodsOf: function (object) {
        return Object.keys(object)
            .filter(function (method) {
                return typeof object[method] === 'function';
            });
    },
 
    /**
     * @example
     *
     * ```js
     * attachTrapTo(console, 'log');
     *
     * console.log(123); // Will print debug message
     * ```
     *
     * @param {String} methodName
     * @private
     */
    _attachTrap: function (methodName) {
        var originalMethod = this.consoleObject[methodName];
 
        // If this is a function and it was not trapped
        Eif (this._isOriginalMethod(originalMethod)) {
            // Keep it and continue
            this.capturedOriginals[methodName] = originalMethod;
        } else {
            // No reason to attach an extra trap
            return;
        }
 
        // Create trap
        var trappedMethod = this._consoleBlameGenerator(originalMethod);
        // "sign" our trapped method
        trappedMethod.toString = trappedToString;
        // Assign trap
        this.consoleObject[methodName] = trappedMethod;
    },
 
    /**
     * Checks if passed `method` is original function (not generated by ConsoleBlame)
     *
     * @param {*} method
     * @returns {boolean}
     * @private
     */
    _isOriginalMethod: function (method) {
        return typeof method === 'function' && method.toString() !== trappedToString();
    },
 
    /**
     * @example
     *
     * ```js
     * console.log = consoleBlameGenerator(log);
     *
     * console.log(123); // Will print debug message
     * ```
     *
     * @param {Function} originalMethod original console's method
     * @returns {Function}
     * @private
     */
    _consoleBlameGenerator: function (originalMethod) {
        var self = this;
 
        return function () {
            originalMethod.apply(null, arguments);
 
            var parseTraceOptions = {
                sources: self.options.sources,
                contextSize: self.options.contextSize
            };
 
            // Getting previous frame where console.*() was called
            var frame = parsetrace(new Error(), parseTraceOptions).object().frames[1];
            self._log(chalk.green(self.options.pathFormat), frame.file, frame.line, frame.column);
            self._printSources(frame.source, frame.line);
        };
    },
 
    /**
     *
     * @param {Object} sources
     * @param {Number} targetLine
     * @private
     */
    _printSources: function (sources, targetLine) {
        if (!sources) {
            return;
        }
 
        var padding = String(targetLine + this.options.contextSize).length + 1;
 
        for (var line in sources) {
            /* istanbul ignore next */
            Iif (!sources.hasOwnProperty(line)) {
                continue;
            }
 
            var format = this.options.lineFormat;
 
            // Hl line
            if (Number(line) === targetLine) {
                format = chalk.bgRed.white(format);
            }
 
            this._log(format, pad(padding, line), sources[line].code);
        }
    },
 
    /**
     * Private implementation of console.log
     *
     * @private
     */
    _log: function () {
        process.stdout.write(format.apply(null, arguments) + '\n');
    }
};
 
module.exports = ConsoleBlame;