rUtilAnts 0.3.0.20110825 → 1.0.0.20120223

data/lib/rUtilAnts/GUI/BugReportDialog.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2009 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
@@ -12,10 +12,10 @@ module RUtilAnts
 
       # Constructor
       #
-      # Parameters:
+      # Parameters::
       # * *iParent* (<em>Wx::Window</em>): The parent
       # * *iMsg* (_String_): The bug message
-      # * *iBugTrackerURL* (_String_): The Bug tracker URL
+      # * *iBugTrackerURL* (_String_): The Bug tracker URL (can be nil)
       def initialize(iParent, iMsg, iBugTrackerURL)
         super(iParent,
           :title => 'Bug',
@@ -46,7 +46,7 @@ Thanks.",
         lBSend = Wx::Button.new(self, Wx::ID_ANY, 'Send Bug report')
         lHCTrackerURL = Wx::HyperlinkCtrl.new(self, Wx::ID_ANY, 'Bug tracker', iBugTrackerURL,
           :style => Wx::NO_BORDER|Wx::HL_ALIGN_CENTRE|Wx::HL_CONTEXTMENU
-        )
+        ) if (iBugTrackerURL != nil)
 
         # Put everything in sizers
         lMainSizer = Wx::BoxSizer.new(Wx::VERTICAL)
@@ -65,7 +65,7 @@ Thanks.",
         lTopSizer.add_item(lTopRightSizer, :flag => Wx::GROW, :proportion => 1)
 
         lBottomSizer = Wx::BoxSizer.new(Wx::HORIZONTAL)
-        lBottomSizer.add_item(lHCTrackerURL, :flag => Wx::ALIGN_CENTRE, :proportion => 0)
+        lBottomSizer.add_item(lHCTrackerURL, :flag => Wx::ALIGN_CENTRE, :proportion => 0) if (iBugTrackerURL != nil)
         lBottomSizer.add_item([8,0], :proportion => 1)
         lBottomSizer.add_item(lBSend, :flag => Wx::ALIGN_CENTRE, :proportion => 0)
         lBottomSizer.add_item(lBClose, :flag => Wx::ALIGN_CENTRE, :proportion => 0)

data/lib/rUtilAnts/Logging.rb

@@ -1,36 +1,43 @@
 #--
-# Copyright (c) 2009 - 2011 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
 # Licensed under the terms specified in LICENSE file. No warranty is provided.
 #++
 
-# This file declares modules that might be shared across several projects.
-
 module RUtilAnts
 
   module Logging
 
-    # The logger class singleton
-    class Logger
+    # Constants used for GUI dialogs selection
+    GUI_WX = 0
 
-      # Constants used for GUI dialogs selection
-      GUI_WX = 0
+    # The logger interface, can be used to decorate any class willing to have de
+    module LoggerInterface
 
-      # Constructor
+      # Initializer of the logger variables
       #
