pantheios-ruby 0.19.2 → 0.22.0.1

data/lib/pantheios/services/multiplexing_log_service.rb

@@ -6,12 +6,13 @@
 #               ::Pantheios::Services::MultiplexingLogService class
 #
 # Created:      14th June 2015
-# Updated:      8th February 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -56,10 +57,11 @@ module Services
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides
 # the instance methods +severity_logged?(severity : Object) : boolean+ and
-# +log(severity : Object, t : Time, prefix : String, msg : String)+
+# +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class MultiplexingLogService
 
-	module MultiplexingLogService_Internals_
+	# @!visibility private
+	module MultiplexingLogService_Internals_ # :nodoc: all
 
 		class ServiceManagementInfo
 
@@ -167,6 +169,43 @@ class MultiplexingLogService
 	end
 	public
 
+	# Indicates whether any of the services require a prefix and, if so,
+	# what it may require
+	#
+	# === Return
+	# (+false+, +true+, +:parts+) An indicator what the most needy of the
+	# multiplexed services requires
+	def requires_prefix?
+
+		return @requires_prefix unless @requires_prefix.nil?
+
+		requires_prefix = false
+
+		@services.each do |svc|
+
+			if svc.respond_to? :requires_prefix?
+
+				case rp = svc.requires_prefix?
+				when nil, false
+
+					;
+				when true
+
+					requires_prefix ||= true
+				when :parts
+
+					requires_prefix = rp
+					break
+				else
+
+					warn "unrecognised return from requires_prefix? for service #{svc}: #{rp} (#{rp.class})"
+				end
+			end
+		end
+
+		@requires_prefix = requires_prefix
+	end
+
 	# Indicates whether the given severity is to be logged by any of the
 	# multiplexed log services
 	def severity_logged? severity

data/lib/pantheios/services/null_log_service.rb

@@ -6,12 +6,13 @@
 #               class
 #
 # Created:      14th June 2015
-# Updated:      8th February 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -56,7 +57,7 @@ module Services
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides
 # the instance methods +severity_logged?(severity : Object) : boolean+ and
-# +log(severity : Object, t : Time, prefix : String, msg : String)+
+# +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class NullLogService
 
 	def severity_logged? severity

data/lib/pantheios/services/simple_console_log_service.rb

@@ -6,12 +6,13 @@
 #               ::Pantheios::Services::SimpleConsoleLogService class
 #
 # Created:      14th June 2015
-# Updated:      6th January 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -45,8 +46,6 @@
 # ######################################################################## #
 
 
-require 'pantheios/application_layer/stock_severity_levels'
-
 =begin
 =end
 
@@ -58,7 +57,7 @@ module Services
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides
 # the instance methods +severity_logged?(severity : Object) : boolean+ and
-# +log(severity : Object, t : Time, prefix : String, msg : String)+
+# +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class SimpleConsoleLogService
 
 	def severity_logged? severity
@@ -73,13 +72,16 @@ class SimpleConsoleLogService
 		stm.puts "#{pref}#{msg}"
 	end
 
+	# Overrideable method that determines which stream to write, based on a
+	# severity. This implementation always returns +$stderr+
+	#
+	# Overrides must return an object that supports the +puts(String)+
+	# method
 	def infer_stream sev
 
-		sev = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev] if ::Symbol === sev
-
-		(sev.to_i < 6) ? $stderr : $stdout
+		$stderr
 	end
-end
+end # class SimpleConsoleLogService
 
 end # module Services
 end # module Pantheios

data/lib/pantheios/services/simple_file_log_service.rb

@@ -6,12 +6,13 @@
 #               ::Pantheios::Services::SimpleFileLogService class
 #
 # Created:      17th June 2015
-# Updated:      4th February 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -60,7 +61,7 @@ module Services
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides
 # the instance methods +severity_logged?(severity : Object) : boolean+ and
-# +log(severity : Object, t : Time, prefix : String, msg : String)+
+# +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class SimpleFileLogService
 
 	module SimpleFileLogService_Constants
@@ -94,8 +95,6 @@ class SimpleFileLogService
 	#   - +:roll_depth+:: [ ::Integer ] The depth of the size-based log
 	#     rolling. Overrides the second element in an array specified for
 	#     +:roll_size+ 
-
-
 	def initialize log_file_or_path, **options
 
 		roll_period	=	options[:roll_period]

data/lib/pantheios/services/standard_log_service_adapter.rb

@@ -6,12 +6,13 @@
 #               ::Pantheios::Services::StandardLogServiceAdapter class
 #
 # Created:      18th June 2015
