eymiha_util 1.0.0 → 1.0.1

data/html/index.html

@@ -19,6 +19,6 @@
         <frame src="fr_class_index.html"  name="Classes" />
         <frame src="fr_method_index.html" name="Methods" />
     </frameset>
-    <frame src="files/lib/eymiha/util/enum_rb.html" name="docwin" />
+    <frame src="files/lib/eymiha/util/easylog_rb.html" name="docwin" />
 </frameset>
 </html>

data/lib/eymiha/util.rb

@@ -3,3 +3,4 @@ require 'eymiha/util/envelope'
 require 'eymiha/util/forward_referencing'
 require 'eymiha/util/histogram'
 require 'eymiha/util/methodic_hash'
+require 'eymiha/util/easylog'

data/lib/eymiha/util/easylog.rb

@@ -0,0 +1,184 @@
+require 'eymiha'
+require 'logger'
+
+
+module Eymiha
+
+  # EasyLogFormatter instances are used to format logging messages generated by
+  # the EasyLogger class. They consist of a date-time stamp, the severity and
+  # a log message.
+  class EasyLogFormatter < Logger::Formatter
+
+    # Creates an instance, using the specified subsecond precision to format
+    # fractional seconds. If nil, the calculated subsecond precision of the
+    # Time class is used.
+    def initialize(subsecond_precision = nil)
+      super()
+      @AppLogFormat = "%s %-5s  %s\n"
+      self.datetime_format = "%m/%d/%y %H:%M:%S."
+      @usecs = subsecond_precision || Time.subsecond_precision
+    end
+
+    # 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.
+    def format_datetime(time)
+      time.strftime(datetime_format) << ("%06d" % time.usec)[0,@usecs]
+    end
+
+    # Returns a String containing a formatted log entry consisting of the given
+    # date-time stamp, severity and log message.
+    def call(severity, time, progname, msg)
+      @AppLogFormat % [format_datetime(time), severity, msg2str(msg)]
+    end
+
+  end
+
+  # Primarily, EasyLogger provides a convienient interface to the Logger at the
+  # class level. The class contains a "default" 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 EasyLogFormatter.
+  #
+  # 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.
+  class EasyLogger < Logger
+
+    class_attr_reader :default_logger
+    attr_accessor :classify
+
+    # Creates a new EasyLogger 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.
+    def initialize(logdev, shift_age = 'weekly', shift_size = 1048576,
+                   subsecond_precision = nil)
+      super(logdev, shift_age, shift_size)
+      @formatter = EasyLogFormatter.new(subsecond_precision)
+      @classify = true
+      @@default_logger = self unless @@default_logger
+    end
+
+    # Changes the default logger to the new logger.
+    def self.change_logger(new)
+      old, @@default_logger = @@default_logger, new
+    end
+
+    # Sets the default logger to nil, indicating that further class level
+    # logging through the default logger mechanism is disabled.
+    def self.finish_logging
+      change_logger nil
+    end
+
+    private
+
+    def self.build_loggers
+      (0..4).collect { |i| Logger::SEV_LABEL[i].downcase }.each do |severity|
+        EasyLogger.class_eval <<EOF
+def self.#{severity}(message,*loggers)
+  loggers = [@@default_logger] if loggers.length == 0
+  loggers.compact.each { |logger| logger.#{severity}(message) }
+end
+EOF
+      end
+    end
+
+    self.build_loggers
+
+  end
+
+  
+  # EasyLog 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.
+  #
+  # There is a natural flow to EasyLog logging. First logging is started
+  # somewhere on high
+  #
+  #   start_logging filename
+  #
+  # then messages are written to the log with the appropriate severity (here
+  # an informational message is logged)
+  #
+  #   log_info "something happened: #{foo}"
+  #
+  # and optionally, when finished,
+  #
+  #   finish_logging
+  #
+  # The upshot is that logging can be done from anywhere, and is as simple and
+  # easy as possible.
+  #
+  # The module builds five methods for EasyLog 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.
+  #
+  # Note that the classify attribute of an EasyLogger 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.
+  #
+  #   easylogger.classify = false
+  #
+  # will turn this off.
+  module EasyLog
+
+    # Creates a new EasyLogger instance with the given arguments, and uses it
+    # for all subsequent EasyLog logging. The arguments are the same as used in
+    # EasyLogger creation.
+    def start_logging(logdev, shift_age = 'weekly', shift_size = 1048576,
+                      subsecond_precision = nil)
+      EasyLogger.finish_logging
+      EasyLogger.new(logdev, shift_age, shift_size, subsecond_precision)
+    end
+
+    # Returns the EasyLogger that is being used for EasyLog logging.
+    def easylogger
+      EasyLogger.default_logger
+    end
+
+    # Changes the EasyLogger used for EasyLog logging to the given EasyLogger.
+    def change_easylogger(easylogger)
+      EasyLogger.change_logger(easylogger)
+    end
+
+    # Turns off EasyLog logging until restarted.
+    def finish_logging
+      EasyLogger.finish_logging
+    end
+
+    private
+
+    def classify_log_message(message,easylogger)
+      ((easylogger != nil) ? easylogger.classify : false) ?
+        "#{message} (#{class_name})" : message
+    end
+
+    def self.build_loggers
+      (0..4).collect { |i| Logger::SEV_LABEL[i].downcase }.each do |severity|
+        EasyLog.module_eval <<EOF
+def log_#{severity}(message,*easyloggers)
+  easyloggers = [easylogger] if easyloggers.size == 0
+  easyloggers.flatten.each { |easylogger|
+    EasyLogger.#{severity}(classify_log_message(message,easylogger),easylogger)
+  }
+end
+EOF
+      end
+    end
+
+    self.build_loggers
+
+  end
+
+end
+
+include Eymiha::EasyLog

data/lib/eymiha/util/string_map.rb

@@ -0,0 +1,78 @@
+module Eymiha
+
+  class StringMapException < Execption
+  end
+
+  class StringMap < MethodicHash
+
+    attr_reader :_format
+
+    def initialize format
+      @_format = StringMapFormat.new(format)
+    end
+
+    def encode_string
+      @_format.encode self
+    end
+
+    def decode_string(string)
+      @_format.decode self, string
+    end
+
+  end
+
+
+  class StringMapFormat
+
+    attr_reader :format
+
+    def initialize format, buffer = nil
+      @_format = (format.kind_of? StringMapFormat) ?
+        format._format.copy : itemize(format)
+      @buffer = buffer || make_buffer
+    end
+
+    def itemize format
+      itemized_format = []
+      format.each { |element| StringMapFormatItem.new
+    end
+
+    def make_buffer
+      instance_eval "@buffer="#{(1..buffersize(true)).each { puts ' ' }}""
+    end
+
+    def buffersize(calculate = false)
+      if calculate
+        @format.collect{ |item| item.next_start }.max
+      else
+        @buffer.size
+      end
+    end
+
+    def encode string_map
+      buffer = @buffer.copy
+      @format.each { |item| 
+    end
+
+    def decode string_map, string
+    end
+
+  end
+
+
+  class StringMapFormatItem < MethodicHash
+    
+    def initialize(hash)
+      self.merge hash
+      raise StringMapError, "Invalid Item Format"  unless
+        name and start and length
+      self.klass = String unless klass
+    end
+
+    def next_start
+      start + length
+    end
+
+  end
+
+end

data/test/tc_easylog.rb

@@ -0,0 +1,106 @@
+require 'test/unit'
+
+require 'stringio'
+require 'eymiha/util/easylog'
+
+include Eymiha
+
+class TC_log < Test::Unit::TestCase
+
+  def teardown
+    finish_logging
+  end
+
+  def test_debug
+    log = StringIO.new
+    start_logging log
+    log_debug "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* DEBUG  logging \(TC_log\)/ =~
+           log.string)
+  end
+
+  def test_info
+    log = StringIO.new
+    start_logging log
+    log_info "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   logging \(TC_log\)/ =~
+           log.string)
+  end
+
+  def test_warn
+    log = StringIO.new
+    start_logging log
+    log_warn "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* WARN   logging \(TC_log\)/ =~
+           log.string)
+  end
+
+  def test_error
+    log = StringIO.new
+    start_logging log
+    log_error "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* ERROR  logging \(TC_log\)/ =~
+           log.string)
+  end
+
+  def test_fatal
+    log = StringIO.new
+    start_logging log
+    log_fatal "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* FATAL  logging \(TC_log\)/ =~
+           log.string)
+  end
+
+  def test_easylogger_instance
+    log1 = StringIO.new
+    logger1 = EasyLogger.new(log1)
+    log2 = StringIO.new
+    logger2 = EasyLogger.new(log2)
+    logger1.info("once")
+    logger2.info("twice")
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   once/ =~
+           log1.string)
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   twice/ =~
+           log2.string)
+  end
+
+  def test_change_log
+    log1 = StringIO.new
+    log2 = StringIO.new
+    start_logging log1
+    logger2 = EasyLogger.new(log2)
+    log_info "once"
+    change_easylogger logger2
+    log_info "twice"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   once \(TC_log\)/ =~
+           log1.string)
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   twice \(TC_log\)/ =~
+           log2.string)
+  end
+
+  def test_multi_log
+    log1 = StringIO.new
+    log2 = StringIO.new
+    start_logging log1
+    logger2 = EasyLogger.new(log2)
+    log_info "once"
+    log_info "twice",logger2
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   once \(TC_log\)/ =~
+           log1.string)
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   twice \(TC_log\)/ =~
+           log2.string)
+  end
+
+  def test_change_classify
+    log = StringIO.new
+    start_logging log
+    easylogger.classify = false
+    log_info "logging"
+    assert(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   logging/ =~
+           log.string)
+    assert(!(/\d\d\/\d\d\/\d\d \d\d:\d\d:\d\d.\d* INFO   logging \(/ =~
+             log.string))
+  end
+
+end
+

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: eymiha_util
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2008-05-08 00:00:00 -04:00
+  version: 1.0.1
+date: 2008-06-09 00:00:00 -04:00
 summary: Eymiha general utility classes and methods
 require_paths: 
 - lib
@@ -33,12 +33,15 @@ files:
 - rakefile.rb
 - lib/eymiha
 - lib/eymiha/util
+- lib/eymiha/util/easylog.rb
 - lib/eymiha/util/enum.rb
 - lib/eymiha/util/envelope.rb
 - lib/eymiha/util/forward_referencing.rb
 - lib/eymiha/util/histogram.rb
 - lib/eymiha/util/methodic_hash.rb
+- lib/eymiha/util/string_map.rb
 - lib/eymiha/util.rb
+- test/tc_easylog.rb
 - test/tc_enum.rb
 - test/tc_envelope.rb
 - test/tc_forward_referencing.rb
@@ -48,64 +51,100 @@ files:
 - html/classes/Eymiha
 - html/classes/Eymiha/BaseEnvelope.html
 - html/classes/Eymiha/BaseEnvelope.src
-- html/classes/Eymiha/BaseEnvelope.src/M000010.html
-- html/classes/Eymiha/BaseEnvelope.src/M000011.html
-- html/classes/Eymiha/BaseEnvelope.src/M000012.html
+- html/classes/Eymiha/BaseEnvelope.src/M000014.html
+- html/classes/Eymiha/BaseEnvelope.src/M000015.html
+- html/classes/Eymiha/BaseEnvelope.src/M000016.html
+- html/classes/Eymiha/EasyLog.html
+- html/classes/Eymiha/EasyLog.src
+- html/classes/Eymiha/EasyLog.src/M000001.html
+- html/classes/Eymiha/EasyLog.src/M000002.html
+- html/classes/Eymiha/EasyLog.src/M000003.html
+- html/classes/Eymiha/EasyLog.src/M000004.html
+- html/classes/Eymiha/EasyLogFormatter.html
+- html/classes/Eymiha/EasyLogFormatter.src
+- html/classes/Eymiha/EasyLogFormatter.src/M000017.html
+- html/classes/Eymiha/EasyLogFormatter.src/M000018.html
+- html/classes/Eymiha/EasyLogFormatter.src/M000019.html
+- html/classes/Eymiha/EasyLogger.html
+- html/classes/Eymiha/EasyLogger.src
+- html/classes/Eymiha/EasyLogger.src/M000032.html
+- html/classes/Eymiha/EasyLogger.src/M000033.html
+- html/classes/Eymiha/EasyLogger.src/M000034.html
 - html/classes/Eymiha/Enum.html
 - html/classes/Eymiha/Envelope.html
 - html/classes/Eymiha/Envelope.src
-- html/classes/Eymiha/Envelope.src/M000025.html
-- html/classes/Eymiha/Envelope.src/M000026.html
-- html/classes/Eymiha/Envelope.src/M000027.html
-- html/classes/Eymiha/Envelope.src/M000028.html
-- html/classes/Eymiha/Envelope.src/M000029.html
-- html/classes/Eymiha/Envelope.src/M000030.html
-- html/classes/Eymiha/Envelope.src/M000032.html
+- html/classes/Eymiha/Envelope.src/M000044.html
+- html/classes/Eymiha/Envelope.src/M000045.html
+- html/classes/Eymiha/Envelope.src/M000046.html
+- html/classes/Eymiha/Envelope.src/M000047.html
+- html/classes/Eymiha/Envelope.src/M000048.html
+- html/classes/Eymiha/Envelope.src/M000049.html
+- html/classes/Eymiha/Envelope.src/M000051.html
 - html/classes/Eymiha/EnvelopeException.html
 - html/classes/Eymiha/ForwardReference.html
 - html/classes/Eymiha/ForwardReference.src
-- html/classes/Eymiha/ForwardReference.src/M000033.html
-- html/classes/Eymiha/ForwardReference.src/M000034.html
+- html/classes/Eymiha/ForwardReference.src/M000054.html
+- html/classes/Eymiha/ForwardReference.src/M000055.html
 - html/classes/Eymiha/ForwardReferencer.html
 - html/classes/Eymiha/ForwardReferencing.html
 - html/classes/Eymiha/ForwardReferencing.src
-- html/classes/Eymiha/ForwardReferencing.src/M000001.html
-- html/classes/Eymiha/ForwardReferencing.src/M000002.html
-- html/classes/Eymiha/ForwardReferencing.src/M000003.html
-- html/classes/Eymiha/ForwardReferencing.src/M000004.html
 - html/classes/Eymiha/ForwardReferencing.src/M000005.html
 - html/classes/Eymiha/ForwardReferencing.src/M000006.html
 - html/classes/Eymiha/ForwardReferencing.src/M000007.html
 - html/classes/Eymiha/ForwardReferencing.src/M000008.html
 - html/classes/Eymiha/ForwardReferencing.src/M000009.html
+- html/classes/Eymiha/ForwardReferencing.src/M000010.html
+- html/classes/Eymiha/ForwardReferencing.src/M000011.html
+- html/classes/Eymiha/ForwardReferencing.src/M000012.html
+- html/classes/Eymiha/ForwardReferencing.src/M000013.html
 - html/classes/Eymiha/Histogram.html
 - html/classes/Eymiha/Histogram.src
-- html/classes/Eymiha/Histogram.src/M000016.html
-- html/classes/Eymiha/Histogram.src/M000017.html
-- html/classes/Eymiha/Histogram.src/M000018.html
-- html/classes/Eymiha/Histogram.src/M000019.html
-- html/classes/Eymiha/Histogram.src/M000020.html
-- html/classes/Eymiha/Histogram.src/M000021.html
-- html/classes/Eymiha/Histogram.src/M000022.html
-- html/classes/Eymiha/Histogram.src/M000023.html
-- html/classes/Eymiha/Histogram.src/M000024.html
+- html/classes/Eymiha/Histogram.src/M000035.html
+- html/classes/Eymiha/Histogram.src/M000036.html
+- html/classes/Eymiha/Histogram.src/M000037.html
+- html/classes/Eymiha/Histogram.src/M000038.html
+- html/classes/Eymiha/Histogram.src/M000039.html
+- html/classes/Eymiha/Histogram.src/M000040.html
+- html/classes/Eymiha/Histogram.src/M000041.html
+- html/classes/Eymiha/Histogram.src/M000042.html
+- html/classes/Eymiha/Histogram.src/M000043.html
 - html/classes/Eymiha/HistogramException.html
 - html/classes/Eymiha/MethodicHash.html
 - html/classes/Eymiha/MethodicHash.src
-- html/classes/Eymiha/MethodicHash.src/M000013.html
-- html/classes/Eymiha/MethodicHash.src/M000014.html
-- html/classes/Eymiha/MethodicHash.src/M000015.html
+- html/classes/Eymiha/MethodicHash.src/M000026.html
+- html/classes/Eymiha/MethodicHash.src/M000027.html
+- html/classes/Eymiha/MethodicHash.src/M000028.html
+- html/classes/Eymiha/StringMap.html
+- html/classes/Eymiha/StringMap.src
+- html/classes/Eymiha/StringMap.src/M000029.html
+- html/classes/Eymiha/StringMap.src/M000030.html
+- html/classes/Eymiha/StringMap.src/M000031.html
+- html/classes/Eymiha/StringMapException.html
+- html/classes/Eymiha/StringMapFormat.html
+- html/classes/Eymiha/StringMapFormat.src
+- html/classes/Eymiha/StringMapFormat.src/M000020.html
+- html/classes/Eymiha/StringMapFormat.src/M000021.html
+- html/classes/Eymiha/StringMapFormat.src/M000022.html
+- html/classes/Eymiha/StringMapFormat.src/M000023.html
+- html/classes/Eymiha/StringMapFormat.src/M000024.html
+- html/classes/Eymiha/StringMapFormat.src/M000025.html
+- html/classes/Eymiha/StringMapFormatItem.html
+- html/classes/Eymiha/StringMapFormatItem.src
+- html/classes/Eymiha/StringMapFormatItem.src/M000052.html
+- html/classes/Eymiha/StringMapFormatItem.src/M000053.html
 - html/classes/Eymiha.html
 - html/created.rid
 - html/files
 - html/files/lib
 - html/files/lib/eymiha
 - html/files/lib/eymiha/util
+- html/files/lib/eymiha/util/easylog_rb.html
 - html/files/lib/eymiha/util/enum_rb.html
 - html/files/lib/eymiha/util/envelope_rb.html
 - html/files/lib/eymiha/util/forward_referencing_rb.html
 - html/files/lib/eymiha/util/histogram_rb.html
 - html/files/lib/eymiha/util/methodic_hash_rb.html
+- html/files/lib/eymiha/util/string_map_rb.html
 - html/files/lib/eymiha/util_rb.html
 - html/fr_class_index.html
 - html/fr_file_index.html