-      # Parameters:
-      # * *iLibRootDir* (_String_): The library root directory that will not appear in the logged stack messages
-      # * *iBugTrackerURL* (_String_): The application's bug tracker URL, used to report bugs
-      # * *iSilentSTDOut* (_Boolean_): Do we silent normal output (nothing sent to $stdout) ? [optional = false]
-      # * *iSilentSTDErr* (_Boolean_): Do we silent error output (nothing sent to $stderr) ? [optional = false]
-      def initialize(iLibRootDir, iBugTrackerURL, iSilentSTDOut = false, iSilentSTDErr = false)
-        @LibRootDir, @BugTrackerURL = iLibRootDir, iBugTrackerURL
-        @DebugMode = false
-        @LogFile = nil
-        @ErrorsStack = nil
-        @MessagesStack = nil
-        @DialogsGUI = nil
-        @ScreenOutput = (!iSilentSTDOut)
-        @ScreenOutputErr = (!iSilentSTDErr)
+      # Parameters::
+      # * *iOptions* (<em>map<Symbol,Object></em>): Options [optional = {}]
+      #   * *:lib_root_dir* (_String_): The library root directory that will not appear in the logged stack messages [optional = nil]
+      #   * *:bug_tracker_url* (_String_): The application's bug tracker URL, used to report bugs [optional = nil]
+      #   * *:mute_stdout* (_Boolean_): Do we silent normal output (nothing sent to $stdout) ? [optional = false]
+      #   * *:mute_stderr* (_Boolean_): Do we silent error output (nothing sent to $stderr) ? [optional = false]
+      #   * *:no_dialogs* (_Boolean_): Do we forbid dialogs usage ? [optional = false]
+      #   * *:debug_mode* (_Boolean_): Do we activate debug mode ? [optional = false]
+      #   * *:log_file* (_String_): Specify a log file [optional = nil]
+      #   * *:errors_stack* (<em>list<String></em>): Specify an errors stack [optional = nil]
+      #   * *:messages_stack* (<em>list<String></em>): Specify a messages stack [optional = nil]
+      #   * *:gui_for_dialogs* (_Integer_): Specify a GUI constant for dialogs [optional = nil]
+      def init_logger(iOptions = {})
+        @LibRootDir = iOptions[:lib_root_dir]
+        @BugTrackerURL = iOptions[:bug_tracker_url]
+        @DebugMode = (iOptions[:debug_mode] == nil) ? false : iOptions[:debug_mode]
+        @LogFile = iOptions[:log_file]
+        @ErrorsStack = iOptions[:errors_stack]
+        @MessagesStack = iOptions[:messages_stack]
+        @DialogsGUI = iOptions[:gui_for_dialogs]
+        @ScreenOutput = (iOptions[:mute_stdout] == nil) ? true : (!iOptions[:mute_stdout])
+        @ScreenOutputErr = (iOptions[:mute_stderr] == nil) ? true : (!iOptions[:mute_stderr])
+        @NoDialogs = (iOptions[:no_dialogs] == nil) ? false : iOptions[:no_dialogs]
         if (!@ScreenOutput)
           # Test if we can write to stdout
           begin
@@ -67,80 +74,80 @@ module RUtilAnts
 
       # Mute or unmute standard output
       #
-      # Parameters:
+      # Parameters::
       # * *iMute* (_Boolean_): Do we mute standard output ? [optional = true]
-      def muteStdOut(iMute = true)
+      def mute_stdout(iMute = true)
         @ScreenOutput = (!iMute)
       end
 
       # Mute or unmute error output
       #
-      # Parameters:
+      # Parameters::
       # * *iMute* (_Boolean_): Do we mute error output ? [optional = true]
-      def muteStdErr(iMute = true)
+      def mute_stderr(iMute = true)
         @ScreenOutputErr = (!iMute)
       end
 
       # Set the log file to use (can be nil to stop logging into a file)
       #
-      # Parameters:
+      # Parameters::
       # * *iFileName* (_String_): Log file name (can be nil)
-      def setLogFile(iFileName)
+      def set_log_file(iFileName)
         @LogFile = iFileName
       end
 
       # Get the log file used (can be nil)
       #
-      # Return:
+      # Return::
       # * _String_: Log file name (can be nil)
-      def getLogFile
+      def get_log_file
         return @LogFile
       end
 
       # Get the library root dir
       #
-      # Return:
+      # Return::
       # * _String_: The library root dir, as defined when initialized
-      def getLibRootDir
+      def get_lib_root_dir
         return @LibRootDir
       end
 
       # Get the bug tracker URL
       #
-      # Return:
+      # Return::
       # * _String_: The bug tracker URL, as defined when initialized
-      def getBugTrackerURL
+      def get_bug_tracker_url
         return @BugTrackerURL
       end
 
       # Indicate which GUI to be used to display dialogs.
       #
-      # Parameters:
+      # Parameters::
       # * *iGUIToUse* (_Integer_): The GUI constant, or nil if no GUI is provided
-      def setGUIForDialogs(iGUIToUse)
+      def set_gui_for_dialogs(iGUIToUse)
         @DialogsGUI = iGUIToUse
       end
 
       # Set the debug mode
       #
-      # Parameters:
+      # Parameters::
       # * *iDebugMode* (_Boolean_): Are we in debug mode ?
-      def activateLogDebug(iDebugMode)
+      def activate_log_debug(iDebugMode)
         if (@DebugMode != iDebugMode)
           @DebugMode = iDebugMode
           if (iDebugMode)
-            logInfo 'Activated log debug'
+            log_info 'Activated log debug'
           else
