loggability 0.1.0 → 0.2.0

data/ChangeLog

@@ -1,8 +1,68 @@
+2012-05-10  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems, README.rdoc, Rakefile, lib/loggability.rb,
+	spec/lib/helpers.rb, spec/loggability/logger_spec.rb,
+	spec/loggability_spec.rb:
+	Add Configurability support.
+	[555511f82876] [tip]
+
+	* lib/loggability/logger.rb:
+	Make Logger#inspect output a bit more terse
+	[fbddf3595a38]
+
+2012-05-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.1.0 for changeset 929216c0ffee
+	[65953fe69af2]
+
+	* .hgsigs:
+	Added signature for changeset ea1633c450be
+	[929216c0ffee] [v0.1.0]
+
+	* History.rdoc, lib/loggability.rb:
+	Bump minor version, update history.
+	[ea1633c450be]
+
+	* .hgignore, Rakefile, lib/loggability.rb,
+	lib/loggability/constants.rb, lib/loggability/formatter/color.rb,
+	lib/loggability/logger.rb, spec/loggability/formatter/html_spec.rb,
+	spec/loggability/formatter_spec.rb, spec/loggability/logger_spec.rb:
+	Remove all 1.9isms so it works under 1.8.x.
+
+	I've been trying to do everything in 1.9 first, but it turns out
+	there's still some 1.8 stuff that I need to support that I'd like to
+	use this with.
+	[e702bbec7c9d]
+
+	* lib/loggability/formatter/color.rb:
+	Fix the docs for the color formatter
+	[4191fb2e0d14]
+
+2012-05-07  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.0.2 for changeset 9a502152869e
+	[984798ba8ace]
+
+	* .hgsigs:
+	Added signature for changeset 1099204b229f
+	[9a502152869e] [v0.0.2]
+
+	* History.rdoc, lib/loggability.rb:
+	Bumped the patch version, updated History.
+	[1099204b229f]
+
+	* lib/loggability/formatter/html.rb, spec/lib/helpers.rb,
+	spec/loggability/formatter/html_spec.rb:
+	Fix escaping of the 'progname' in the HTML log formatter.
+	[748e600c8037]
+
 2012-05-06  Michael Granger  <ged@FaerieMUD.org>
 
 	* README.rdoc:
 	Add some stuff to the README.
-	[711c4dff84cf] [tip]
+	[711c4dff84cf] [github/master]
 
 	* .hgtags:
 	Added tag v0.0.1 for changeset 6dc36a56ff79

data/History.rdoc

@@ -1,3 +1,8 @@
+== v0.2.0 [2012-05-10] Michael Granger <ged@FaerieMUD.org>
+
+Add Configurability support.
+
+
 == v0.1.0 [2012-05-08] Michael Granger <ged@FaerieMUD.org>
 
 - Add Ruby 1.8.7 support.

data/README.rdoc

@@ -45,6 +45,43 @@ An example:
     Loggability.level = :info
 
 
