logeasy 0.0.6 → 0.0.7

data/lib/example/example.rb

@@ -3,6 +3,8 @@
 # 19-02-2011
 #
 
+$LOAD_PATH << "../"
+
 require "logeasy"
 
 # Configuring the self logger. The self logger will log internal logger messages.
@@ -31,9 +33,13 @@ file_appender_2 = LogEasy::FileAppender.new("easylog_example.log") # Simple file
 file_appender_2.min_level = LogEasy::Level::INFO # Specific level of INFO for the appender. The logger's level will not be applied to this appender now.
 console_appender_2 = LogEasy::ConsoleAppender.new # Simple console appender.
 console_appender_2.formatter = custom_formatter
+file_appender_3 = LogEasy::HTMLFileAppender.new("easylog_example.html", "easylog.css")
+file_appender_3.formatter = LogEasy::Formatters::STYLED_HTML_FORMATTER
 root_logger = LogEasy::Logger.root_logger # Get the handle to the root logger. The root logger's default level is ALL.
 root_logger.add_appender(console_appender_2) # Add the appenders to the root logger.
 root_logger.add_appender(file_appender_2)
+root_logger.add_appender(file_appender_3)
+
 
 # Logging to a child logger, sends messages to the parent loggers too (by default).
 custom_logger = LogEasy::Logger.get_logger("Parent::Child") # Creates a logger. The '::' or '.' characters can be used to separate logger names.
@@ -50,3 +56,7 @@ custom_logger << "UNFORMATTED message"
 # Adding a custom level.
 custom_level = LogEasy::Level.new("FINER", 500) # ALL < FINER < FINE
 custom_logger.log(custom_level, "Custom level message")
+
+file_appender_1.close
+file_appender_2.close
+file_appender_3.close

data/lib/logeasy/appender.rb

@@ -4,6 +4,7 @@
 #
 
 require "time"
+require "logeasy/formatters"
 
 module LogEasy
 
@@ -12,29 +13,6 @@ module LogEasy
   # A simple console logger and file logger are provided.
   class Appender
 
-    # Timestamp format for use by log formatters.
-    LOG_TIMESTAMP = "%d-%m-%Y %H:%M:%S.%L %z"
-
-    # Default formatter that prints messages in the format [TIMESTAMP] [LEVEL] -- [LOGGER] - [MESSAGE]
-    DEFAULT_FORMATTER = proc do |log_item|
-      logger_name = log_item.logger.name
-      level = log_item.level
-      message = log_item.message
-      timestamp = log_item.timestamp.strftime(LOG_TIMESTAMP)
-
-      "[#{timestamp}] %-5s -- (%s) - %s\n" % [level, logger_name, message]
-    end
-
-    # Custom formatter that prints messages in the format [TIMESTAMP] [LEVEL] -- [LOGGER_FULL_NAME] - [MESSAGE]
-    FULL_LOGGER_NAME_FORMATTER = proc do |log_item|
-      logger_name = log_item.logger.full_name
-      level = log_item.level
-      message = log_item.message
-      timestamp = log_item.timestamp.strftime(LOG_TIMESTAMP)
-
-      "[#{timestamp}] %-5s -- (%s) - %s\n" % [level, logger_name, message]
-    end
-
     attr_accessor :formatter
     attr_accessor :logger
     attr_accessor :min_level
@@ -56,7 +34,7 @@ module LogEasy
 
     # Creates a new appender.
     def initialize
-      @formatter = DEFAULT_FORMATTER
+      @formatter = Formatters::DEFAULT_FORMATTER
       @allow_unformatted_messages = true
     end
 
@@ -127,6 +105,8 @@ module LogEasy
   # A file appender that writes to the end of the file if it exists.
   class ConcatFileAppender < FileAppender
 
+    private
+
     # Overrides default create file. This will use an existing file.
     def create_file
       @file = File.open(file_path, "a")
@@ -134,4 +114,43 @@ module LogEasy
 
   end
 
