TwP-logging 0.9.7

data/History.txt

@@ -0,0 +1,169 @@
+== 0.9.7 / 2009-02-
+
+1 bug fix
+  - Handling objects that cannot be dumped via YAML [Tim Galeckas]
+
+== 0.9.6 / 2009-02-02
+
+2 minor enhancements
+  - Ruby 1.9.1 compatability
+  - JRuby 1.1.5 compatability
+
+== 0.9.5 / 2009-01-25
+
+2 minor enhancements
+  - The pattern layout can output the current thread name
+    if set using Thread.current[:name]         [valodzka]
+  - Added buffered logging to all IO based loggers
+    (console, file, rolling file)
+1 bug fix
+  - Uncaught TimeoutError in the e-mail appender
+
+== 0.9.4 / 2008-10-04
+
+2 minor enhancements
+  - Flag to suppress exception backtraces from being logged
+  - Cleaning up color codes on Growl output
+4 bug fixes
+  - Child loggers were not being found in some cases
+  - RollingFileAppender fails to reopen the log file if
+    the log file is deleted.
+  - Fixed a copy/paste error in the YAML configurator
+  - Bug in the configurator where a nil object was being used
+
+== 0.9.3 / 2008-09-12
+
+2 minor enhancement
+  - Added a class for tracking basic statistics
+  - Will use the 'fastthread' gem if availble
+
+== 0.9.2 / 2008-09-03
+
+2 bug fixes
+  - Properly generates logger names for anonymous classes and
+    modules and meta-classes
+  - Fixed the rescue clause when 'turn' cannot be required
+
+== 0.9.1 / 2008-08-14
+
+1 minor enhancement
+  - added a method to show the logging configuration
+2 bug fixes
+  - checking for sync method on the IO streams before calling
+  - fixed the internal logging levels
+
+== 0.9.0 / 2008-07-16
+
+2 minor enhancement
+  - Exceptions from appenders are captured and logged
+  - Internal logger for the Logging framework (disabled by default)
+  - Added a DSL configuration format (more readable than YAML)
+1 bug fix
+  - Modules could not have their own logger instance
+
+== 0.8.0 / 2008-07-02
+
+1 minor enhancement
+  - Setting the log level of a parent will cause this level to
+    be propagated to the children
+1 bug fix
+  - Fixed error with the e-mail appender and missing hostname
+
+== 0.7.1 / 2008-02-25
+
+1 minor enhancement
+  - Removed dependency on the Lockfile gem (brought the ruby
+    file into the logging/stelan directory)
+1 bug fix
+  - Fixed bug with age based rolling: was not multi-process safe
+
+== 0.7.0 / 2008-02-12
+
+1 major enhancement
+  - Rails compatibility
+    * renamed Logger#add method to Logger#add_appenders
+    * renamed Logger#remove method to Logger#remove_appenders
+    * renamed Logger#clear method to Logger#clear_appenders
+    * added a new Logger#add method that conforms to the calling
+      semantics of the Ruby stdlib Logger 
+
+2 minor enhancements
+  - Speed improvements and test coverage
+  - Created a top-level Logging.init method that is used to
+    define the default logging levels
+
+1 bug fix
+  - Tweaked windows detection code
+
+== 0.6.3 / 2008-02-08
+
+2 minor enhancements
+  - YAML configuration now supports multiple keys -- i.e. development
+    or production or whatever
+  - Reorganized a lot of files so that requiring files is cleaner and
+    more deterministic
+
+== 0.6.2 / 2008-02-06
+
+2 bug fixes
+  - An extra e-mail was being pushed out when the e-mail
+    appender was closed
+  - Created an at_exit handler to close all appenders
+
+== 0.6.1 / 2008-01-01
+
+1 bug fix
+  - Fixed include order to avoid double loading when testing
+
+== 0.6.0 / 2007-12-26
+
+* Using the new 'getopt' method for handling option hashes
+* Rolling file appender is safe for multiple processes
+* Added an e-mail appender from Jeremy Hinegardner
+* Updated tests for the appenders
+
+== 0.5.3 / 2007-12-08
+
+* Fixed the quoting for messages sent to the growl appender
+
+== 0.5.2 / 2007-11-28
+
+* Updated the library to work with Ruby 1.9
+* Fixed coalescing with the growl appender
+
+== 0.5.1 / 2007-11-18
+
+* Fixed a bug on Windows when attempting to load the syslog library
+
+== 0.5.0 / 2007-11-18
+
+* Added the ability to log via the syslog daemon
+* Can send messages to the Growl notification system on Mac OS X
+* The Growl appender can coalesce messages of the same title/priority
+
+== 0.4.0 / 2007-03-21
+
+* Added a microsecond flag to the Pattern layout
+* All appenders write immediately upon receipt of a logging event
+* Added a basic logging method that returns a logger object configured in
+  the same manner as the standard Ruby logger
+* Fixed a bug caused by nil log messages
+
+== 0.3.1 / 2007-02-08
+
+* Bugfix Release
+
+== 0.3.0 / 2007-02-01
+
+* Remove the ability to log multiple objects from a single log method call
+
+== 0.2.0 / 2007-01-29
+
+* The "once every four years" release
+* Storage and retrieval of appenders by name
+* YAML configuration support
+* Rolling file appender
+
+== 0.1.0 / 2007-01-12
+
+* Birthday!

