RubyGems - sml-log4r - Versions diffs - 1.0.6 - Mend

sml-log4r 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

data/doc/content/contact.html +22 -0
data/doc/content/contribute.html +21 -0
data/doc/content/index.html +90 -0
data/doc/content/license.html +56 -0
data/doc/content/manual.html +449 -0
data/doc/dev/README.developers +40 -0
data/doc/dev/checklist +14 -0
data/doc/dev/things-to-do +2 -0
data/doc/images/crush/logo2.png +0 -0
data/doc/images/log4r-logo.png +0 -0
data/doc/images/logo2.png +0 -0
data/doc/log4r.css +111 -0
data/doc/old/manual.html +348 -0
data/doc/templates/main.html +147 -0
data/examples/README +19 -0
data/examples/customlevels.rb +34 -0
data/examples/fileroll.rb +40 -0
data/examples/log4r_yaml.yaml +0 -0
data/examples/logclient.rb +25 -0
data/examples/logserver.rb +18 -0
data/examples/moderate.xml +29 -0
data/examples/moderateconfig.rb +66 -0
data/examples/myformatter.rb +23 -0
data/examples/outofthebox.rb +21 -0
data/examples/rrconfig.xml +63 -0
data/examples/rrsetup.rb +42 -0
data/examples/simpleconfig.rb +39 -0
data/examples/xmlconfig.rb +25 -0
data/examples/yaml.rb +30 -0
data/src/log4r.rb +17 -0
data/src/log4r/base.rb +74 -0
data/src/log4r/config.rb +9 -0
data/src/log4r/configurator.rb +224 -0
data/src/log4r/formatter/formatter.rb +105 -0
data/src/log4r/formatter/patternformatter.rb +108 -0
data/src/log4r/lib/drbloader.rb +52 -0
data/src/log4r/lib/xmlloader.rb +24 -0
data/src/log4r/logevent.rb +28 -0
data/src/log4r/logger.rb +194 -0
data/src/log4r/loggerfactory.rb +89 -0
data/src/log4r/logserver.rb +28 -0
data/src/log4r/outputter/consoleoutputters.rb +18 -0
data/src/log4r/outputter/datefileoutputter.rb +110 -0
data/src/log4r/outputter/emailoutputter.rb +115 -0
data/src/log4r/outputter/fileoutputter.rb +49 -0
data/src/log4r/outputter/iooutputter.rb +55 -0
data/src/log4r/outputter/outputter.rb +132 -0
data/src/log4r/outputter/outputterfactory.rb +59 -0
data/src/log4r/outputter/remoteoutputter.rb +40 -0
data/src/log4r/outputter/rollingfileoutputter.rb +126 -0
data/src/log4r/outputter/staticoutputter.rb +30 -0
data/src/log4r/outputter/syslogoutputter.rb +75 -0
data/src/log4r/rdoc/configurator +243 -0
data/src/log4r/rdoc/emailoutputter +103 -0
data/src/log4r/rdoc/formatter +39 -0
data/src/log4r/rdoc/log4r +89 -0
data/src/log4r/rdoc/logger +175 -0
data/src/log4r/rdoc/logserver +85 -0
data/src/log4r/rdoc/outputter +108 -0
data/src/log4r/rdoc/patternformatter +128 -0
data/src/log4r/rdoc/syslogoutputter +29 -0
data/src/log4r/rdoc/yamlconfigurator +20 -0
data/src/log4r/repository.rb +65 -0
data/src/log4r/staticlogger.rb +49 -0
data/src/log4r/yamlconfigurator.rb +0 -0
data/tests/include.rb +7 -0
data/tests/runtest.rb +6 -0
data/tests/testbase.rb +45 -0
data/tests/testcustom.rb +33 -0
data/tests/testdefault.rb +25 -0
data/tests/testformatter.rb +29 -0
data/tests/testlogger.rb +198 -0
data/tests/testoutputter.rb +112 -0
data/tests/testpatternformatter.rb +26 -0
data/tests/testxmlconf.rb +51 -0
data/tests/xml/testconf.xml +37 -0
metadata +140 -0

data/doc/templates/main.html ADDED

