logback 0.9.15.1 → 0.9.15.2

data/History.txt

@@ -1,24 +1,23 @@
-=== 0.9.15.1 / 2009-02-15
+=== 0.9.15.2 (2009-5-8)
+* Added Logback.config_console({}) convenience config method.
+* Use rdoc 2.4.3 and hoe 1.12.2 for build, and general rdoc
+  improvements.
 
+=== 0.9.15.1 (2009-2-15)
 * Upgraded to Logback 0.9.15
-* Fixed fuzzy slf4j dependency as "~> 1.5.6.1" 
-
-=== 0.9.14.1 / 2009-01-04
+* Fixed fuzzy slf4j dependency as "~> 1.5.6.1"
 
+=== 0.9.14.1 (2009-1-4)
 * Upgraded to Logback 0.9.14
 
-=== 0.9.13.1 / 2008-12-06
-
+=== 0.9.13.1 (2008-12-6)
 * Upgraded to Logback 0.9.13
 * Updated SLF4J dependency to ~> 1.5.6
-* LogbackBase -rename-> Logback 
-
-=== 0.9.11.1 / 2008-11-01
+* LogbackBase -rename-> Logback
 
+=== 0.9.11.1 (2008-11-1)
 * Upgraded to Logback 0.9.11
-* Updated SLF4J dependency to ~> 1.5.5 
-
-=== 0.9.9.1 / 2008-10-08
+* Updated SLF4J dependency to ~> 1.5.5
 
+=== 0.9.9.1 (2008-10-8)
 * Initial release based on Logback 0.9.9
-

data/README.txt

@@ -14,11 +14,11 @@ packaged in the slf4j gem.
 
 === Logback Ruby
 
-Copyright (C) 2008-2009 David Kellum
+Copyright (c) 2008-2009 David Kellum
 
 Logback Ruby is free software: you can redistribute it and/or
-modify it under the terms of the 
-{GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html] 
+modify it under the terms of the
+{GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html]
 as published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.
 
@@ -29,9 +29,9 @@ Lesser General Public License for more details.
 
 === Logback Java
 
-Logback: the reliable, generic, fast and flexible logging library for Java.  
+Logback: the reliable, generic, fast and flexible logging library for Java.
 
-Copyright (C) 2000-2008, QOS.ch
+Copyright (c) 2000-2008, QOS.ch
 
 This library is free software, you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as

data/Rakefile

@@ -1,10 +1,10 @@
 # -*- ruby -*-
 #--
-# Copyright (C) 2008 David Kellum
+# Copyright (C) 2008-2009 David Kellum
 #
 # Logback Ruby is free software: you can redistribute it and/or
-# modify it under the terms of the 
-# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html] 
+# modify it under the terms of the
+# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html]
 # as published by the Free Software Foundation, either version 3 of the
 # License, or (at your option) any later version.
 #
@@ -22,14 +22,14 @@ require 'hoe'
 $LOAD_PATH << './lib'
 require 'logback/base'
 
-JARS = %w{ core classic access }.map do |n| 
+JARS = %w{ core classic access }.map do |n|
   "logback-#{n}-#{ Logback::LOGBACK_VERSION }.jar"
 end
 JAR_FILES = JARS.map { |jar| "lib/logback/#{jar}" }
 
 desc "Update the Manifest with actual jars"
 task :manifest do
-  out = File.new( 'Manifest.txt', 'w' ) 
+  out = File.new( 'Manifest.txt', 'w' )
   begin
     out.write <<END
 History.txt
@@ -67,7 +67,7 @@ task :mvn_clean do
   rm_f( JAR_FILES )
   sh( 'mvn clean' )
 end
-task :clean => :mvn_clean 
+task :clean => :mvn_clean
 
 task :tag do
   tag = "logback-#{Logback::VERSION}"
@@ -86,5 +86,4 @@ hoe = Hoe.new( "logback", Logback::VERSION ) do |p|
   p.developer( "David Kellum", "dek-ruby@gravitext.com" )
   p.extra_deps << [ 'slf4j', '~> 1.5.6.1' ]
   p.rubyforge_name = "rjack"
