jlog-rails 0.1.3 → 0.2.0

data/test/logger-test.js

@@ -0,0 +1,49 @@
+// var buster = require("buster");
+
+var id = 0;
+buster.testCase("Check logger main possibilities", {
+  setUp: function() {
+    JLog.handleError = function(error) { throw error };
+  },
+
+  tearDown: function() {
+  },
+
+  "Check inheritance": function() {
+    var hitGirl = JLog.getLogger("bigDaddy.hitGirl");
+    var bigDaddy = JLog.getLogger("bigDaddy");
+    var rootLogger = JLog.getRootLogger();
+
+    assert.equals(hitGirl.parent, bigDaddy, "Named parent must match");
+    assert.equals(bigDaddy.parent, rootLogger, "Root logger has to be parent of base loggers");
+  },
+
+  "Logger should evaluate levels": function() {
+    var logger = JLog.getLogger("kick-ass");
+    logger.setLevel(JLog.Level.WARN);
+
+    var appender = new JLog.ConsoleAppender();
+    var stub = sinon.stub(appender, "append");
+    logger.addAppender(appender);
+
+    logger.info("hello");
+    assert(!stub.called, "INFO is lower then WARN");
+    logger.warn("hello");
+    assert(stub.called, "WARN should be logged");
+  },
+
+  "Check log message propagation": function() {
+    var hitGirl = JLog.getLogger("bigDaddy.hitGirl");
+    var bigDaddy = JLog.getLogger("bigDaddy");
+    hitGirl.setLevel(JLog.Level.ALL);
+    bigDaddy.setLevel(JLog.Level.ALL);
+
+    var appender = new JLog.ConsoleAppender();
+    var stub = sinon.stub(appender, "append");
+    bigDaddy.addAppender(appender);
+    hitGirl.error("hello");
+
+    assert(stub.called, "Log message should rich appender");
+    stub.restore();
+  }
+});

data/test/pattern-layout-test.js

@@ -0,0 +1,37 @@
+var id = 0;
+
+buster.testCase("Check pattern layout", {
+  setUp: function() {
+    JLog.errorHandler = function(error) { throw error };
+  },
+
+  tearDown: function() {
+  },
+
+  "Basic layout": function() {
+    var pl = new JLog.PatternLayout("%m%n");
+    var res = pl.format(new JLog.LoggingEvent(null, new Date(), JLog.Level.INFO, ["hello"], null));
+    assert.equals("hello\n", res, "just message with new line");
+  },
+
+  "Custom fields": function() {
+    var pl = new JLog.PatternLayout("%f{left} %m %f{right}");
+    pl.setCustomField("left", "<<");
+    pl.setCustomField("right", ">>");
+    var res = pl.format(new JLog.LoggingEvent(null, new Date(), JLog.Level.INFO, ["whats up?"], null));
+    assert.equals("<< whats up? >>", res, "message with custom fields");
+  },
+
+  "Logger name and Level": function() {
+    var pl = new JLog.PatternLayout("%c [%p] %m");
+    var res = pl.format(new JLog.LoggingEvent(JLog.getLogger("hi-log"), new Date(),
+                                              JLog.Level.INFO, ["msg-msg"], null));
+    assert.equals("hi-log [INFO] msg-msg", res, "Logger name and Level has to be printed");
+  },
+
+  "Startup time": function() {
+    var pl = new JLog.PatternLayout("%r");
+    var res = pl.format(new JLog.LoggingEvent(null, new Date(), JLog.Level.INFO, ["msg-msg"], null));
+    assert(/\d+/.test(res), "Startup time has to be printed");
+  }
+});

data/vendor/assets/javascripts/appender.js

