pantheios-ruby 0.22.0.2 → 0.22.3

data/lib/pantheios/front_ends/threshold_front_end.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/front_ends/threshold_front_end.rb
 #
@@ -6,13 +6,13 @@
 #               class
 #
 # Created:      3rd June 2020
-# Updated:      4th June 2020
+# Updated:      28th August 2026
 #
-# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+# Home:         https://github.com/synesissoftware/Pantheios.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2020-2026, Matthew Wilson and Synesis Information Systems
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -60,83 +60,83 @@ module FrontEnds
 # the instance method +severity_logged?(severity : Object)+
 class ThresholdFrontEnd
 
-	# Initialises the instance
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +threshold_severity+ [ ::Symbol ] The threshold severity
-	#
-	# * *Options:*
-	#   - +value_lookup_map+ [ ::Hash ] A map that is used to lookup
-	#     +severity+ values (that are not +::Integer+) in
-	#     +severity_logged?+. May be +nil+, in which case
-	#     +::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES+
-	#     is used
-	#
-	# * *Exceptions:*
-	#   - +::TypeError+ raised if a value given for +:value_lookup_map+ is
-	#     not a ::hash
-	def initialize(threshold_severity, **options)
-
-		m = options[:value_lookup_map]
-
-		raise TypeError, "value given for :value_lookup_map must be a #{::Hash}" if m && !m.respond_to?(:to_hash)
-
-		if m
-
-			@value_lookup_map = m
-			@relativity_lookup_map = ::Hash.new(:relative)
-		else
-
-			@value_lookup_map = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
-			@relativity_lookup_map = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_RELATIVE
-		end
-
-		self.threshold = threshold_severity
-	end
-
-	# Determines whether a given severity is logged
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +severity+:: The severity level, which should be a known log
-	#   severity symbol or an integral equivalent
-	#
-	# * *Returns:*
-	#   a +truey+ value if the severity should be logged; a +falsey+ value
-	#   otherwise
-	def severity_logged? severity
-
-		case severity
-		when ::Integer
-
-			v = severity
-		else
-
-			v = @value_lookup_map[severity] or warn "unknown severity level '#{severity}' (#{severity.class})"
-		end
-
-		return true if v.nil?
-
-		v <= @threshold_v
-	end
-
-	# assigns the threshold
-	#
-	# * *Parameters:*
-	#   - +threshold_severity+ [ ::Symbol ] The threshold severity
-	def threshold=(threshold_severity)
-
-		raise TypeError, "threshold_severity must be a #{::Symbol}" unless ::Symbol === threshold_severity
-
-		@threshold_v = @value_lookup_map[threshold_severity] if @relativity_lookup_map[threshold_severity] or raise ArgumentError, "unknown threshold severity level '#{threshold_severity}' (#{threshold_severity.class})"
-		@threshold = threshold_severity
-
-		nil
-	end
-	attr_reader :threshold
+  # Initialises the instance
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +threshold_severity+ [ ::Symbol ] The threshold severity
+  #
+  # * *Options:*
+  #   - +value_lookup_map+ [ ::Hash ] A map that is used to lookup
+  #     +severity+ values (that are not +::Integer+) in
+  #     +severity_logged?+. May be +nil+, in which case
+  #     +::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES+
+  #     is used
+  #
+  # * *Exceptions:*
+  #   - +::TypeError+ raised if a value given for +:value_lookup_map+ is
+  #     not a ::hash
+  def initialize(threshold_severity, **options)
+
+    m = options[:value_lookup_map]
+
+    raise TypeError, "value given for :value_lookup_map must be a #{::Hash}" if m && !m.respond_to?(:to_hash)
+
+    if m
+
+      @value_lookup_map = m
+      @relativity_lookup_map = ::Hash.new(:relative)
+    else
+
+      @value_lookup_map = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+      @relativity_lookup_map = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS_RELATIVE
+    end
+
+    self.threshold = threshold_severity
+  end
+
+  # Determines whether a given severity is logged
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +severity+:: The severity level, which should be a known log
+  #   severity symbol or an integral equivalent
+  #
+  # * *Returns:*
+  #   a +truey+ value if the severity should be logged; a +falsey+ value
+  #   otherwise
+  def severity_logged? severity
+
+    case severity
+    when ::Integer
+
+      v = severity
+    else
+
+      v = @value_lookup_map[severity] or warn "unknown severity level '#{severity}' (#{severity.class})"
+    end
+
+    return true if v.nil?
+
+    v <= @threshold_v
+  end
+
+  # assigns the threshold
+  #
+  # * *Parameters:*
+  #   - +threshold_severity+ [ ::Symbol ] The threshold severity
+  def threshold=(threshold_severity)
+
+    raise TypeError, "threshold_severity must be a #{::Symbol}" unless ::Symbol === threshold_severity
+
+    @threshold_v = @value_lookup_map[threshold_severity] if @relativity_lookup_map[threshold_severity] or raise ArgumentError, "unknown threshold severity level '#{threshold_severity}' (#{threshold_severity.class})"
+    @threshold = threshold_severity
+
+    nil
+  end
+  attr_reader :threshold
 
 end # class ThresholdFrontEnd
 