-  p.rdoc_pattern = /^(lib.*\.(rb|txt))|[^\/]*\.txt$/
 end

data/lib/logback.rb

@@ -1,9 +1,9 @@
 #--
-# Copyright (C) 2008 David Kellum
+# Copyright (C) 2008-2009 David Kellum
 #
 # Logback Ruby is free software: you can redistribute it and/or
-# modify it under the terms of the 
-# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html] 
+# modify it under the terms of the
+# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html]
 # as published by the Free Software Foundation, either version 3 of the
 # License, or (at your option) any later version.
 #
@@ -19,14 +19,20 @@ require 'slf4j'
 
 require 'logback/base'
 
-# Jruby wrapper module for the Logback[http://logback.qos.ch/] log writer.  
+# Jruby wrapper module for the Logback[http://logback.qos.ch/] log writer.
 # Programmatic configuration and setting of logger output levels is supported.
 #
-# == Example
+# == Examples
 #
-# Logback configuration:
+# === High level configuration
 #
-#   require 'slf4j' 
+#   require 'logback'
+#
+#   Logback.config_console( :thread => true, :level => Logback:INFO )
+#
+# === Low level configuration
+#
+#   require 'slf4j'
 #   require 'logback'
 #
 #   log = SLF4J[ 'example' ]
@@ -38,7 +44,7 @@ require 'logback/base'
 #       a.layout = Logback::PatternLayout.new do |p|
 #         p.pattern = "%r %-5level %logger{35} - %msg %ex%n"
 #       end
-#     end 
+#     end
 #     Logback.root.add_appender( console )
 #     Logback.root.level = Logback::INFO
 #   end
@@ -48,7 +54,7 @@ require 'logback/base'
 #
 #   log.debug "...after reconfigure."
 #
-# Configure with Logback XML configuration: 
+# Configure with Logback XML configuration:
 #
 #   Logback.configure do
 #     Logback.load_xml_config( 'sample-logback.xml' )
@@ -69,11 +75,12 @@ require 'logback/base'
 # +start+.  Logback provides many other components not yet extended in
 # this way.  These can be created directly and or extended in a
 # similar fashion externally.  Consider providing a patch to the
-# jrack[http://rubyforge.org/projects/rjack] project with any desired
+# rjack[http://rubyforge.org/projects/rjack] project with desired
 # extensions.
 #
 module Logback
 
+  # Load logback jar.
   def self.require_jar( name )
     require File.join( LOGBACK_DIR, "#{name}-#{ LOGBACK_VERSION }.jar" )
   end
@@ -81,43 +88,61 @@ module Logback
   require_jar 'logback-core'
   require_jar 'logback-classic'
 
-  import 'ch.qos.logback.classic.Level'
+  # ch.qos.logback.classic.Level
+  Level = Java::ch.qos.logback.classic.Level
 
+  # Level::TRACE
   TRACE = Level::TRACE
+
+  # Level::DEBUG
   DEBUG = Level::DEBUG
-  INFO  = Level::INFO 
-  WARN  = Level::WARN  
+
+  # Level::INFO
+  INFO  = Level::INFO
+
+  # Level::WARN
+  WARN  = Level::WARN
+
+  # Level::ERROR
   ERROR = Level::ERROR
 
-  DEFAULT_PATTERN = "%date [%thread] %-5level %logger{35} - %msg %ex%n"
+  DEFAULT_PATTERN = "%date [%thread] %-5level %logger{35} - %msg %ex%n" #:nodoc:
 
   @@context = SLF4J.linked_factory
 
-  # Returns the LoggerContext 
+  # Returns the LoggerContext
   def self.context
-    @@context 
+    @@context
   end
 
+  # Utility mixin of Logback ch.qos.logback.core.spi.LifeCycle instances
   module Util
+    # Start, raise if not started
     def self.start( lifecycle_obj )
       lifecycle_obj.start
       raise "#{lifecycle_obj.class.name} did not start" if ! lifecycle_obj.started?
     end
-  end 
+  end
 
