pantheios-ruby 0.22.0.2 → 0.22.3

data/lib/pantheios/services/simple_file_log_service.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/services/simple_file_log_service.rb
 #
@@ -6,14 +6,14 @@
 #               ::Pantheios::Services::SimpleFileLogService class
 #
 # Created:      17th June 2015
-# 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) 2015-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -64,160 +64,159 @@ module Services
 # +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class SimpleFileLogService
 
-	module SimpleFileLogService_Constants
+  module SimpleFileLogService_Constants
 
-		DEFAULT_ROLL_DEPTH		=	7
-		DEFAULT_ROLL_SIZE		=	1024 * 1024
+    DEFAULT_ROLL_DEPTH    =  7
+    DEFAULT_ROLL_SIZE    =  1024 * 1024
 
-		RECOGNISED_OPTIONS		=	%w{ roll_depth roll_period roll_size }.map { |s| s.to_sym }
+    RECOGNISED_OPTIONS    =  %w{ roll_depth roll_period roll_size }.map { |s| s.to_sym }
 
-	end # module SimpleFileLogService_Constants
+  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
+  #
+  # === 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]
+    roll_period  =  options[:roll_period]
+    roll_size  =  options[:roll_size]
+    roll_depth  =  options[:roll_depth]
 
-		if $DEBUG
+    if $DEBUG
 
-			options.each do |k, v|
+      options.each do |k, v|
 
-				warn "#{self.class}##{__method__}(): ignoring unrecognised option '#{k}'" unless SimpleFileLogService_Constants::RECOGNISED_OPTIONS.include?(:k)
-			end
-		end
+        warn "#{self.class}##{__method__}(): ignoring unrecognised option '#{k}'" unless SimpleFileLogService_Constants::RECOGNISED_OPTIONS.include?(:k)
+      end
+    end
 
-		if roll_period && (roll_size || roll_depth)
+    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
+      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
+      roll_period = nil
+    end
 
-		if roll_size || roll_depth
+    if roll_size || roll_depth
 
-			if ::Array === roll_size
+      if ::Array === roll_size
 
-				roll_size, d	=	roll_size
+        roll_size, d  =  roll_size
 
-				roll_depth		||=	d
-			end
+        roll_depth    ||=  d
+      end
 
-			roll_size	||=	SimpleFileLogService_Constants::DEFAULT_ROLL_SIZE
-			roll_depth	||=	SimpleFileLogService_Constants::DEFAULT_ROLL_DEPTH
-		end
+      roll_size  ||=  SimpleFileLogService_Constants::DEFAULT_ROLL_SIZE
+      roll_depth  ||=  SimpleFileLogService_Constants::DEFAULT_ROLL_DEPTH
+    end
 
-		logger_init_args	=	[]
-		logger_init_options	=	{}
+    logger_init_args  =  []
 
-		if false;
-		elsif roll_depth
+    if false;
+    elsif roll_depth
 
-			logger_init_args	<<	roll_depth
-			logger_init_args	<<	roll_size
-		elsif roll_period
+      logger_init_args  <<  roll_depth
+      logger_init_args  <<  roll_size
+    elsif roll_period
 
-			roll_period = roll_period.downcase.to_sym if ::String === roll_period
+      roll_period = roll_period.downcase.to_sym if ::String === roll_period
 
-			case roll_period
-			when :daily, :weekly, :monthly
+      case roll_period
+      when :daily, :weekly, :monthly
 
-				;
-			else
+        ;
+      else
 
-				raise ArgumentError, ":roll_period value must be one of :daily, :weekly, :monthly"
-			end
+        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
+      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)
+    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
+    file_proc = lambda do
 
-			@logger			=	::Logger.new log_file_or_path, *logger_init_args
-			@log_file_path	=	log_file_or_path.path
-		end
+      @logger      =  ::Logger.new log_file_or_path, *logger_init_args
+      @log_file_path  =  log_file_or_path.path
+    end
 
-		io_proc = lambda do
+    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
+      @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
+    case log_file_or_path
+    when nil
 
-			raise ArgumentError, 'log_file_or_path may not be nil'
-		when ::IO#, ::StringIO
+      raise ArgumentError, 'log_file_or_path may not be nil'
+    when ::IO#, ::StringIO
 
