RubyGems - highlogger - Versions diffs - 0.0.1 → 0.0.2 - Mend

highlogger 0.0.1 → 0.0.2

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 (7) hide show

data/lib/highlogger/version.rb CHANGED Viewed

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

data/lib/highlogger.rb CHANGED Viewed

@@ -2,21 +2,6 @@ $:.unshift File.dirname(__FILE__)
 require "logger"
-module LogSource
-  @logger = nil
-  def set_logger(logger_obj)
-    @logger = logger_obj
-  end
-  def log(severity, *strings, &block)
-    caller_str = caller()[0]
-    matchobj = /([^\/]+)\.rb/.match(caller_str)
-    raise "Call set_logger before logging!" if(not @logger)
-    @logger.add(matchobj[1], severity, *strings, &block)
-  end
-end # module LogSource
 # This class implements a simple heirarchical logging system.
 #
 class HighLogger < Logger
@@ -169,3 +154,60 @@ class HighLogger < Logger
   end
 end # class HighLogger
+module LogSource
+  @@highlogger_default_logger = HighLogger.new(STDERR)
+  @highlogger_logger = nil
+  def set_logger(logger_obj)
+    @highlogger_logger = logger_obj
+    @highlogger_component = nil
+  end
+  def set_component(comp_name)
+    @highlogger_component = comp_name
+  end
+  def log(severity, *strings, &block)
+    if @highlogger_component
+      comp = @highlogger_component
+    else
+      caller_str = caller()[0]
+      matchobj = /([^\/]+)\.rb/.match(caller_str)
+      comp = matchobj[1]
+    end
+    if @highlogger_logger
+      @highlogger_logger.add(comp, severity, *strings, &block)
+    else
+      @@highlogger_default_logger.add(comp, severity, *strings, &block)
+    end
+  end
+  alias add log
+  def debug(progname = nil, &block)
+    add(Logger::DEBUG, nil, progname, &block)
+  end
+  def info(progname = nil, &block)
+    add(Logger::INFO, nil, progname, &block)
+  end
+  def warn(progname = nil, &block)
+    add(Logger::WARN, nil, progname, &block)
+  end
+  def error(progname = nil, &block)
+    add(Logger::ERROR, nil, progname, &block)
+  end
+  def fatal(progname = nil, &block)
+    add(Logger::FATAL, nil, progname, &block)
+  end
+  def unknown(progname = nil, &block)
+    add(Logger::UNKNOWN, nil, progname, &block)
+  end
+end # module LogSource

data/test/test_highlogger.rb CHANGED Viewed

@@ -106,4 +106,56 @@ EOS
     end
   end
+  def test_logsource
+    dls = LogSourceTest.new(TESTFILE4)
+    dls.test_func
+    (1..4).each do |index|
+      assert_file_contains_on_line(TESTFILE4, "test line #{index}", index)
+      assert_file_contains_on_line(TESTFILE4, "componentname", index)
+    end
+  end
+  def test_default_logger
+    dt = DefaultLoggerTest.new
+    dt.test_func
+  end
+end
+class LogSourceTest
+  include LogSource
+  def initialize(filename)
+    set_logger(HighLogger.new(filename))
+    set_component("componentname")
+  end
+  def test_func
+    warn("Warn message, test line 1")
+    error("Error message, test line 2")
+    fatal("Fatal message, test line 3")
+    unknown("Unknown message, test line 4")
+  end
+end
+class DefaultLoggerTest
+  include LogSource
+  # Intentionally don't call set_logger
+  def test_func
+    $VERBOSE = false
+    # These will come out on STDERR
+    debug("Testing: Debug message on STDERR (SHOULD NOT SEE!)")
+    info("Testing: Info message on STDERR (SHOULD NOT SEE!)")
+    warn("Testing: Warn message on STDERR (should be one of three visible)")
+    fatal("Testing: Fatal message on STDERR (should be one of three visible)")
+    error("Testing: Error message on STDERR (should be one of three visible)")
+    $VERBOSE = true
+  end
 end

data/website/index.html CHANGED Viewed

