RubyGems - eymiha_util - Versions diffs - 1.0.0 → 1.0.1 - Mend

eymiha_util 1.0.0 → 1.0.1

Files changed (91) hide show

data/html/classes/Eymiha/EasyLogFormatter.html ADDED Viewed

@@ -0,0 +1,192 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Eymiha::EasyLogFormatter</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Eymiha::EasyLogFormatter</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/eymiha/util/easylog_rb.html">
+                lib/eymiha/util/easylog.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Logger::Formatter
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="EasyLogFormatter.html">EasyLogFormatter</a> instances are used to
+format logging messages generated by the <a
+href="EasyLogger.html">EasyLogger</a> class. They consist of a date-time
+stamp, the severity and a log message.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000019">call</a>&nbsp;&nbsp;
+      <a href="#M000018">format_datetime</a>&nbsp;&nbsp;
+      <a href="#M000017">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000017" class="method-detail">
+        <a name="M000017"></a>
+        <div class="method-heading">
+          <a href="EasyLogFormatter.src/M000017.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogFormatter.src/M000017.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(subsecond_precision = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Creates an instance, using the specified subsecond precision to format
+fractional seconds. If nil, the calculated subsecond precision of the Time
+class is used.
+</p>
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000019" class="method-detail">
+        <a name="M000019"></a>
+        <div class="method-heading">
+          <a href="EasyLogFormatter.src/M000019.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogFormatter.src/M000019.html');return false;">
+          <span class="method-name">call</span><span class="method-args">(severity, time, progname, msg)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a String containing a formatted log entry consisting of the given
+date-time stamp, severity and log message.
+</p>
+        </div>
+      </div>
+      <div id="method-M000018" class="method-detail">
+        <a name="M000018"></a>
+        <div class="method-heading">
+          <a href="EasyLogFormatter.src/M000018.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogFormatter.src/M000018.html');return false;">
+          <span class="method-name">format_datetime</span><span class="method-args">(time)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns a String containing a date-time stamp for the given time in
+month/day/year hour:minute:second.microsecond format with the microsecond
+part having the precision specified when the instance was created.
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/html/classes/Eymiha/EasyLogFormatter.src/M000017.html ADDED Viewed

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>new (Eymiha::EasyLogFormatter)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/eymiha/util/easylog.rb, line 15</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">subsecond_precision</span> = <span class="ruby-keyword kw">nil</span>)
+      <span class="ruby-keyword kw">super</span>()
+      <span class="ruby-ivar">@AppLogFormat</span> = <span class="ruby-value str">&quot;%s %-5s  %s\n&quot;</span>
+      <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">datetime_format</span> = <span class="ruby-value str">&quot;%m/%d/%y %H:%M:%S.&quot;</span>
+      <span class="ruby-ivar">@usecs</span> = <span class="ruby-identifier">subsecond_precision</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">subsecond_precision</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLogFormatter.src/M000018.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>format_datetime (Eymiha::EasyLogFormatter)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/eymiha/util/easylog.rb, line 25</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format_datetime</span>(<span class="ruby-identifier">time</span>)
+      <span class="ruby-identifier">time</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-identifier">datetime_format</span>) <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-value str">&quot;%06d&quot;</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">time</span>.<span class="ruby-identifier">usec</span>)[<span class="ruby-value">0</span>,<span class="ruby-ivar">@usecs</span>]
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLogFormatter.src/M000019.html ADDED Viewed

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>call (Eymiha::EasyLogFormatter)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/eymiha/util/easylog.rb, line 31</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">call</span>(<span class="ruby-identifier">severity</span>, <span class="ruby-identifier">time</span>, <span class="ruby-identifier">progname</span>, <span class="ruby-identifier">msg</span>)
+      <span class="ruby-ivar">@AppLogFormat</span> <span class="ruby-operator">%</span> [<span class="ruby-identifier">format_datetime</span>(<span class="ruby-identifier">time</span>), <span class="ruby-identifier">severity</span>, <span class="ruby-identifier">msg2str</span>(<span class="ruby-identifier">msg</span>)]
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLogger.html ADDED Viewed

@@ -0,0 +1,218 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Eymiha::EasyLogger</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Eymiha::EasyLogger</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/eymiha/util/easylog_rb.html">
+                lib/eymiha/util/easylog.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Logger
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Primarily, <a href="EasyLogger.html">EasyLogger</a> provides a convienient
+interface to the Logger at the class level. The class contains a
+&quot;default&quot; instance of Logger to which the class methods send
+their log messages. By convention, the first instance created is made the
+default, however this can be changed. Of course, instances may be used
+directly for logging if desired. Instances format their log entries using
+an <a href="EasyLogFormatter.html">EasyLogFormatter</a>.
+</p>
+<p>
+Five class-level methods are built that have the same names as the instance
+methods: debug, info, warn, error and fatal. Their arguments are different,
+however, being the message to be logged and optionally, one or more Loggers
+to log the message. If no Loggers are passed, the default is used, and if
+that is nil,no logging takes place.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000033">change_logger</a>&nbsp;&nbsp;
+      <a href="#M000034">finish_logging</a>&nbsp;&nbsp;
+      <a href="#M000032">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">classify</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000033.html');return false;">
+          <span class="method-name">change_logger</span><span class="method-args">(new)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Changes the default logger to the <a href="EasyLogger.html#M000032">new</a>
+logger.
+</p>
+        </div>
+      </div>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000034.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000034.html');return false;">
+          <span class="method-name">finish_logging</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Sets the default logger to nil, indicating that further class level logging
+through the default logger mechanism is disabled.
+</p>
+        </div>
+      </div>
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
+        <div class="method-heading">
+          <a href="EasyLogger.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLogger.src/M000032.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(logdev, shift_age = 'weekly', shift_size = 1048576, subsecond_precision = nil)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Creates a <a href="EasyLogger.html#M000032">new</a> <a
+href="EasyLogger.html">EasyLogger</a> instance. Logging is recorded through
+the given logdev, either an IO stream or to a file when logdev is a String
+containing its filename. Shift age is either the number of log files to
+keep, or the frequency of rotation. Shift size is the maximum logfile size,
+applicable when shift age is a number. Subsecond precision is the number of
+decimal places that express fractional seconds. If this is the first
+instance being created, it is remembered and used by the logging methods at
+the class level as the default logger.
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>