@@ -0,0 +1,147 @@
+<html>
+<head>
+  <!-- TITLE -->
+  <link rel="stylesheet" type="text/css" href="log4r.css">
+</head>
+<body>
+<div align="right"><img src="images/log4r-logo.png"/></div>
+<hr noshade>
+<table border="0" cellspacing="3" cellpadding="0" width="100%">
+<tr>
+<!-- Sidebar -->
+<td width="15%" valign="top">
+<table cellspacing="0" cellpadding="0" width=100%" nowrap="true">
+<!-- Log4r Box -->
+<tr><td >
+<table width="100%" cellspacing="0" cellpadding="0" align="center" >
+<tr><td width="100%" class="menutitle">Log4r</td></tr>
+<tr><td width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td ><a href="index.html">Home Page</a></tr></td>
+<tr><td><a href="http://sourceforge.net/project/showfiles.php?group_id=43396">
+Download</a></td></tr>
+<tr><td nowrap="true">
+<a href="http://sourceforge.net/projects/log4r/">@ SourceForge</a>
+</td></tr>
+<tr><td>
+<a href="license.html">License</a>
+</td></tr>
+<tr><td>
+<a href="contact.html">Contact</a>
+</td></tr>
+</table>
+</td></tr>
+<tr><td height=15>&nbsp;</td></tr>
+<!-- Doc Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Documents</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+    <a href="manual.html">#{version} Manual</a>
+</tr></tr>
+<tr><td>
+    <a href="rdoc/index.html">#{version} RDoc API</a>
+</td></tr>
+</table>
+</td></tr>
+<tr><td height=15>&nbsp;</td></tr>
+<!-- Development Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Development</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+<a
+href="http://sourceforge.net/tracker/?atid=436181&group_id=43396&func=browse">
+Bugs</a>
+</tr></tr>
+<tr><td>
+<a
+href="http://sourceforge.net/tracker/?atid=436184&group_id=43396&func=browse">
+Requests</a>
+</td></tr>
+<tr><td>
+<a href="contribute.html">Contribute</a>
+</td></tr>
+</table>
+</td></tr>
+<tr><td height=15>&nbsp;</td></tr>
+<!-- Link Box -->
+<tr><td >
+<table cellspacing="0" cellpadding="0" align="center" width="100%">
+<tr><td width="100%"  class="menutitle">Links</td></tr>
+<tr><td  width="100%" class="menubuff">&nbsp;</td></tr>
+<!-- list -->
+<table class="menu"  cellspacing="3" cellpadding="0" width="100%"
+       align="center">
+<tr><td>
+<a href="http://www.ruby-lang.org/en/index.html">Ruby</a>
+</td></tr>
+<tr><td>
+<a href="http://jakarta.apache.org/log4j/docs/index.html">Apache Log4j</a>
+</tr></tr>
+<tr><td>
+<a href="http://www.ruby-lang.org/en/raa-list.rhtml?name=REXML">REXML</a>
+</td></tr>
+<tr><td>
+<a href="http://rm-f.net/~cout/ruby/romp/">ROMP</a>
+</td></tr>
+<tr><td height="5">&nbsp;</td></tr>
+<tr><td align="center">
+<a href="http://sourceforge.net">
+<img
+src="http://sourceforge.net/sflogo.php?group_id=43396" width="88" height="31"
+border="0" alt="SourceForge Logo"></a>
+</td></tr>
+</table>
+</td></tr>
+</table>
+</td>
+<!-- Main column -->
+<td width="85%" align="left" valign="top">
+<center>
+<table cellspacing="0" cellpadding="0" align="center" width="95%">
+<!-- CONTENT -->
+</table>
+</center>
+</td>
+</tr>
+</table>
+<hr noshade>
+<div align="right">
+<font color="#888888" size="-1">
+<i>
+<!-- CVSID -->
+</i></font>
+</div>
+</body>
+</html>

data/examples/README ADDED

@@ -0,0 +1,19 @@
+The examples are:
+1. outofthebox.rb                 - How to get started with minimal setup
+2. simpleconfig.rb                - Using Log4r casually
+3. moderateconfig.rb              - A more sophisticated config
+4. xmlconfig.rb and moderate.xml  - XML configuration example based on #3
+5. rrsetup.rb and rrconfig.xml    - A real example (or used to be ;-)
+6. logserver.rb and logclient.rb  - Remote logging example
+7. fileroll.rb                    - Using RollingFileOutputter
+8. yaml.rb and log4r_yaml.yaml    - YAML configuration example
+The output will go to screen and to files in the directory logs/.
+Note to RubyGems users: The syntax to require log4r as a gem is as follows:
+  require 'rubygems'
+  require_gem 'log4r'
+Obviously, the examples will need to be modified to follow this.

