lib/glue/logger.rb in og-0.7.0 vs lib/glue/logger.rb in og-0.8.0

@@ -1,51 +1,151 @@
-# = Logger
-#
-# A simple wrapper arround the Ruby logger. Mainly for compatibility
-# purposes.
-#
 # code:
 # * George Moschovitis  <[e-mail]>
 #
 # (c) 2004 Navel, all rights reserved.
 # $Id: logger.rb 161 2004-11-18 10:51:51Z gmosx $
 
-require "logger"
+require 'logger'
 
 # = Logger
 #
-# A simple wrapper arround the Ruby logger. Mainly for compatibility
-# purposes.
+# A simple wrapper arround the Ruby logger. Mainly for 
+# compatibility purposes.
 #
 class Logger
 	alias_method :devel, :debug
 	alias_method :fine, :debug
 	
-	def detach
+	# Prints a trace message to DEBUGLOG (at debug level).  
+	# Useful for emitting the value of variables, etc.  Use 
+	# like this:
+	#
+	#   x = y = 5
+	#   trace 'x'        # -> 'x = 5'
+	#   trace 'x ** y'   # -> 'x ** y = 3125'
+	#
+	# If you have a more complicated value, like an array of 
+	# hashes, then you'll probably want to use an alternative 
+	# output format.  For instance:
+	#
+	#   trace 'value', :yaml
+	#
+	# Valid output format values (the _style_ parameter) are:
+	#
+	#   :p :inspect
+	#   :pp                     (pretty-print, using 'pp' library)
+	#   :s :to_s
+	#   :y :yaml :to_yaml       (using the 'yaml' library')
+	#
+	# The default is <tt>:p</tt>.
+	#
+	# CREDITS:
+	# 
+	# This code comes straight from the dev-utils Gem.
+	# Author: Gavin Sinclair <[e-mail]>
+	#
+  def trace(expr, style=:p)
+    unless expr.respond_to? :to_str
+      warn "trace: Can't evaluate the given value: #{caller.first}"
+    else
+			require 'extensions/binding'
+
+      Binding.of_caller do |b|
+        value = b.eval(expr.to_str)
+        formatter = TRACE_STYLES[style] || :inspect
+        case formatter
+        when :pp then require 'pp'
+        when :y, :yaml, :to_yaml then require 'yaml'
+        end
+        value_s = value.send(formatter)
+        message = "#{expr} = #{value_s}"
+        lines = message.split(/\n/)
+        indent = "   "
+        debug(lines.shift)            					
+        lines.each do |line|
+          debug(indent + line)
+        end
+      end
+    end
+  end
+  TRACE_STYLES = {}  # :nodoc:
+  TRACE_STYLES.update( :pp => :pp_s, :s => :to_s, :p => :inspect, :y => :to_yaml,
+                       :yaml => :to_yaml, :inspect => :inspect, :to_yaml => :to_yaml )
+
+	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+	# Global logger interface. 
+	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+	# Override the logger with your custom version.
+	#
+	@@global_logger = Logger.new(STDERR)
+
+	def self.set(logger)
+		@@global_logger = logger
 	end
+
+	def self.get
+		@@global_logger
+	end
 	
-	# Used for debuging, remove this in release code.
-	#
-	def d(str)
-		self << "#{str}\n"
+	def self.warn(str)
+		@@global_logger.warn(str)
 	end
 
-	# Inspect an object. Used for debugging, remove this in release
-	# code.
-	#
-	def i(obj)
-		self << "Inspect #{obj.inspect()}\n"
+	def self.info(str)
+		@@global_logger.info(str)
 	end
 
+	def self.debug(str)
+		@@global_logger.debug(str)
+	end
+	
+	def self.error(str)
+		@@global_logger.error(str)
+	end
+
+	#--
+	# Saddly have to duplicate the code to make
+	# Binding.of_caller work.
+	#++
+  def self.trace(expr, style=:p)
+    unless expr.respond_to? :to_str
+      warn "trace: Can't evaluate the given value: #{caller.first}"
+    else
+			require 'extensions/binding'
+
+      Binding.of_caller do |b|
+        value = b.eval(expr.to_str)
+        formatter = TRACE_STYLES[style] || :inspect
+        case formatter
+        when :pp then require 'pp'
+        when :y, :yaml, :to_yaml then require 'yaml'
+        end
+        value_s = value.send(formatter)
+        message = "#{expr} = #{value_s}"
+        lines = message.split(/\n/)
+        indent = "   "
+        debug(lines.shift)            					
+        lines.each do |line|
+          debug(indent + line)
+        end
+      end
+    end
+  end
+	
+	# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+	
 	private
 		
 	# the default Ruby logger has a hardwired silly format.
 	# we use some Ruby magic to fix it!
+
 	remove_const "Format"
 
 	Format = "%5s: %s\n"
 
 	def format_message(severity, timestamp, msg, progname)
 		Format % [severity, msg]
 	end
+
 end