loggability 0.14.0 → 0.15.0.pre20190714094638

data/Manifest.txt

@@ -10,6 +10,7 @@ lib/loggability/formatter.rb
 lib/loggability/formatter/color.rb
 lib/loggability/formatter/default.rb
 lib/loggability/formatter/html.rb
+lib/loggability/formatter/structured.rb
 lib/loggability/logclient.rb
 lib/loggability/logger.rb
 lib/loggability/loghost.rb
@@ -17,7 +18,9 @@ lib/loggability/override.rb
 lib/loggability/spechelpers.rb
 spec/helpers.rb
 spec/loggability/formatter/color_spec.rb
+spec/loggability/formatter/default_spec.rb
 spec/loggability/formatter/html_spec.rb
+spec/loggability/formatter/structured_spec.rb
 spec/loggability/formatter_spec.rb
 spec/loggability/logger_spec.rb
 spec/loggability/loghost_spec.rb

data/Rakefile

@@ -27,8 +27,9 @@ hoespec = Hoe.spec 'loggability' do
 	self.dependency 'hoe-bundler',     '~> 1.2', :developer
 	self.dependency 'simplecov',       '~> 0.7', :developer
 	self.dependency 'configurability', '~> 3.1', :developer
+	self.dependency 'timecop',         '~> 0.9', :developer
 
-	self.license "Ruby"
+	self.license "BSD-3-Clause"
 	self.require_ruby_version( '>=1.9.3' )
 	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
 	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )

data/lib/loggability.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'logger'
 require 'date'
@@ -12,7 +12,7 @@ module Loggability
 	VERSION = '0.14.0'
 
 	# VCS revision
-	REVISION = %q$Revision: 500260d36bfb $
+	REVISION = %q$Revision$
 
 	# The key for the global logger (Loggability's own logger)
 	GLOBAL_KEY = :__global__

data/lib/loggability/constants.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'logger'
 require 'loggability' unless defined?( Loggability )

data/lib/loggability/formatter.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 
@@ -8,21 +8,23 @@ require 'loggability' unless defined?( Loggability )
 ### An abstract base class for Loggability log formatters.
 class Loggability::Formatter
 
-	# The default sprintf pattern
-	DEFAULT_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
-
-
 	##
 	# Derivative classes, keyed by name
-	class << self; attr_reader :derivatives; end
+	singleton_class.attr_reader( :derivatives )
 	@derivatives = {}
 
 
 	### Inherited hook -- add subclasses to the ::derivatives Array.
 	def self::inherited( subclass )
 		super
-		classname = subclass.name.sub( /.*::/, '' ).downcase.to_sym
-		Loggability::Formatter.derivatives[ classname ] = subclass
+
+		if ( name = subclass.name )
+			classname = name.sub( /.*::/, '' ).downcase
+		else
+			classname = "anonymous_%d" % [ subclass.object_id ]
+		end
+
+		Loggability::Formatter.derivatives[ classname.to_sym ] = subclass
 	end
 
 
@@ -42,69 +44,13 @@ class Loggability::Formatter
 	end
 
 
-
-	### Initialize a new Loggability::Formatter. The specified +logformat+ should
-	### be a sprintf pattern with positional placeholders:
-	###
-	### [<tt>%1$s</tt>] Time (pre-formatted using strftime with the +datetime_format+)
-	### [<tt>%2$d</tt>] Time microseconds
-	### [<tt>%3$d</tt>] PID
-	### [<tt>%4$s</tt>] Thread ID
-	### [<tt>%5$s</tt>] Severity
-	### [<tt>%6$s</tt>] Object/Program Name
-	### [<tt>%7$s</tt>] Message
-	###
-	def initialize( logformat, datetime_format=DEFAULT_DATETIME_FORMAT )
-		@format          = logformat.dup
-		@datetime_format = datetime_format.dup
-	end
-
-
-	######
-	public
-	######
-
-	# Main log sprintf format
-	attr_accessor :format
-
-	# Strftime format for log messages
-	attr_accessor :datetime_format
-
-
 	### Create a log message from the given +severity+, +time+, +progname+, and +message+
 	### and return it.
 	def call( severity, time, progname, message )
-		timeformat = self.datetime_format
-		args = [
-			time.strftime( timeformat ),                                       # %1$s
-			time.usec,                                                         # %2$d
-			Process.pid,                                                       # %3$d
-			Thread.current == Thread.main ? 'main' : Thread.current.object_id, # %4$s
-			severity.downcase,                                                 # %5$s
-			progname,                                                          # %6$s
-			self.msg2str(message, severity)                                    # %7$s
-		]
-
-		return self.format % args
+		raise NotImplementedError, "%p doesn't implement required method %s" %
+			[ self.class, __method__ ]
 	end
 
 