-  # Wrapper for 
+  # Wrapper for
   # ch.qos.logback.classic.Logger[http://logback.qos.ch/apidocs/ch/qos/logback/classic/Logger.html]
   class Logger
+
+    # Initialize given ch.qos.logback.classic.Logger
     def initialize( jlogger )
       @jlogger = jlogger
     end
 
-    # Set output level to specified constant (DEBUG,INFO,...)
+    # Set output level
+    # ==== Parameters
+    # :level<Level>:: New output Level.
     def level=( level )
       @jlogger.level = level
     end
 
     # Add appender to this logger
+    # ==== Parameters
+    # :appender<ch.qos.logback.core.Appender>:: Appender
     def add_appender( appender )
       @jlogger.add_appender( appender )
     end
@@ -127,8 +152,9 @@ module Logback
       @jlogger.additive = is_additive
     end
   end
-  
-  import 'ch.qos.logback.classic.joran.JoranConfigurator'
+
+  # ch.qos.logback.classic.joran.JoranConfigurator
+  JoranConfigurator = Java::ch.qos.logback.classic.joran.JoranConfigurator
 
   # Load the specified Logback (Joran) XML configuration file. Should be
   # called within a configure {...} block.
@@ -138,19 +164,15 @@ module Logback
     cfger.doConfigure( file )
   end
 
-  import( 'ch.qos.logback.classic.PatternLayout' ) { 'JPatternLayout' }
+  # ch.qos.logback.classic.PatternLayout
+  JPatternLayout = Java::ch.qos.logback.classic.PatternLayout
 
-  # Extends 
-  # ch.qos.logback.classic.PatternLayout[http://logback.qos.ch/apidocs/ch/qos/logback/access/PatternLayout.html] 
-  # with a block initializer. 
+  # Extends
+  # ch.qos.logback.classic.PatternLayout[http://logback.qos.ch/apidocs/ch/qos/logback/access/PatternLayout.html]
+  # with a block initializer.
   class PatternLayout < JPatternLayout
 
     # Sets context and pattern, yields self to block, and calls self.start
-    #
-    # :call-seq:
-    #   new(pattern=DEFAULT_PATTERN)                -> PatternLayout
-    #   new(pattern=DEFAULT_PATTERN) { |self| ... } -> PatternLayout
-    #
     def initialize( pattern=DEFAULT_PATTERN )
       super()
       self.context = Logback.context
@@ -160,48 +182,48 @@ module Logback
     end
   end
 
+  # Utility implementation mixin for Appenders.
   module AppenderUtil
     @@default_layout = Logback::PatternLayout.new
 
+    # Set appender defaults.
     def set_defaults
       self.context = Logback.context
       self.name = self.class.name
       self.layout = @@default_layout
     end
-    
+
+    # Yield to block, then start.
     def finish( &block )
       block.call( self ) unless block.nil?
       Util.start( self )
     end
   end
 
-  import( 'ch.qos.logback.core.ConsoleAppender' ) { 'JConsoleAppender' }
+  # ch.qos.logback.core.ConsoleAppender
+  JConsoleAppender = Java::ch.qos.logback.core.ConsoleAppender
 
-  # Extends 
+  # Extends
   # ch.qos.logback.core.ConsoleAppender[http://logback.qos.ch/apidocs/ch/qos/logback/core/ConsoleAppender.html]
-  # with a block initializer. 
+  # with a block initializer.
   class ConsoleAppender < JConsoleAppender
     include AppenderUtil
-    
+
     # Sets context, default name and layout, yields self to block, and
     # calls self.start
-    #
-    # :call-seq:
-    #   new()                -> ConsoleAppender
-    #   new() { |self| ... } -> ConsoleAppender
-    #
     def initialize( &block )
       super()
       set_defaults
       finish( &block )
     end
   end
-  
-  import( 'ch.qos.logback.core.FileAppender' ) { 'JFileAppender' }
 
-  # Extends 
+  # ch.qos.logback.core.FileAppender
+  JFileAppender = Java::ch.qos.logback.core.FileAppender
+
+  # Extends
   # ch.qos.logback.core.FileAppender[http://logback.qos.ch/apidocs/ch/qos/logback/core/FileAppender.html]