@@ -0,0 +1,93 @@
+/*
+  Class: Appender
+
+  Base class for sending/outputting of logging event.
+*/
+JLog.Appender = function() {};
+
+JLog.Appender.prototype = {
+  /*
+    Property: layout
+
+    Layout to use with this appender.
+  */
+  layout: new JLog.PatternLayout(),
+
+  /*
+    Property: threshold
+
+    Appender's internal <Level>.
+  */
+  threshold: JLog.Level.ALL,
+
+  /*
+    Method: doAppend
+
+    Checks and navigates logging events. Logger uses this method as gateway.
+
+    Parameters:
+      loggingEvent - <LoggingEvent> to append
+  */
+  doAppend: function(loggingEvent) {
+    if(loggingEvent.level.isGreaterOrEqual(this.threshold)) {
+      this.append(loggingEvent);
+    }
+  },
+
+  /*
+    Method: append
+
+    Virtual method, has to be overloaded by derivative classes to perform actual appending.
+
+    Parameters:
+      loggingEvent - <LoggingEvent> to append
+  */
+  append: function(loggingEvent) {
+    JLog.handleError("JLog.Appender: This method has to be implemented by derivative classes!");
+  },
+
+  /*
+    Method: setLayout
+
+    Set appender's <Layout>
+
+    Parameters:
+      layout - <Layout> for appender.
+  */
+  setLayout: function(layout) {
+    if (layout instanceof JLog.Layout) {
+      this.layout = layout;
+    } else {
+      JLog.handleError("Appender.setLayout: layout supplied to " +
+                  this.toString() + " is not a subclass of Layout");
+    }
+  },
+
+  /*
+    Method: getLayout
+
+    Get appender's <Layout>
+  */
+  getLayout: function() { return this.layout; },
+
+  /*
+    Method: setThreshold
+
+    Set appender's threshold <Level>
+
+    Parameters:
+      threshold - <Level> for appender.
+  */
+  setThreshold: function(threshold) { this.threshold = threshold; },
+
+  /*
+    Method: getThreshold
+
+    Get appender's threshold <Level>
+  */
+  getThreshold: function() { return this.threshold; },
+
+  toString: function() {
+    JLog.handleError("Appender.toString: all appenders must override this method");
+  }
+};

data/vendor/assets/javascripts/appenders/ajax.js

@@ -0,0 +1,151 @@
+/*
+  Class: AjaxAppender
+
+  Ajax calls based appender.
+*/
+JLog.AjaxAppender = function(url) {
+  this.name = 'AjaxAppender';
+
+  // Do we make more then 1 call at a time?
+  var waitForResponse = true;
+  // Current buffer of messages
+  var queuedLoggingEvents = [];
+  // Messages which should be sent
+  var queuedRequests = [];
+  // Maximum count of messages sent at a one time
+  var batchSize = 10;
+  // Are we currently sending something
+  var sending = false;
+  // Timeout between sending data
+  var timerInterval = 1000;
+
+  function scheduleSending() {
+    window.setTimeout(sendAllRemaining, timerInterval);
+  }
+
+  function sendRequest(postData, callback) {
+    $.ajax({
+      type: 'POST',
+      url: url,
+      data: postData,
+      dataType: 'json',
+      global: false,
+      complete: function() {
+        if (waitForResponse) sending = false;
+        if (callback) callback(true);
+      }
+    });
+  }
+
+  function sendAllRemaining() {
+    if (queuedLoggingEvents.length === 0) return;
+    var eventCopy = queuedLoggingEvents;
+    queuedLoggingEvents = [];
+    queuedRequests.push(eventCopy);
+    sendAll();
+  }
+
+  function preparePostData(data) {
+    return { message:data };
+  }
+
+  function sendAll() {
+    if (waitForResponse && sending) return;
+    sending = true;
+    var currentRequestBatch;
+    if (waitForResponse) {
+      if (queuedRequests.length > 0) {
+        currentRequestBatch = queuedRequests.shift();
+        sendRequest(preparePostData(currentRequestBatch), sendAll);
+      } else {
+        sending = false;
+        scheduleSending();
+      }
+    } else {
+      // Rattle off all the requests without waiting to see the response
+      while ((currentRequestBatch = queuedRequests.shift())) {
+        sendRequest(preparePostData(currentRequestBatch));
+      }
+      sending = false;
+      scheduleSending();
+    }
+  }
+
+  scheduleSending();
+
+  /*
+    Method: setWaitForResponce
+
+    If ajax appender has to make calls one by one, or it can do then concurrently.
+
+    Parameters:
+      waitForResponseParam - if should wait
+  */
+  this.setWaitForResponse = function(waitForResponseParam) {
+    waitForResponse = waitForResponseParam;
+  }
+
+  /*
+    Method: isWaitForResponse
+
+    Returns if ajax makes calls one at a time.
+  */
+  this.isWaitForResponse = function() {
+    return waitForResponse;
+  }
+
+  /*
+    Method: setBatchSize
+
+    Set single batch send size.
+
+    Parameters:
+      batchSizeParam - new size of batch
+  */
+  this.setBatchSize = function(batchSizeParam) {
+    batchSize = batchSizeParam;
+  }
+
+  /*
+    Method: getBatchSize
+
+    Return count of messages in batch.
+  */
+  this.getBatchSize = function() {
+    return batchSize;
+  }
+
+  /*
+    Method: setTimeout
+
+    Set buffering time before sending unfinished batch.
+
+    Parameters:
+      timeout - milliseconds
+  */
+  this.setBatchSize = function(timeout) {
+    timerInterval = timeout
+  }
+
+  /*
+    Method: setTimeout
+
+    Return timeout.
+  */
+  this.getBatchSize = function() {
+    return timerInterval;
+  }
+
+  /*
+    Method: append
+
+    Attempts to send message.
+  */
+  this.append = function(msg) {
+    queuedLoggingEvents.push({level:msg.level.name, message:this.getLayout().format(msg)});
+    if(queuedLoggingEvents.length >= batchSize) sendAllRemaining();
+    else if(queuedLoggingEvents.length == 1) scheduleSending();
+  }
+};
+
+JLog.AjaxAppender.prototype = new JLog.Appender();