data/README.rdoc

@@ -0,0 +1,102 @@
+Logging
+    by Tim Pease
+
+* {Homepage}[http://logging.rubyforge.org/]
+* {Rubyforge Project}[http://rubyforge.org/projects/logging]
+* email tim dot pease at gmail dot com
+
+== DESCRIPTION
+
+Logging is a flexible logging library for use in Ruby programs based on the
+design of Java's log4j library. It features a hierarchical logging system,
+custom level names, multiple output destinations per log event, custom
+formatting, and more.
+
+== INSTALL
+
+   sudo gem install logging
+
+== EXAMPLE
+
+This example configures a logger to output messages in a format similar to the
+core ruby Logger class. Only log messages that are warnings or higher will be
+logged.
+
+   require 'logging'
+
+   logger = Logging.logger(STDOUT)
+   logger.level = :warn
+
+   logger.debug "this debug message will not be output by the logger"
+   logger.warn "this is your last warning"
+
+In this example, a single logger is crated that will append to STDOUT and to a
+file. Only log messages that are informational or higher will be logged.
+
+   require 'logging'
+
+   logger = Logging::Logger['example_logger']
+   logger.add_appenders(
+       Logging::Appender.stdout,
+       Logging::Appenders::File.new('example.log')
+   )
+   logger.level = :info
+
+   logger.debug "this debug message will not be output by the logger"
+   logger.info "just some friendly advice"
+
+The Logging library was created to allow each class in a program to have its
+own configurable logger. The logging level for a particular class can be
+changed independently of all other loggers in the system. This example shows
+the recommended way of accomplishing this.
+
+   require 'logging'
+
+   Logging::Logger['FirstClass'].level = :warn
+   Logging::Logger['SecondClass'].level = :debug
+
+   class FirstClass
+     def initialize
+       @log = Logging::Logger[self]
+     end
+
+     def some_method
+       @log.debug "some method was called on #{self.inspect}"
+     end
+   end
+
+   class SecondClass
+     def initialize
+       @log = Logging::Logger[self]
+     end
+
+     def another_method
+       @log.debug "another method was called on #{self.inspect}"
+     end
+   end
+
+== NOTES
+
+Although Logging is intended to supersede Log4r, it is not a one-to-one
+replacement for the Log4r library. Most notably is the difference in namespaces
+-- Logging vs. Log4r. Other differences include renaming Log4r::Outputter to
+Logging::Appender and renaming Log4r::Formatter to Logging::Layout. These
+changes were meant to bring the Logging class names more in line with the Log4j
+class names.
+
+== REQUIREMENTS
+
+Logging requires the "lockfile" gem to run and the "flexmock" gem to run the
+tests"
+
+== DEVELOPMENT REQUIREMENTS
+
+The Logging source code relies on the Mr Bones project for default rake tasks.
+You will need to install the Mr Bones gem if you want to build or test the
+logging gem.
+
+   gem install bones
+
+== LICENSE
+
+Ruby

data/Rakefile

@@ -0,0 +1,42 @@
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'logging'
+
+task :default => 'test:run'
+
+PROJ.name = 'logging'
+PROJ.summary = 'A flexible and extendable logging library for Ruby'
+PROJ.authors = 'Tim Pease'
+PROJ.email = 'tim.pease@gmail.com'
+PROJ.url = 'http://logging.rubyforge.org/'
+PROJ.rubyforge.name = 'logging'
+PROJ.version = Logging::VERSION
+PROJ.readme_file = 'README.rdoc'
+PROJ.ignore_file = '.gitignore'
+
+PROJ.exclude << %w[^tags$]
+PROJ.rdoc.exclude << '^data'
+#PROJ.rdoc.dir = 'doc/rdoc'
+#PROJ.rdoc.remote_dir = 'rdoc'
+PROJ.rdoc.dir = 'doc'
+PROJ.rdoc.remote_dir = ''
+
+PROJ.ann.email[:server] = 'smtp.gmail.com'
+PROJ.ann.email[:port] = 587
+PROJ.ann.email[:from] = 'Tim Pease'
+
+depend_on 'flexmock'
+depend_on 'lockfile'
+
+# EOF

data/data/bad_logging_1.rb

@@ -0,0 +1,13 @@
+
+Logging.configure {
+
+  logger(:root) {
+    level      :info
+    appenders  'bad'
+  }
+
+  appender('bad') {
+    type 'FooBar'
+  }
+
+}  # logging configuration

data/data/bad_logging_2.rb

@@ -0,0 +1,21 @@
+
+Logging.configure {
+
+  logger(:root) {
+    level      :info
+    appenders  'logfile'
+  }
+
+  appender('logfile') {
+    type      'File'
+    level     'DEB'
+    filename  'tmp/temp.log'
+    truncate  true
+    layout {
+      type         'BadLayout'
+      date_method  'to_s'
+      pattern      '[%d] %l  %c : %m\n'
+    }
+  }
+
+}  # logging configuration

data/data/logging.rb

@@ -0,0 +1,42 @@
+
+Logging.configure {
+
+  pre_config {
+    levels      %w[DEB INF PRT WRN ERR FAT]
+    format_as  :inspect
+  }
+
+  logger('A::B::C') {
+    level      'DEB'
+    additive   false
+    trace      false
+    appenders  %w[stderr logfile]
+  }
+
+  logger('yourlogger') {
+    level      'INF'
+    appenders  %w[stderr logfile]
+  }
+
+  appender('stderr') {
+    type   'Stderr'
+    level  'DEB'
+    layout {
+      type       'Basic'
+      format_as  :string
+    }
+  }
+
+  appender('logfile') {
+    type      'File'
+    level     'DEB'
+    filename  'tmp/temp.log'
+    truncate  true
+    layout {
+      type         'Pattern'
+      date_method  'to_s'
+      pattern      '[%d] %l  %c : %m\n'
+    }
+  }
+
+}  # logging configuration

data/data/logging.yaml

@@ -0,0 +1,63 @@
+
+purpose    : TestA
+description: This is the 1st YAML doc
+say        : Hi
+
+---
+# *** YAML2LOGGING ***
+logging_config:
+  # define all pre config ...
+  pre_config:
+    define_levels:
+      - DEB
+      - INF
+      - PRT
+      - WRN
+      - ERR
+      - FAT
+    format_as   : inspect
+    root:
+      level     : WRN
+
+  # define all loggers ...
+  loggers:
+    - name      : mylogger
+      level     : DEB
+      additive  : false
+      trace     : false      
+      appenders:
+        - stderr
+        - logfile 
+
+    - name      : yourlogger
+      level     : INF 
+      appenders: 
+        - stderr
+        - logfile 
+
+  # define all appenders (incl. layouts)      
+  appenders:
+    - type          : Stderr
+      name          : stderr 
+      level         : DEB
+      layout:
+        type        : Basic
+        format_as   : string
+
+    - type          : File
+      name          : logfile
+      level         : DEB
+      filename      : 'tmp/temp.log'
+      truncate      : true
+      layout:
+        type        : Pattern
+        date_method : to_s
+        pattern     : '[%d] %l  %c : %m\n'
+  
+---
+purpose    : TestB
+description: This is the last YAML doc
+say        : Bye
+
+
+# EOF