@@ -1,11 +1,151 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>highlogger</title>
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>highlogger</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      highlogger
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+    <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>
+    </div>
+    <h1>&#x2192; &#8216;highlogger&#8217;</h1>
+	<h2>What</h2>
+	<p>HighLogger is a nearly-industrial-strength logging package for Ruby,
+more suitable for the purpose than Ruby&#8217;s own Logger package, which it
+uses as a back end.  HighLogger logs all messages by component, which
+may be a file, class or anything else, and each component may set a
+visible logging level.  All log messages of that level or &#8216;higher&#8217;
+(i.e. more severe) will be sent to the backend logger.</p>
+	<p>If no level has been set for a given component and the component name
+contains the colon character, it is assumed to be multipart.  So if
+the component is &#8216;MyProgram:Networking:TCP:NagelsAlgorithm&#8221;,
+HighLogger will check &#8216;MyProgram:Networking:TCP&#8217; next, then
+&#8216;MyProgram:Networking&#8217;, then &#8216;MyProgram&#8217;, and use the first level that
+you&#8217;ve set.  This is the &#8216;heirarchical&#8217; part in HighLogger&#8217;s
+description.  If no level has been set for any of these then
+HighLogger will see if a default level has been set.  If no default
+level has been set then it will default to showing Warnings and
+beyond.  HighLogger uses the severity constants from the Logger
+library, just as Logger does.</p>
+	<h2>Installing</h2>
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">highlogger</span></pre></p>
+	<h2>The basics</h2>
+	<p>A HighLogger can be created with the same syntax as a standard Ruby
+Logger.  Valid forms include <ins>HighLogger.new(STDOUT)</ins>,
+<ins>HighLogger.new(STDERR)</ins>, and <ins>HighLogger.new(&#8220;myfile.log&#8221;)</ins>.</p>
+	<p>The logging functions on a HighLogger object (log, add, debug, info,
+warn, error, etc) are identical to the ones for a Logger except they
+require an additional first parameter which is the component name.</p>
+	<h2>Demonstration of usage</h2>
+<pre>
+    logger = HighLogger.new(TESTFILE)
+    config_file = &amp;lt;&amp;lt;EOS
+myprog = WARN
+mylib = ERROR
+myprog:graphics = FATAL
+myprog:network:tcp:myproto = INFO
+mylib:comp1 = WARN
+mylib:comp2:subcomp1:subcomp2 = ANY
+mylib:comp3:subcomp1 = none
+otherlib = info
+EOS
+    # Can also load from a filename with read_config_file
+    logger.read_config_buffer(conf_file)
+    logger.add("myprog:graphics:area1", Logger::UNKNOWN, "test line 1")
+    logger.add("myprog:graphics:area1", Logger::WARN, "should not see")
+    logger.fatal("mylib", "test line 2")
+    logger.error("myprog:graphics", "should not see")
+    logger.debug("mylib:comp1:sub", "should not see")
+    logger.info("mylib:comp2:subcomp1", "should not see")
+    logger.info("mylib:comp2:subcomp1:subcomp2:subcomp3", "test line 3")
+    logger.unknown("myprog:graphics", "test line 4")
+    logger.unknown("myprog:graphics") { "test line 5" }
+    logger.debug("myprog:network:tcp:myproto") { "should not see" }
+    logger.error("myprog:network:tcp:myproto:sub") { "test line 6" }
+</pre>
+	<h2>Forum</h2>
+	<p>There is a Rubyforge forum for the ab-ext project which may be used for
+questions about HighLogger.</p>
+	<h2>How to submit patches</h2>
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and submit patches by email to the author.</p>
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/highlogger/trunk</code> for anonymous access.</p>
+	<h2>License</h2>
+	<p>This code is free to use under the terms of the Ruby license.</p>
+	<h2>Contact</h2>
+	<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>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+<!-- insert site tracking codes here, like Google Urchin -->
+</body>
+</html>

data/website/index.txt CHANGED Viewed

@@ -5,6 +5,24 @@ h1. &#x2192; 'highlogger'
 h2. What
+HighLogger is a nearly-industrial-strength logging package for Ruby,
+more suitable for the purpose than Ruby's own Logger package, which it
+uses as a back end.  HighLogger logs all messages by component, which
+may be a file, class or anything else, and each component may set a
+visible logging level.  All log messages of that level or 'higher'
+(i.e. more severe) will be sent to the backend logger.
+If no level has been set for a given component and the component name
+contains the colon character, it is assumed to be multipart.  So if
+the component is 'MyProgram:Networking:TCP:NagelsAlgorithm",
+HighLogger will check 'MyProgram:Networking:TCP' next, then
+'MyProgram:Networking', then 'MyProgram', and use the first level that
+you've set.  This is the 'heirarchical' part in HighLogger's
+description.  If no level has been set for any of these then
+HighLogger will see if a default level has been set.  If no default
+level has been set then it will default to showing Warnings and
+beyond.  HighLogger uses the severity constants from the Logger
+library, just as Logger does.
 h2. Installing
@@ -12,28 +30,60 @@ h2. Installing
 h2. The basics
+A HighLogger can be created with the same syntax as a standard Ruby
+Logger.  Valid forms include +HighLogger.new(STDOUT)+,
++HighLogger.new(STDERR)+, and +HighLogger.new("myfile.log")+.
-h2. Demonstration of usage
+The logging functions on a HighLogger object (log, add, debug, info,
+warn, error, etc) are identical to the ones for a Logger except they
+require an additional first parameter which is the component name.
+h2. Demonstration of usage
+<pre>
+    logger = HighLogger.new(TESTFILE)
+    config_file = &lt;&lt;EOS
+myprog = WARN
+mylib = ERROR
+myprog:graphics = FATAL
+myprog:network:tcp:myproto = INFO
+mylib:comp1 = WARN
+mylib:comp2:subcomp1:subcomp2 = ANY
+mylib:comp3:subcomp1 = none
+otherlib = info
+EOS
+    # Can also load from a filename with read_config_file
+    logger.read_config_buffer(conf_file)
+    logger.add("myprog:graphics:area1", Logger::UNKNOWN, "test line 1")
+    logger.add("myprog:graphics:area1", Logger::WARN, "should not see")
+    logger.fatal("mylib", "test line 2")
+    logger.error("myprog:graphics", "should not see")
+    logger.debug("mylib:comp1:sub", "should not see")
+    logger.info("mylib:comp2:subcomp1", "should not see")
+    logger.info("mylib:comp2:subcomp1:subcomp2:subcomp3", "test line 3")
+    logger.unknown("myprog:graphics", "test line 4")
+    logger.unknown("myprog:graphics") { "test line 5" }
+    logger.debug("myprog:network:tcp:myproto") { "should not see" }
+    logger.error("myprog:network:tcp:myproto:sub") { "test line 6" }
+</pre>
 h2. Forum
-"http://groups.google.com/group/highlogger":http://groups.google.com/group/highlogger
-TODO - create Google Group - highlogger
+There is a Rubyforge forum for the ab-ext project which may be used for
+questions about HighLogger.
 h2. How to submit patches
-Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and submit patches by email to the author.
 The trunk repository is <code>svn://rubyforge.org/var/svn/highlogger/trunk</code> for anonymous access.
 h2. License
-This code is free to use under the terms of the MIT license.
+This code is free to use under the terms of the Ruby license.
 h2. Contact
-Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/highlogger
+Comments are welcome. Send email to "Noah Gibbs":mailto:angelbob@nospam.users.sourceforge.net

data/website/template.rhtml CHANGED Viewed

@@ -37,7 +37,7 @@
     </div>
     <%= body %>
     <p class="coda">
-      <a href="FIXME email">FIXME full name</a>, <%= modified.pretty %><br>
+      <a href="angelbob@nospam.users.sourceforge.net">Noah Gibbs</a>, <%= modified.pretty %><br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

metadata CHANGED Viewed

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
-rubygems_version: 0.8.11
+rubygems_version: 0.9.4
 specification_version: 1
 name: highlogger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-date: 2007-10-21 00:00:00 -07:00
+  version: 0.0.2
+date: 2007-10-26 00:00:00 -07:00
 summary: A heirarchical component-based logging system
 require_paths:
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key:
 cert_chain:
+post_install_message:
 authors:
 - Noah Gibbs
 files: