semlog 0.6.9 → 0.7.0

package/test/test.spec.js

@@ -1,15 +1,11 @@
 'use strict';
 
-/*global describe, it*/
-
-var semlog = require('../');
-var log = semlog.log;
-var expect = require('chai').expect;
-
-describe('semlog logger', function() {
-
-    it('logs a string message to the console', function() {
+const semlog = require('../');
+const log = semlog.log;
+const expect = require('chai').expect;
 
+describe('semlog logger', function () {
+    it('logs a string message to the console', function () {
         console.log('');
         console.log('-------------------------------------------------------------');
         console.log(' Testing Log Messages');
@@ -40,13 +36,12 @@ describe('semlog logger', function() {
         log(null);
         log(Infinity);
 
-
         console.log('');
         console.log('-------------------------------------------------------------');
         console.log(' Testing Log Objects and Errors');
         console.log('-------------------------------------------------------------');
 
-        // Create a new object, that prototypally inherits from the Error constructor.
+        // Create a new object, that prototypical inherits from the Error constructor.
         function MyError(message) {
             this.name = 'MyError';
             this.message = message || 'Default Message';
@@ -54,7 +49,7 @@ describe('semlog logger', function() {
         MyError.prototype = Object.create(Error.prototype);
         MyError.prototype.constructor = MyError;
 
-        log({title: 'Object log entry', number: 10});
+        log({ title: 'Object log entry', number: 10 });
         log(new Error('error log entry'));
         log(new TypeError('error log entry'));
         log(new MyError('error log entry'));
@@ -63,132 +58,146 @@ describe('semlog logger', function() {
         console.log('');
     });
 
-    it('prints objects as colorized YAML', function() {
-        semlog.updateConfig({printYaml: true});
+    it('prints objects as colorized YAML', function () {
+        semlog.updateConfig({ printYaml: true });
         log({
             text: 'text',
             number: 42,
             array: [1, '2'],
             object: {
-                key: 'value'
-            }
+                key: 'value',
+            },
         });
-        semlog.updateConfig({printYaml: false});
+        semlog.updateConfig({ printYaml: false });
     });
 
-    it('prints errors', function() {
+    it('prints objects as YAML without color when colorize is false', function () {
+        semlog.updateConfig({ printYaml: true, colorize: false });
+        log({ key: 'value' });
+        semlog.updateConfig({ printYaml: false, colorize: true });
+    });
+
+    it('prints errors', function () {
         semlog.error(new Error('Test Error'));
     });
 
-    it('handles various invalid log objects', function() {
+    it('handles various invalid log objects', function () {
         log(undefined);
         log(null);
         log(Error);
         log(Infinity);
     });
 
-    it('returns the log history as an array', function() {
-        var logArchive = semlog.getLogHistory();
+    it('suppresses verbose and debug messages when configured', function () {
+        semlog.updateConfig({ printVerbose: false, printDebug: false });
+        log('[V] suppressed verbose');
+        log('[D] suppressed debug');
+        semlog.updateConfig({ printVerbose: true, printDebug: true });
+    });
+
+    it('returns the log history as an array', function () {
+        const logArchive = semlog.getLogHistory();
 
         expect(logArchive).to.be.instanceof(Array);
         expect(logArchive.length).to.be.least(1);
     });
 
-    it('clears global log object', function() {
+    it('clears global log object', function () {
         semlog.clearLogHistory();
-        var logArchive = semlog.getLogHistory();
+        const logArchive = semlog.getLogHistory();
 
         expect(logArchive).to.be.instanceof(Array);
         expect(logArchive.length).to.equal(0);
     });
 
-    it('logs silently', function() {
+    it('logs silently', function () {
         semlog.log(' [i] info log entry ', true);
         semlog.log(' [W] warning log entry', true);
         semlog.log(' [E] error log entry', true);
 
-        var logArchive = semlog.getLogHistory();
+        const logArchive = semlog.getLogHistory();
 
         expect(logArchive).to.be.instanceof(Array);
         expect(logArchive.length).to.equal(3);
     });
 
-    it('gets config', function() {
-        var config = semlog.getConfig();
+    it('gets config', function () {
+        const config = semlog.getConfig();
 
         expect(config).to.be.instanceof(Object);
         expect(Object.keys(config).length).to.be.least(3);
     });
 
-    it('updates the config', function() {
-
-        var config = semlog.getConfig();
-        var newConfig = semlog.updateConfig({printTime: false});
+    it('updates the config', function () {
+        const config = semlog.getConfig();
+        const newConfig = semlog.updateConfig({ printTime: false });
 
         expect(newConfig).to.be.instanceof(Object);
         expect(newConfig.printTime).to.equal(false);
         expect(newConfig.historySize).to.equal(config.historySize);
     });
 
-    it('keeps the log object at a specific size', function() {
+    it('keeps the log object at a specific size', function () {
+        const historySize = 7;
+        const newConfig = semlog.updateConfig({ historySize: historySize, logDateTime: true });
 
-        var historySize = 7;
-        var newConfig = semlog.updateConfig({historySize: historySize, logDateTime: true});
-
-        for (var i = 0; i < 32; i++) {
+        for (let i = 0; i < 32; i++) {
             log('[i] Index added: ' + i, true);
         }
 
-        var logHistory = semlog.getLogHistory();
+        const logHistory = semlog.getLogHistory();
         expect(newConfig.historySize).to.equal(logHistory.length);
         expect(logHistory.length).to.equal(historySize);
     });
 
-    it('returns the log archive as non circular array', function() {
+    it('handles circular objects in history gracefully', function () {
+        const circular = {};
+        circular.self = circular;
+        semlog.addToHistory(circular);
+        const history = semlog.getLogHistory();
+        expect(history[history.length - 1]).to.include('[W]');
+    });
 
+    it('returns the log archive as non circular array', function () {
         log(semlog.getLogHistory());
-        var logHistory = semlog.getLogHistory();
+        const logHistory = semlog.getLogHistory();
 
         expect(JSON.stringify(logHistory)).to.be.a('string');
-
     });
 
-    it('returns log statistics', function() {
-
+    it('returns log statistics', function () {
         log(semlog.getStatistics());
-        var statistics = semlog.getStatistics();
+        const statistics = semlog.getStatistics();
 
         expect(statistics.total).to.be.a('number');
-
     });
-
 });
 
-describe('semlog utilities', function() {
-
-    it('pad numbers', function() {
+describe('semlog utilities', function () {
+    it('pad numbers', function () {
         expect(semlog.pad(7, 1)).to.equal('7');
         expect(semlog.pad(7, 2)).to.equal('07');
         expect(semlog.pad(7, 3)).to.equal('007');
     });
 
-    it('pretty prints numbers', function() {
+    it('pretty prints numbers', function () {
         expect(semlog.prettyNumber(1)).to.equal('1');
         expect(semlog.prettyNumber(100000)).to.equal('100.000');
         expect(semlog.prettyNumber(-100000)).to.equal('-100.000');
     });
 
-    it('pretty prints bytes', function() {
+    it('pretty prints bytes', function () {
+        expect(semlog.prettyBytes(500)).to.equal('500 B');
         expect(semlog.prettyBytes(1024)).to.be.a('string');
         expect(semlog.prettyBytes(1024)).to.equal('1.0 KiB');
         expect(semlog.prettyBytes(1024, true)).to.equal('1.0 kB');
     });
 
-    it('strips trailing slashes from URLs', function() {
+    it('strips trailing slashes from URLs', function () {
         expect(semlog.stripTrailingSlash('http://fannon.de/')).to.equal('http://fannon.de');
     });
 
-    it('strips leading and ending slashes from URLs / URL paths', function() {
+    it('strips leading and ending slashes from URLs / URL paths', function () {
         expect(semlog.cleanUrl('http://fannon.de/')).to.equal('http://fannon.de');
         expect(semlog.cleanUrl('http://fannon.de  ')).to.equal('http://fannon.de');
         expect(semlog.cleanUrl('/test/')).to.equal('test');
@@ -196,40 +205,44 @@ describe('semlog utilities', function() {
         expect(semlog.cleanUrl('   test/ ')).to.equal('test');
     });
 
-    it('creates date arrays', function() {
+    it('creates date arrays', function () {
         expect(semlog.getDateArray().length).to.equal(7);
         expect(semlog.getDateArray()[0]).to.equal(new Date().getFullYear());
     });
 
-    it('return human readable date-times', function() {
+    it('return human readable date-times', function () {
         expect(semlog.humanDate().length).to.equal(19);
         expect(semlog.humanDate(new Date('October 13, 2014 11:13:00'))).to.equal('2014-10-13 11:13:00');
     });
 
-    it('return machine optimized date-times', function() {
+    it('return machine optimized date-times', function () {
         expect(semlog.roboDate().length).to.equal(19);
         expect(semlog.roboDate(new Date('October 13, 2014 11:13:00'))).to.equal('2014-10-13_11-13-00');
     });
 
-    it('return human readable time', function() {
+    it('return human readable time', function () {
         expect(semlog.humanTime().length).to.equal(8);
         expect(semlog.humanTime(new Date('October 13, 2014 11:13:00'))).to.equal('11:13:00');
     });
 
-    it('return machine optimized time', function() {
+    it('return machine optimized time', function () {
         expect(semlog.roboTime().length).to.equal(8);
         expect(semlog.roboTime(new Date('October 13, 2014 11:13:00'))).to.equal('11-13-00');
     });
 
-    it('calculates the bytesize of strings', function() {
+    it('calculates the bytesize of strings', function () {
         expect(semlog.byteSize('internationalization')).to.be.a('number');
         expect(semlog.byteSize('internationalization')).to.equal(20);
     });
 
-    it('calculates the bytesize of objects (parsed to JSON)', function() {
-        expect(semlog.byteSize({title: 'internationalization'})).to.be.a('number');
-        expect(semlog.byteSize({title: 'internationalization'})).to.equal(32);
+    it('calculates the bytesize of objects (parsed to JSON)', function () {
+        expect(semlog.byteSize({ title: 'internationalization' })).to.be.a('number');
+        expect(semlog.byteSize({ title: 'internationalization' })).to.equal(32);
     });
 
-
+    it('calculates the bytesize of multibyte strings', function () {
+        expect(semlog.byteSize('\u00F1')).to.equal(2); // 2-byte UTF-8 (ñ)
+        expect(semlog.byteSize('\u20AC')).to.equal(3); // 3-byte UTF-8 (€)
+        expect(semlog.byteSize('\uD840\uDC00')).to.equal(4); // 4-byte UTF-8 surrogate pair (𠀀)
+    });
 });

package/.eslintrc

@@ -1,20 +0,0 @@
-extends: 'eslint:recommended'
-
-rules:
-  indent:
-    - 2
-    - 4
-  quotes:
-    - 2
-    - single
-  semi:
-    - 2
-    - always
-  no-unused-vars:
-    - 1
-  no-console:
-    - 0
-
-env:
-  es6: true
-  node: true

package/.jscsrc

@@ -1,61 +0,0 @@
-{
-  "disallowSpacesInNamedFunctionExpression": {
-    "beforeOpeningRoundBrace": true
-  },
-  "disallowSpacesInFunctionExpression": {
-    "beforeOpeningRoundBrace": true
-  },
-  "disallowSpacesInAnonymousFunctionExpression": {
-    "beforeOpeningRoundBrace": true
-  },
-  "disallowSpacesInFunctionDeclaration": {
-    "beforeOpeningRoundBrace": true
-  },
-  "disallowEmptyBlocks": true,
-  "disallowSpacesInsideArrayBrackets": true,
-  "disallowSpacesInsideParentheses": true,
-  "disallowSpaceAfterObjectKeys": true,
-  "disallowSpaceAfterPrefixUnaryOperators": true,
-  "disallowSpaceBeforePostfixUnaryOperators": true,
-  "disallowSpaceBeforeBinaryOperators": [
-    ","
-  ],
-  "disallowMixedSpacesAndTabs": true,
-  "disallowTrailingWhitespace": "ignoreEmptyLines",
-  "disallowTrailingComma": true,
-  "disallowYodaConditions": true,
-  "disallowKeywords": [ "with" ],
-  "disallowMultipleVarDecl": true,
-  "requireSpaceBeforeBlockStatements": true,
-  "requireParenthesesAroundIIFE": true,
-  "requireSpacesInConditionalExpression": true,
-  "requireBlocksOnNewline": 1,
-  "requireCommaBeforeLineBreak": true,
-  "requireSpaceBeforeBinaryOperators": true,
-  "requireSpaceAfterBinaryOperators": true,
-  "requireLineFeedAtFileEnd": true,
-  "requireCapitalizedConstructors": true,
-  "requireDotNotation": true,
-  "requireSpacesInForStatement": true,
-  "requireSpaceBetweenArguments": true,
-  "requireCurlyBraces": [
-    "do"
-  ],
-  "requireSpaceAfterKeywords": [
-    "if",
-    "else",
-    "for",
-    "while",
-    "do",
-    "switch",
-    "case",
-    "return",
-    "try",
-    "catch",
-    "typeof"
-  ],
-  "safeContextKeyword": "_this",
-  "validateLineBreaks": "LF",
-  "validateQuoteMarks": "'",
-  "validateIndentation": 4
-}

package/.npmignore

@@ -1,4 +0,0 @@
-.idea/
-/node_modules/
-/coverage/
-npm-debug.log

package/.travis.yml

@@ -1,22 +0,0 @@
-language: node_js
-node_js:
-  - '0.10'
-  - '0.12'
-  - '4.2'
-  - '5.1'
-
-sudo: false
-
-addons:
-  code_climate:
-    repo_token: d025e5a435157e5cf3b9573054d1c2777cc6c8eb2d4d6abb6a0c976e9c4b75f6
-
-notifications:
-  email:
-    on_success: [never] # default: change
-    on_failure: [always] # default: always
-    recipients:
-      - info@fannon.de
-
-after_script:
-  - cat coverage/lcov.info | codeclimate

package/.yo-rc.json

@@ -1,3 +0,0 @@
-{
-  "generator-node": {}
-}

package/Gruntfile.js

@@ -1,102 +0,0 @@
-'use strict';
-module.exports = function(grunt) {
-
-    // Show elapsed time at the end
-    require('time-grunt')(grunt);
-
-    // Load all grunt tasks
-    require('load-grunt-tasks')(grunt);
-
-    grunt.initConfig({
-        eslint: {
-            options: {
-                configFile: '.eslintrc'
-            },
-            js: {
-                src: ['*.js']
-            },
-            test: {
-                src: ['test/**/*.js']
-            }
-        },
-        jscs: {
-            options: {
-                config: '.jscsrc',
-                force: true
-            },
-            lib: {
-                src: ['lib/**/*.js']
-            },
-            test: {
-                src: ['test/**/*.js']
-            }
-        },
-        mochacli: {
-            options: {
-                reporter: 'spec',
-                bail: true,
-                force: true,
-                timeout: 16000
-            },
-            all: ['test/**/*.spec.js']
-        },
-        mocha_istanbul: {
-            coverage: {
-                src: ['test/'],
-                options: {
-                    mask: '*.spec.js',
-                    coverage: true,
-                    reportFormats: ['lcov', 'text']
-                }
-            }
-        },
-        watch: {
-            gruntfile: {
-                files: '<%= jshint.gruntfile.src %>',
-                tasks: ['jshint:gruntfile']
-            },
-            js: {
-                files: '<%= jshint.js.src %>',
-                tasks: ['lint', 'test']
-            },
-            test: {
-                files: '<%= jshint.test.src %>',
-                tasks: ['lint', 'test']
-            }
-        },
-        documentation: {
-            md: {
-                files: [{
-                    'src': ['index.js']
-                }],
-                options: {
-                    format: 'md',
-                    destination: 'doc'
-                }
-            },
-            html: {
-                files: [{
-                    'src': ['index.js']
-                }],
-                options: {
-                    destination: 'doc'
-                }
-            }
-        },
-        release: {
-            options: {
-
-            }
-        }
-    });
-
-    // Default task.
-    grunt.registerTask('lint', ['eslint', 'jscs']);
-    grunt.registerTask('test', ['mochacli']);
-    grunt.registerTask('coverage', ['mocha_istanbul:coverage']);
-    grunt.registerTask('default', ['lint', 'coverage', 'documentation']);
-
-    grunt.event.on('coverage', function(content, done) {
-        done();
-    });
-};