+=== Configurability
+
+Loggability has support for the Configurability[https://rubygems.org/gems/configurability]
+library, which does the same thing for configuration that Loggability does for
+logging.
+
+You can configure all registered loggers from the 'logging' section of the config:
+
+    logging:
+	  __default__: warn STDERR
+	  mongrel2: info STDOUT (html)
+	  strelka: debug (html)
+	  inversion: error /var/log/templating.log (default)
+
+The format of the value of each logger is:
+
+    SEVERITY [TARGET] [(FORMAT)]
+
+where:
+
+[+SEVERITY+]
+  The log level; one of: +debug+, +info+, +warn+, +error+, or +fatal+
+[+TARGET+]
+  The destination for log messages. This can be the path to a log file, or
+  one of <tt>'STDOUT'</tt> or <tt>'STDERR'</tt>, which get mapped to the
+  equivalent filehandle. Optional.
+[+FORMAT+]
+  The name of one of the formatters. Loggability comes with +default+ (plaintext),
+  +color+ (ANSI colored text), and +html+ formatters.
+
+If the special key <tt>__default__</tt> is included, its config will be used to set
+global defaults before the individual configs are applied.
+
+If either of the optional values is unspecified, it is left unchanged from what it
+was before configuration.
+
+
 == Prerequisites
 
 * Ruby 1.9.3 or better, Rubinius 2.0 or better

data/Rakefile

@@ -21,10 +21,11 @@ hoespec = Hoe.spec 'loggability' do
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.dependency 'pluginfactory', '~> 1.0'
+	self.dependency 'pluginfactory',   '~> 1.0'
 
-	self.dependency 'hoe-deveiate',  '~> 0.1', :developer
-	self.dependency 'simplecov',     '~> 0.6', :developer
+	self.dependency 'hoe-deveiate',    '~> 0.1', :developer
+	self.dependency 'simplecov',       '~> 0.6', :developer
+	self.dependency 'configurability', '~> 1.2', :developer
 
 	self.spec_extras[:licenses] = ["Ruby"]
 	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Loggability Toolkit']

data/lib/loggability/logger.rb

@@ -33,6 +33,15 @@ class Loggability::Logger < ::Logger
 			@target = target
 		end
 
+
+		######
+		public
+		######
+
+		# The target of the log device
+		attr_reader :target
+
+
 		### Append the specified +message+ to the target.
 		def write( message )
 			@target << message
@@ -128,6 +137,24 @@ class Loggability::Logger < ::Logger
 	public
 	######
 
+	### Return a human-readable representation of the object suitable for debugging.
+	def inspect
+		dev = if self.logdev.respond_to?( :dev )
+				self.logdev.dev.class
+			else
+				self.logdev.target.class
+			end
+
+		return "#<%p:%#x severity: %s, formatter: %s, outputting to: %p>" % [
+			self.class,
+			self.object_id * 2,
+			self.level,
+			self.formatter.class.name.sub( /.*::/, '' ).downcase,
+			dev,
+		]
+	end
+
+
 	#
 	# :section: Severity Level
 	#

data/lib/loggability.rb

@@ -5,15 +5,14 @@
 require 'logger'
 require 'date'
 
-
 # A mixin that provides a top-level logging subsystem based on Logger.
 module Loggability
 
 	# Package version constant
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 
 	# VCS revision
-	REVISION = %q$Revision: ea1633c450be $
+	REVISION = %q$Revision: 4c9840dcb9fd $
 
 	# The key for the global logger (Loggability's own logger)
 	GLOBAL_KEY = :__global__
@@ -21,6 +20,30 @@ module Loggability
 	# The methods that are delegated across all loggers
 	AGGREGATE_METHODS = [ :level=, :output_to, :write_to, :format_with, :format_as, :formatter= ]
 
+	# Configuration defaults
+	CONFIG_DEFAULTS = {
+		:defaults => {
+			:severity  => 'warn',
+			:formatter => 'default',
+			:output    => 'STDERR',
+		},
+	}
+
+	# Regexp for parsing logspec lines in the config
+	LOGSPEC_PATTERN = %r{
+		^
+			\s*
+			((?i:debug|info|warn|error|fatal))   # severity
+		    (?:
+				\s+
+				((?:[\w\-/:\.]|\\[ ])+)
+			)?
+			(?: \s+\(
+				(\w+)
+			\) )?
+			\s*
+		$
+	}x
 
 	require 'loggability/constants'
 	include Loggability::Constants
@@ -56,9 +79,26 @@ module Loggability
 	end
 
 
+	### Return the log host key for +object+, using its #log_host_key method
+	### if it has one, or returning it as a Symbol if it responds to #to_sym. Returns
+	### +nil+ if no key could be derived.
+	def self::log_host_key_for( object )
+		return object.log_host_key if object.respond_to?( :log_host_key )
+		return object.to_sym if object.respond_to?( :to_sym )
+		return nil
+	end
+
+
+	### Returns +true+ if there is a log host associated with the given +object+.
+	def self::log_host?( object )
+		key = self.log_host_key_for( object ) or return false
+		return self.log_hosts.key?( key )
+	end
+
+
 	### Return the Loggability::Logger for the loghost associated with +logclient+.
 	def self::[]( logclient )
-		key = logclient.log_host_key if logclient.respond_to?( :log_host_key )
+		key = self.log_host_key_for( logclient )
 		key ||= GLOBAL_KEY
 
 		return self.log_hosts[ key ].logger
@@ -79,7 +119,10 @@ module Loggability
 	### Call the method with the given +methodname+ across the loggers of all loghosts with
 	### the given +arg+ and/or +block+.
 	def self::aggregate( methodname, arg, &block )
+		# self.log.debug "Aggregating a call to %p with %p to %d log hosts" %
+		#	[ methodname, arg, Loggability.log_hosts.length ]
 		Loggability.log_hosts.values.each do |loghost|
+			# self.log.debug "  %p.logger.%s( %p )" % [ loghost, methodname, arg ]
 			loghost.logger.send( methodname, arg, &block )
 		end
 	end
@@ -221,17 +264,80 @@ module Loggability
 	### either the +key+ the host registered with, or the log host object itself. Log messages
 	### can be written to the loghost via the LogClient API, which is automatically included.
 	def log_to( loghost )
-		self.extend( Loggability::LogClient )
-		self.log_host_key = if loghost.respond_to?( :log_host_key )
-				loghost.log_host_key
+		extend( Loggability::LogClient )
+		include( Loggability::LogClient::InstanceMethods ) if self.is_a?( Class )
+
+		self.log_host_key = Loggability.log_host_key_for( loghost )
+	end
+
+
+	#
+	# :section: Configurability Support
+	#
+
+	# Load the Configurability library if it's installed
+	begin
+		require 'configurability'
+	rescue LoadError
+	end
+
+
+	# Configurability support -- load Loggability configuration from the 'logging' section
+	# of the config.
+	if defined?( Configurability )
+		extend Configurability
+		config_key :logging if respond_to?( :config_key )
+	end
+
+	### Configurability API -- configure logging.
+	def self::configure( config=nil )
+		if config
+			self.log.debug "Configuring Loggability with custom config."
+
+			# Set up all loggers with defaults first
+			if defaultspec = config.delete( :__default__ ) || config.delete( '__default__' )
+				level, format, target = self.parse_config_spec( defaultspec )
+				Loggability.level = level if level
+				Loggability.format_as( format ) if format
+				Loggability.output_to( target ) if target
+			end
+
+			# Then let individual configs override.
+			config.each do |key, logspec|
+				unless Loggability.log_host?( key )
+					self.log.debug "  no such log host %p; skipping" % [ key ]
+					next
+				end
+
+				self.log.debug "  configuring logger for %p: %s" % [ key, logspec ]
+				level, format, target = self.parse_config_spec( logspec )
+				Loggability[ key ].level = level if level
+				Loggability[ key ].format_with( format ) if format
+				Loggability[ key ].output_to( target ) if target
+			end
+		else
+			self.log.debug "Configuring Loggability with defaults."
+		end
+	end
+
+
+	### Parse the specified +spec+ into level,
+	def self::parse_config_spec( spec )
+		match = LOGSPEC_PATTERN.match( spec ) or
+			raise ArgumentError, "Couldn't parse logspec: %p" % [ spec ]
+		self.log.error "  parsed config spec %p -> %p" % [ spec, match ]
+		severity, target, format = match.captures
+
+		target = case target
+			when 'STDOUT' then $stdout
+			when 'STDERR' then $stderr
 			else
-				loghost.to_sym
+				target
 			end
 
-		# For objects that also can be instantiated
-		include( Loggability::LogClient::InstanceMethods ) if self.is_a?( Class )
+		return severity, format, target
 	end
 
 
-end # module Strelka
+end # module Loggability
 

data/spec/lib/helpers.rb

@@ -28,9 +28,34 @@ require 'loggability' unless defined?( Loggability )
 #
 module Loggability::SpecHelpers
 
+	### Reset the logging subsystem to its default state.
+	def reset_logging
+		Loggability.formatter = nil
+		Loggability.output_to( $stderr )
+		Loggability.level = :fatal
+	end
+
+
+	### Alter the output of the default log formatter to be pretty in SpecMate output
+	def setup_logging( level=:fatal )
+
+		# Only do this when executing from a spec in TextMate
+		if ENV['HTML_LOGGING'] || (ENV['TM_FILENAME'] && ENV['TM_FILENAME'] =~ /_spec\.rb/)
+			logarray = []
+			Thread.current['logger-output'] = logarray
+			Loggability.output_to( logarray )
+			Loggability.format_as( :html )
+			Loggability.level = :debug
+		else
+			Loggability.level = level
+		end
+	end
+
+
 end # Loggability::SpecHelpers
 
 
+
 ### Mock with RSpec
 RSpec.configure do |c|
 	c.mock_with( :rspec )

data/spec/loggability/logger_spec.rb

@@ -31,6 +31,10 @@ describe Loggability::Logger do
 	end
 
 
+	it "has a less-verbose inspection format than that of its parent" do
+		@logger.inspect.should =~ /severity: \S+ formatter: \S+ outputting to: \S+/
+	end
+
 	describe "severity level API" do
 
 		it "defaults to :warn level" do
@@ -145,6 +149,12 @@ describe Loggability::Logger do
 			messages.first.should =~ /DEBUG \{Object:0x[[:xdigit:]]+\} -- A debug message.\n/
 		end
 
+		it "has a terse inspection format" do
+			object = Object.new
+			@logger.proxy_for( object ).inspect.
+				should =~ /ObjectNameProxy.* for Object/
+		end
+
 	end
 
 end

data/spec/loggability_spec.rb

@@ -13,12 +13,19 @@ require 'loggability/logger'
 
 describe Loggability do
 
+	before( :each ) do
+		setup_logging( :fatal )
+	end
+
+	after( :each ) do
+		reset_logging()
+	end
+
 	it "is itself a log host for the global logger" do
 		described_class.logger.should be_a( Loggability::Logger )
 		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.]+/
