eymiha_util 1.0.0 → 1.0.1

data/gem_package.rb

@@ -4,7 +4,7 @@ class GemPackage
   
   def initialize
     @name = 'eymiha_util'
-    @version = '1.0.0'
+    @version = '1.0.1'
     @files = FileList[
       '*.rb',
       'lib/**/*',

data/html/classes/Eymiha.html

@@ -55,6 +55,10 @@
         <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 />
                 <a href="../files/lib/eymiha/util/enum_rb.html">
                 lib/eymiha/util/enum.rb
                 </a>
@@ -74,6 +78,10 @@
                 <a href="../files/lib/eymiha/util/methodic_hash_rb.html">
                 lib/eymiha/util/methodic_hash.rb
                 </a>
+        <br />
+                <a href="../files/lib/eymiha/util/string_map_rb.html">
+                lib/eymiha/util/string_map.rb
+                </a>
         <br />
             </td>
         </tr>
@@ -111,8 +119,11 @@ is just what&#8216;s needed.
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
 
-      Module <a href="Eymiha/ForwardReferencing.html" class="link">Eymiha::ForwardReferencing</a><br />
+      Module <a href="Eymiha/EasyLog.html" class="link">Eymiha::EasyLog</a><br />
+Module <a href="Eymiha/ForwardReferencing.html" class="link">Eymiha::ForwardReferencing</a><br />
 Class <a href="Eymiha/BaseEnvelope.html" class="link">Eymiha::BaseEnvelope</a><br />
+Class <a href="Eymiha/EasyLogFormatter.html" class="link">Eymiha::EasyLogFormatter</a><br />
+Class <a href="Eymiha/EasyLogger.html" class="link">Eymiha::EasyLogger</a><br />
 Class <a href="Eymiha/Enum.html" class="link">Eymiha::Enum</a><br />
 Class <a href="Eymiha/Envelope.html" class="link">Eymiha::Envelope</a><br />
 Class <a href="Eymiha/EnvelopeException.html" class="link">Eymiha::EnvelopeException</a><br />
@@ -121,6 +132,10 @@ Class <a href="Eymiha/ForwardReferencer.html" class="link">Eymiha::ForwardRefere
 Class <a href="Eymiha/Histogram.html" class="link">Eymiha::Histogram</a><br />
 Class <a href="Eymiha/HistogramException.html" class="link">Eymiha::HistogramException</a><br />
 Class <a href="Eymiha/MethodicHash.html" class="link">Eymiha::MethodicHash</a><br />
+Class <a href="Eymiha/StringMap.html" class="link">Eymiha::StringMap</a><br />
+Class <a href="Eymiha/StringMapException.html" class="link">Eymiha::StringMapException</a><br />
+Class <a href="Eymiha/StringMapFormat.html" class="link">Eymiha::StringMapFormat</a><br />
+Class <a href="Eymiha/StringMapFormatItem.html" class="link">Eymiha::StringMapFormatItem</a><br />
 
     </div>
 

data/html/classes/Eymiha/BaseEnvelope.html

@@ -93,9 +93,9 @@ provide a count of objects that have been added to an envelope.
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000012">new</a>&nbsp;&nbsp;
-      <a href="#M000011">raise_no_compare</a>&nbsp;&nbsp;
-      <a href="#M000010">raise_no_envelope</a>&nbsp;&nbsp;
+      <a href="#M000016">new</a>&nbsp;&nbsp;
+      <a href="#M000015">raise_no_compare</a>&nbsp;&nbsp;
+      <a href="#M000014">raise_no_envelope</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -133,19 +133,19 @@ count of added values reader.
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
+      <div id="method-M000016" class="method-detail">
+        <a name="M000016"></a>
 
         <div class="method-heading">
-          <a href="BaseEnvelope.src/M000012.html" target="Code" class="method-signature"
-            onclick="popupCode('BaseEnvelope.src/M000012.html');return false;">
+          <a href="BaseEnvelope.src/M000016.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseEnvelope.src/M000016.html');return false;">
           <span class="method-name">new</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
-Returns a <a href="BaseEnvelope.html#M000012">new</a> instance with no
+Returns a <a href="BaseEnvelope.html#M000016">new</a> instance with no
 values added.
 </p>
         </div>
@@ -153,12 +153,12 @@ values added.
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
+      <div id="method-M000015" class="method-detail">
+        <a name="M000015"></a>
 
         <div class="method-heading">
-          <a href="BaseEnvelope.src/M000011.html" target="Code" class="method-signature"
-            onclick="popupCode('BaseEnvelope.src/M000011.html');return false;">
+          <a href="BaseEnvelope.src/M000015.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseEnvelope.src/M000015.html');return false;">
           <span class="method-name">raise_no_compare</span><span class="method-args">(value=nil)</span>
           </a>
         </div>
@@ -171,12 +171,12 @@ instance.
         </div>
       </div>
 
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
 
         <div class="method-heading">
-          <a href="BaseEnvelope.src/M000010.html" target="Code" class="method-signature"
-            onclick="popupCode('BaseEnvelope.src/M000010.html');return false;">
+          <a href="BaseEnvelope.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('BaseEnvelope.src/M000014.html');return false;">
           <span class="method-name">raise_no_envelope</span><span class="method-args">()</span>
           </a>
         </div>

data/html/classes/Eymiha/EasyLog.html

@@ -0,0 +1,246 @@
+<?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>Module: Eymiha::EasyLog</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>Module</strong></td>
+          <td class="class-name-in-header">Eymiha::EasyLog</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>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+<a href="EasyLog.html">EasyLog</a> is a quick and convenient way to
+implement logging in Ruby code. By requiring the eymiha/util/easylog code,
+Easylog is included into module and is subsequently available to all
+classes.
+</p>
+<p>
+There is a natural flow to <a href="EasyLog.html">EasyLog</a> logging.
+First logging is started somewhere on high
+</p>
+<pre>
+  start_logging filename
+</pre>
+<p>
+then messages are written to the log with the appropriate severity (here an
+informational message is logged)
+</p>
+<pre>
+  log_info &quot;something happened: #{foo}&quot;
+</pre>
+<p>
+and optionally, when finished,
+</p>
+<pre>
+  finish_logging
+</pre>
+<p>
+The upshot is that logging can be done from anywhere, and is as simple and
+easy as possible.
+</p>
+<p>
+The module builds five methods for <a href="EasyLog.html">EasyLog</a>
+logging corresponding to the five Logger severities: log_debug, log_info,
+log_warn, log_error and log_fatal. Their arguments are a message to be
+logged, and optionally one or more EasyLoggers that will be the targets of
+the message.
+</p>
+<p>
+Note that the classify attribute of an <a
+href="EasyLogger.html">EasyLogger</a> stores the decision about adding the
+class name to the end of the message or not; by default it is true and
+class names are added.
+</p>
+<pre>
+  easylogger.classify = false
+</pre>
+<p>
+will turn this off.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000003">change_easylogger</a>&nbsp;&nbsp;
+      <a href="#M000002">easylogger</a>&nbsp;&nbsp;
+      <a href="#M000004">finish_logging</a>&nbsp;&nbsp;
+      <a href="#M000001">start_logging</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="EasyLog.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLog.src/M000003.html');return false;">
+          <span class="method-name">change_easylogger</span><span class="method-args">(easylogger)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Changes the <a href="EasyLogger.html">EasyLogger</a> used for <a
+href="EasyLog.html">EasyLog</a> logging to the given <a
+href="EasyLogger.html">EasyLogger</a>.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="EasyLog.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLog.src/M000002.html');return false;">
+          <span class="method-name">easylogger</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the <a href="EasyLogger.html">EasyLogger</a> that is being used for
+<a href="EasyLog.html">EasyLog</a> logging.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="EasyLog.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLog.src/M000004.html');return false;">
+          <span class="method-name">finish_logging</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Turns off <a href="EasyLog.html">EasyLog</a> logging until restarted.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="EasyLog.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('EasyLog.src/M000001.html');return false;">
+          <span class="method-name">start_logging</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 new <a href="EasyLogger.html">EasyLogger</a> instance with the
+given arguments, and uses it for all subsequent <a
+href="EasyLog.html">EasyLog</a> logging. The arguments are the same as used
+in <a href="EasyLogger.html">EasyLogger</a> creation.
+</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/EasyLog.src/M000001.html

@@ -0,0 +1,20 @@
+<?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>start_logging (Eymiha::EasyLog)</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 138</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_logging</span>(<span class="ruby-identifier">logdev</span>, <span class="ruby-identifier">shift_age</span> = <span class="ruby-value str">'weekly'</span>, <span class="ruby-identifier">shift_size</span> = <span class="ruby-value">1048576</span>,
+                      <span class="ruby-identifier">subsecond_precision</span> = <span class="ruby-keyword kw">nil</span>)
+      <span class="ruby-constant">EasyLogger</span>.<span class="ruby-identifier">finish_logging</span>
+      <span class="ruby-constant">EasyLogger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">logdev</span>, <span class="ruby-identifier">shift_age</span>, <span class="ruby-identifier">shift_size</span>, <span class="ruby-identifier">subsecond_precision</span>)
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLog.src/M000002.html

@@ -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>easylogger (Eymiha::EasyLog)</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 145</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">easylogger</span>
+      <span class="ruby-constant">EasyLogger</span>.<span class="ruby-identifier">default_logger</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLog.src/M000003.html

@@ -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>change_easylogger (Eymiha::EasyLog)</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 150</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">change_easylogger</span>(<span class="ruby-identifier">easylogger</span>)
+      <span class="ruby-constant">EasyLogger</span>.<span class="ruby-identifier">change_logger</span>(<span class="ruby-identifier">easylogger</span>)
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/Eymiha/EasyLog.src/M000004.html

@@ -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>finish_logging (Eymiha::EasyLog)</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 155</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">finish_logging</span>
+      <span class="ruby-constant">EasyLogger</span>.<span class="ruby-identifier">finish_logging</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>