-            logInfo 'Deactivated log debug'
+            log_info 'Deactivated log debug'
           end
         end
       end
 
       # Is debug mode activated ?
       #
-      # Return:
+      # Return::
       # * _Boolean_: Are we in debug mode ?
-      def debugActivated?
+      def debug_activated?
         return @DebugMode
       end
 
@@ -148,9 +155,9 @@ module RUtilAnts
       # If set to nil, errors will be displayed as they appear.
       # If set to a stack, errors will silently be added to the list.
       #
-      # Parameters:
+      # Parameters::
       # * *iErrorsStack* (<em>list<String></em>): The stack of errors, or nil to unset it
-      def setLogErrorsStack(iErrorsStack)
+      def set_log_errors_stack(iErrorsStack)
         @ErrorsStack = iErrorsStack
       end
 
@@ -158,44 +165,44 @@ module RUtilAnts
       # If set to nil, messages will be displayed as they appear.
       # If set to a stack, messages will silently be added to the list.
       #
-      # Parameters:
+      # Parameters::
       # * *iMessagesStack* (<em>list<String></em>): The stack of messages, or nil to unset it
-      def setLogMessagesStack(iMessagesStack)
+      def set_log_messages_stack(iMessagesStack)
         @MessagesStack = iMessagesStack
       end
 
       # Log an exception
       # This is called when there is a bug due to an exception in the program. It has been set in many places to detect bugs.
       #
-      # Parameters:
+      # Parameters::
       # * *iException* (_Exception_): Exception
       # * *iMsg* (_String_): Message to log
