pantheios-ruby 0.13.4 → 0.20.3.1

data/lib/pantheios/services.rb

@@ -0,0 +1,3 @@
+
+Dir[File.join(File.dirname(__FILE__), 'services', '*log_service.rb')].each { |f| require f }
+

data/lib/pantheios/services/multiplexing_log_service.rb

@@ -0,0 +1,239 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/services/multiplexing_log_service.rb
+#
+# Purpose:      Definition of the
+#               ::Pantheios::Services::MultiplexingLogService class
+#
+# Created:      14th June 2015
+# Updated:      8th February 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Pantheios
+module Services
+
+# A class that fulfils the Pantheios *LogService* protocol by multiplexing
+# its responsibilities to a number of (concrete) log service instances
+#
+# 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 MultiplexingLogService
+
+	module MultiplexingLogService_Internals_
+
+		class ServiceManagementInfo
+
+			def initialize svc
+
+				@service	=	svc
+			end
+
+			attr_reader	:service
+		end
+	end
+
+	# Initializes the instance with an array of log services, according to
+	# the given options
+	#
+	# ===Signature
+	#
+	# * *Parameters:*
+	#   - +services+:: [ ::Array ] An array of instances that observe the
+	#     Log Service protocol
+	#   - +options+:: [ ::Hash] options
+	#
+	# * *Options:*
+	#   - +:level_cache_mode+:: [ ::Symbol ] Specifies the mode of severity
+	#     level caching, and must be one of the following values:
+	#     * +:none+:: no severity level caching is performed. This is the
+	#       default because it is completely thread-safe, but it is the
+	#       slowest mode, and users are advised to specify another mode
+	#       suitable to their use
+	#     * +:thread_fixed+:: remembers the response of each multiplexed log
+	#       service to each severity level on a thread-specific basis
+	#     * +:process_fixed+:: remembers the response of each multiplexed
+	#       log service to each severity level and then remembers that for
+	#       the duration of the lifetime of the instance
+	#   - +:unsync_process_lcm+:: [ boolean ] If truey, causes
+	#     +:process_fixed+ +:level_cache_mode+ to NOT be synchronised; the
+	#     default is for it to be synchronised using an internal +Mutex+
+	#     instance
+	def initialize services, **options
+
+		@tss_sym	=	self.to_s.to_sym
+		@services	=	services.map { |svc| MultiplexingLogService_Internals_::ServiceManagementInfo.new svc }
+		@options	=	options.dup
+		@mode		=	options[:level_cache_mode]
+		@unsync_pf	=	options[:unsync_process_lcm]
+
+		@process_m	=	{}
+		@mx			=	Mutex.new unless @unsync_pf
+	end
+
+	private
+
+	# { svc => { sev => flag } }
+	def get_tss_svc_sev_map_
+
+		sym	=	@tss_sym
+		tc	=	Thread.current
+		m	=	tc.thread_variable_get sym
+
+		unless m
+
+			tc.thread_variable_set sym, (m = {})
+		end
+
+		m
+	end
+
+	def svc_sev_logged_tf_ m, svc, severity
+
+		m[svc.object_id]	||=	{}
+
+		unless m[svc.object_id].has_key? severity
+
+			r = svc.severity_logged? severity
+
+			m[svc.object_id][severity] = r
+		else
+
+			r = m[svc.object_id][severity]
+		end
+
+		r
+	end
+
+	def svc_sev_logged_pf_ m, svc, severity
+
+		m[svc.object_id]	||=	{}
+
+		unless m[svc.object_id].has_key? severity
+
+			r = svc.severity_logged? severity
+
+			m[svc.object_id][severity] = r
+		else
+
+			r = m[svc.object_id][severity]
+		end
+
+		r
+	end
+
+	def sev_logged_pf_ m, severity
+
+		@services.any? { |smi| svc_sev_logged_pf_ m, smi.service, severity }
+	end
+	public
+
+	# Indicates whether the given severity is to be logged by any of the
+	# multiplexed log services
+	def severity_logged? severity
+
+		case @mode
+		when :process_fixed
+
+			if @unsync_pf
+
+				sev_logged_pf_ @process_m, severity
+			else
+
+				@mx.synchronize { sev_logged_pf_ @process_m, severity }
+			end
+		when :thread_fixed
+
+			m	=	get_tss_svc_sev_map_
+
+			@services.any? do |smi|
+
+				svc	=	smi.service
+
+				svc_sev_logged_tf_ m, svc, severity
+			end
+		else # :none
+
+			@services.any? { |smi| smi.service.severity_logged? severity }
+		end
+	end
+
+	def log sev, t, pref, msg
+
+		tss_m	=	:thread_fixed == @mode ? get_tss_svc_sev_map_ : nil
+
+		@services.each do |smi|
+
+			svc	=	smi.service
+
+			case @mode
+			when :process_fixed
+
+				if @unsync_pf
+
+					isl	=	svc_sev_logged_pf_ @process_m, svc, sev
+				else
+
+					isl	=	@mx.synchronize { svc_sev_logged_pf_ @process_m, svc, sev }
+				end
+			when :thread_fixed
+
+				m	=	tss_m
+
+				isl	=	svc_sev_logged_tf_ m, svc, sev
+			else # :none
+
+				isl	=	svc.severity_logged? sev
+			end
+
+
+			svc.log sev, t, pref, msg if isl
+		end
+	end
+end
+
+end # module Services
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+

data/lib/pantheios/services/null_log_service.rb

@@ -1,12 +1,12 @@
 
 # ######################################################################## #
-# File:         lib/pantheios/services/simple_console_log_service.rb
+# File:         lib/pantheios/services/null_log_service.rb
 #
 # Purpose:      Definition of the ::Pantheios::Services::NullLogService
 #               class
 #
 # Created:      14th June 2015
-# Updated:      22nd January 2018
+# Updated:      8th February 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #

data/lib/pantheios/services/simple_console_log_service.rb

@@ -6,7 +6,7 @@
 #               ::Pantheios::Services::SimpleConsoleLogService class
 #
 # Created:      14th June 2015
-# Updated:      6th January 2018
+# Updated:      12th March 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -45,8 +45,6 @@
 # ######################################################################## #
 
 
-require 'pantheios/application_layer/stock_severity_levels'
-
 =begin
 =end
 
@@ -73,11 +71,14 @@ 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
 

data/lib/pantheios/services/simple_file_log_service.rb

@@ -0,0 +1,230 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/services/simple_file_log_service.rb
+#
+# Purpose:      Definition of the
+#               ::Pantheios::Services::SimpleFileLogService class
+#
+# Created:      17th June 2015
+# Updated:      4th February 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 'logger'
+
+=begin
+=end
+
+module Pantheios
+module Services
+
+# A class that fulfils the Pantheios *LogService* protocol that allows all
+# severities and logs to a file
+#
+# 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 SimpleFileLogService
+
+	module SimpleFileLogService_Constants
+
+		DEFAULT_ROLL_DEPTH		=	7
+		DEFAULT_ROLL_SIZE		=	1024 * 1024
+
+		RECOGNISED_OPTIONS		=	%w{ roll_depth roll_period roll_size }.map { |s| s.to_sym }
+
+	end # module SimpleFileLogService_Constants
+
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +log_file_or_path+:: [ +::File+, +::IO+, +::String+ ] A file or an
+	#     IO that will be used as the target of the log statements, or a
+	#     string specifying the path of the file to be used as the target
+	#   - +options+:: [ ::Hash ] Options. Options other than those listed
+	#     are ignored silently (except if +$DEBUG+, in which case a
+	#     +warn+ing will be issued)
+	#
+	# * *Options:*
+	#   - +:roll_period+:: ( +:daily+, +:weekly+, +:monthly+ ) The
+	#     periodicity of the log-file rolling. Ignored unless
+	#     +log_file_or_path+ is a +::String+. Ignored if either +:roll_size+
+	#     or +:roll_depth+ is specified
+	#   - +:roll_size+:: [ ::Integer, [ ::Integer, ::Integer ] ] An integer
+	#     specifying the size of the log file, or an array containing the
+	#     size of the log file and the depth of the log roll
+	#   - +: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]
+		roll_size	=	options[:roll_size]
+		roll_depth	=	options[:roll_depth]
+
+		if $DEBUG
+
+			options.each do |k, v|
+
+				warn "#{self.class}##{__method__}(): ignoring unrecognised option '#{k}'" unless SimpleFileLogService_Constants::RECOGNISED_OPTIONS.include?(:k)
+			end
+		end
+
+		if roll_period && (roll_size || roll_depth)
+
+			warn "#{self.class}##{__method__}(): caller specified :roll_depth/:roll_period with :roll_size to #{self.class}##{__method__}() - ignoring :roll_period" if $DEBUG
+
+			roll_period = nil
+		end
+
+		if roll_size || roll_depth
+
+			if ::Array === roll_size
+
+				roll_size, d	=	roll_size
+
+				roll_depth		||=	d
+			end
+
+			roll_size	||=	SimpleFileLogService_Constants::DEFAULT_ROLL_SIZE
+			roll_depth	||=	SimpleFileLogService_Constants::DEFAULT_ROLL_DEPTH
+		end
+
+		logger_init_args	=	[]
+		logger_init_options	=	{}
+
+		if false;
+		elsif roll_depth
+
+			logger_init_args	<<	roll_depth
+			logger_init_args	<<	roll_size
+		elsif roll_period
+
+			roll_period = roll_period.downcase.to_sym if ::String === roll_period
+
+			case roll_period
+			when :daily, :weekly, :monthly
+
+				;
+			else
+
+				raise ArgumentError, ":roll_period value must be one of :daily, :weekly, :monthly"
+			end
+
+			logger_init_args	<<	roll_period.to_s
+			logger_init_args	<<	0
+		end
+
+		raise ArgumentError, ":roll_depth must be a non-negative integer" unless roll_depth.nil? || (::Integer === roll_depth && roll_depth >= 0)
+		raise ArgumentError, ":roll_size must be a non-negative integer" unless roll_size.nil? || (::Integer === roll_size && roll_size >= 0)
+
+		file_proc = lambda do
+
+			@logger			=	::Logger.new log_file_or_path, *logger_init_args
+			@log_file_path	=	log_file_or_path.path
+		end
+
+		io_proc = lambda do
+
+			@logger			=	::Logger.new log_file_or_path, *logger_init_args
+			@log_file_path	=	log_file_or_path.respond_to?(:path) ? log_file_or_path.path : nil
+		end
+
+		case log_file_or_path
+		when nil
+
+			raise ArgumentError, 'log_file_or_path may not be nil'
+		when ::IO#, ::StringIO
+
+			io_proc.call
+		when ::File#, ::Tempfile
+
+			file_proc.call
+		when ::String
+
+			@logger			=	::Logger.new log_file_or_path, *logger_init_args
+			@log_file_path	=	log_file_or_path
+		else
+
+			ancestor_names	=	log_file_or_path.class.ancestors.map(&:to_s)
+
+			if false
+
+				;
+			elsif ancestor_names.include?('StringIO')
+
+				io_proc.call
+			elsif ancestor_names.include?('Tempfile')
+
+				file_proc.call
+			else
+
+				raise TypeError, "log_file_or_path type must be one of #{::File}, #{::IO}, #{::String}, #{::StringIO}"
+			end
+		end
+
+		self
+	end
+
+	# The path of the underlying log file. May return +nil+ if the path
+	# cannot be determined
+	attr_reader	:log_file_path
+
+	def severity_logged? severity
+
+		true
+	end
+
+	def log sev, t, pref, msg
+
+		@logger << "#{pref}#{msg}\n"
+	end
+end
+
+
+end # module Services
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+