-	#########
-	protected
-	#########
-
-	### Format the specified +msg+ for output to the log.
-	def msg2str( msg, severity )
-		case msg
-		when String
-			return msg
-		when Exception
-			bt = severity == 'DEBUG' ? msg.backtrace.join("\n") : msg.backtrace.first
-			return "%p: %s from %s" % [ msg.class, msg.message, bt ]
-		else
-			return msg.inspect
-		end
-	end
-
 end # class Loggability::Formatter
 

data/lib/loggability/formatter/color.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 require 'loggability/formatter' unless defined?( Loggability::Formatter )

data/lib/loggability/formatter/default.rb

@@ -1,20 +1,83 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 require 'loggability/formatter' unless defined?( Loggability::Formatter )
 
 
-# The default log formatter class.
+# The default sprintf-based log formatter class.
 class Loggability::Formatter::Default < Loggability::Formatter
 
+	# The default sprintf pattern
+	DEFAULT_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
+
 	# The format to output unless debugging is turned on
 	FORMAT = "[%1$s.%2$06d %3$d/%4$s] %5$5s {%6$s} -- %7$s\n"
 
-	### Specify the format for the default formatter.
-	def initialize( format=FORMAT )
-		super
+	### Initialize a new Loggability::Formatter. The specified +logformat+ should
+	### be a sprintf pattern with positional placeholders:
+	###
+	### [<tt>%1$s</tt>] Time (pre-formatted using strftime with the +datetime_format+)
+	### [<tt>%2$d</tt>] Time microseconds
+	### [<tt>%3$d</tt>] PID
+	### [<tt>%4$s</tt>] Thread ID
+	### [<tt>%5$s</tt>] Severity
+	### [<tt>%6$s</tt>] Object/Program Name
+	### [<tt>%7$s</tt>] Message
+	###
+	def initialize( logformat=FORMAT, datetime_format=DEFAULT_DATETIME_FORMAT )
+		super()
+
+		@format          = logformat.dup
+		@datetime_format = datetime_format.dup
+	end
+
+
+	######
+	public
+	######
+
+	# Main log sprintf format
+	attr_accessor :format
+
+	# Strftime format for log messages
+	attr_accessor :datetime_format
+
+
+	### Create a log message from the given +severity+, +time+, +progname+, and +message+
+	### and return it.
+	def call( severity, time, progname, message )
+		timeformat = self.datetime_format
+		args = [
+			time.strftime( timeformat ),                                       # %1$s
+			time.usec,                                                         # %2$d
+			Process.pid,                                                       # %3$d
+			Thread.current == Thread.main ? 'main' : Thread.current.object_id, # %4$s
+			severity.downcase,                                                 # %5$s
+			progname,                                                          # %6$s
+			self.msg2str(message, severity)                                    # %7$s
+		]
+
+		return self.format % args
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Format the specified +msg+ for output to the log.
+	def msg2str( msg, severity )
+		case msg
+		when String
+			return msg
+		when Exception
+			bt = severity == 'DEBUG' ? msg.backtrace.join("\n") : msg.backtrace.first
+			return "%p: %s from %s" % [ msg.class, msg.message, bt ]
+		else
+			return msg.inspect
+		end
 	end
 
 end # class Loggability::Formatter::Default

data/lib/loggability/formatter/html.rb

@@ -1,13 +1,13 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'loggability' unless defined?( Loggability )
 require 'loggability/formatter' unless defined?( Loggability::Formatter )
