pantheios-ruby 0.22.0.2 → 0.22.3

data/lib/pantheios/api.rb

@@ -1,16 +1,17 @@
-
+# frozen_string_literal: true
 # ######################################################################## #
 # File:         lib/pantheios/api.rb
 #
 # Purpose:      The Pantheios.Ruby API (::Pantheios::API)
 #
 # Created:      2nd April 2011
-# 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-2026, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2011-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -77,219 +78,219 @@ module Pantheios
 # - prefix
 module API
 
-	# Logs an arbitrary set of parameters at the given severity level
-	def log severity, *args, &block
+  # Logs an arbitrary set of parameters at the given severity level
+  def log severity, *args, &block
 
-		return nil unless severity_logged? severity
+    return nil unless severity_logged? severity
 
-		log_or_trace_with_block_ 1, severity, args, &block
-	end
+    log_or_trace_with_block_ 1, severity, args, &block
+  end
 
-	# Logs an array of parameters at the given severity level
-	def log_v severity, argv, &block
+  # Logs an array of parameters at the given severity level
+  def log_v severity, argv, &block
 
-		return nil unless severity_logged? severity
+    return nil unless severity_logged? severity
 
-		log_or_trace_with_block_ 1, severity, argv, &block
-	end
+    log_or_trace_with_block_ 1, severity, argv, &block
+  end
 
-	# Logs an arbitrary set of parameters at the Trace (:trace) level
-	def trace *args, &block
+  # Logs an arbitrary set of parameters at the Trace (:trace) level
+  def trace *args, &block
 
-		return nil unless tracing?
+    return nil unless tracing?
 
-		trace_with_block_ 1, args, &block
-	end
+    trace_with_block_ 1, args, &block
+  end
 
-	# Logs an array of parameters at the Trace (:trace) level
-	def trace_v argv, &block
+  # Logs an array of parameters at the Trace (:trace) level
+  def trace_v argv, &block
 
-		return nil unless tracing?
+    return nil unless tracing?
 
-		trace_with_block_ 1, argv, &block
-	end
+    trace_with_block_ 1, argv, &block
+  end
 
-	if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 1 ]) >= 0
+  if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 1 ]) >= 0
 
-	def trace_blv b, lvars, &block
+  def trace_blv b, lvars, &block
 
-		return nil unless tracing?
+    return nil unless tracing?
 
-		::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*lvars], :trace, lvars.map { |lv| b.local_variable_get(lv) }, &block)
-	end
-	end # RUBY_VERSION
+    ::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*lvars], :trace, lvars.map { |lv| b.local_variable_get(lv) }, &block)
+  end
+  end # RUBY_VERSION
 
-	if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 2 ]) >= 0
+  if Util::VersionUtil.version_compare(RUBY_VERSION, [ 2, 2 ]) >= 0
 
-	def trace_b b, &block
+  def trace_b b, &block
 
-		return nil unless tracing?
+    return nil unless tracing?
 
-		::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*b.local_variables], :trace, b.local_variables.map { |lv| b.local_variable_get(lv) }, &block)
-	end
-	end # RUBY_VERSION
+    ::Pantheios::Core.trace_v_impl(self, 1, ApplicationLayer::ParamNameList[*b.local_variables], :trace, b.local_variables.map { |lv| b.local_variable_get(lv) }, &block)
+  end
+  end # RUBY_VERSION
 
 
-	# 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
+  # 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
 
-		::Pantheios::Core.severity_logged? severity
-	end
+    ::Pantheios::Core.severity_logged? severity
+  end
 
-	# Determines whether tracing (severity == :trace) is enabled. This is
-	# used in the trace methods (+trace+, +trace_v+, +trace_blv+, +trace_b+)
-	# and therefore it may be overridden independently of +severity_logged?+
-	def tracing?
+  # Determines whether tracing (severity == :trace) is enabled. This is
+  # used in the trace methods (+trace+, +trace_v+, +trace_blv+, +trace_b+)
+  # and therefore it may be overridden independently of +severity_logged?+
+  def tracing?
 
-		severity_logged? :trace
-	end
+    severity_logged? :trace
+  end
 
 
 
-	# Defines the ordered list of log-statement elements
-	#
-	# === Elements
-	#
-	# Elements can be one of:
-	#   - +:process_name+
-	#   - +:process_id+
-	#   - +:severity+
-	#   - +:thread_id+
-	#   - +:timestamp+
-	#
-	# This is called from +prefix+
-	def prefix_elements
+  # Defines the ordered list of log-statement elements
+  #
+  # === Elements
+  #
+  # Elements can be one of:
+  #   - +:process_name+
+  #   - +:process_id+
+  #   - +:severity+
+  #   - +:thread_id+
+  #   - +:timestamp+
+  #
+  # This is called from +prefix+
+  def prefix_elements
 
-		[ :process_name, :thread_id, :timestamp, :severity ]
-	end
+    [ :process_name, :thread_id, :timestamp, :severity ]
+  end
 
-	# Obtains the process id
-	#
-	# Unless overridden, returns the value provided by
-	# +::Pantheios::Core::process_id+
-	def process_id
+  # Obtains the process id
+  #
+  # Unless overridden, returns the value provided by
+  # +::Pantheios::Core::process_id+
+  def process_id
 
