globalog 0.1.1 → 0.1.2

data/lib/globalog.rb

@@ -7,7 +7,7 @@
 # 
 # It is essentially compatible with existing Logger, because it uses logger as it base lib.  So all logging is done the same way, with all of logger instance methods also working on globalog instances.  You can then transition code logged with logger easily, by either replacing the Logger initialisation in your code by a GlobaLog initialisation, or by leaving logger where it is and only deriving its output and level settings from globalog class methods of the same names, still allowing you to tap into globalog cascading settings.
 # 
-# The logging in Globalog is done with Logger so please refer to its documentation for the logging methodologies: http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/
+# The logging in GlobaLog is done with Logger so please refer to its documentation for the logging methodologies: http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/
 # 
 # ///////////////////////////////////////////////////////////////////////////////////////
 # Example:
@@ -51,7 +51,7 @@
 #   => Printing Debug!!
 #   
 # So this allow you to set a default Logger setting in your libraries, override them with an other default setting in client scripts and still get the flexibility to override both defaults at runtime by providing command line arguments.  Ideal for testing purposes where you want a default log level for test overriding the Local log level of your tested libraries, while allowing you to choose the test log level at runtime. 
-#
+# See Logger rdoc for full operation details: http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/
 #  
 # Author:: lp (mailto:lp@spiralix.org)
 # Copyright:: 2009 Louis-Philippe Perron - Released under the terms of the MIT license
@@ -63,10 +63,11 @@ class GlobaLog < Logger
 	require 'globalog_args'
 	require 'globalog_hijack'
 	
-	# The +GlobaLog.logger+ acts as a constructor method for the logger.
+	# The GlobaLog.logger acts as a constructor method for the logger.
 	# === Parameters
 	# * _def_out_ = the output io or logfile path
 	# * _def_level_ = the log level, as a symbol (i.e. :warn, :info, etc)
+	# * _opt1_, _opt2_ = (optional) logger extra log rotation parameters (see Logger rdoc for more details) 
 	# * _master_ = (optional) the logger presence in the cascading settings chain
 	# _master_ can be any of the following:
 	# * _true_ = Impose its settings on the loggers down the chain
@@ -75,19 +76,29 @@ class GlobaLog < Logger
 	# === Example
 	# 	@log = GlobaLog.logger('logfile.txt',:error,true)
 	
-	def GlobaLog.logger(def_out,def_level,master=false)
-		Args.are({:log_output => def_out, :log_level => def_level},master)	
+	def GlobaLog.logger(def_out,def_level, opt1= :empty, opt2= :empty, opt3= :empty)
+		logger_opts = []; master = false
+		[opt1,opt2,opt3].each do |opt|
+			if opt == :empty
+				next
+			elsif opt == true || opt == false || opt == nil
+				master = opt
+			else
+				logger_opts << opt
+			end
+		end
+		Args.are({:log_output => def_out, :log_level => def_level, :log_opts => logger_opts},master)	
 		if master.nil?
-			log = self.new(def_out)
+			log = self.new(def_out,*logger_opts)
 			log.level = Args.sym_to_level(def_level)
 		else
-			log = self.new(Args::log_output)
+			log = self.new(Args::log_output,*logger_opts)
 			log.level = Args::log_level
 		end
 		return log
 	end
 	
-	# The +GlobaLog::output+ method return the current log output.
+	# The GlobaLog::output method return the current log output.
 	# Can be used to chain existing Logger instances to GlobaLog cascade, 
 	# when you don't want to replace them with GlobaLog instances.
 	# (and you can only replace the constructor, the logging will still work)
@@ -97,7 +108,7 @@ class GlobaLog < Logger
 		Args::log_output
 	end
 	
-	# The +Globalog::level+ method returns the current log level.
+	# The GlobaLog::level method return the current log level.
 	# Can be used to chain existing Logger instances to GlobaLog cascade, 
 	# when you don't want to replace them with GlobaLog instances.
 	# (and you can only replace the constructor, the logging will still work)
@@ -107,4 +118,21 @@ class GlobaLog < Logger
 		Args::log_level
 	end
 	
+	# The GlobaLog::options method return the current extra Logger options.
+	# i.e. Log rotations, size, etc.
+	# They are returned as array so must be splatted before they are usefull for classic Logger initialization.
+	# === Example
+	# 	$logger = Logger.new(GlobaLog::output,*GlobaLog::options)
+	def GlobaLog::options
+		Args::log_opts
+	end
+	
+	# The GlobaLog::logger_params method return the current full Logger parameter arguments.
+	# They are returned as array so must be splatted before they are usefull for classic Logger initialization.
+	# === Example
+	# 	$logger = Logger.new(*GlobaLog::logger_params)
+	def GlobaLog::logger_params
+		return Args::log_output, *Args::log_opts
+	end
+	
 end

data/lib/globalog_args.rb

@@ -11,9 +11,11 @@ class GlobaLog
 			if override == true
 				$logger_args[:log_level] = args[:log_level].to_sym unless args[:log_level].nil?
 				$logger_args[:log_output] = args[:log_output] unless args[:log_output].nil?
+				$logger_args[:log_opts] = args[:log_opts] unless args[:log_opts].nil?
 			else
 				$logger_args[:log_level] ||= args[:log_level].to_sym unless args[:log_level].nil?
 				$logger_args[:log_output] ||= args[:log_output] unless args[:log_output].nil?
+				$logger_args[:log_opts] ||= args[:log_opts] unless args[:log_opts].nil?
 			end
 		end
 		
@@ -28,6 +30,10 @@ class GlobaLog
 			$logger_args[:log_level]
 		end
 		
+		def Args::log_opts
+			$logger_args[:log_opts]
+		end
+		
 		def Args.sym_to_level(sym)
 			case sym
 			when :debug

data/test/external_helper.rb

@@ -12,14 +12,27 @@ module LogMessage
 end
 
 class External
+	require 'logger'
 	include LogMessage
 	
-	def initialize
-		@log = GlobaLog.logger(STDERR,:warn)
+	def initialize(type)
+		case type
+		when 0
+			@log = GlobaLog.logger(STDERR,:warn)
+			@id = type
+		when 1
+			@log = Logger.new(*GlobaLog::logger_params)
+			@log.level = GlobaLog::level
+			@id = type
+		when 2
+			@log = Logger.new(GlobaLog::output,*GlobaLog::options)
+			@log.level = GlobaLog::level
+			@id = type
+		end
 	end
 	
 	def log
-		log_all_level('external')
+		log_all_level("external #{@id}")
 	end
 	
 end

data/test/tc_globalog_main.rb

@@ -63,7 +63,9 @@ class TestGlobaLogMain < Test::Unit::TestCase
 		pid1 = fork {log_all_level('fork 1'); exit}
 		pid2 = fork {log_all_level('fork 2'); exit}
 		Process.waitpid(pid2,0)
-		External.new().log
+		External.new(0).log
+		External.new(1).log
+		External.new(2).log
 	end
 	
 	def check_test(level)
@@ -76,7 +78,9 @@ class TestGlobaLogMain < Test::Unit::TestCase
 		assert_match(/base/,content)
 		assert_match(/fork 1/,content)
 		assert_match(/fork 2/,content)
-		assert_match(/external/,content)
+		assert_match(/external 0/,content)
+		assert_match(/external 1/,content)
+		assert_match(/external 2/,content)
 	end
 	
 	def check_level(level,content)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: globalog
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-12 00:00:00 -05:00
+date: 2009-02-14 00:00:00 -05:00
 default_executable: 
 dependencies: []