+  class HTMLFileAppender < FileAppender
+
+    # Close the file.
+    def close
+      @file.puts("</body>")
+      @file.puts("</html>")
+      # Close the file.
+      super
+    end
+
+    # Override do_log to add a line feed to the end of an unformatted message.
+    def do_log(log_item)
+      log_item.message += "<br />" if log_item.unformatted
+      super
+    end
+
+    private
+
+    attr_reader :external_css
+
+    # New HTML appender. Use in conjunction with a STYLED_HTML_FORMATTER for best results.
+    def initialize(file_path, external_css = "log.css")
+      @external_css = external_css
+      # Create the appender.
+      super(file_path)
+    end
+
+    # Create the file. Adds the header details.
+    def create_file
+      @file = File.open(file_path, "w")
+      @file.puts("<html>")
+      @file.puts("<head>")
+      @file.puts("<link rel=\"stylesheet\" href=\"#{external_css}\">")
+      @file.puts("</head>")
+      @file.puts("<body>")
+    end
+
+  end
+
 end

data/lib/logeasy/formatters.rb

@@ -0,0 +1,54 @@
+#
+# Suraj Vijayakumar
+# 24-02-2011
+#
+
+module LogEasy
+
+  # Pre-defined formatter procs.
+  module Formatters
+
+    # Timestamp format for use by log formatters.
+    LOG_TIMESTAMP = "%d-%m-%Y %H:%M:%S.%L %z"
+
+    # Default formatter that prints messages in the format [TIMESTAMP] [LEVEL] -- [LOGGER] - [MESSAGE]
+    DEFAULT_FORMATTER = proc do |log_item|
+      logger_name = log_item.logger.name
+      level = log_item.level
+      message = log_item.message
+      timestamp = log_item.timestamp.strftime(LOG_TIMESTAMP)
+
+      "[#{timestamp}] %-5s -- (%s) - %s\n" % [level, logger_name, message]
+    end
+
+    # Custom formatter that prints messages in the format [TIMESTAMP] [LEVEL] -- [LOGGER_FULL_NAME] - [MESSAGE]
+    FULL_LOGGER_NAME_FORMATTER = proc do |log_item|
+      logger_name = log_item.logger.full_name
+      level = log_item.level
+      message = log_item.message
+      timestamp = log_item.timestamp.strftime(LOG_TIMESTAMP)
+
+      "[#{timestamp}] %-5s -- (%s) - %s\n" % [level, logger_name, message]
+    end
+
+    # Styled HTML formatter. Allows the logs to be formatted easily using a CSS.
+    # 
+    # Each element is applied a class name.
+    # The whole log message is wrapped in a <span class="<LEVEL>"> tag.
+    # The timestamp is wrapped in a <span class="time"> tag.
+    # The level is wrapped in a <span class="level"> tag.
+    # The logger name is wrapped in a <span class="logger"> tag.
+    # The message is wrapped in a <span class="message"> tag.
+    STYLED_HTML_FORMATTER = proc do |log_item|
+      level_str = log_item.level.to_s
+      logger_name = "<span class=\"logger\">(#{log_item.logger.name})</span>"
+      level = "<span class=\"level\">#{("%-5s" % level_str).gsub(" ", "&nbsp;")}</span>"
+      message = "<span class=\"message\">#{log_item.message}</span>"
+      timestamp = "<span class=\"time\">[#{log_item.timestamp.strftime(LOG_TIMESTAMP)}]</span>"
+
+      "<span class=\"#{log_item.level}\">#{timestamp} #{level} -- #{logger_name} #{message}</span><br />"
+    end
+
+  end
+
+end

data/lib/logeasy/log.rb

@@ -8,11 +8,11 @@ module LogEasy
   # Represents the actual log message. Simply a wrapper for the log information (i.e. level, logger, timestamp, message, etc...).
   class Log
 
-    attr_reader :logger
-    attr_reader :level
-    attr_reader :message
-    attr_reader :timestamp
-    attr_reader :unformatted
+    attr_accessor :logger
+    attr_accessor :level
+    attr_accessor :message
+    attr_accessor :timestamp
+    attr_accessor :unformatted
 
     # New log item.
     #

data/lib/logeasy/logger.rb

@@ -6,6 +6,7 @@
 require "logeasy/level"
 require "logeasy/log"
 require "logeasy/appender"
+require "logeasy/formatters"
 
 module LogEasy
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logeasy
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-22 00:00:00.000000000 +05:30
+date: 2011-02-24 00:00:00.000000000 +05:30
 default_executable: 
 dependencies: []
 description: Hierarchical logger for Ruby. The loggers are arranged in a tree. Output
@@ -21,6 +21,7 @@ extra_rdoc_files: []
 files:
 - lib/logeasy.rb
 - lib/logeasy/appender.rb
+- lib/logeasy/formatters.rb
 - lib/logeasy/level.rb
 - lib/logeasy/log.rb
 - lib/logeasy/logger.rb