-# Updated:      23rd January 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -64,7 +65,7 @@ module Services
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides
 # the instance methods +severity_logged?(severity : Object) : boolean+ and
-# +log(severity : Object, t : Time, prefix : String, msg : String)+
+# +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class StandardLogServiceAdapter
 
 	include ::Xqsr3::Quality::ParameterChecking

data/lib/pantheios/util/process_util.rb

@@ -2,13 +2,13 @@
 module Pantheios
 module Util
 
+# process utilities
 module ProcessUtil
 
 	#
 	# * *Options:*
-	#   - +:style+:: (:script, :script_basename, :script_dirname,
-	#   :script_realpath, :script_stem) directs the inference of the process
-	#   name. If none specified, :script_stem is assumed
+	#   - +:style+:: (:script, :script_basename, :script_dirname, :script_realpath, :script_stem) directs
+	#   the inference of the process name. If none specified, :script_stem is assumed
 	def self.derive_process_name dollar0 = nil, **options
 
 		dollar0	||=	$0

data/lib/pantheios/util/reflection_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# reflection utilities
 module ReflectionUtil
 
 	module ReflectionUtil_Constants
@@ -9,6 +10,8 @@ module ReflectionUtil
 		ROOT_CLASSES = [ ::Object, ::BasicObject ]
 	end
 
+	# Obtains a list of all classes pertaining to +o+, excepting root
+	# objects (+::Object+ and +::BaseObject+).
 	def self.non_root_classes o
 
 		return [] if o.nil?

data/lib/pantheios/util/thread_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# threading utilities
 module ThreadUtil
 
 	# Creates (if necessary) and sets the given thread's +thread_name+
@@ -22,6 +23,7 @@ module ThreadUtil
 		t.thread_name = name
 	end
 
+	# Obtains the name of the calling thread
 	def self.get_thread_name t
 
 		t ||= Thread.current

data/lib/pantheios/util/version_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# version utilities
 module VersionUtil
 
 	# Compares two version designators and returns a spaceship comparison

data/lib/pantheios/version.rb

@@ -5,13 +5,14 @@
 # Purpose:      Version for Pantheios.Ruby library
 #
 # Created:      2nd April 2011
-# Updated:      8th February 2018
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2011-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2011-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,7 +51,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.19.2'
+	VERSION				=	'0.22.0.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/application_layer/tc_stock_severity_levels.rb

@@ -26,12 +26,15 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 		debug2
 		debug3
 		debug4
+		debug5
 		trace
+		benchmark
 	}.map { |s| s.to_sym }
 
 	EXPECTED_LEVELS = %w{
 
 		emergency
+		fail
 		info
 		warn
 	}.map { |s| s.to_sym } + EXPECTED_LEVELS_PRIME
@@ -51,6 +54,7 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 		if defined? StockSeverityLevels
 
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVELS)
+			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVELS_PRIME)
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_VALUES)
 			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_STRINGS)
 		end
@@ -58,18 +62,36 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 
 	def test_StockSeverityLevels_expected_levels
 
+		# all the ones that we expect exist
+
 		EXPECTED_LEVELS.each do |sev|
 
 			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
 		end
+
+		# we expect all the ones that exist
+
+		StockSeverityLevels::STOCK_SEVERITY_LEVELS.each do |sev|
+
+			assert(EXPECTED_LEVELS.include?(sev), "found unexpected level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
 	end
 
 	def test_StockSeverityLevels_expected_prime_levels
 
+		# all the ones that we expect exist
+
 		EXPECTED_LEVELS_PRIME.each do |sev|
 
 			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
 		end
+
+		# we expect all the ones that exist
+
+		StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME.each do |sev|
+
+			assert(EXPECTED_LEVELS_PRIME.include?(sev), "found unexpected level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
 	end
 
 	def test_StockSeverityLevels_expected_prime_levels_have_distinct_values
@@ -99,5 +121,50 @@ class Test_StockSeverityLevels < Test::Unit::TestCase
 			strings[string] = string
 		end
 	end
+
+	def test_StockSeverityLevels_aliases
+
+		aliases = StockSeverityLevels::STOCK_SEVERITY_LEVEL_ALIASES
+
+		assert_equal :violation, aliases[:violation]
+		assert_equal :violation, aliases[:emergency]
+
+		assert_equal :alert, aliases[:alert]
+
+		assert_equal :critical, aliases[:critical]
+
+		assert_equal :failure, aliases[:failure]
+		assert_equal :failure, aliases[:fail]
+		#assert_equal :failure, aliases[:error]
+
+		assert_equal :warning, aliases[:warning]
+		assert_equal :warning, aliases[:warn]
+
+		assert_equal :notice, aliases[:notice]
+
+		assert_equal :informational, aliases[:informational]
+		assert_equal :informational, aliases[:info]
+
+		%i{ debug0 debug1 debug2 debug3 debug4 debug5 }.each do |sev|
+
+			assert_equal sev, aliases[sev]
+		end
+
+		assert_equal :trace, aliases[:trace]
+
+		assert_equal :benchmark, aliases[:benchmark]
+	end
+
+	def test_StockSeverityLevels_recognised_values_are_nil
+
+		EXPECTED_LEVELS.each do |sev|
+
+			assert_not_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev]
+			assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev.to_s]
+		end
+
+		assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[nil]
+		assert_nil StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES['failure']
+	end
 end
 

