loggability 0.3.0 → 0.4.0

data.tar.gz.sig

@@ -1,2 +1 @@
-���
J
-��70�>���B<��ߘ����5�$���ԋ��ry���;����-��""Fa�2��J;u'��p5�8j��W+B7m�ꢹ�X��;������Ze�����$[�2��Y�����)h�XD��,� ��T����?'�%H!�"}���$>�c�`�ܾ5��R	W�ІE�"�����mDa��n4n�;Ն5�r�o��92��]�u�
 ��'����5 ��^��64��᷏��Biy��Y�P���
+?�R�
<��R��?�pmC:�kΊda����$}#eY��}G�����lM+ۋ�|i��� �>!
 #���.����j����m9��h�e���F1d�d�"�y�u�ƀѰ�����-���5@�+���߱�a��ึ�����C>[��kv:���F�a���6P�/l&٧�GJjl�=�^��ST��

data/ChangeLog

@@ -1,9 +1,27 @@
+2012-05-26  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.3.0 for changeset 6c526d42bafb
+	[581580843d12] [tip]
+
+	* .hgsigs:
+	Added signature for changeset 7b6ef57de872
+	[6c526d42bafb] [v0.3.0]
+
+	* History.rdoc, lib/loggability.rb:
+	Bump the minor version, update history.
+	[7b6ef57de872]
+
+	* Manifest.txt, lib/loggability/spechelpers.rb, spec/lib/helpers.rb:
+	Add Loggability::SpecHelpers for setting up logging in tests.
+	[e9edf26e0c6a]
+
 2012-05-22  Michael Granger  <ged@FaerieMUD.org>
 
 	* lib/loggability/formatter.rb, spec/loggability/formatter_spec.rb,
 	spec/loggability/logger_spec.rb:
 	Downcase the severity before outputting.
-	[040bb1a5dc84] [tip]
+	[040bb1a5dc84] [github/master]
 
 2012-05-18  Michael Granger  <ged@FaerieMUD.org>
 

data/History.rdoc

@@ -1,3 +1,14 @@
+== v0.4.0 [2012-05-26] Michael Granger <ged@FaerieMUD.org>
+
+- Add some conversion-convenience code. You can now assign ::Logger
+  instances to LogHosts, use ::Logger::Formatter, and construct
+  Loggability::Logger instances with any device supported by
+  #output_to.
+  
+  Also adds a Loggability::Logger() casting method for easy logger
+  creation.
+
+
 == v0.3.0 [2012-05-26] Michael Granger <ged@FaerieMUD.org>
 
 - Add Loggability::SpecHelpers for setting up logging in tests.

data/lib/loggability.rb

@@ -9,10 +9,10 @@ require 'date'
 module Loggability
 
 	# Package version constant
-	VERSION = '0.3.0'
+	VERSION = '0.4.0'
 
 	# VCS revision
-	REVISION = %q$Revision: 7b6ef57de872 $
+	REVISION = %q$Revision: 2615ed217d34 $
 
 	# The key for the global logger (Loggability's own logger)
 	GLOBAL_KEY = :__global__
@@ -61,6 +61,15 @@ module Loggability
 	end
 
 
+	### Cast the given +device+ to a Loggability::Logger, if possible, and return it. If
+	### it can't be converted, raises a ArgumentError.
+	def self::Logger( device )
+		return device if device.is_a?( Loggability::Logger )
+		return Loggability::Logger.from_std_logger( device ) if device.is_a?( ::Logger )
+		return Loggability::Logger.new( device )
+	end
+
+
 	### Register the specified +host+ as a log host. It should already have been extended
 	### with LogHostMethods.
 	def self::register_loghost( host )
@@ -188,13 +197,20 @@ module Loggability
 		attr_accessor :default_logger
 
 		# The logger that's currently in effect
-		attr_accessor :logger
+		attr_reader :logger
 		alias_method :log, :logger
-		alias_method :log=, :logger=
 
 		# The key associated with the logger for this host
 		attr_accessor :log_host_key
 
+
+		### Set the logger associated with the LogHost to +newlogger+. If +newlogger+ isn't a
+		### Loggability::Logger, it will be converted to one.
+		def logger=( newlogger )
+			@logger = Loggability::Logger( newlogger )
+		end
+		alias_method :log=, :logger=
+
 	end # module LogHost
 
 

data/lib/loggability/logger.rb

@@ -125,10 +125,31 @@ class Loggability::Logger < ::Logger
 	end # class ObjectNameProxy
 
 
+	### Return an equivalent Loggability::Logger object for the given +logger+.
+	def self::from_std_logger( logger )
+		device = logger.instance_variable_get( :@logdev ) or
+			raise ArgumentError, "%p doesn't appear to be a Logger (no @logdev)" % [ logger ]
+
+		newlogger = self.new( device.dev )
+
+		newlogger.level     = logger.level
+		newlogger.formatter = logger.formatter
+
+		return newlogger
+	end
+
+
+	#################################################################
+	###	I N S T A N C E   M E T H O D S
+	#################################################################
+
 	### Create a new Logger wrapper that will output to the specified +logdev+.
 	def initialize( logdev=DEFAULT_DEVICE, *args )
-		super
+		super( nil )
+
 		self.level = if $DEBUG then :debug else :warn end
+		self.output_to( logdev, *args )
+
 		@default_formatter = Loggability::Formatter.create( :default )
 	end
 
@@ -189,7 +210,7 @@ class Loggability::Logger < ::Logger
 	### set up logging to any object that responds to #<<.
 	def output_to( target, *args )
 		if target.respond_to?( :write ) || target.is_a?( String )
-			opts = { :shift_age => args.shift, :shift_size => args.shift }
+			opts = { :shift_age => args.shift || 0, :shift_size => args.shift || 1048576 }
 			self.logdev = Logger::LogDevice.new( target, opts )
 		elsif target.respond_to?( :<< )
 			self.logdev = AppendingLogDevice.new( target )

data/spec/loggability/logger_spec.rb

@@ -35,6 +35,17 @@ describe Loggability::Logger do
 		@logger.inspect.should =~ /severity: \S+ formatter: \S+ outputting to: \S+/
 	end
 
+
+	it "provides an upgrade constructor for regular Logger objects" do
+		logger = ::Logger.new( $stderr )
+		newlogger = described_class.from_std_logger( logger )
+		newlogger.should be_a( Loggability::Logger )
+		newlogger.logdev.dev.should be( logger.instance_variable_get(:@logdev).dev )
+		Loggability::LOG_LEVELS[ newlogger.level ].should == logger.level
+		newlogger.formatter.should be_a( Loggability::Formatter::Default )
+	end
+
+
 	describe "severity level API" do
 
 		it "defaults to :warn level" do
@@ -128,6 +139,15 @@ describe Loggability::Logger do
 			@logger.formatter.should be_a( Loggability::Formatter::HTML )
 		end
 
+		it "supports formatting with ::Logger::Formatter, too" do
+			output = []
+			@logger.output_to( output )
+			@logger.level = :debug
+			@logger.formatter = ::Logger::Formatter.new
+			@logger.debug "This should work."
+			output.first.should =~ /D, \[\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d.\d+ #\d+\] DEBUG -- : This should work.\n/
+		end
+
 	end
 
 

data/spec/loggability_spec.rb

@@ -26,6 +26,7 @@ describe Loggability do
 		described_class.log_hosts.should include( Loggability::GLOBAL_KEY => Loggability )
 	end
 
+
 	describe "version methods" do
 		it "returns a version string if asked" do
 			described_class.version_string.should =~ /\w+ [\d.]+/
@@ -84,6 +85,17 @@ describe Loggability do
 			Loggability[ subclass ].should be( origin.logger )
 		end
 
+		it "wraps Logger instances assigned as its logger in a Loggability::Logger" do
+			@class.log_as( :testing )
+
+			logger = ::Logger.new( $stderr )
+
+			@class.logger = logger
+			@class.logger.should be_a( Loggability::Logger )
+
+			@class.log.debug "This shouldn't raise."
+		end
+
 	end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-26 00:00:00.000000000 Z
+date: 2012-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginfactory