logeasy 0.0.7 → 0.0.8

data/lib/example/easylog.css

@@ -0,0 +1,39 @@
+/*
+    Simple css file for HTML logs.
+    While selecting a font, choose one that is mono-spaced.
+    Using white-space: pre; is strongly recommended since the log level is aligned using spaces.
+*/
+
+/* Recommend using a mono-spaced font. */
+body {
+    font-family: "Consolas", sans-serif;
+    font-size: 1em;
+}
+
+body.log {
+    font-size: 85%;
+}
+
+/* Recommended. Ensures that the log levels (and unformatted messages) are properly aligned. */
+span {
+    white-space: pre;
+}
+
+span.time {
+    font-family: "Courier New", sans-serif;
+}
+
+span.WARN {
+    background-color: #ff6600;
+    color: #ffffff;
+}
+
+span.ERROR {
+    background-color: #ff0000;
+    color: #ffffff;
+}
+
+span.FATAL {
+    background-color:#660000;
+    color: #ffffff;
+}

data/lib/example/example.rb

@@ -31,12 +31,14 @@ end
 
 file_appender_2 = LogEasy::FileAppender.new("easylog_example.log") # Simple file logger.
 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
+
+console_appender_1 = LogEasy::ConsoleAppender.new # Simple console appender.
+console_appender_1.formatter = custom_formatter
+
+file_appender_3 = LogEasy::HTMLFileAppender.new("easylog_example.html", "w", "easylog.css") # New HTML appender. Uses the STYLED_HTML_FORMATTER by default.
+
 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(console_appender_1) # Add the appenders to the root logger.
 root_logger.add_appender(file_appender_2)
 root_logger.add_appender(file_appender_3)
 
@@ -51,12 +53,16 @@ custom_logger.info("INFO message")
 custom_logger.warn("WARN message")
 custom_logger.error("ERROR message")
 custom_logger.fatal("FATAL message")
-custom_logger << "UNFORMATTED message"
+custom_logger << "UNFORMATTED message\nIt has multiple lines.\n\tAnd tabs.\nAnd <escaped> characters."
 
 # Adding a custom level.
 custom_level = LogEasy::Level.new("FINER", 500) # ALL < FINER < FINE
 custom_logger.log(custom_level, "Custom level message")
 
+# Turn off parent appenders.
+custom_logger.use_parent_logger = false
+custom_logger.error("Not sent to parent.")
+
 file_appender_1.close
 file_appender_2.close
 file_appender_3.close

data/lib/logeasy/appender.rb

@@ -80,18 +80,22 @@ module LogEasy
 
     attr_reader :file
     attr_reader :file_path
+    attr_reader :mode
 
     # Creates a new file appender.
-    # If the specified file already exists, it is overwritten.
-    def initialize(file_path)
+    # By default, existing files are overwritten. Use the mode argument to control this.
+    def initialize(file_path, mode = "w")
       super()
+
       @file_path = file_path
+      @mode = mode
+
       create_file
     end
 
     # Default create file will overwrite existing files.
     def create_file
-      @file = File.open(file_path, "w")
+      @file = File.open(file_path, mode)
     end
 
     # Writes the message to the file.
@@ -102,32 +106,29 @@ module LogEasy
 
   end
 
-  # 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")
-    end
-
-  end
-
+  # A simple HTML file appender.
   class HTMLFileAppender < FileAppender
 
     # Close the file.
     def close
-      @file.puts("</body>")
-      @file.puts("</html>")
+      file.puts("</body>")
+      file.puts("\n</html>")
+
       # Close the file.
       super
     end
 
-    # Override do_log to add a line feed to the end of an unformatted message.
+    # Write this log item. Since this is an HTML appender, even unformatted logs are sent to the formatter.
+    # If this appender's level is higher than the log item's level, this method will return immediately.
+    #
+    # 'log_item' - The log to write.
     def do_log(log_item)
-      log_item.message += "<br />" if log_item.unformatted
-      super
+      return if log_item.level < min_level
+      # Escape characters before formatting it.
+      escape(log_item)
+      # Format the message and log it.
+      message = formatter.call(log_item)
+      write(message)
     end
 
     private
@@ -135,20 +136,38 @@ module LogEasy
     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")
+    # STYLED_HTML_FORMATTER is the default formatter.
+    #
+    # By default the style sheet referenced is named log.css. Use the external_css argument to control this.
+    # By default existing files are overwritten. Use the mode argument to control this.
+    def initialize(file_path, mode = "w", external_css = "log.css")
       @external_css = external_css
       # Create the appender.
-      super(file_path)
+      super(file_path, mode)
+      # The default formatter is the Styled HTML Formatter.
+      self.formatter = Formatters::STYLED_HTML_FORMATTER
     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>")
+      # Create the file.
+      super
+
+      file.puts("<html>")
+      file.puts("<head><link rel=\"stylesheet\" href=\"#{external_css}\"></head>")
+      file.puts("\n<body class=\"log\">")
+    end
+
+    # Escapes all '<' and '>' characters.
+    def escape(log_item)
+      log_item.message = log_item.message.gsub(/<|>/) do |match|
+        case match
+          when "<"
+            next "&lt;"
+          when ">"
+            next "&gt;"
+        end
+      end
     end
 
   end

data/lib/logeasy/formatters.rb

@@ -3,6 +3,8 @@
 # 24-02-2011
 #
 
+require "logeasy/level"
+
 module LogEasy
 
   # Pre-defined formatter procs.
@@ -39,14 +41,20 @@ module LogEasy
     # 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.
+    #
+    # Unformatted messages are wrapped in a <span class="UNF"> tag, irrespective of the level they were logged at.
     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 />"
+      if log_item.unformatted
+        level_str = Level::UNFORMATTED.to_s
+        "<span class=\"#{level_str}\">#{log_item.message}</span><br />"
+      else
+        level_str = log_item.level.to_s
+        logger_name = "<span class=\"logger\">(#{log_item.logger.name})</span>"
+        level = "<span class=\"level\">#{("%-5s" % level_str)}</span>"
+        message = "<span class=\"message\">#{log_item.message}</span>"
+        timestamp = "<span class=\"time\">[#{log_item.timestamp.strftime(LOG_TIMESTAMP)}]</span>"
+        "<span class=\"#{level_str}\">#{timestamp} #{level} -- #{logger_name} #{message}</span><br />"
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logeasy
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-24 00:00:00.000000000 +05:30
+date: 2011-02-26 00:00:00.000000000 +05:30
 default_executable: 
 dependencies: []
 description: Hierarchical logger for Ruby. The loggers are arranged in a tree. Output
@@ -26,6 +26,7 @@ files:
 - lib/logeasy/log.rb
 - lib/logeasy/logger.rb
 - lib/example/example.rb
+- lib/example/easylog.css
 has_rdoc: true
 homepage: http://rubyforge.org/projects/logeasy/
 licenses: []