log4ruby 0.0.4 → 0.0.5

data/lib/log4ruby/appender.rb

@@ -48,15 +48,17 @@ module Log4Ruby
       return if log[:level] < @level
 
       # Format the log item and emit it.
-      emit(@formatter.format(log))
+      string = @formatter.format(log)
+      emit(string, log)
     end
 
     private
 
     # Emits a log message to this appenders target.
     #
-    # @param [String] message the message to emit.
-    def emit(message)
+    # @param [String] string the message to emit.
+    # @param [Log4Ruby::Log] log the log item.
+    def emit(string, log)
     end
 
   end

data/lib/log4ruby/appenders/console_appender.rb

@@ -17,12 +17,68 @@ module Log4Ruby
     # @param [Hash] options configuration options. Supported keys are:
     #   :formatter - the formatter this appender should use. Uses the DefaultFormatter if not specified.
     #   :target - the target stream to use (:stdout or :stderr). Default is :stdout
+    #   :colorize - true to color the content printed to the console. Default is false.
     def initialize(level, options = {})
       target = get_option(options, :target, false, :stdout)
       raise ArgumentError.new("Invalid target '#{target}'. Must be either 'stdout' or 'stderr'.") unless TARGETS.has_key?(target)
 
       set_option(options, :stream, TARGETS[target], true)
       super(level, options)
+
+      @colorize = get_option(options, :colorize, false, false)
+      register_default_colors if @colorize
+    end
+
+    # Registers a color for a particular level. Does nothing if the colorize flag was false.
+    #
+    # @param [Log4Ruby::Level] level the level to register the color for.
+    # @param [Array] color_details the details of the color. An array with the attributes, foreground and background colours.
+    def register_color(level, color_details)
+      return if @colors.nil?
+      @colors[level] = color_details
+    end
+
+    private
+
+    # Registers the default set of colors.
+    def register_default_colors
+      @colors = {}
+      @colors[Log4Ruby::Level::TRACE] = [2, 30, nil]
+      @colors[Log4Ruby::Level::FINE] = [2, 30, nil]
+      @colors[Log4Ruby::Level::DEBUG] = [2, 30, nil]
+      @colors[Log4Ruby::Level::CONF] = [nil, 30, nil]
+      @colors[Log4Ruby::Level::INFO] = [nil, 30, nil]
+      @colors[Log4Ruby::Level::WARN] = [1, 30, nil]
+      @colors[Log4Ruby::Level::ERROR] = [1, 31, nil]
+      @colors[Log4Ruby::Level::FATAL] = [1, 31, nil]
+    end
+
+    # Colors the specified string.
+    #
+    # @param [String] string
+    # @param [Hash] options configuration hash.
+    #   :attributes - modifiers for the text.
+    #   :foreground - the color of the text.
+    #   :background - the color the background.
+    def color(string, options = {})
+      attributes = get_option(options, :attributes, false, nil)
+      foreground = get_option(options, :foreground, false, nil)
+      background = get_option(options, :background, false, nil)
+      # Color!
+      color_string = [attributes, foreground, background].compact.join(";")
+      string = "\e[#{color_string}m#{string}\e[0m" unless color_string.empty?
+      # Return colored string.
+      string
+    end
+
+    # Override to color output if needed.
+    def emit(string, log)
+      if @colorize
+        attributes, foreground, background = @colors[log[:level]]
+        string = color(string, :attributes => attributes, :foreground => foreground, :background => background)
+      end
+
+      super(string, log)
     end
 
   end

data/lib/log4ruby/appenders/file_appender.rb

@@ -107,14 +107,9 @@ module Log4Ruby
       # @stream is set to the latest file.
       latest_file
       # Create the emit method that will roll using the file date as the trigger.
-      class << self
-        self
-
-        # Override to roll using the date of the file.
-        def emit(message)
-          roll_using_date
-          super(message)
-        end
+      def self.emit(string, log)
+        roll_using_date
+        super
       end
     end
 
@@ -126,14 +121,9 @@ module Log4Ruby
       # @stream is set to the latest file.
       latest_file
       # Create the emit method that will roll using the file size as the trigger.