-			io_proc.call
-		when ::File#, ::Tempfile
+      io_proc.call
+    when ::File#, ::Tempfile
 
-			file_proc.call
-		when ::String
+      file_proc.call
+    when ::String
 
-			@logger			=	::Logger.new log_file_or_path, *logger_init_args
-			@log_file_path	=	log_file_or_path
-		else
+      @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)
+      ancestor_names  =  log_file_or_path.class.ancestors.map(&:to_s)
 
-			if false
+      if false
 
-				;
-			elsif ancestor_names.include?('StringIO')
+        ;
+      elsif ancestor_names.include?('StringIO')
 
-				io_proc.call
-			elsif ancestor_names.include?('Tempfile')
+        io_proc.call
+      elsif ancestor_names.include?('Tempfile')
 
-				file_proc.call
-			else
+        file_proc.call
+      else
 
-				raise TypeError, "log_file_or_path type must be one of #{::File}, #{::IO}, #{::String}, #{::StringIO}"
-			end
-		end
+        raise TypeError, "log_file_or_path type must be one of #{::File}, #{::IO}, #{::String}, #{::StringIO}"
+      end
+    end
 
-		self
-	end
+    self
+  end
 
-	# The path of the underlying log file. May return +nil+ if the path
-	# cannot be determined
-	attr_reader	:log_file_path
+  # 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
+  def severity_logged? severity
 
-		true
-	end
+    true
+  end
 
-	def log sev, t, pref, msg
+  def log sev, t, pref, msg
 
-		@logger << "#{pref}#{msg}\n"
-	end
+    @logger << "#{pref}#{msg}\n"
+  end
 end
 
 

data/lib/pantheios/services/standard_log_service_adapter.rb

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/services/standard_log_service_adapter.rb
 #
@@ -6,14 +6,14 @@
 #               ::Pantheios::Services::StandardLogServiceAdapter class
 #
 # Created:      18th June 2015
-# 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) 2015-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2026, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -68,176 +68,176 @@ module Services
 # +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class StandardLogServiceAdapter
 
-	include ::Xqsr3::Quality::ParameterChecking
+  include ::Xqsr3::Quality::ParameterChecking
 
-	STOCK_SEVS_EXT2NUM = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
+  STOCK_SEVS_EXT2NUM = ::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
 
-	SEV_LEVELS_INT2PAIR = {
+  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] ],
-	}
+    ::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 = {
+  SEV_LEVELS_EXT2INT = {
 
-		:trace => ::Logger::DEBUG,
-		:benchmark => ::Logger::DEBUG,
+    :trace => ::Logger::DEBUG,
+    :benchmark => ::Logger::DEBUG,
 
-		:debug0 => ::Logger::DEBUG,
-		:debug1 => ::Logger::DEBUG,
-		:debug2 => ::Logger::DEBUG,
-		:debug3 => ::Logger::DEBUG,
-		:debug4 => ::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,
+    :notice => ::Logger::INFO,
+    :informational => ::Logger::INFO, :info => ::Logger::INFO,
 
-		:warning => ::Logger::WARN, :warn => ::Logger::WARN,
+    :warning => ::Logger::WARN, :warn => ::Logger::WARN,
 
-		:failure => ::Logger::ERROR, :error => ::Logger::ERROR,
-		:critical => ::Logger::ERROR,
+    :failure => ::Logger::ERROR, :error => ::Logger::ERROR,
+    :critical => ::Logger::ERROR,
 
-		:alert => ::Logger::UNKNOWN,
-		:violation => ::Logger::UNKNOWN, :emergency => ::Logger::UNKNOWN,
-	}
+    :alert => ::Logger::UNKNOWN,
+    :violation => ::Logger::UNKNOWN, :emergency => ::Logger::UNKNOWN,
+  }
 