data/vendor/assets/javascripts/appenders/console.js

@@ -0,0 +1,20 @@
+/*
+  Class: ConsoleAppender
+
+  Simple console appender.
+*/
+JLog.ConsoleAppender = function() {
+  this.name = 'ConsoleAppender';
+
+  /*
+    Method: append
+
+    Attempts to append message into console.
+  */
+  if (window.console && window.console.log)
+    this.append = function(loggingEvent) {
+      window.console.log(this.getLayout().format(loggingEvent));
+    };
+};
+
+JLog.ConsoleAppender.prototype = new JLog.Appender();

data/vendor/assets/javascripts/jlog.js

@@ -1,3 +1,14 @@
+//= include mount
+
+//= include levels
+//= include logger
+//= include logging_event
+//= include layout
+//= include layouts/pattern
+//= include appender
+//= include appenders/ajax
+//= include appenders/console
+
 /**
  *
  * @author Marcus R Breese mailto:mbreese@users.sourceforge.net
@@ -30,239 +41,3 @@
 *
 **/
 
-function JLog(name) {
-  this._appenders.push(new JLog.ConsoleAppender());
-  this.setName(name);
-}
-
-JLog.ALL   = 0;
-JLog.DEBUG = 1;
-JLog.INFO  = 2;
-JLog.WARN  = 3;
-JLog.ERROR = 4;
-JLog.FATAL = 5;
-JLog.NONE  = 6;
-
-JLog.prototype = {
-  _currentLevel: JLog.ALL,
-  _appenders: [],
-  _enabled: true,
-  _name: null,
-
-  debug: function() {
-    if (this.getLevel() <= JLog.DEBUG) {
-      this._log("DEBUG", arguments);
-    }
-  },
-
-  info: function() {
-    if (this.getLevel() <= JLog.INFO) {
-      this._log("INFO", arguments);
-    }
-  },
-
-  warn: function() {
-    if (this.getLevel() <= JLog.WARN) {
-      this._log("WARN", arguments);
-    }
-  },
-
-  error: function() {
-    if (this.getLevel() <= JLog.ERROR) {
-      this._log("ERROR", arguments);
-    }
-  },
-
-  fatal: function() {
-    if (this.getLevel() <= JLog.FATAL) {
-      this._log("FATAL", arguments);
-    }
-  },
-
-  _log: function() {
-    if (this.isOn()) {
-      var level = arguments[0],
-      args = Array.prototype.slice.call(arguments[1] || []),
-      namePrefix = this.getName() ? '[' + this.getName() + ']' : '',
-      msgString = level + namePrefix + ': ',
-      appenders = this.getAppenders();
-
-      for (var i in args) {
-        if (typeof args[i] === 'object') {
-          args[i] = JSON.stringify(args[i]);
-        }
-      }
-
-      msgString += args.join(', ');
-      for(i = 0; i < appenders.length; ++i) {
-        appenders[i].log(msgString);
-      }
-    }
-  },
-
-  getName: function() {
-    return _name;
-  },
-
-  setName: function(name) {
-    _name = name || null;
-  },
-
-  addAppender: function(appender) {
-    if (appender) {
-      this._appenders.push(appender);
-    }
-  },
-
-  removeAppender: function(name) {
-    for (var i in _appenders) {
-      if (this._appenders[i].name === name) {
-        this._appenders.splice(i, 1);
-      }
-    }
-    return null;
-  },
-
-  turnOn: function() {
-    this._enabled = true;
-  },
-
-  turnOff: function() {
-    this._enabled = false;
-  },
-
-  isOn: function() {
-    return this._enabled;
-  },
-
-  //
-  // Sets the current threshold log level for this Log instance.
-  // Only events that have a priority of this level or greater are logged.
-  //
-  setLevel: function(level) {
-    if (typeof level === 'number') {
-      if (level >= JLog.ALL && level <= JLog.NONE) {
-        this._currentLevel = level;
-      } else {
-        this._currentLevel = JLog.NONE;
-      }
-    } else if (level) {
-      switch(level) {
-        case 'all': this._currentLevel = JLog.ALL; break;
-        case 'debug': this._currentLevel = JLog.DEBUG; break;
-        case 'info': this._currentLevel = JLog.INFO; break;
-        case 'warn': this._currentLevel = JLog.WARN; break;
-        case 'error': this._currentLevel = JLog.ERROR; break;
-        case 'fatal': this._currentLevel = JLog.FATAL; break;
-        default: this._currentLevel = JLog.NONE;
-      }
-    } else {
-      this._currentLevel = JLog.NONE;
-    }
-  },
-
-  getAppender: function(name) {
-    for (var i in this._appenders) {
-      if (this._appenders[i].name === name) {
-        return this._appenders[i];
-      }
-    }
-    return null;
-  },
-
-  getAppenders: function() {
-    return this._appenders;
-  },
-
-  getLevel: function() {
-    return this._currentLevel;
-  }
-}
-
-JLog.ConsoleAppender = function() {
-  this.name = 'ConsoleAppender';
-
-  if (window.console && window.console.log)
-    this.log = function(msg) { window.console.log(msg); };
-  else
-    this.log = function(msg) {};
-};
-
-JLog.AjaxAppender = function(url) {
-  // Do we make more then 1 call at a time?
-  var waitForResponse = true;
-  // Current buffer of messages
-  var queuedLoggingEvents = [];
-  // Messages which should be sent
-  var queuedRequests = [];
-  // Maximum count of messages sent at a one time
-  var batchSize = 10;
-  // Are we currently sending something
-  var sending = false;
-  // Timeout between sending data
-  var timerInterval = 1000;
-
-  function scheduleSending() {
-    window.setTimeout(sendAllRemaining, timerInterval);
-  }
-
-  function sendRequest(postData, callback) {
-    $.ajax({
-      type: 'POST',
-      url: url,
-      data: postData,
-      dataType: 'json',
-      global: false,
-      complete: function() {
-        if (waitForResponse) sending = false;
-        if (callback) callback(true);
-      }
-    });
-  }
-
-  function sendAllRemaining() {
-    if (queuedLoggingEvents.length === 0) return;
-    var eventCopy = queuedLoggingEvents;
-    queuedLoggingEvents = [];
-    queuedRequests.push(eventCopy);
-    sendAll();
-  }
-
-  function preparePostData(data) {
-    return { message:data };
-  }
-
-  function sendAll() {
-    if (waitForResponse && sending) return;
-    sending = true;
-    var currentRequestBatch;
-    if (waitForResponse) {
-      if (queuedRequests.length > 0) {
-        currentRequestBatch = queuedRequests.shift();
-        sendRequest(preparePostData(currentRequestBatch), sendAll);
-      } else {
-        sending = false;
-        scheduleSending();
-      }
-    } else {
-      // Rattle off all the requests without waiting to see the response
-      while ((currentRequestBatch = queuedRequests.shift())) {
-        sendRequest(preparePostData(currentRequestBatch));
-      }
-      sending = false;
-      scheduleSending();
-    }
-  }
-
-  scheduleSending();
-
-  return {
-    name: 'AjaxAppender',
-
-    log: function(msg) {
-      queuedLoggingEvents.push(msg);
-      if (queuedLoggingEvents.length >= batchSize) sendAllRemaining();
-      else if (queuedLoggingEvents.length == 1) scheduleSending();
-    }
-  };
-};