highlogger 0.0.2 → 0.0.3

data/History.txt

@@ -1,4 +1,8 @@
 == 0.0.1 2007-10-15
 
+* Updated documentation and webpages
+
+* Added LogSource module
+
 * 1 major enhancement:
   * Initial release

data/config/hoe.rb

@@ -5,7 +5,7 @@ EMAIL = "angelbob@nospam.users.sourceforge.net"
 DESCRIPTION = "A heirarchical component-based logging system"
 GEM_NAME = 'highlogger'
 RUBYFORGE_PROJECT = 'ab-ext'
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org/highlogger"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
 @config_file = "~/.rubyforge/user-config.yml"

data/lib/highlogger.rb

@@ -11,6 +11,9 @@ class HighLogger < Logger
     @default_level = Logger::WARN
   end
 
+  # Adds a message to the log, with the given component name, severity,
+  # message (or block if no message), and program name.
+  #
   def add(component, severity, message = nil, progname = nil, &block)
     return if severity == :none
 
@@ -32,51 +35,85 @@ class HighLogger < Logger
 
   alias log add
 
+  # Returns whether a DEBUG log message will be visible for the
+  # given component, if any, or by default if no arg is given.
+  #
   def debug?(*args)
     return super() if args.empty?
     @logmap[args[0]] <= Logger::DEBUG
   end
 
+  # Returns whether an INFO log message will be visible for the
+  # given component, if any, or by default if no arg is given.
+  #
   def info?(*args)
     return super() if args.empty?
     @logmap[args[0]] <= Logger::INFO
   end
 
+  # Returns whether a WARN log message will be visible for the
+  # given component, if any, or by default if no arg is given.
+  #
   def warn?(*args)
     return super() if args.empty?
     @logmap[args[0]] <= Logger::WARN
   end
 
+  # Returns whether an ERROR log message will be visible for the
+  # given component, if any, or by default if no arg is given.
+  #
   def error?(*args)
     return super() if args.empty?
     @logmap[args[0]] <= Logger::ERROR
   end
 
+  # Returns whether a FATAL log message will be visible for the
+  # given component, if any, or by default if no arg is given.
+  #
   def fatal?(*args)
     return super() if args.empty?
     @logmap[args[0]] <= Logger::FATAL
   end
 
+  # Logs a DEBUG message for the given component name and progname,
+  # using the given block as the output message.
+  #
   def debug(component, progname = nil, &block)
     add(component, Logger::DEBUG, nil, progname, &block)
   end
 
+  # Logs an INFO message for the given component name and progname,
+  # using the given block as the output message.
+  #
   def info(component, progname = nil, &block)
     add(component, Logger::INFO, nil, progname, &block)
   end
 
+  # Logs a WARN message for the given component name and progname,
+  # using the given block as the output message.
+  #
   def warn(component, progname = nil, &block)
     add(component, Logger::WARN, nil, progname, &block)
   end
 
+  # Logs an ERROR message for the given component name and progname,
+  # using the given block as the output message.
+  #
   def error(component, progname = nil, &block)
     add(component, Logger::ERROR, nil, progname, &block)
   end
 
+  # Logs a FATAL message for the given component name and progname,
+  # using the given block as the output message.
+  #
   def fatal(component, progname = nil, &block)
     add(component, Logger::FATAL, nil, progname, &block)
   end
 
+  # Logs an UNKNOWN message for the given component name and progname,
+  # using the given block as the output message.  UNKNOWN is more severe
+  # than even FATAL.
+  #
   def unknown(component, progname = nil, &block)
     add(component, Logger::UNKNOWN, nil, progname, &block)
   end
@@ -102,7 +139,7 @@ class HighLogger < Logger
       loglevel = parse_loglevel(mobj[2])
       if mobj[1] =~ /default/i
         @default_level = loglevel
-	parent.level = loglevel
+	#parent.level = loglevel
 	next
       end
 
@@ -155,19 +192,33 @@ class HighLogger < Logger
 
 end # class HighLogger
 
+# LogSource sets up simple logging functions accessible from a class's
+# namespace when it is included.  A logger and component name are usually
+# set in the initialize() function of the including object.  The default
+# logger will log to STDERR, and the default component name is the caller's
+# file name.
+#
 module LogSource
   @@highlogger_default_logger = HighLogger.new(STDERR)
   @highlogger_logger = nil
 
+  # Set the HighLogger or other Logger that this LogSource will log to.
+  # The given object must accept an appropriate @add()@ method call.
+  #
   def set_logger(logger_obj)
     @highlogger_logger = logger_obj
     @highlogger_component = nil
   end
 
+  # Set the component string that the LogSource reports with.
+  #
   def set_component(comp_name)
     @highlogger_component = comp_name
   end
 
+  # Add a message to the current logger, with the appropriate component
+  # name.
+  #
   def log(severity, *strings, &block)
     if @highlogger_component
       comp = @highlogger_component
@@ -186,26 +237,39 @@ module LogSource
 
   alias add log
 
+  # Log a DEBUG message to the current logger and component.
+  #
   def debug(progname = nil, &block)
     add(Logger::DEBUG, nil, progname, &block)
   end
 
+  # Log an INFO message to the current logger and component.
+  #
   def info(progname = nil, &block)
     add(Logger::INFO, nil, progname, &block)
   end
 
+  # Log a WARN message to the current logger and component.
+  #
   def warn(progname = nil, &block)
     add(Logger::WARN, nil, progname, &block)
   end
 
+  # Log an ERROR message to the current logger and component.
+  #
   def error(progname = nil, &block)
     add(Logger::ERROR, nil, progname, &block)
   end
 
+  # Log a FATAL message to the current logger and component.
+  #
   def fatal(progname = nil, &block)
     add(Logger::FATAL, nil, progname, &block)
   end
 
+  # Log an UNKNOWN message to the current logger and component.
+  # UNKNOWN is more severe than FATAL.
+  #
   def unknown(progname = nil, &block)
     add(Logger::UNKNOWN, nil, progname, &block)
   end

data/lib/highlogger/version.rb

@@ -2,7 +2,7 @@ module Highlogger #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>highlogger</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/highlogger"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/highlogger" class="numbers">0.0.1</a>
+      <a href="http://rubyforge.org/projects/highlogger" class="numbers">0.0.2</a>
     </div>
     <h1>&#x2192; &#8216;highlogger&#8217;</h1>
 
@@ -140,7 +140,7 @@ questions about HighLogger.</p>
 
 	<p>Comments are welcome. Send email to <a href="mailto:angelbob@nospam.users.sourceforge.net">Noah Gibbs</a></p>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, 22nd October 2007<br>
+      <a href="angelbob@nospam.users.sourceforge.net">Noah Gibbs</a>, 23rd October 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

metadata

@@ -3,13 +3,13 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: highlogger
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
-date: 2007-10-26 00:00:00 -07:00
+  version: 0.0.3
+date: 2007-10-29 00:00:00 -07:00
 summary: A heirarchical component-based logging system
 require_paths: 
 - lib
 email: angelbob@nospam.users.sourceforge.net
-homepage: http://ab-ext.rubyforge.org
+homepage: http://ab-ext.rubyforge.org/highlogger
 rubyforge_project: ab-ext
 description: A heirarchical component-based logging system
 autorequire: