pantheios-ruby 0.12.2 → 0.13.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 007a1649b4cecf6cc6660ecef993af29771aa029
-  data.tar.gz: 8ba667a42b97fc3b5d4b7fb68178473009d7841d
+  metadata.gz: 42dd156fe607cf0712c3f8bf87a4b18d00b5876f
+  data.tar.gz: 2fb2a26c90fb74f89b0d6ddf37e95ae26a1786f8
 SHA512:
-  metadata.gz: cc618b1f877201d97fee7ba4ea981515f0dd8c0724fd32eb0f5da00634eee71765e0d08d834747e572c093495f1b8933e1ee0eb4c1f0620e9d9078af5d062dad
-  data.tar.gz: fc41afd6e93cfe3401c8585e8fdf60afab5b1fe5cf584e2b4600802f514807ca2acd7b2630cbaebbb294f86db913043d286ff222f82db4d41bcc2e956e014624
+  metadata.gz: 3143dabf9f559f38711bc3f90cc849fa3b91e21f08373cfaf63d769e6f704d27197cf9d22f5d3b1108e83db388987c815b59cbca1de5642e9f987a3b61da2005
+  data.tar.gz: c203a65311dca3d02517ed8e1ba34b3cf2137a19d8514788a6dcb216700a2a56b07bca0f972a9981cafffb39232082b52c5cc2721e7427191697b8f077626e67

data/lib/pantheios/core.rb

@@ -5,7 +5,7 @@
 # Purpose:      The Pantheios.Ruby core (::Pantheios::Core)
 #
 # Created:      2nd April 2011
-# Updated:      22nd January 2018
+# Updated:      23rd January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -99,7 +99,7 @@ module Core
 
 			def set_front_end fe
 
-				raise ::TypeError, "front-end instance (#{fe.class}) does not respond to all the required messages (#{Constants_::REQUIRED_FRONTEND_METHODS.join(', ')})" unless fe && Constants_::REQUIRED_FRONTEND_METHODS.all? { |m| fe.respond_to? m }
+				raise ::TypeError, "front-end instance (#{fe.class}) does not respond to all the required messages ([ #{Constants_::REQUIRED_FRONTEND_METHODS.join(', ')} ])" unless fe && Constants_::REQUIRED_FRONTEND_METHODS.all? { |m| fe.respond_to? m }
 
 				r	=	nil
 
@@ -117,7 +117,7 @@ module Core
 
 			def set_back_end be
 
-				raise ::TypeError, "back-end instance (#{fe.class}) does not respond to all the required messages (#{Constants_::REQUIRED_BACKEND_METHODS.join(', ')})" unless be && Constants_::REQUIRED_BACKEND_METHODS.all? { |m| be.respond_to? m }
+				raise ::TypeError, "back-end instance (#{fe.class}) does not respond to all the required messages ([ #{Constants_::REQUIRED_BACKEND_METHODS.join(', ')} ])" unless be && Constants_::REQUIRED_BACKEND_METHODS.all? { |m| be.respond_to? m }
 
 				r	=	nil
 				srp	=	svc.respond_to?(:requires_prefix?) ? svc.requires_prefix? : true
@@ -132,7 +132,7 @@ module Core
 
 			def set_service svc
 
-				raise ::TypeError, "service instance (#{svc.class}) does not respond to all the required messages (#{Constants_::REQUIRED_SERVICE_METHODS.join(', ')})" unless svc && Constants_::REQUIRED_SERVICE_METHODS.all? { |m| svc.respond_to? m }
+				raise ::TypeError, "service instance (#{svc.class}) does not respond to all the required messages ([ #{Constants_::REQUIRED_SERVICE_METHODS.join(', ')} ])" unless Constants_::REQUIRED_SERVICE_METHODS.all? { |m| svc.respond_to? m }
 
 				r	=	[]
 				srp	=	svc.respond_to?(:requires_prefix?) ? svc.requires_prefix? : true

data/lib/pantheios/services/simple_console_log_service.rb

@@ -53,7 +53,7 @@ require 'pantheios/application_layer/stock_severity_levels'
 module Pantheios
 module Services
 
-# A class that fulfils the Pantheios *LogService* protocol that sallows all
+# A class that fulfils the Pantheios *LogService* protocol that allows all
 # severities and logs to the console (via +$stdout+ and +$stderr+)
 #
 # NOTE: The *LogService* protocol is implemented by a class that provides

data/lib/pantheios/services/standard_log_service_adapter.rb

@@ -0,0 +1,247 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/services/standard_log_service_adapter.rb
+#
+# Purpose:      Definition of the
+#               ::Pantheios::Services::StandardLogServiceAdapter class
+#
+# Created:      18th June 2015
+# Updated:      23rd January 2018
+#
+# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2015-2018, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+#   notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   notice, this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the names of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'pantheios/util/process_util'
+
+require 'xqsr3/quality/parameter_checking'
+
+require 'logger'
+
+=begin
+=end
+
+module Pantheios
+module Services
+
+# An adapter class that fulfils the Pantheios *LogService* protocol in terms
+# an instance of the standard Ruby logger
+#
+# 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)+
+class StandardLogServiceAdapter
+
+	include ::Xqsr3::Quality::ParameterChecking
+
+	STOCK_SEVS_EXT2NUM = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+
+	SEV_LEVELS_INT2PAIR = {
+
+		::Logger::DEBUG => [ :debug0, STOCK_SEVS_EXT2NUM[:debug0] ],
+		::Logger::WARN => [ :warning, STOCK_SEVS_EXT2NUM[:warning] ],
+		::Logger::ERROR => [ :failure, STOCK_SEVS_EXT2NUM[:failure] ],
+		::Logger::FATAL => [ :alert, STOCK_SEVS_EXT2NUM[:alert] ],
+		::Logger::UNKNOWN => [ :violation, STOCK_SEVS_EXT2NUM[:violation] ],
+	}
+
+	SEV_LEVELS_EXT2INT = {
+
+		:trace => ::Logger::DEBUG,
+		:benchmark => ::Logger::DEBUG,
+
+		:debug0 => ::Logger::DEBUG,
+		:debug1 => ::Logger::DEBUG,
+		:debug2 => ::Logger::DEBUG,
+		:debug3 => ::Logger::DEBUG,
+		:debug4 => ::Logger::DEBUG,
+
+		:notice => ::Logger::INFO,
+		:informational => ::Logger::INFO, :info => ::Logger::INFO,
+
+		:warning => ::Logger::WARN, :warn => ::Logger::WARN,
+
+		:failure => ::Logger::ERROR, :error => ::Logger::ERROR,
+		:critical => ::Logger::ERROR,
+
+		:alert => ::Logger::UNKNOWN,
+		:violation => ::Logger::UNKNOWN, :emergency => ::Logger::UNKNOWN,
+	}
+
+	SEV_LEVELS_EXT2NUM = {
+
+		STOCK_SEVS_EXT2NUM[:trace] => ::Logger::DEBUG,
+		STOCK_SEVS_EXT2NUM[:benchmark] => ::Logger::DEBUG,
+
+		STOCK_SEVS_EXT2NUM[:debug0] => ::Logger::DEBUG,
+		STOCK_SEVS_EXT2NUM[:debug1] => ::Logger::DEBUG,
+		STOCK_SEVS_EXT2NUM[:debug2] => ::Logger::DEBUG,
+		STOCK_SEVS_EXT2NUM[:debug3] => ::Logger::DEBUG,
+		STOCK_SEVS_EXT2NUM[:debug4] => ::Logger::DEBUG,
+
+		STOCK_SEVS_EXT2NUM[:notice] => ::Logger::INFO,
+		STOCK_SEVS_EXT2NUM[:informational] => ::Logger::INFO,
+
+		STOCK_SEVS_EXT2NUM[:warning] => ::Logger::WARN,
+
+		STOCK_SEVS_EXT2NUM[:failure] => ::Logger::ERROR,
+		STOCK_SEVS_EXT2NUM[:critical] => ::Logger::ERROR,
+
+		STOCK_SEVS_EXT2NUM[:alert] => ::Logger::UNKNOWN,
+		STOCK_SEVS_EXT2NUM[:violation] => ::Logger::UNKNOWN,
+	}
+
+
+	def initialize logger, adapter_threshold = nil, **options
+
+		check_parameter logger, 'logger', responds_to: [ :add, :level, :level= ]
+		check_parameter adapter_threshold, 'adapter_threshold', types: [ ::Integer, ::Symbol ], allow_nil: true
+		format = check_option options, :format, type: ::Symbol, values: [ :default, :simple, :standard ], allow_nil: true
+
+		@logger				=	logger
+		@format				=	format || :default
+		@adapter_threshold	=	adapter_threshold
+		@at_value			=	nil
+		@closed				=	false
+	end
+
+	# The threshold of the adapter, as expressed in a Pantheios severity
+	# level
+	#
+	# NOTE: may be +nil+, in which case the decision to determine whether to
+	# log (in the form of the +severity_logged?+ method) will be defered to
+	# the underlying logger.
+	attr_reader :adapter_threshold
+
+	def adapter_threshold= threshold
+
+		case @adapter_threshold	=	threshold
+		when nil
+
+			@at_value	=	nil
+		when ::Symbol
+
+			@at_value	=	STOCK_SEVS_EXT2NUM[threshold]
+		when ::Integer
+
+			@at_value	=	threshold
+		else
+
+			raise ::TypeError, 'adapter_threshold must be a symbol, an integer value, or nil'
+		end
+	end
+
+	def close
+
+		raise "already closed" if @closed
+
+		@logger.close
+
+		@closed = true
+	end
+
+	def flush
+
+		@logger.flush if @logger.respond_to? :flush
+	end
+
+	def severity_logged? severity
+
+		case severity
+		when nil
+
+			return true
+		when adapter_threshold
+
+			return true
+		when ::Symbol
+
+			sev	=	STOCK_SEVS_EXT2NUM[severity] || 0
+		when ::Integer
+
+			sev	=	severity
+		else
+
+			warn "severity - '#{severity}' - of invalid type (#{severity.class}) specified to severity_logged?"
+
+			return true
+		end
+
+
+		unless adapter_threshold
+
+			# ask the logger
+
+			sym, val = SEV_LEVELS_INT2PAIR[@logger.level]
+
+			return sev <= val
+		end
+
+
+		return sev <= @at_value
+	end
+
+	def log severity, t, prefix, msg
+
+		sev_ext		=	STOCK_SEVS_EXT2NUM[severity]
+		sev_ext		||=	severity if ::Integer === severity
+		sev_int		=	SEV_LEVELS_EXT2NUM[sev_ext]
+		sev_int		||=	::Logger::UNKNOWN
+
+		case @format
+		when :default
+
+			prog_name	=	::Pantheios::Util::ProcessUtil.derive_process_name $0
+
+			@logger.add sev_int, msg, prog_name
+		when :simple
+
+			@logger << msg + ?\n
+		when :standard
+
+			@logger << "#{prefix}#{msg}\n"
+		end
+	end
+end
+
+end # module Services
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+

data/lib/pantheios/util/process_util.rb

@@ -18,5 +18,6 @@ end # module ProcessUtil
 end # module Util
 end # module Pantheios
 
+# ############################## end of file ############################# #
 
 

data/lib/pantheios/util/thread_util.rb

@@ -80,4 +80,6 @@ end # module ThreadUtil
 end # module Util
 end # module Pantheios
 
+# ############################## end of file ############################# #
+
 

data/lib/pantheios/util/version_util.rb

@@ -42,3 +42,6 @@ end # module VersionUtil
 end # module Util
 end # module Pantheios
 
+# ############################## end of file ############################# #
+
+

data/lib/pantheios/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Pantheios.Ruby library
 #
 # Created:      2nd April 2011
-# Updated:      22nd January 2018
+# Updated:      23rd January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -50,7 +50,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.12.2'
+	VERSION				=	'0.13.4'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/services/tc_standard_log_service_adapter.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+#
+# test/unit/services/tc_standard_log_service.rb
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/services/standard_log_service_adapter'
+
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'pantheios/util/process_util'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_StandardLogservice < Test::Unit::TestCase
+
+	include ::Pantheios::Services
+
+	STOCK_SEVERITY_LEVEL_VALUES = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+
+	def test_StandardLogServiceAdapter_type_exists
+
+		assert defined? StandardLogServiceAdapter
+	end
+
+	if  defined?(StandardLogServiceAdapter)
+
+		def test_StandardLogServiceAdapter_type_is_a_class
+
+			assert_kind_of(::Class, StandardLogServiceAdapter)
+		end
+
+		def test_StandardLogServiceAdapter_type_has_expected_instance_methods
+
+			assert_type_has_instance_methods StandardLogServiceAdapter, [ :severity_logged?, :log ]
+		end
+
+		def test_severity_logged
+
+			logdev	=	StringIO.new
+			logger	=	::Logger.new logdev
+
+			svc		=	StandardLogServiceAdapter.new logger
+
+			logger.level	=	::Logger::WARN
+
+			assert_false svc.severity_logged?(:debug4)
+			assert_false svc.severity_logged?(:debug3)
+			assert_false svc.severity_logged?(:debug2)
+			assert_false svc.severity_logged?(:debug1)
+			assert_false svc.severity_logged?(:debug0)
+			assert_false svc.severity_logged?(:informational)
+			assert_false svc.severity_logged?(:notice)
+			assert_true svc.severity_logged?(:warning)
+			assert_true svc.severity_logged?(:failure)
+			assert_true svc.severity_logged?(:critical)
+			assert_true svc.severity_logged?(:alert)
+			assert_true svc.severity_logged?(:violation)
+
+			assert_true svc.severity_logged?(nil)
+
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:debug4])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:debug3])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:debug2])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:debug1])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:debug0])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:informational])
+			assert_false svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:notice])
+			assert_true svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:warning])
+			assert_true svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:failure])
+			assert_true svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:critical])
+			assert_true svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:alert])
+			assert_true svc.severity_logged?(STOCK_SEVERITY_LEVEL_VALUES[:violation])
+		end
+
+		def test_selected_log_with_default_format
+
+			logdev	=	StringIO.new
+			logger	=	::Logger.new logdev
+
+			svc		=	StandardLogServiceAdapter.new logger
+
+			logger.level	=	::Logger::WARN
+
+			t		=	Time.now
+			pid		=	Process.pid
+			prname	=	::Pantheios::Util::ProcessUtil.derive_process_name
+
+			[ :notice, :warning, :critical ].each do |level|
+
+				svc.log level, t, nil, "a message at #{level}" if svc.severity_logged? level
+			end
+
+			svc.flush if svc.respond_to? :flush
+
+			res		=	logdev.string.split /\n/
+
+			assert_equal 2, res.size
+
+			assert_match /W\s*,\s*\[.*##{pid}\s*\]\s*WARN\s*--\s*#{prname}\s*:\s*a message at warning/, res[0]
+			assert_match /E\s*,\s*\[.*##{pid}\s*\]\s*ERROR\s*--\s*#{prname}\s*:\s*a message at critical/, res[1]
+		end
+
+		def test_selected_log_with_blank_format
+
+			logdev	=	StringIO.new
+			logger	=	::Logger.new logdev
+
+			svc		=	StandardLogServiceAdapter.new logger, format: :simple
+
+			logger.level	=	::Logger::WARN
+
+			t		=	Time.now
+
+			[ :notice, :warning, :critical ].each do |level|
+
+				svc.log level, t, nil, "a message at #{level}" if svc.severity_logged? level
+			end
+
+			svc.flush if svc.respond_to? :flush
+
+			res		=	logdev.string.split /\n/
+
+			assert_equal 2, res.size
+
+			assert_equal 'a message at warning', res[0]
+			assert_equal 'a message at critical', res[1]
+		end
+
+		def test_selected_log_with_standard_format
+
+			logdev	=	StringIO.new
+			logger	=	::Logger.new logdev
+
+			svc		=	StandardLogServiceAdapter.new logger, format: :standard
+
+			logger.level	=	::Logger::WARN
+
+			t		=	Time.now
+			pid		=	Process.pid
+			tid		=	Thread.current.object_id
+			prname	=	::Pantheios::Util::ProcessUtil.derive_process_name
+			ts		=	t.strftime '%Y-%m-%d %H:%M:%S.%6N'
+
+			[ :notice, :warning, :critical ].each do |level|
+
+				pref = "[#{prname} #{tid} #{ts} #{level}]"
+
+				svc.log level, t, pref, "a message at #{level}" if svc.severity_logged? level
+			end
+
+			svc.flush if svc.respond_to? :flush
+
+			res		=	logdev.string.split /\n/
+
+			assert_equal 2, res.size
+
+			assert_match /\s*\[\s*#{prname} #{tid} #{ts} warning\s*\]\s*a message at warning/, res[0]
+			assert_match /\s*\[\s*#{prname} #{tid} #{ts} critical\s*\]\s*a message at critical/, res[1]
+		end
+	end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pantheios-ruby
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.4
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
@@ -46,6 +46,7 @@ files:
 - lib/pantheios/globals.rb
 - lib/pantheios/services/null_log_service.rb
 - lib/pantheios/services/simple_console_log_service.rb
+- lib/pantheios/services/standard_log_service_adapter.rb
 - lib/pantheios/util.rb
 - lib/pantheios/util/process_util.rb
 - lib/pantheios/util/thread_util.rb
@@ -59,6 +60,7 @@ files:
 - test/unit/application_layer/ts_all.rb
 - test/unit/services/tc_null_log_service.rb
 - test/unit/services/tc_simple_console_log_service.rb
+- test/unit/services/tc_standard_log_service_adapter.rb
 - test/unit/services/ts_all.rb
 - test/unit/ts_all.rb
 - test/unit/util/tc_thread_util.rb