data/examples/customlevels.rb ADDED

@@ -0,0 +1,34 @@
+# Suppose we don't like having 5 levels named DEBUG, INFO, etc.
+# Suppose we'd rather use 3 levels named Foo, Bar, and Baz.
+# Log4r allows you to rename the levels and their corresponding methods
+# in a painless way. This file provides and example
+$: << '../src'
+require 'log4r'
+require 'log4r/configurator'
+include Log4r
+# This is how we specify our levels
+Configurator.custom_levels "Foo", "Bar", "Baz"
+l = Logger.new('custom levels')
+l.add StdoutOutputter.new('console')
+l.level = Foo
+puts l.foo?
+l.foo "This is foo"
+puts l.bar?
+l.bar "this is bar"
+puts l.baz?
+l.baz "this is baz"
+puts "Now change to Baz"
+l.level = Baz
+puts l.foo?
+l.foo {"This is foo"}
+puts l.bar?
+l.bar {"this is bar"}
+puts l.baz?
+l.baz {"this is baz"}

data/examples/fileroll.rb ADDED

@@ -0,0 +1,40 @@
+# How to use RollingFileOutputter
+$: << "../src"
+require 'log4r'
+include Log4r
+puts "this will take a while"
+# example of log file being split by time constraint 'maxtime'
+config = {
+  "filename" => "logs/TestTime.log",
+  "maxtime" => 10,
+  "trunc" => true
+}
+timeLog = Logger.new 'WbExplorer'
+timeLog.outputters = RollingFileOutputter.new("WbExplorer", config)
+timeLog.level = DEBUG
+# log something once a second for 100 seconds
+100.times { |t|
+  timeLog.info "blah #{t}"
+  sleep(1.0)
+}
+# example of log file being split by space constraint 'maxsize'
+config = {
+  "filename" => "logs/TestSize.log",
+  "maxsize" => 16000,
+  "trunc" => true
+}
+sizeLog = Logger.new 'WbExplorer'
+sizeLog.outputters = RollingFileOutputter.new("WbExplorer", config)
+sizeLog.level = DEBUG
+# log a large number of times
+100000.times { |t|
+  sizeLog.info "blah #{t}"
+}
+puts "done! check the two sets of log files in logs/ (TestTime and TestSize)"

data/examples/log4r_yaml.yaml ADDED

Binary file

data/examples/logclient.rb ADDED

@@ -0,0 +1,25 @@
+# How to use RemoteOutputter. See logserver.rb first.
+$: << File.join('..','src')
+require 'log4r'
+require 'log4r/outputter/remoteoutputter'
+include Log4r
+Logger.new('log4r').add 'stdout'        # to see what's going on inside
+RemoteOutputter.new 'remote',           # make a RemoteOutputter
+    :uri=>'tcpromp://localhost:9999',   # where our LogServer is
+    :buffsize=>10                       # buffer 10 before sending to LogServer
+Logger.new('client').add('remote')      # give 'remote' to a 'client' Logger
+# we're done with setup, now let's log
+def log(l)
+  l.debug "debugging"
+  l.info "a piece of info"
+  l.warn "Danger, Will Robinson, danger!"
+  l.error "I dropped by Wookie! :("
+  l.fatal "kaboom!"
+end
+5.times { log(Logger['client']) }      # do a bunch of logging
+Logger['client'].info "Bye Bye from client!"
+Outputter['remote'].flush              # flush the RemoteOutputter

data/examples/logserver.rb ADDED

@@ -0,0 +1,18 @@
+# How to use LogServer
+$: << File.join('..','src')
+require 'log4r'
+require 'log4r/configurator'
+# XML configuration is simple enough to embed here
+xml = %(
+<log4r_config>
+  <logserver name="server" uri="tcpromp://localhost:9999">
+   <outputter>stdout</outputter>
+  </logserver>
+</log4r_config>
+)
+Log4r::Logger.new('log4r').add 'stdout'        # to see what's going on inside
+Log4r::Configurator.load_xml_string xml        # load it up
+sleep
+# now run logclient.rb on another terminal