+require 'loggability/formatter/default'
 
 
-# The default log formatter class.
-class Loggability::Formatter::HTML < Loggability::Formatter
+# Output logs as HTML
+class Loggability::Formatter::HTML < Loggability::Formatter::Default
 
 	# The default HTML fragment that'll be used as the template for each log message.
 	HTML_LOG_FORMAT = %q{

data/lib/loggability/logclient.rb

@@ -1,5 +1,6 @@
 # -*- ruby -*-
-#encoding: utf-8
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 

data/lib/loggability/logger.rb

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'logger'
 require 'loggability' unless defined?( Loggability )
@@ -278,7 +278,7 @@ class Loggability::Logger < ::Logger
 
 	### Format a log message using the current formatter and return it.
 	def format_message( severity, datetime, progname, msg )
-		self.formatter.call(severity, datetime, progname, msg)
+		self.formatter.call( severity, datetime, progname, msg )
 	end
 
 

data/lib/loggability/loghost.rb

@@ -1,5 +1,6 @@
 # -*- ruby -*-
-#encoding: utf-8
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 

data/lib/loggability/override.rb

@@ -1,5 +1,6 @@
 # -*- ruby -*-
-#encoding: utf-8
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require 'monitor'
 require 'loggability' unless defined?( Loggability )

data/lib/loggability/spechelpers.rb

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'loggability' unless defined?( Loggability )
 

data/spec/helpers.rb

@@ -1,15 +1,6 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
 # vim: set nosta noet ts=4 sw=4:
-# encoding: utf-8
-
-BEGIN {
-	require 'pathname'
-	basedir = Pathname.new( __FILE__ ).dirname.parent
-
-	libdir = basedir + "lib"
-
-	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
-}
+# frozen_string_literal: true
 
 # SimpleCov test coverage reporting; enable this using the :coverage rake task
 if ENV['COVERAGE']
@@ -25,6 +16,7 @@ begin
 rescue LoadError
 end
 
+require 'timecop'
 require 'loggability'
 require 'loggability/spechelpers'
 

data/spec/loggability/formatter/color_spec.rb

@@ -1,13 +1,9 @@
-# -*- rspec -*-
-#encoding: utf-8
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require_relative '../../helpers'
 
-require 'tempfile'
-require 'rspec'
-
-require 'loggability/logger'
-require 'loggability/formatter'
 require 'loggability/formatter/color'
 
 

data/spec/loggability/formatter/html_spec.rb

@@ -1,13 +1,9 @@
-# -*- rspec -*-
-#encoding: utf-8
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require_relative '../../helpers'
 
-require 'tempfile'
-require 'rspec'
-
-require 'loggability/logger'
-require 'loggability/formatter'
 require 'loggability/formatter/html'
 
 
@@ -15,12 +11,14 @@ describe Loggability::Formatter::HTML do
 
 	subject { described_class.new }
 
+
 	it "formats messages as HTML" do
 		expect(
 			subject.call( 'INFO', Time.at(1336286481), nil, "Foom." )
 		).to match( %r{<span class="log-message-text">Foom.</span>}i )
 	end
 
+
 	it "formats exceptions into useful messages" do
 		msg = nil
 
@@ -35,12 +33,14 @@ describe Loggability::Formatter::HTML do
 		expect( msg ).to match( %r{ from <span class=\"log-exc-firstframe\">}i )
 	end
 
+
 	it "formats regular objects into useful messages" do
 		expect(
 			subject.call( 'INFO', Time.at(1336286481), nil, Object.new )
 		).to match( %r{<span class=\"log-message-text\">#&lt;Object:0x[[:xdigit:]]+&gt;</span>} )
 	end
 
+
 	it "escapes the 'progname' part of log messages" do
 		progname = "#<Class:0x007f9efa153d08>:0x7f9efa153c18"
 		expect(

data/spec/loggability/formatter_spec.rb

@@ -1,52 +1,65 @@
-# -*- rspec -*-
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
 
 require_relative '../helpers'
 
-require 'tempfile'
-require 'rspec'
-
-require 'loggability/logger'
 require 'loggability/formatter'
-require 'loggability/formatter/default'
 
 
 describe Loggability::Formatter do
 
-	it "formats messages with the pattern it's constructed with" do
-		formatter = described_class.new( '[%5$s] %7$s' )
-		result = formatter.call( 'INFO', Time.at(1336286481), nil, 'Foom.' )
-		expect( result ).to match(/\[INFO\] Foom./i)
+	before( :all ) do
+		@actual_derivatives = described_class.derivatives.dup
+	end
+
+	after( :all ) do
+		described_class.derivatives.replace( @actual_derivatives )
 	end
 
 
-	it "formats exceptions into useful messages" do
-		formatter = described_class.new( '[%5$s] %7$s' )
-		msg = nil
+	describe "concrete subclasses" do
 
-		begin
-			raise ArgumentError, "invalid argument"
-		rescue => err
-			msg = formatter.call( 'INFO', Time.at(1336286481), nil, err )
+		class Test < described_class
 		end
 
-		expect( msg ).to match(/\[INFO\] ArgumentError: invalid argument/i)
-	end
 
+		it "must implement #call" do
+			expect {
+				Test.new.call( 'INFO', Time.now, nil, "A message." )
+			}.to raise_error( /doesn't implement required method/i )
+		end
 
-	it "formats regular objects into useful messages" do
-		formatter = described_class.new( '[%5$s] %7$s' )
-		result = formatter.call( 'INFO', Time.at(1336286481), nil, Object.new )
 
-		expect( result ).to match(/\[INFO\] #<Object:0x[[:xdigit:]]+>/i)
-	end
+		it "is tracked by the base class" do
+			expect( described_class.derivatives ).to include( test: Test )
+		end
 
 
-	it "includes the thread ID if logging from a thread other than the main thread" do
-		formatter = described_class.new( '%4$d' )
-		thr = Thread.new do
-			formatter.call( 'INFO', Time.now, nil, 'Foom.' )
+		it "is tracked if its anonymous" do
+			subclass = Class.new( described_class )
+			expect( described_class.derivatives.values ).to include( subclass )
 		end
-		expect( thr.value ).to eq( thr.object_id.to_s )
+
+
+		it "can be loaded by name" do
+			expect( described_class ).to receive( :require ).
+				with( "loggability/formatter/test" )
+
+			expect( described_class.create(:test) ).to be_an_instance_of( Test )
+		end
+
+
+		it "raises a LoadError if loading doesn't work" do
+			expect( described_class ).to receive( :require ).
+				with( "loggability/formatter/circus" )
+
+			expect {
+				described_class.create( :circus )
+			}.to raise_error( LoadError, /didn't load a class/i )
+		end
+
+
 	end
 
 end