-	SEV_LEVELS_EXT2NUM = {
+  SEV_LEVELS_EXT2NUM = {
 
-		STOCK_SEVS_EXT2NUM[:trace] => ::Logger::DEBUG,
-		STOCK_SEVS_EXT2NUM[:benchmark] => ::Logger::DEBUG,
+    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[: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[:notice] => ::Logger::INFO,
+    STOCK_SEVS_EXT2NUM[:informational] => ::Logger::INFO,
 
-		STOCK_SEVS_EXT2NUM[:warning] => ::Logger::WARN,
+    STOCK_SEVS_EXT2NUM[:warning] => ::Logger::WARN,
 
-		STOCK_SEVS_EXT2NUM[:failure] => ::Logger::ERROR,
-		STOCK_SEVS_EXT2NUM[:critical] => ::Logger::ERROR,
+    STOCK_SEVS_EXT2NUM[:failure] => ::Logger::ERROR,
+    STOCK_SEVS_EXT2NUM[:critical] => ::Logger::ERROR,
 
-		STOCK_SEVS_EXT2NUM[:alert] => ::Logger::UNKNOWN,
-		STOCK_SEVS_EXT2NUM[:violation] => ::Logger::UNKNOWN,
-	}
+    STOCK_SEVS_EXT2NUM[:alert] => ::Logger::UNKNOWN,
+    STOCK_SEVS_EXT2NUM[:violation] => ::Logger::UNKNOWN,
+  }
 
 
-	def initialize logger, adapter_threshold = nil, **options
+  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
+    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
+    @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
+  # 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
+  def adapter_threshold= threshold
 
-		case @adapter_threshold	=	threshold
-		when nil
+    case @adapter_threshold  =  threshold
+    when nil
 
-			@at_value	=	nil
-		when ::Symbol
+      @at_value  =  nil
+    when ::Symbol
 
-			@at_value	=	STOCK_SEVS_EXT2NUM[threshold]
-		when ::Integer
+      @at_value  =  STOCK_SEVS_EXT2NUM[threshold]
+    when ::Integer
 
-			@at_value	=	threshold
-		else
+      @at_value  =  threshold
+    else
 
-			raise ::TypeError, 'adapter_threshold must be a symbol, an integer value, or nil'
-		end
-	end
+      raise ::TypeError, 'adapter_threshold must be a symbol, an integer value, or nil'
+    end
+  end
 
-	def close
+  def close
 
-		raise "already closed" if @closed
+    raise "already closed" if @closed
 
-		@logger.close
+    @logger.close
 
-		@closed = true
-	end
+    @closed = true
+  end
 
-	def flush
+  def flush
 
-		@logger.flush if @logger.respond_to? :flush
-	end
+    @logger.flush if @logger.respond_to? :flush
+  end
 
-	def severity_logged? severity
+  def severity_logged? severity
 
-		case severity
-		when nil
+    case severity
+    when nil
 
-			return true
-		when adapter_threshold
+      return true
+    when adapter_threshold
 
-			return true
-		when ::Symbol
+      return true
+    when ::Symbol
 
-			sev	=	STOCK_SEVS_EXT2NUM[severity] || 0
-		when ::Integer
+      sev  =  STOCK_SEVS_EXT2NUM[severity] || 0
+    when ::Integer
 
-			sev	=	severity
-		else
+      sev  =  severity
+    else
 
-			warn "severity - '#{severity}' - of invalid type (#{severity.class}) specified to severity_logged?"
+      warn "severity - '#{severity}' - of invalid type (#{severity.class}) specified to severity_logged?"
 
-			return true
-		end
+      return true
+    end
 
 
-		unless adapter_threshold
+    unless adapter_threshold
 
-			# ask the logger
+      # ask the logger
 
-			sym, val = SEV_LEVELS_INT2PAIR[@logger.level]
+      _unused_sym, val = SEV_LEVELS_INT2PAIR[@logger.level]
 
-			return sev <= val
-		end
+      return sev <= val
+    end
 
 
-		return sev <= @at_value
-	end
+    return sev <= @at_value
+  end
 
-	def log severity, t, prefix, msg
+  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
+    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
+    case @format
+    when :default
 
-			prog_name	=	::Pantheios::Util::ProcessUtil.derive_process_name $0
+      prog_name  =  ::Pantheios::Util::ProcessUtil.derive_process_name $0
 
-			@logger.add sev_int, msg, prog_name
-		when :simple
+      @logger.add sev_int, msg, prog_name
+    when :simple
 
-			@logger << msg + ?\n
-		when :standard
+      @logger << msg + ?\n
+    when :standard
 
-			@logger << "#{prefix}#{msg}\n"
-		end
-	end
+      @logger << "#{prefix}#{msg}\n"
+    end
+  end
 end
 
 end # module Services

data/lib/pantheios/services.rb

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