data/examples/moderate.xml ADDED

@@ -0,0 +1,29 @@
+<!-- the config file used by xmlconfig.rb -->
+<log4r_config>
+  <pre_config>
+    <global level="DEBUG"/>
+    <!-- we'll set serverlog in XML and logpath at runtime for illustration -->
+    <parameter name="serverlog" value="./logs/server.log"/>
+  </pre_config>
+  <!-- outputters, illustrating XML config flexibility -->
+  <outputter type="FileOutputter" name="server">
+    <filename>#{serverlog}</filename>
+    <trunc>false</trunc>
+  </outputter>
+  <outputter type="FileOutputter" name="client"
+             filename="#{logpath}/client.log"/>
+  <outputter type="FileOutputter" name="gui"
+             filename="#{logpath}/guidebug.log"/>
+  <outputter type="StderrOutputter" name="console" level="ERROR"/>
+  <!-- loggers -->
+  <logger name="server" level="ERROR" outputters="server, console"/>
+  <logger name="client" level="INFO"  outputters="client, console"/>
+  <logger name="client::gui" trace="true">
+    <level>DEBUG</level>
+    <outputter>gui</outputter>
+  </logger>
+</log4r_config>

data/examples/moderateconfig.rb ADDED

@@ -0,0 +1,66 @@
+# Now, for something more complicted
+# Let's pretend this is the global config file for our app
+$: << File.join('..','src')
+require "log4r"
+include Log4r                   # include Log4r to make things simple
+Logger.root.level = DEBUG       # global level DEBUG
+# suppose we want to have loggers for a Server and a Client class
+# furthermore, we want the client gui to have its own logger. (You'll want
+# one logger per class or so.)
+# When the loggers are created, they are stored in a repository for further
+# retreival at any point using a hash method call: Logger['name']
+# server is stable, so only log ERROR and FATAL
+Logger.new("server", ERROR)
+# let's say we don't need the DEBUG junk for client logs
+Logger.new("client", INFO)
+# but we're still debugging the gui
+debugger = Logger.new("client::gui", DEBUG)
+debugger.trace = true     # we want to see where the log method was called
+# Guilog is a child of client. In this case, any log events to the gui
+# logger will also be logged to the client outputters. We can change
+# that behavior by setting guilogger's 'additive' to false, but not yet.
+# let's create the outputters
+FileOutputter.new('server', :filename=>'logs/server.log', :trunc => false)
+FileOutputter.new('client', :filename=>'logs/client.log')
+FileOutputter.new('gui', :filename=>'logs/guidebug.log')
+# additionally, we want ERROR and FATAL messages to go to stderr
+StderrOutputter.new('console', :level=>ERROR)
+# add the outputters
+Logger['server'].add 'server', 'console'
+Logger['client'].add 'client', 'console'
+Logger['client::gui'].add 'gui'  # gui will also write to client's outputters
+# That's it for config. Now let's use the loggers:
+def do_logging(log)
+  log.debug "debugging"
+  log.info "a piece of info"
+  log.warn "Danger, Will Robinson, danger!"
+  log.error "I dropped my Wookie! :("
+  log.fatal "kaboom!"
+end
+Logger.each_logger{|logger| do_logging(logger) }
+# You can dynamically change levels and turn off tracing:
+Logger['client'].level = OFF
+Logger['client::gui'].trace = false
+puts 'Only server should show Dynamic Change onscreen:'
+Logger.each_logger{|logger| logger.fatal "Dynamic change." }
+# logs/client.log file should not show "Dynamic change."
+# logs/guidebug.log should not show the trace at "Dynamic change."
+# we can also set our outputter to log only specified levels:
+Outputter['console'].only_at ERROR
+puts "Should only see ERROR next:"
+do_logging Logger['server']

data/examples/myformatter.rb ADDED