data/lib/pantheios/globals.rb

@@ -1,18 +1,18 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/globals.rb
 #
 # Purpose:      The Pantheios.Ruby "globals" (::Pantheios::Globals)
 #
 # Created:      24th December 2017
-# Updated:      3rd June 2020
+# Updated:      28th August 2026
 #
-# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+# Home:         https://github.com/synesissoftware/Pantheios.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
-# Copyright (c) 2017-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -89,70 +89,70 @@ module Pantheios
 #
 module Globals
 
-	# @!visibility private
-	module Internals_ # :nodoc: all
+  # @!visibility private
+  module Internals_ # :nodoc: all
 
-		BOOLEAN_CLASSES			=	[ ::FalseClass, ::TrueClass ]
-		TRUTHY_CLASSES			=	BOOLEAN_CLASSES + [ ::NilClass ]
+    BOOLEAN_CLASSES      =  [ ::FalseClass, ::TrueClass ]
+    TRUTHY_CLASSES      =  BOOLEAN_CLASSES + [ ::NilClass ]
 
-		PROCESS_NAME_CLASSES	=	[ ::Symbol, ::String ]
-	end
+    PROCESS_NAME_CLASSES  =  [ ::Symbol, ::String ]
+  end
 
-	# @!visibility private
-	module Helpers_ # :nodoc: all
+  # @!visibility private
+  module Helpers_ # :nodoc: all
 
-		def self.cattr receiver, name, types, initial_value, **options
+    def self.cattr receiver, name, types, initial_value, **options
 
-			if options[:boolean] && types.nil?
+      if options[:boolean] && types.nil?
 
-				types = Internals_::TRUTHY_CLASSES
-			end
+        types = Internals_::TRUTHY_CLASSES
+      end
 
-			types = nil if !types.nil? && types.empty?
+      types = nil if !types.nil? && types.empty?
 
-			receiver.class_eval do
+      receiver.class_eval do
 
-				field_name	=	'@' + name
-				get_name	=	name
-				get_name	+=	'?' if options[:boolean]
+        field_name  =  '@' + name
+        get_name  =  name
+        get_name  +=  '?' if options[:boolean]
 
-				instance_variable_set field_name, initial_value
+        instance_variable_set field_name, initial_value
 
-				define_singleton_method(get_name) do
+        define_singleton_method(get_name) do
 
-					instance_variable_get field_name
-				end
+          instance_variable_get field_name
+        end
 
-				define_singleton_method(name + '=') do |v|
+        define_singleton_method(name + '=') do |v|
 
-					if types
+          if types
 
-						warn "Assigning to #{__method__} with argument of invalid type - #{v.class} given; one of #{types.join(', ')} required" unless types.any? { |c| c === v }
-					end
+            warn "Assigning to #{__method__} with argument of invalid type - #{v.class} given; one of #{types.join(', ')} required" unless types.any? { |c| c === v }
+          end
 
-					instance_variable_set field_name, v
-				end
-			end
-		end
-	end
+          instance_variable_set field_name, v
+        end
+      end
+    end
+  end
 
-	Helpers_.cattr self, 'HAS_CASCADED_INCLUDES', Internals_::BOOLEAN_CLASSES, true
+  Helpers_.cattr self, 'HAS_CASCADED_INCLUDES', Internals_::BOOLEAN_CLASSES, true
 
-	Helpers_.cattr self, 'INITIAL_SERVICE_INSTANCES', nil, nil
+  Helpers_.cattr self, 'INITIAL_SERVICE_INSTANCES', nil, nil
 
-	Helpers_.cattr self, 'INITIAL_SERVICE_CLASSES', nil, nil
+  Helpers_.cattr self, 'INITIAL_SERVICE_CLASSES', nil, nil
 
-	Helpers_.cattr self, 'MAIN_THREAD_NAME', [ ::Array, ::String ], nil
+  Helpers_.cattr self, 'MAIN_THREAD_NAME', [ ::Array, ::String ], nil
 
-	Helpers_.cattr self, 'PROCESS_NAME', Internals_::PROCESS_NAME_CLASSES, nil
+  Helpers_.cattr self, 'PROCESS_NAME', Internals_::PROCESS_NAME_CLASSES, nil
 
-	Helpers_.cattr self, 'SYNCHRONISED_SEVERITY_LOGGED', nil, true, boolean: true
+  Helpers_.cattr self, 'SYNCHRONISED_SEVERITY_LOGGED', nil, true, boolean: true
 
-	# @!visibility private
-	def self.included receiver # :nodoc:
+  # @!visibility private
+  def self.included receiver # :nodoc:
 
-		abort "Attempt to include #{self} into #{receiver}. This is not allowed"
-	end
+    abort "Attempt to include #{self} into #{receiver}. This is not allowed"
+  end
 
 end # module Globals
 end # module Pantheios

data/lib/pantheios/services/coloured_console_log_service.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/services/coloured_console_log_service.rb
 #