@@ -46,6 +53,8 @@ describe Loggability do
 			Loggability.log_hosts.should include( :testing => @class )
 			@class.logger.should be_a( Loggability::Logger )
 			@class.default_logger.should be( @class.logger )
+			Loggability[ @class ].should be( @class.logger )
+			Loggability[ :testing ].should be( @class.logger )
 		end
 
 		it "allows it to designate itself as a logging client" do
@@ -55,8 +64,12 @@ describe Loggability do
 			end
 			@class.log_to( :testing )
 			@class.log.logger.should be( origin.logger )
+			Loggability[ @class ].should be( origin.logger )
 
-			@class.new.log.logger.should be( origin.logger )
+			obj = @class.new
+
+			obj.log.logger.should be( origin.logger )
+			Loggability[ obj ].should be( origin.logger )
 		end
 
 	end
@@ -80,5 +93,87 @@ describe Loggability do
 
 	end
 
+
+	describe "Configurability support" do
+
+		after( :each ) do
+			File.delete( 'spec-error.log' ) if File.exist?( 'spec-error.log' )
+		end
+
+		it "can parse a logging config spec with just a severity" do
+			Loggability.parse_config_spec( 'debug' ).should == [ 'debug', nil, nil ]
+		end
+
+		it "can parse a logging config spec with a severity and STDERR" do
+			Loggability.parse_config_spec( 'fatal STDERR' ).should == [ 'fatal', nil, $stderr ]
+		end
+
+		it "can parse a logging config spec with a severity and STDOUT" do
+			Loggability.parse_config_spec( 'error STDOUT' ).should == [ 'error', nil, $stdout ]
+		end
+
+		it "can parse a logging config spec with a severity and a path" do
+			Loggability.parse_config_spec( 'debug /var/log/debug.log' ).
+				should == [ 'debug', nil, '/var/log/debug.log' ]
+		end
+
+		it "can parse a logging config spec with a severity and a path with escaped spaces" do
+			Loggability.parse_config_spec( 'debug /store/media/Stormcrow\\ and\\ Raven/dl.log' ).
+				should == [ 'debug', nil, '/store/media/Stormcrow\\ and\\ Raven/dl.log' ]
+		end
+
+		it "can parse a logging config spec with a severity and a formatter" do
+			Loggability.parse_config_spec( 'warn (html)' ).
+				should == [ 'warn', 'html', nil ]
+		end
+
+		it "can parse a logging config spec with a severity, a path, and a formatter" do
+			Loggability.parse_config_spec( 'info /usr/local/www/htdocs/log.html (html)' ).
+				should == [ 'info', 'html', '/usr/local/www/htdocs/log.html' ]
+		end
+
+		it "can configure loghosts via its ::configure method" do
+			class1 = Class.new { extend Loggability; log_as :class1 }
+			class2 = Class.new { extend Loggability; log_as :class2 }
+
+			config = {'class1' => 'debug (html)', 'class2' => 'error spec-error.log'}
+			Loggability.configure( config )
+
+			Loggability[ class1 ].level.should == :debug
+			Loggability[ class1 ].formatter.should be_a( Loggability::Formatter::HTML )
+			Loggability[ class2 ].level.should == :error
+			Loggability[ class2 ].logdev.dev.should be_a( File )
+			Loggability[ class2 ].logdev.dev.path.should == 'spec-error.log'
+		end
+
+		it "can configure all loghosts with a config key of __default__" do
+			Loggability.configure( '__default__' => 'debug STDERR (html)' )
+
+			all_loggers = Loggability.log_hosts.values.map( &:logger )
+			all_loggers.all? {|lh| lh.level == :debug }.should be_true()
+			all_loggers.all? {|lh| lh.formatter.class == Loggability::Formatter::HTML }.should be_true()
+			all_loggers.all? {|lh| lh.logdev.dev.should == $stderr }.should be_true()
+		end
+
+		it "raises an error if configured with a logspec with an invalid severity" do
+			expect {
+				Loggability.configure( 'class1' => 'awesome /var/log/awesome.log' )
+			}.to raise_error( ArgumentError, /couldn't parse/i )
+		end
+
+		it "raises an error if configured with a logspec with an malformed filename" do
+			expect {
+				Loggability.configure( 'class1' => 'info Kitchen!!' )
+			}.to raise_error( ArgumentError, /couldn't parse/i )
+		end
+
+		it "raises an error if configured with a bogus formatter" do
+			expect {
+				Loggability.configure( 'class1' => 'debug (mindwaves)' )
+			}.to raise_error( FactoryError, /couldn't find a formatter/i )
+		end
+
+	end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loggability
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
   Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
   cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pluginfactory
@@ -134,6 +134,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: configurability
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement

metadata.gz.sig

@@ -1,3 +1 @@
-`�U�J�-�j|�`�(CG8p[��vj'���X�5{6;o�Y���(ni3q
-�������ɏ<o�@
-e��<��]�B��� ���>
+���hZ���u�ҹ>|�"O'E���@�}�I{��Yzw�諸g�<�H4�l���+����L�*�����o���NJ�Ɗ>��N>��_�!�a[