-      def logExc(iException, iMsg)
-        logBug("#{iMsg}
+      def log_exc(iException, iMsg)
+        log_bug("#{iMsg}
 Exception: #{iException}
 Exception stack:
-#{getSimpleCaller(iException.backtrace, caller).join("\n")}
+#{get_simple_caller(iException.backtrace, caller).join("\n")}
 ...")
       end
 
       # Log a bug
       # This is called when there is a bug in the program. It has been set in many places to detect bugs.
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logBug(iMsg)
+      def log_bug(iMsg)
         lCompleteMsg = "Bug: #{iMsg}
 Stack:
-#{getSimpleCaller(caller[0..-2]).join("\n")}"
+#{get_simple_caller(caller[0..-2]).join("\n")}"
         # Log into stderr
         if (@ScreenOutputErr)
           $stderr << "!!! BUG !!! #{lCompleteMsg}\n"
         end
         if (@LogFile != nil)
-          logFile(lCompleteMsg)
+          log_file(lCompleteMsg)
         end
         # Display Bug dialog
-        if (showModalWxAvailable?)
+        if (show_modal_wx_available?)
           # We require the file here, as we hope it will not be required often
           require 'rUtilAnts/GUI/BugReportDialog'
           showModal(GUI::BugReportDialog, nil, lCompleteMsg, @BugTrackerURL) do |iModalResult, iDialog|
@@ -203,8 +210,9 @@ Stack:
           end
         else
           # Use normal platform dependent message, if the platform has been initialized (otherwise, stick to $stderr)
-          if (defined?($rUtilAnts_Platform_Info) != nil)
-            $rUtilAnts_Platform_Info.sendMsg("A bug has just occurred.
+          if ((defined?(sendMsg) != nil) and
+              (!@NoDialogs))
+            sendMsg("A bug has just occurred.
 Normally you should never see this message, but this application is not bug-less.
 We are sorry for the inconvenience caused.
 If you want to help improving this application, please inform us of this bug:
@@ -222,20 +230,20 @@ Details:
       # Log an error.
       # Those errors can be normal, as they mainly depend on external factors (lost connection, invalid user file...)
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logErr(iMsg)
+      def log_err(iMsg)
         lMsg = "!!! ERR !!! #{iMsg}"
         # Log into stderr
         if (@ScreenOutputErr)
           $stderr << "#{lMsg}\n"
         end
         if (@LogFile != nil)
-          logFile(lMsg)
+          log_file(lMsg)
         end
         # Display dialog only if we are not redirecting messages to a stack
         if (@ErrorsStack == nil)
-          if (showModalWxAvailable?)
+          if (show_modal_wx_available?)
             showModal(Wx::MessageDialog, nil,
               iMsg,
               :caption => 'Error',
@@ -243,9 +251,10 @@ Details:
             ) do |iModalResult, iDialog|
               # Nothing to do
             end
-          elsif (defined?($rUtilAnts_Platform_Info) != nil)
+          elsif ((defined?(sendMsg) != nil) and
+                 (!@NoDialogs))
             # Use normal platform dependent message, if the platform has been initialized (otherwise, stick to $stderr)
-            $rUtilAnts_Platform_Info.sendMsg(iMsg)
+            sendMsg(iMsg)
           end
         else
           @ErrorsStack << iMsg
@@ -255,20 +264,20 @@ Details:
       # Log a normal message to the user
       # This is used to display a simple message to the user
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logMsg(iMsg)
+      def log_msg(iMsg)
         # Log into stderr
         if (@ScreenOutput)
           $stdout << "#{iMsg}\n"
         end
         if (@LogFile != nil)
-          logFile(iMsg)
+          log_file(iMsg)
         end
         # Display dialog only if we are not redirecting messages to a stack
         if (@MessagesStack == nil)
           # Display dialog only if showModal exists and that we are currently running the application
-          if (showModalWxAvailable?)
+          if (show_modal_wx_available?)
             showModal(Wx::MessageDialog, nil,
               iMsg,
               :caption => 'Notification',
@@ -276,9 +285,10 @@ Details:
             ) do |iModalResult, iDialog|
               # Nothing to do
             end
-          elsif (defined?($rUtilAnts_Platform_Info) != nil)
+          elsif ((defined?(sendMsg) != nil) and
+                 (!@NoDialogs))
             # Use normal platform dependent message, if the platform has been initialized (otherwise, stick to $stderr)
-            $rUtilAnts_Platform_Info.sendMsg(iMsg)
+            sendMsg(iMsg)
           end
         else
           @MessagesStack << iMsg
@@ -288,47 +298,47 @@ Details:
       # Log an info.
       # This is just common journal.
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logInfo(iMsg)
+      def log_info(iMsg)
         # Log into stdout
         if (@ScreenOutput)
           $stdout << "#{iMsg}\n"
         end
         if (@LogFile != nil)
-          logFile(iMsg)
+          log_file(iMsg)
         end
       end
 
       # Log a warning.
       # Warnings are not errors but still should be highlighted.
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logWarn(iMsg)
+      def log_warn(iMsg)
         # Log into stdout
         lMsg = "!!! WARNING !!! - #{iMsg}"
         if (@ScreenOutput)
           $stdout << "#{lMsg}\n"
         end
         if (@LogFile != nil)
-          logFile(lMsg)
+          log_file(lMsg)
         end
       end
 
       # Log a debugging info.
       # This is used when debug is activated
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): Message to log
-      def logDebug(iMsg)
+      def log_debug(iMsg)
         # Log into stdout
         if (@DebugMode)
           if (@ScreenOutput)
             $stdout << "#{iMsg}\n"
           end
           if (@LogFile != nil)
-            logFile(iMsg)
+            log_file(iMsg)
           end
         end
       end
@@ -337,9 +347,9 @@ Details:
 
       # Check if Wx dialogs environment is set up
       #
-      # Return:
+      # Return::
       # * _Boolean_: Can we use showModal ?
-      def showModalWxAvailable?
+      def show_modal_wx_available?
         return (
           (defined?(showModal) != nil) and
           (@DialogsGUI == GUI_WX)
@@ -348,9 +358,9 @@ Details:
 
       # Log a message in the log file
       #
-      # Parameters:
+      # Parameters::
       # * *iMsg* (_String_): The message to log
-      def logFile(iMsg)
+      def log_file(iMsg)
         File.open(@LogFile, 'a+') do |oFile|
           oFile << "#{Time.now.gmtime.strftime('%Y/%m/%d %H:%M:%S')} - #{iMsg}\n"
         end
@@ -359,12 +369,12 @@ Details:
       # Get a stack trace in a simple format:
       # Remove @LibRootDir paths from it.
       #
-      # Parameters:
+      # Parameters::
       # * *iCaller* (<em>list<String></em>): The caller, or nil if no caller
       # * *iReferenceCaller* (<em>list<String></em>): The reference caller: we will not display lines from iCaller that also belong to iReferenceCaller [optional = nil]
-      # Return:
+      # Return::
       # * <em>list<String></em>): The simple stack
-      def getSimpleCaller(iCaller, iReferenceCaller = nil)
+      def get_simple_caller(iCaller, iReferenceCaller = nil)
         rSimpleCaller = []
 
         if (iCaller != nil)
@@ -384,13 +394,18 @@ Details:
             # Here we have either one of the indexes that is -1, or the indexes point to different lines between the caller and its reference.
             lCaller = iCaller[0..lIdxCaller+1]
           end
-          lCaller.each do |iCallerLine|
-            lMatch = iCallerLine.match(/^(.*):([[:digit:]]*):in (.*)$/)
-            if (lMatch == nil)
-              # Did not get which format. Just add it blindly.
-              rSimpleCaller << iCallerLine
-            else
-              rSimpleCaller << "#{File.expand_path(lMatch[1]).gsub(@LibRootDir, '')}:#{lMatch[2]}:in #{lMatch[3]}"
+          if (@LibRootDir == nil)
+            rSimpleCaller = lCaller
+          else
+            # Remove @LibRootDir from each entry
+            lCaller.each do |iCallerLine|
+              lMatch = iCallerLine.match(/^(.*):([[:digit:]]*):in (.*)$/)
+              if (lMatch == nil)
+                # Did not get which format. Just add it blindly.
+                rSimpleCaller << iCallerLine
+              else
+                rSimpleCaller << "#{File.expand_path(lMatch[1]).gsub(@LibRootDir, '')}:#{lMatch[2]}:in #{lMatch[3]}"
+              end
             end
           end
         end
@@ -400,174 +415,29 @@ Details:
 
     end
 
-    # The following methods are meant to be included in a class to be easily useable.
-
-    # Initialize the logging features
-    #
-    # Parameters:
-    # * *iLibRootDir* (_String_): The library root directory that will not appear in the logged stack messages
-    # * *iBugTrackerURL* (_String_): The application's bug tracker URL, used to report bugs
-    # * *iSilentOutputs* (_Boolean_): Do we silent outputs (nothing sent to $stdout or $stderr) ? [optional = false]
-    def self.initializeLogging(iLibRootDir, iBugTrackerURL, iSilentOutputs = false)
-      $rUtilAnts_Logging_Logger = RUtilAnts::Logging::Logger.new(iLibRootDir, iBugTrackerURL, iSilentOutputs)
-      # Add the module accessible from the Object namespace
-      Object.module_eval('include RUtilAnts::Logging')
-    end
-
-    # Mute or unmute standard output
-    #
-    # Parameters:
-    # * *iMute* (_Boolean_): Do we mute standard output ? [optional = true]
-    def muteStdOut(iMute = true)
-      $rUtilAnts_Logging_Logger.muteStdOut(iMute)
-    end
-
-    # Mute or unmute error output
-    #
-    # Parameters:
-    # * *iMute* (_Boolean_): Do we mute error output ? [optional = true]
-    def muteStdErr(iMute = true)
-      $rUtilAnts_Logging_Logger.muteStdErr(iMute)
-    end
-
-    # Set the log file to use (can be nil to stop logging into a file)
-    #
-    # Parameters:
-    # * *iFileName* (_String_): Log file name (can be nil)
-    def setLogFile(iFileName)
-      $rUtilAnts_Logging_Logger.setLogFile(iFileName)
-    end
-
-    # Get the log file used (can be nil)
-    #
-    # Return:
-    # * _String_: Log file name (can be nil)
-    def getLogFile
-      return $rUtilAnts_Logging_Logger.getLogFile
-    end
-
-    # Get the library root dir
-    #
-    # Return:
-    # * _String_: The library root dir, as defined when initialized
-    def getLibRootDir
-      return $rUtilAnts_Logging_Logger.getLibRootDir
-    end
-
-    # Get the bug tracker URL
-    #
-    # Return:
-    # * _String_: The bug tracker URL, as defined when initialized
-    def getBugTrackerURL
-      return $rUtilAnts_Logging_Logger.getBugTrackerURL
-    end
-
-    # Indicate which GUI to be used to display dialogs.
-    #
-    # Parameters:
-    # * *iGUIToUse* (_Integer_): The GUI constant, or nil if no GUI is provided
-    def setGUIForDialogs(iGUIToUse)
-      $rUtilAnts_Logging_Logger.setGUIForDialogs(iGUIToUse)
-    end
-
-    # Set the debug mode
-    #
-    # Parameters:
-    # * *iDebugMode* (_Boolean_): Are we in debug mode ?
-    def activateLogDebug(iDebugMode)
-      $rUtilAnts_Logging_Logger.activateLogDebug(iDebugMode)
-    end
-
-    # Is debug mode activated ?
-    #
-    # Return:
-    # * _Boolean_: Are we in debug mode ?
-    def debugActivated?
-      return $rUtilAnts_Logging_Logger.debugActivated?
-    end
-
-    # Set the stack of the errors to fill.
-    # If set to nil, errors will be displayed as they appear.
-    # If set to a stack, errors will silently be added to the list.
-    #
-    # Parameters:
-    # * *iErrorsStack* (<em>list<String></em>): The stack of errors, or nil to unset it
-    def setLogErrorsStack(iErrorsStack)
-      $rUtilAnts_Logging_Logger.setLogErrorsStack(iErrorsStack)
-    end
-
-    # Set the stack of the messages to fill.
-    # If set to nil, messages will be displayed as they appear.
-    # If set to a stack, messages will silently be added to the list.
-    #
-    # Parameters:
-    # * *iMessagesStack* (<em>list<String></em>): The stack of messages, or nil to unset it
-    def setLogMessagesStack(iMessagesStack)
-      $rUtilAnts_Logging_Logger.setLogMessagesStack(iMessagesStack)
-    end
-
-    # Log an exception
-    # This is called when there is a bug due to an exception in the program. It has been set in many places to detect bugs.
-    #
-    # Parameters:
-    # * *iException* (_Exception_): Exception
-    # * *iMsg* (_String_): Message to log
-    def logExc(iException, iMsg)
-      $rUtilAnts_Logging_Logger.logExc(iException, iMsg)
-    end
-
-    # Log a bug
-    # This is called when there is a bug in the program. It has been set in many places to detect bugs.
-    #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logBug(iMsg)
-      $rUtilAnts_Logging_Logger.logBug(iMsg)
-    end
-
-    # Log an error.
-    # Those errors can be normal, as they mainly depend on external factors (lost connection, invalid user file...)
-    #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logErr(iMsg)
-      $rUtilAnts_Logging_Logger.logErr(iMsg)
-    end
+    # A stand-alone logger
+    class Logger
 
-    # Log a normal message to the user
-    # This is used to display a simple message to the user
-    #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logMsg(iMsg)
-      $rUtilAnts_Logging_Logger.logMsg(iMsg)
-    end
+      include RUtilAnts::Logging::LoggerInterface
 
-    # Log an info.
-    # This is just common journal.
-    #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logInfo(iMsg)
-      $rUtilAnts_Logging_Logger.logInfo(iMsg)
-    end
+      # Constructor
+      #
+      # Parameters::
+      # * *iOptions* (<em>map<Symbol,Object></em>): Options (see LoggerInterface for details) [optional = {}]
+      def initialize(iOptions = {})
+        init_logger(iOptions)
+      end
 
-    # Log a warning.
-    # Warnings are not errors but still should be highlighted.
-    #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logWarn(iMsg)
-      $rUtilAnts_Logging_Logger.logWarn(iMsg)
     end
 
-    # Log a debugging info.
-    # This is used when debug is activated
+    # Set Object as a logger.
     #
-    # Parameters:
-    # * *iMsg* (_String_): Message to log
-    def logDebug(iMsg)
-      $rUtilAnts_Logging_Logger.logDebug(iMsg)
+    # Parameters::
+    # * *iOptions* (<em>map<Symbol,Object></em>): Options (see RUtilAnts::Logging::Logger::initialize documentation for options) [optional = {}]
+    def self.install_logger_on_object(iOptions = {})
+      require 'rUtilAnts/SingletonProxy'
+      RUtilAnts::make_singleton_proxy(RUtilAnts::Logging::LoggerInterface, Object)
+      init_logger(iOptions)
     end
 
   end