@@ -6,13 +6,13 @@
 #               ::Pantheios::Services::ColouredConsoleLogService class
 #
 # Created:      19th June 2019
-# Updated:      4th June 2020
+# Updated:      28th August 2026
 #
-# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+# Home:         https://github.com/synesissoftware/Pantheios.Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2019-2020, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -62,138 +62,138 @@ module Services
 # +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class ColouredConsoleLogService
 
-	module Constants
+  module Constants
 
-		include ::Pantheios::Services::Common::Console::AnsiEscapeSequences
-	end # module Constants
+    include ::Pantheios::Services::Common::Console::AnsiEscapeSequences
+  end # module Constants
 
-	def self.requires_prefix?
+  def self.requires_prefix?
 
-		return @requires_prefix unless @requires_prefix.nil?
+    return @requires_prefix unless @requires_prefix.nil?
 
-		@requires_prefix = ::Pantheios::Services::Common::Console::Internal_::SHOULD_COLOURIZE_ ? :parts : false
-	end
+    @requires_prefix = ::Pantheios::Services::Common::Console::Internal_::SHOULD_COLOURIZE_ ? :parts : false
+  end
 
-	def requires_prefix?
+  def requires_prefix?
 
-		self.class.requires_prefix?
-	end
+    self.class.requires_prefix?
+  end
 
-	def severity_logged? severity
+  def severity_logged? severity
 
-		true
-	end
+    true
+  end
 
-	def log sev, t, pref, msg
+  def log sev, t, pref, msg
 
-		stm = infer_stream sev
+    stm = infer_stream sev
 
-		if requires_prefix?
+    if requires_prefix?
 
-			pref = pref.map do |part|
+      pref = pref.map do |part|
 
-				bg	=	Constants::Background
-				fg	=	Constants::Foreground
+        bg  =  Constants::Background
+        fg  =  Constants::Foreground
 
-				if part.respond_to?(:severity)
+        if part.respond_to?(:severity)
 
-					part = fg.bold part
+          part = fg.bold part
 
-					case sev
-					when :violation
+          case sev
+          when :violation
 
-						part = bg.red part
-						#part = fg.bright_magenta part
-						part = fg.bright_yellow part
-						part = fg.blinking part
-					when :alert
+            part = bg.red part
+            #part = fg.bright_magenta part
+            part = fg.bright_yellow part
+            part = fg.blinking part
+          when :alert
 
-						part = bg.red part
-						part = fg.bright_cyan part
-						part = fg.blinking part
-					when :critical
+            part = bg.red part
+            part = fg.bright_cyan part
+            part = fg.blinking part
+          when :critical
 
-						part = bg.red part
-						part = fg.white part
-					when :failure
+            part = bg.red part
+            part = fg.white part
+          when :failure
 
-						part = bg.yellow part
-						part = fg.red part
-					when :warning
+            part = bg.yellow part
+            part = fg.red part
+          when :warning
 
-						part = bg.yellow part
-						part = fg.blue part
-					when :notice
+            part = bg.yellow part
+            part = fg.blue part
+          when :notice
 
-						part = bg.dark_grey part
-						part = fg.white part
-					when :informational
+            part = bg.dark_grey part
+            part = fg.white part
+          when :informational
 
-						part = bg.dark_grey part
-						part = fg.light_grey part
-					when :debug0
+            part = bg.dark_grey part
+            part = fg.light_grey part
+          when :debug0
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :debug1
+            part = bg.blue part
+            part = fg.light_grey part
+          when :debug1
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :debug2
+            part = bg.blue part
+            part = fg.light_grey part
+          when :debug2
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :debug3
+            part = bg.blue part
+            part = fg.light_grey part
+          when :debug3
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :debug4
+            part = bg.blue part
+            part = fg.light_grey part
+          when :debug4
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :debug5
+            part = bg.blue part
+            part = fg.light_grey part
+          when :debug5
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :trace
+            part = bg.blue part
+            part = fg.light_grey part
+          when :trace
 
-						part = bg.blue part
-						part = fg.light_grey part
-					when :benchmark
+            part = bg.blue part
+            part = fg.light_grey part
+          when :benchmark
 
-						part = bg.black part
-						part = fg.light_grey part
-					else
+            part = bg.black part
+            part = fg.light_grey part
+          else
 
-						;
-					end
-				else
+            ;
+          end
+        else
 
-					part = fg.dark_grey part
-				end
+          part = fg.dark_grey part
+        end
 
-				part
-			end.join(', ')
+        part
+      end.join(', ')
 
-			pref = '[' + pref + ']: '
+      pref = '[' + pref + ']: '
 
-			#pref = pref.map { |pp| pp.severity? ? map_sev_(sev) : sev }.join(
-		end
+      #pref = pref.map { |pp| pp.severity? ? map_sev_(sev) : sev }.join(
+    end
 
-		stm.puts "#{pref}#{msg}"
-	end
+    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
+  # 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
 
-		$stderr
-	end
+    $stderr
+  end
 
-	private
+  private
 end # class ColouredConsoleLogService
 
 end # module Services