loggability 0.14.0 → 0.18.0

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 )
@@ -24,35 +24,6 @@ class Loggability::Logger < ::Logger
 	DEFAULT_SHIFT_SIZE = 1048576
 
 
-	# A log device that appends to the object it's constructed with instead of writing
-	# to a file descriptor or a file.
-	class AppendingLogDevice
-
-		### Create a new AppendingLogDevice that will append content to +array+.
-		def initialize( target )
-			@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
-		end
-
-		### No-op -- this is here just so Logger doesn't complain
-		def close; end
-
-	end # class AppendingLogDevice
-
-
 	# Proxy for the Logger that injects the name of the object it wraps as the 'progname'
 	# of each log message.
 	class ObjectNameProxy
@@ -182,6 +153,28 @@ class Loggability::Logger < ::Logger
 	end
 
 
+	### Log a message if the +severity+ is high enough. Overridden to account for
+	### the overridden #level.
+	def add( severity, message=nil, progname=nil )
+		return true if severity < self.sev_threshold
+		progname ||= @progname
+
+		unless message
+			if block_given?
+				message = yield
+			else
+				message = progname
+				progname = @progname
+			end
+		end
+
+		msg = self.format_message( self.format_severity(severity), Time.now, progname, message )
+		self.logdev.write( msg )
+
+		return true
+	end
+
+
 	### Append operator -- Override Logger's append so log messages always have
 	### formatting, and are always appended at :debug level.
 	def <<( message )
@@ -224,8 +217,7 @@ class Loggability::Logger < ::Logger
 
 	### Return the logger's level as a Symbol.
 	def level
-		numeric_level = super
-		return LOG_LEVEL_NAMES[ numeric_level ]
+		return LOG_LEVEL_NAMES[ self.sev_threshold ]
 	end
 
 
@@ -251,14 +243,17 @@ class Loggability::Logger < ::Logger
 	### logging to IO objects and files (given a filename in a String), this method can also
 	### set up logging to any object that responds to #<<.
 	def output_to( target, *args )
-		if target.is_a?( Logger::LogDevice ) ||
-		   target.is_a?( Loggability::Logger::AppendingLogDevice )
+		if target.is_a?( Logger::LogDevice ) || target.is_a?( Loggability::LogDevice )
 			self.logdev = target
 		elsif target.respond_to?( :write ) || target.is_a?( String )
 			opts = { :shift_age => args.shift || 0, :shift_size => args.shift || 1048576 }
-			self.logdev = Logger::LogDevice.new( target, opts )
+			self.logdev = Logger::LogDevice.new( target, **opts )
+		elsif target.respond_to?( :any? ) && target.any?( Loggability::LogDevice )
+			self.logdev = MultiDevice.new( target )
 		elsif target.respond_to?( :<< )
-			self.logdev = AppendingLogDevice.new( target )
+			self.logdev = Loggability::LogDevice.create( :appending, target )
+		elsif target.is_a?( Symbol )
+			self.logdev = Loggability::LogDevice.create( target, *args )
 		else
 			raise ArgumentError, "don't know how to output to %p (a %p)" % [ target, target.class ]
 		end
@@ -278,14 +273,22 @@ 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
+
+
+	### Return the formatted name of the given +severity+.
+	def format_severity( severity )
+		name = LOG_LEVEL_NAMES[ severity ] || severity.to_s
+		return name.upcase
 	end
 
 
-	### Set a new +formatter+ for the logger. If +formatter+ is +nil+ or +:default+, this causes the
-	### logger to fall back to its default formatter. If it's a Symbol other than +:default+, it looks
-	### for a similarly-named formatter under loggability/formatter/ and uses that. If +formatter+ is
-	### an object that responds to #call (e.g., a Proc or a Method object), that object is used directly.
+	### Set a new +formatter+ for the logger. If +formatter+ is +nil+ or +:default+, this causes
+	### the logger to fall back to its default formatter. If it's a Symbol other than +:default+,
+	### it looks for a similarly-named formatter under loggability/formatter/ and uses that. If
+	### +formatter+ is an object that responds to #call (e.g., a Proc or a Method object), that
+	### object is used directly.
 	###
 	### Procs and methods should have the method signature: (severity, datetime, progname, msg).
 	###

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,10 +16,10 @@ begin
 rescue LoadError
 end
 
+require 'timecop'
 require 'loggability'
 require 'loggability/spechelpers'
 
-
 # Helpers specific to Loggability specs
 module SpecHelpers
 
@@ -107,10 +98,13 @@ RSpec.configure do |c|
 	c.mock_with( :rspec ) do |mock|
 		mock.syntax = :expect
 	end
+	c.warnings = true
+	c.profile_examples = 5
 
 	c.include( SpecHelpers )
 	c.include( Loggability::SpecHelpers )
 	c.filter_run_excluding( :configurability ) unless defined?( Configurability )
 
+
 end
 

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/default_spec.rb

@@ -0,0 +1,50 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
+
+require_relative '../../helpers'
+
+require 'loggability/formatter/default'
+
+
+describe Loggability::Formatter::Default 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)
+	end
+
+
+	it "formats exceptions into useful messages" do
+		formatter = described_class.new( '[%5$s] %7$s' )
+		msg = nil
+
+		begin
+			raise ArgumentError, "invalid argument"
+		rescue => err
+			msg = formatter.call( 'INFO', Time.at(1336286481), nil, err )
+		end
+
+		expect( msg ).to match(/\[INFO\] ArgumentError: invalid argument/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 "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.' )
+		end
+		expect( thr.value ).to eq( thr.object_id.to_s )
+	end
+
+end
+

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/structured_spec.rb

@@ -0,0 +1,61 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# frozen_string_literal: true
+
+require_relative '../../helpers'
+
+require 'loggability/formatter/structured'
+
+
+describe Loggability::Formatter::Structured do
+
+	before( :each ) do
+		ENV['TZ'] = 'UTC'
+	end
+
+
+	it "outputs a stream of JSON objects" do
+		expect(
+			subject.call('INFO', Time.at(1336286481), nil, "Foom.")
+		).to eq(
+			%q|{"@version":1,"@timestamp":"2012-05-06T06:41:21.000+00:00"| +
+			%q|,"level":"INFO","progname":null,"message":"Foom."}|
+		)
+	end
+
+
+	it "includes a time even if called without one" do
+		Timecop.freeze( Time.at(1563114765.123) ) do
+			expect(
+				subject.call('WARN', nil, nil, "Right.")
+			).to match( %r(
+				\{
+					"@version":1,
+					"@timestamp":"2019-07-14T14:32:45\.\d{3}\+00:00",
+					"level":"WARN",
+					"progname":null,
+					"message":"Right\."
+				\}
+			)x )
+		end
+	end
+
+
+	it "defaults to DEBUG severity" do
+		Timecop.freeze( Time.at(1563114765.123) ) do
+			expect(
+				subject.call(nil, nil, nil, "Crane.")
+			).to match( %r(
+				\{
+					"@version":1,
+					"@timestamp":"2019-07-14T14:32:45\.\d{3}\+00:00",
+					"level":"DEBUG",
+					"progname":null,
+					"message":"Crane\."
+				\}
+			)x )
+		end
+	end
+
+end
+

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