@@ -0,0 +1,23 @@
+# try out a custom formatter
+$: << '../src'
+require "log4r"
+class MyFormatter <  Log4r::Formatter
+  def format(event)
+    buff = "The level is #{event.level} and has "
+    buff += "name '#{Log4r::LNAMES[event.level]}'\n"
+    buff += "The logger is '#{event.name}' "
+    buff += "and the data type is #{event.data.class}\n"
+    buff += "Let's inspect the data:\n"
+    buff += event.data.inspect + "\n"
+    buff += "We were called at #{event.tracer[0]}\n\n"
+  end
+end
+log = Log4r::Logger.new('custom formatter')
+log.trace = true
+log.add Log4r::StdoutOutputter.new('stdout', :formatter=>MyFormatter)
+log.info [1, 2, 3, 4]
+log.error "A log statement"

data/examples/outofthebox.rb ADDED

@@ -0,0 +1,21 @@
+# Here's how to start using log4r right away
+$: << File.join('..','src')                   # path if log4r not installed
+require "log4r"
+Log = Log4r::Logger.new("outofthebox")        # create a logger
+Log.add Log4r::Outputter.stderr               # which logs to stdout
+# do some logging
+def do_logging
+ Log.debug "debugging"
+ Log.info "a piece of info"
+ Log.warn "Danger, Will Robinson, danger!"
+ Log.error "I dropped my Wookie! :("
+ Log.fatal "kaboom!"
+end
+do_logging
+# now let's filter anything below WARN level (DEBUG and INFO)
+puts "-= Changing level to WARN =-"
+Log.level = Log4r::WARN
+do_logging

data/examples/rrconfig.xml ADDED

@@ -0,0 +1,63 @@
+<!-- This is a real config file used by a game that I'm working on
+     The Ruby file that loads this is rrsetup.rb -->
+<log4r_config>
+  <pre_config>
+    <!-- I like having a ton of levels. There are three extra for component
+         data, comp1..3 and one level for object dumps (DATA) -->
+    <custom_levels>
+      COMP3, COMP2, COMP1, DATA, DEBUG, INFO, WARN, ERROR, FATAL
+    </custom_levels>
+    <!-- change to ERROR when the game goes to production -->
+    <global level="ALL"/>
+  </pre_config>
+  <!-- Outputters -->
+  <!-- game.log records DEBUG and higher, so no game component data -->
+  <outputter name="gameout" type="FileOutputter" level="DEBUG">
+    <!-- I set the logpath from within the game. -->
+    <filename>#{logpath}/game.log</filename>
+  </outputter>
+  <!-- DATA level goes to its own special file. These log events are
+       too noisy for game.log and are not game components. Useful
+       for dumping lots of objects during development. -->
+  <outputter name="gamedata" type="FileOutputter" only_at="DATA">
+    <filename>#{logpath}/data.log</filename>
+    <!-- low-noise custom formatter for objects -->
+    <formatter type="CompFormatter"/>
+  </outputter>
+  <!-- Spit any errors to the console. They merit special attention -->
+  <outputter name="console" type="StderrOutputter" level="ERROR"/>
+  <!-- A separate log file for tracking game components,
+       used for development. It logs ALL-->
+  <outputter name="componentout" type="FileOutputter">
+    <filename>#{logpath}/component.log</filename>
+    <formatter type="CompFormatter"/>
+  </outputter>
+  <!-- Loggers -->
+  <!-- 'game' is the main logger for the client-server framework -->
+  <logger name="game" level="DATA" additive="false" trace="true">
+    <outputters>gameout, gamedata, console</outputters>
+  </logger>
+  <!-- Notice how we have fine control over how each element logs.
+       The gui and controller are stable while the rest are being debugged. -->
+  <logger name="game::gui" level="ERROR" additive="true" trace="true"/>
+  <logger name="game::boardgui" level="DEBUG" additive="true" trace="false"/>
+  <logger name="game::server" level="DEBUG" additive="true" trace="true"/>
+  <logger name="game::client" level="DEBUG" additive="true" trace="true"/>
+  <logger name="game::controller" level="ERROR" additive="true" trace="false"/>
+  <!-- 'component' is the main logger for game objects. It's used in
+       development to track how the objects change with time. -->
+  <logger name="component" level="ALL" additive="false" trace="false">
+    <outputter>componentout</outputter>
+    <outputter>console</outputter>
+  </logger>
+  <logger name="component::board"/>
+  <logger name="component::tile"/>
+  <logger name="component::player"/>
+  <logger name="component::player::robot"/>
+</log4r_config>