-      class << self
-        self
-
-        # Override to roll using the size of the file.
-        def emit(message)
-          roll_using_size
-          super(message)
-        end
+      def self.emit(string, log)
+        roll_using_size
+        super
       end
     end
 

data/lib/log4ruby/appenders/stream_appender.rb

@@ -54,10 +54,11 @@ module Log4Ruby
 
     # Writes the message to the underlying stream.
     #
-    # @param [String] message the message to write.
-    def emit(message)
+    # @param [String] string the message to write.
+    # @param [Log4Ruby::Log] log the log item.
+    def emit(string, log)
       emit_header if @emit_header
-      @stream.write(message)
+      @stream.write(string)
     end
 
   end

data/lib/log4ruby/level.rb

@@ -60,18 +60,46 @@ module Log4Ruby
       @weight = weight
     end
 
+    # Check if this level is equal to the specified other log level.
+    # Comparison is done using the weight attribute
+    #
+    # @param [Log4Ruby::Level] other the other level.
+    def ==(other)
+      self.weight == other.weight
+    end
+
     # Check if this level is less than the specified other log level.
     # Comparison is done using the weight attribute
+    #
+    # @param [Log4Ruby::Level] other the other level.
     def <(other)
       self.weight < other.weight
     end
 
     # Check if this level is less than or equal to the specified other log level.
     # Comparison is done using the weight attribute
+    #
+    # @param [Log4Ruby::Level] other the other level.
     def <=(other)
       self.weight <= other.weight
     end
 
+    # Check if this level is greater than the specified other log level.
+    # Comparison is done using the weight attribute
+    #
+    # @param [Log4Ruby::Level] other the other level.
+    def >(other)
+      self.weight > other.weight
+    end
+
+    # Check if this level is greater than or equal to the specified other log level.
+    # Comparison is done using the weight attribute
+    #
+    # @param [Log4Ruby::Level] other the other level.
+    def >=(other)
+      self.weight <= other.weight
+    end
+
     # Override to return the name of the level.
     #
     # @return [String] the level's name.

data/lib/log4ruby/version.rb

@@ -4,6 +4,6 @@
 
 module Log4Ruby
 
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 
 end

data/lib/sample.rb

@@ -14,7 +14,7 @@ formatter = Log4Ruby::PatternFormatter.new("[%s] %7s - %s : %s (%s)\n", [:timest
 formatter.add_parameter_formatter(:logger, Log4Ruby::ParameterFormatters.logger_formatter(1))
 formatter.add_parameter_formatter(:timestamp, Log4Ruby::ParameterFormatters.timestamp_formatter("%Y-%m-%d %H:%M:%S.%L"))
 # Console appender for printing to stdout.
-console_appender = Log4Ruby::ConsoleAppender.new(Log4Ruby::Level::ALL, :target => :stdout)
+console_appender = Log4Ruby::ConsoleAppender.new(Log4Ruby::Level::ALL, :target => :stdout, :colorize => true)
 # Rolling file appender
 file_appender = Log4Ruby::FileAppender.new(Log4Ruby::Level::ALL, :roll_type => :dont_roll,
                                            :directory => "../logs", :prefix => "TestLogger")

metadata

@@ -1,34 +1,48 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: log4ruby
-version: !ruby/object:Gem::Version
-  version: 0.0.4
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
 platform: ruby
-authors:
+authors: 
 - Suraj Vijayakumar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-07-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: options-arg
-  requirement: &7797456 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
         version: 0.0.1
   type: :runtime
-  prerelease: false
-  version_requirements: *7797456
+  version_requirements: *id001
 description: A logging system for Ruby applications inspired by Java's logging API.
-email:
+email: 
 - vijayakumar.suraj@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/log4ruby/appender.rb
 - lib/log4ruby/appenders/console_appender.rb
 - lib/log4ruby/appenders/file_appender.rb
@@ -46,26 +60,38 @@ files:
 - lib/sample.rb
 homepage: 
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 51
+      segments: 
+      - 1
+      - 9
+      - 0
       version: 1.9.0
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple and customizable logging system inspired by Java logging API.
 test_files: []
+