data/test/unit/front_ends/tc_threshold_front_end.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/front_ends/threshold_front_end'
+
+require 'test/unit'
+
+class Test_FrontEnds_ThresholdFrontEnd < Test::Unit::TestCase
+
+	include ::Pantheios::FrontEnds
+
+	def test_SimpleConsoleLogService_type_exists
+
+		assert defined? ThresholdFrontEnd
+	end
+
+	def test_construct_with_invalid_parameters
+
+		assert_raise(::TypeError) { ThresholdFrontEnd.new('notice') }
+
+		assert_raise_with_message(::ArgumentError, /unknown threshold severity level.*something_else.*Symbol/) { ThresholdFrontEnd.new(:something_else) }
+
+		ThresholdFrontEnd.new(:notice)
+		ThresholdFrontEnd.new(:notice, value_lookup_map: Hash.new)
+		assert_raise_with_message(::TypeError, /:value_lookup_map must be.*Hash/) { ThresholdFrontEnd.new(:notice, value_lookup_map: Array.new) }
+	end
+
+	def test_default_construct
+
+		fe = ThresholdFrontEnd.new(:notice)
+
+		assert_equal :notice, fe.threshold
+
+		assert_true fe.severity_logged?(:violation)
+		assert_true fe.severity_logged?(:alert)
+		assert_true fe.severity_logged?(:critical)
+		assert_true fe.severity_logged?(:failure)
+		assert_true fe.severity_logged?(:warning)
+		assert_true fe.severity_logged?(:notice)
+		assert_false fe.severity_logged?(:informational)
+		assert_false fe.severity_logged?(:debug0)
+		assert_false fe.severity_logged?(:debug1)
+		assert_false fe.severity_logged?(:debug2)
+		assert_false fe.severity_logged?(:debug3)
+		assert_false fe.severity_logged?(:debug4)
+		assert_false fe.severity_logged?(:debug5)
+		assert_false fe.severity_logged?(:trace)
+	end
+
+	def test_default_construct_and_change_threshold
+
+		fe = ThresholdFrontEnd.new(:notice)
+
+		assert_equal :notice, fe.threshold
+
+		fe.threshold = :failure
+
+		assert_equal :failure, fe.threshold
+
+		assert_true fe.severity_logged?(:violation)
+		assert_true fe.severity_logged?(:alert)
+		assert_true fe.severity_logged?(:critical)
+		assert_true fe.severity_logged?(:failure)
+		assert_false fe.severity_logged?(:warning)
+		assert_false fe.severity_logged?(:notice)
+		assert_false fe.severity_logged?(:informational)
+		assert_false fe.severity_logged?(:debug0)
+		assert_false fe.severity_logged?(:debug1)
+		assert_false fe.severity_logged?(:debug2)
+		assert_false fe.severity_logged?(:debug3)
+		assert_false fe.severity_logged?(:debug4)
+		assert_false fe.severity_logged?(:debug5)
+		assert_false fe.severity_logged?(:trace)
+	end
+
+	def test_use_custom_thresholds
+
+		value_lookup_map = {
+
+			FATAL: 1,
+			ERROR: 2,
+			WARN: 3,
+			INFO: 4,
+			DEBUG: 5,
+		}
+
+		fe = ThresholdFrontEnd.new(:INFO, value_lookup_map: value_lookup_map)
+
+		assert_equal :INFO, fe.threshold
+
+		assert_true fe.severity_logged?(:FATAL)
+		assert_true fe.severity_logged?(:ERROR)
+		assert_true fe.severity_logged?(:WARN)
+		assert_true fe.severity_logged?(:INFO)
+		assert_false fe.severity_logged?(:DEBUG)
+	end
+end
+
+# ############################## end of file ############################# #
+
+