-		::Pantheios::Core.process_id
-	end
+    ::Pantheios::Core.process_id
+  end
 
-	# Obtains the program name
-	#
-	# Unless overridden, returns the value provided by
-	# +::Pantheios::Core::process_name+
-	def process_name
+  # Obtains the program name
+  #
+  # Unless overridden, returns the value provided by
+  # +::Pantheios::Core::process_name+
+  def process_name
 
-		::Pantheios::Core.process_name
-	end
+    ::Pantheios::Core.process_name
+  end
 
-	# Obtains the string corresponding to the severity
-	#
-	# Unless overridden, returns the value provided by
-	# +::Pantheios::Core::severity_string+
-	def severity_string severity
+  # Obtains the string corresponding to the severity
+  #
+  # Unless overridden, returns the value provided by
+  # +::Pantheios::Core::severity_string+
+  def severity_string severity
 
-		::Pantheios::Core.severity_string severity
-	end
+    ::Pantheios::Core.severity_string severity
+  end
 
-	# Obtains the thread id
-	#
-	# Unless overridden, returns the value provided by
-	# +::Pantheios::Core::thread_id+
-	def thread_id
+  # Obtains the thread id
+  #
+  # Unless overridden, returns the value provided by
+  # +::Pantheios::Core::thread_id+
+  def thread_id
 
-		::Pantheios::Core.thread_id
-	end
+    ::Pantheios::Core.thread_id
+  end
 
-	# Obtains a string-form of the timestamp
-	#
-	# Unless overridden, returns the value provided by
-	# +::Pantheios::Core::timestamp+
-	def timestamp t
+  # Obtains a string-form of the timestamp
+  #
+  # Unless overridden, returns the value provided by
+  # +::Pantheios::Core::timestamp+
+  def timestamp t
 
-		::Pantheios::Core.timestamp t, nil
-	end
+    ::Pantheios::Core.timestamp t, nil
+  end
 
-	# Assembles the prefix according to +prefix_elements+ into an array of
-	# parts
-	#
-	# * *Parameters:*
-	#   - +t+ [ Date, Time, DateTime ] The timestamp of the log entry
-	#   - +severity+ The severity
-	def prefix_parts t, severity
+  # Assembles the prefix according to +prefix_elements+ into an array of
+  # parts
+  #
+  # * *Parameters:*
+  #   - +t+ [ Date, Time, DateTime ] The timestamp of the log entry
+  #   - +severity+ The severity
+  def prefix_parts t, severity
 
-		prefix_elements.map do |el|
+    prefix_elements.map do |el|
 
-			case el
-			when :program_name, :process_name
+      case el
+      when :program_name, :process_name
 
-				process_name
-			when :process_id
+        process_name
+      when :process_id
 
-				process_id
-			when :severity
+        process_id
+      when :severity
 
-				severity_string severity
-			when :thread_id
+        severity_string severity
+      when :thread_id
 
-				thread_id
-			when :timestamp
+        thread_id
+      when :timestamp
 
-				timestamp t
-			else
+        timestamp t
+      else
 
-				s = ::Symbol === el ? ":#{el}" : el.to_s
+        s = ::Symbol === el ? ":#{el}" : el.to_s
 
-				warn "ignoring unrecognised prefix_element '#{s}'"
+        warn "ignoring unrecognised prefix_element '#{s}'"
 
-				nil
-			end
-		end
-	end
+        nil
+      end
+    end
+  end
 
-	# Assembles the +prefix_parts+ into a string
-	#
-	# * *Parameters:*
-	#   - +t+ [ Date, Time, DateTime ] The timestamp of the log entry
-	#   - +severity+ The severity
-	def prefix t, severity
+  # Assembles the +prefix_parts+ into a string
+  #
+  # * *Parameters:*
+  #   - +t+ [ Date, Time, DateTime ] The timestamp of the log entry
+  #   - +severity+ The severity
+  def prefix t, severity
 
-		prefix_parts(t, severity).join(', ')
-	end
+    prefix_parts(t, severity).join(', ')
+  end
 
-	# @!visibility private
-	def self.included receiver # :nodoc:
+  # @!visibility private
+  def self.included receiver # :nodoc:
 
-		receiver.extend self
+    receiver.extend self
 
-		::Pantheios::Core.register_include self, receiver
-	end
+    ::Pantheios::Core.register_include self, receiver
+  end
 
-	private
+  private
 
-	# Private implementation method that should not need to be overridden
-	def log_or_trace_with_block_ call_depth, severity, argv, &block
+  # Private implementation method that should not need to be overridden
+  def log_or_trace_with_block_ call_depth, severity, argv, &block
 
-		if :trace == severity
+    if :trace == severity
 
-			return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, severity, argv, &block
-		end
+      return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, severity, argv, &block
+    end
 
-		::Pantheios::Core.log_v_impl self, severity, argv, &block
-	end
+    ::Pantheios::Core.log_v_impl self, severity, argv, &block
+  end
 
-	def trace_with_block_ call_depth, argv, &block
+  def trace_with_block_ call_depth, argv, &block
 
-		return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, :trace, argv, &block
-	end
+    return ::Pantheios::Core.trace_v_impl self, 1 + call_depth, nil, :trace, argv, &block
+  end
 
 end # module API
 end # module Pantheios

data/lib/pantheios/application_layer/param_name_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Pantheios
 module ApplicationLayer