-  # with a block initializer. 
+  # with a block initializer.
   #
   # Note that if buffered (immediate_flush = false, buffer_size > 0),
   # you will need to +stop+ the appender before exiting in order to
@@ -215,38 +237,55 @@ module Logback
     include AppenderUtil
 
     # Sets defaults, yields self to block, and calls self.start
-    #
-    # :call-seq:
-    #   new(file_name,append = true)                -> FileAppender
-    #   new(file_name,append = true) { |self| ... } -> FileAppender
-    #
     def initialize( file_name, append = true, &block )
       super()
       set_defaults
       self.file = file_name
       self.append = append
       self.immediate_flush = true #default
-      self.encoding = "UTF-8"  
+      self.encoding = "UTF-8"
       finish( &block )
     end
   end
 
   # Configure Logback with the specified block. The Logback context is
-  # +reset+ before yielding, and then started after return
+  # +reset+, yielded to block, and then started after return
   # from the block.
-  #
-  # :call-seq:
-  #   configure { |context| ... } -> nil
-  #
   def self.configure
     @@context.reset
 
-    yield( context )
+    yield context
 
     Util.start( context )
     nil
   end
 
+  # Configure a single ConsoleAppender using options hash.
+  # ==== Options
+  # :stderr:: Output to standard error? (default: false)
+  # :full:: Output full date? (default: false, milliseconds)
+  # :thread:: Output thread name? (default: false)
+  # :level<Level>:: Set root level (default: INFO)
+  # :lwidth<~to_s>:: Logger width (default: :full ? 35 : 30)
+  def self.config_console( options = {} )
+    configure do
+      console = Logback::ConsoleAppender.new do |a|
+        a.target = "System.err" if options[ :stderr ]
+        a.layout = Logback::PatternLayout.new do |layout|
+          pat = [ options[ :full ] ? '%date' : '%-4r' ]
+          pat << '[%thread]' if options[ :thread ]
+          pat << '%-5level'
+          w = ( options[ :lwidth ] || ( options[ :full ] ? 35 : 30 ) )
+          pat << "%logger{#{w}}"
+          pat += [ '-', '%msg' '%ex%n' ]
+          layout.pattern = pat.join( ' ' )
+        end
+      end
+      Logback.root.add_appender( console )
+      Logback.root.level = options[ :level ] || INFO
+    end
+  end
+
   # Returns the named Logger
   def self.logger( name )
     Logger.new( @@context.getLogger( name ) )

data/lib/logback/base.rb

@@ -2,8 +2,8 @@
 # Copyright (C) 2008 David Kellum
 #
 # Logback Ruby is free software: you can redistribute it and/or
-# modify it under the terms of the 
-# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html] 
+# modify it under the terms of the
+# {GNU Lesser General Public License}[http://www.gnu.org/licenses/lgpl.html]
 # as published by the Free Software Foundation, either version 3 of the
 # License, or (at your option) any later version.
 #
@@ -14,8 +14,11 @@
 #++
 
 module Logback
+  # Logback java version
   LOGBACK_VERSION = '0.9.15'
-  VERSION = LOGBACK_VERSION + '.1'
+
+  # Logback gem version
+  VERSION = LOGBACK_VERSION + '.2'
 
   LOGBACK_DIR = File.dirname(__FILE__) # :nodoc:
 end

metadata

@@ -58,12 +58,12 @@ requirements: []
 
 authors: 
 - David Kellum
-date: 2009-02-15 08:00:00 +00:00
+date: 2009-05-08 08:00:00 +00:00
 platform: ruby
 test_files: 
 - test/test_logback.rb
 version: !ruby/object:Gem::Version 
-  version: 0.9.15.1
+  version: 0.9.15.2
 require_paths: 
 - lib
 dependencies: 
@@ -82,7 +82,7 @@ dependencies:
     requirements: 
     - - '>='
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.12.2
     version: 
   type: :development
   version_requirement: