pantheios-ruby 0.18.2 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a4ab16037fef01cf24d88b041cc75c15f08e494
-  data.tar.gz: 4c7fe9d47274ab9fc3d669558469486d0683e4fe
+  metadata.gz: c08cdda0f4237044c0b2681d2b1a5cf47ff2315f
+  data.tar.gz: b06b7ac4f43eead0c66d1253b72198ae1b63b28a
 SHA512:
-  metadata.gz: 215ebce2885a0824efa7c30a26321d882a7697c895fa098f7a063e9db443c72ba4ff73f33125e4774531a4c4fa8109124beca833ca5dc1773d149a968b6018c7
-  data.tar.gz: 9b6ec5a9ff274cbadcf817b0822812c65ef007db9f1c51a98565d5b753b54789538429db51ee6e3233bd71699bf38dd236441e954e79c4a00d2dc80eea934886
+  metadata.gz: 8650e0cad32dcb92b16e677da6e7a09def7302c52465460fe431890827d074cd11d009ba22d06f85a2f0de9b5003f902882085ffc206233dd47dda0de9e65e69
+  data.tar.gz: 3ccbdfd84bf0b5ba7ada60754bd40e3a4361637da3f0c07e8ee225fd4fe1125c26f8bffcddbd8bcab58bd1ed37a97b1c02fd99a68a3e8eb9e2e5090e1ed5e940

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

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

data/test/scratch/multiplexing_log_service.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+# File:         test/scratch/multiplexing_log_service.rb
+#
+# Purpose:      COMPLETE_ME
+#
+# Created:      7th February 2018
+# Updated:      7th February 2018
+#
+# Author:       Matthew Wilson
+#
+# Copyright:    <<TBD>>
+#
+#############################################################################
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 2), 'lib')
+
+require 'pantheios'
+require 'pantheios/application_layer/stock_severity_levels'
+require 'pantheios/services'
+
+$num_BLS_sls	=	0
+$num_ELS_sls	=	0
+
+class BenchmarkLogService
+
+	def severity_logged? severity
+
+		$num_BLS_sls	+=	1
+
+		(0..100).each { |n| n ** n  }
+
+		:benchmark == severity.to_s.to_sym
+	end
+
+	def log sev, t, pref, msg
+
+		puts "BENCHMARK: #{pref}#{msg}\n"
+	end
+end
+
+class EventLogService
+
+	def severity_logged? severity
+
+		$num_ELS_sls	+=	1
+
+		case severity.to_s.to_sym
+		when :notice, :warning, :failure, :critical, :alert, :violation
+
+			true
+		when :warn, :error, :emergency
+
+			true
+		else
+
+			false
+		end
+	end
+
+	def log sev, t, pref, msg
+
+		puts "EVENTLOG: #{pref}#{msg}\n"
+	end
+end
+
+scls		=	Pantheios::Services::SimpleConsoleLogService.new
+
+def scls.severity_logged? severity; ![ :benchmark, :trace, :violation ].include? severity; end
+
+services	=	[
+
+	BenchmarkLogService.new,
+	EventLogService.new,
+	scls,
+]
+
+lcm = :none
+#lcm = :thread_fixed
+#lcm = :process_fixed
+unsync = false
+#unsync = true
+
+Pantheios::Core.set_service Pantheios::Services::MultiplexingLogService.new(services, level_cache_mode: lcm, unsyc_process_lcm: unsync)
+
+include Pantheios
+
+t_b	=	Time.now
+
+log :benchmark, 'statement at benchmark'
+(0..100000).each { log :trace, 'statement at trace' }
+log :debug4, 'statement at debug-4'
+log :debug3, 'statement at debug-3'
+log :debug2, 'statement at debug-2'
+log :debug1, 'statement at debug-1'
+log :debug0, 'statement at debug-0'
+log :informational, 'statement at informational'
+log :notice, 'statement at notice'
+log :warning, 'statement at warning'
+log :failure, 'statement at failure'
+log :critical, 'statement at critical'
+log :alert, 'statement at alert'
+log :violation, 'statement at violation'
+
+t_a	=	Time.now
+
+$stderr.puts "mode= :#{lcm}; t=#{t_a - t_b}; #BLS=#{$num_BLS_sls}; #ELS=#{$num_ELS_sls}"
+

data/test/unit/services/tc_multiplexing_log_service.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+#
+# test/unit/services/tc_multiplexing_log_service.rb
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/services/multiplexing_log_service'
+
+require 'pantheios/api'
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_MultiplexingLogservice < Test::Unit::TestCase
+
+	include ::Pantheios::API
+	include ::Pantheios::Services
+
+	class ProgrammableLogService
+
+		def initialize name, severities
+
+			@name		=	name
+			@severities	=	severities
+			@items		=	[]
+		end
+
+		attr_reader :name
+		attr_reader :items
+
+		def severity_logged? severity
+
+			@severities.include? severity
+		end
+
+		def log sev, t, pref, msg
+
+			@items << [ sev, t, pref, msg ]
+		end
+	end
+
+	def log_multiple_statements svc
+
+		previous, _	=	Pantheios::Core.set_service svc
+
+		begin
+
+			severities	=	Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME
+
+			severities.each do |sev|
+
+				log sev, "a(n) #{sev} statement"
+			end
+		ensure
+
+			Pantheios::Core.set_service previous
+		end
+	end
+
+
+	def test_MultiplexingLogService_type_exists
+
+		assert defined? MultiplexingLogService
+	end
+
+	if  defined?(MultiplexingLogService)
+
+		def test_MultiplexingLogService_type_is_a_class
+
+			assert_kind_of(::Class, MultiplexingLogService)
+		end
+
+		def test_MultiplexingLogService_type_has_expected_instance_methods
+
+			assert_type_has_instance_methods MultiplexingLogService, [ :severity_logged?, :log ]
+		end
+
+		def test_multiplex_1
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ]
+
+			log_multiple_statements svc
+
+			assert_equal 11, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_2
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :none
+
+			log_multiple_statements svc
+
+			assert_equal 11, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_3
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :process_fixed
+
+			log_multiple_statements svc
+
+			assert_equal 11, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+
+		def test_multiplex_4
+
+			svc_0		=	ProgrammableLogService.new 'svc_0', Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME - [ :informational, :notice, :trace ]
+			svc_1		=	ProgrammableLogService.new 'svc_1', [ :informational, :notice, :warning, :failure ]
+			svc_2		=	ProgrammableLogService.new 'svc_2', [ :informational, :debug0, :debug1, :debug2, :debug3, :debug4 ]
+
+			svc			=	MultiplexingLogService.new [ svc_0, svc_1, svc_2 ], level_cache_mode: :thread_fixed
+
+			log_multiple_statements svc
+
+			assert_equal 11, svc_0.items.size
+			assert_equal  4, svc_1.items.size
+			assert_equal  6, svc_2.items.size
+		end
+	end
+end
+
+

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: pantheios-ruby
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.2
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2018-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xqsr3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: 0.21.1
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.21.1
+    - - <
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '1.0'
 description: |
   A Ruby version of the popular C++ (and .NET) logging API library
 email: matthew@synesis.com.au
@@ -38,6 +44,8 @@ files:
 - lib/pantheios/application_layer/stock_severity_levels.rb
 - lib/pantheios/core.rb
 - lib/pantheios/globals.rb
+- lib/pantheios/services.rb
+- lib/pantheios/services/multiplexing_log_service.rb
 - lib/pantheios/services/null_log_service.rb
 - lib/pantheios/services/simple_console_log_service.rb
 - lib/pantheios/services/simple_file_log_service.rb
@@ -54,11 +62,13 @@ files:
 - test/scratch/log_rolling_by_period_daily.rb
 - test/scratch/log_rolling_by_size_and_depth.rb
 - test/scratch/log_using_blocks.rb
+- test/scratch/multiplexing_log_service.rb
 - test/unit/application_layer/tc_param_name_list.rb
 - test/unit/application_layer/tc_stock_severity_levels.rb
 - test/unit/application_layer/ts_all.rb
 - test/unit/core/tc_core_1.rb
 - test/unit/core/ts_all.rb
+- test/unit/services/tc_multiplexing_log_service.rb
 - test/unit/services/tc_null_log_service.rb
 - test/unit/services/tc_simple_console_log_service.rb
 - test/unit/services/tc_simple_file_log_service.rb
@@ -70,9 +80,9 @@ files:
 - test/unit/util/tc_thread_util.rb
 - test/unit/util/tc_version_util.rb
 - test/unit/util/ts_all.rb
-homepage: http://github.com/synesissoftware/Pantheios.Ruby
+homepage: http://www.pantheios.org/
 licenses:
-- BSD-3-Clause
+- Modified BSD
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -80,18 +90,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '2'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Pantheios.Ruby
 test_files: []
+has_rdoc: