pantheios-ruby 0.22.0 → 0.22.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554c2a9920c4d3459aac5f8a222cc862547f397d
-  data.tar.gz: 8edd3f22884716113a84f5291092d25f4be684bb
+  metadata.gz: ad32385bd72202625243bd53a0bb8016939ccc38
+  data.tar.gz: a96bedc8fa2604cf562ce2daa376ceaf929414c4
 SHA512:
-  metadata.gz: bf9014bf59fbc49c97509b72fa4f6acbc5b96582ee078598c9f98c83c9a2c691220cf19665da1173859e187b806ff5639192ebe6e409d672e9e4a3d75b95bc7b
-  data.tar.gz: 9ce3d10428dd953ba201eec61a32bc4172d341fa9e0bb8332df2685fa902595429f1be41c692bc34c21780962be452e9b0a8d66e35125b2df8eb9dee2ee6df9b
+  metadata.gz: da221cb043bf8a6639497a913e219328e4c68abc53fc73cd76b1e80b0483a07dbecc11c5a36bb8bb2cccd5cbc5c6407c3fc3161e81a12651c46f2e6b9270aa74
+  data.tar.gz: 31182596ce8e65269a7ac3d64ca510d7430874208de1c81e94fce4db8722f30f52dcc0fabfe9792ee70194ab6ea2d7bea49cd739f68424be74fc5543d9eaa169

data/lib/pantheios.rb

@@ -6,7 +6,7 @@
 # +Pantheios::API+, +Pantheios::ApplicationLayer+, and +Pantheios::Util+ (as
 # well as certain sub modules of +Pantheios::Util+; see +Pantheios::Util+
 # for details), unless the global symbol
-# +::Pantheios::Globals.HAS_CASCADED_INCLUDES+ is truey
+# +::Pantheios::Globals.HAS_CASCADED_INCLUDES+ is falsey
 module Pantheios
 end # module Pantheios
 
@@ -19,7 +19,8 @@ require 'pantheios/version'
 
 module Pantheios
 
-	def self.included receiver
+	# @!visibility private
+	def self.included receiver # :nodoc:
 
 		if ::Pantheios::Globals.HAS_CASCADED_INCLUDES
 

data/lib/pantheios/api.rb

@@ -265,7 +265,8 @@ module API
 		prefix_parts(t, severity).join(', ')
 	end
 
-	def self.included receiver
+	# @!visibility private
+	def self.included receiver # :nodoc:
 
 		receiver.extend self
 

data/lib/pantheios/application_layer.rb

@@ -7,7 +7,8 @@ require 'pantheios/core'
 module Pantheios
 module ApplicationLayer
 
-	def self.included receiver
+	# @!visibility private
+	def self.included receiver # :nodoc:
 
 		receiver.extend self
 

data/lib/pantheios/application_layer/param_name_list.rb

@@ -2,9 +2,18 @@
 module Pantheios
 module ApplicationLayer
 
+# Type-distinct +::Array+ for use with tracing, as in
+#
+#    def my_func arg1, arg2, **options
+#
+#        trace ParamNames [ :arg1, :arg2, :options ], arg1, arg2, options
+#
+#    end
+#
 class ParamNameList < Array
 end
 
+# Another name for +ParamNameList+
 ParamNames = ParamNameList
 
 end # module ApplicationLayer

data/lib/pantheios/application_layer/stock_severity_levels.rb

@@ -56,8 +56,10 @@ module ApplicationLayer
 module StockSeverityLevels
 
 	private
-	module Internal_
+	# @!visibility private
+	module Internal_ # :nodoc: all
 
+		# @!visibility private
 		STOCK_SEVERITY_LEVELS_ = {
 
 			:violation => [ 1, 'Violation', :relative, [ :emergency ] ],
@@ -77,7 +79,8 @@ module StockSeverityLevels
 			:benchmark => [ 16, 'Benchmark', :separate ],
 		}
 
-		def self.create_level_keys m
+		# @!visibility private
+		def self.create_level_keys m # :nodoc:
 
 			r = m.keys
 
@@ -92,7 +95,8 @@ module StockSeverityLevels
 			r.uniq
 		end
 
-		def self.create_level_value_map m
+		# @!visibility private
+		def self.create_level_value_map m # :nodoc:
 
 			r = {}
 
@@ -110,7 +114,8 @@ module StockSeverityLevels
 			r
 		end
 
-		def self.create_level_string_map m
+		# @!visibility private
+		def self.create_level_string_map m # :nodoc:
 
 			r = {}
 
@@ -132,7 +137,8 @@ module StockSeverityLevels
 			r
 		end
 
-		def self.create_level_aliases m
+		# @!visibility private
+		def self.create_level_aliases m # :nodoc:
 
 			r = {}
 
@@ -150,7 +156,8 @@ module StockSeverityLevels
 			r
 		end
 
-		def self.create_level_relative_map m
+		# @!visibility private
+		def self.create_level_relative_map m # :nodoc:
 
 			r = {}
 

data/lib/pantheios/core.rb

@@ -61,7 +61,8 @@ require 'pantheios/util/thread_util'
 module Pantheios
 module Core
 
-	module Constants_
+	# @!visibility private
+	module Constants_ # :nodoc: all
 
 		REQUIRED_SERVICE_METHODS	=	%w{ severity_logged? log }.map { |name| name.to_sym }
 		REQUIRED_FRONTEND_METHODS	=	%w{ severity_logged?     }.map { |name| name.to_sym }
@@ -69,9 +70,11 @@ module Core
 
 	end # module Constants_
 
-	module Internals_
+	# @!visibility private
+	module Internals_ # :nodoc: all
 
-		class DefaultDiscriminator
+		# @!visibility private
+		class DefaultDiscriminator # :nodoc:
 
 			def severity_logged? severity
 
@@ -88,8 +91,8 @@ module Core
 			end
 		end
 
-		# :nodoc:
-		class State
+		# @!visibility private
+		class State # :nodoc:
 
 			def initialize default_fe, **options
 
@@ -200,13 +203,14 @@ module Core
 		end # class State
 	end # module Internals_
 
-	def self.included receiver
+	# @!visibility private
+	def self.included receiver # :nodoc:
 
 		abort "Attempt to include #{self} into #{receiver}. This is not allowed"
 	end
 
-	# :nodoc:
-	def self.core_init
+	# @!visibility private
+	def self.core_init # :nodoc:
 
 		# process-name
 
@@ -277,8 +281,8 @@ module Core
 		self.set_default_service
 	end
 
-	# :nodoc:
-	def self.set_default_service **options
+	# @!visibility private
+	def self.set_default_service **options # :nodoc:
 
 		# determine which log service to initialise as the default
 
@@ -463,7 +467,9 @@ module Core
 
 
 	# Internal implementation method, not to be called by application code
-	def self.get_block_value_ &block
+	#
+	# @!visibility private
+	def self.get_block_value_ &block # :nodoc:
 
 		case block.arity
 		when 0
@@ -487,7 +493,9 @@ module Core
 	end
 
 	# Internal implementation method, not to be called by application code
-	def self.log_v_impl prefix_provider, severity, argv, &block
+	#
+	# @!visibility private
+	def self.log_v_impl prefix_provider, severity, argv, &block # :nodoc:
 
 		argv << get_block_value_(&block) if block_given?
 
@@ -495,7 +503,9 @@ module Core
 	end
 
 	# Internal implementation method, not to be called by application code
-	def self.trace_v_impl prefix_provider, call_depth, param_list, severity, argv, &block
+	#
+	# @!visibility private
+	def self.trace_v_impl prefix_provider, call_depth, param_list, severity, argv, &block # :nodoc:
 
 		unless param_list
 
@@ -592,7 +602,9 @@ module Core
 	end
 
 	# Internal implementation method, not to be called by application code
-	def self.log_raw prefix_provider, severity, message
+	#
+	# @!visibility private
+	def self.log_raw prefix_provider, severity, message # :nodoc:
 
 		now	=	Time.now
 

data/lib/pantheios/front_ends/threshold_front_end.rb

@@ -6,7 +6,7 @@
 #               class
 #
 # Created:      3rd June 2020
-# Updated:      3rd June 2020
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -60,8 +60,6 @@ module FrontEnds
 # the instance method +severity_logged?(severity : Object)+
 class ThresholdFrontEnd
 
-	include ::Pantheios::ApplicationLayer
-
 	# Initialises the instance
 	#
 	# === Signature
@@ -75,6 +73,10 @@ class ThresholdFrontEnd
 	#     +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]
@@ -87,13 +89,24 @@ class ThresholdFrontEnd
 			@relativity_lookup_map = ::Hash.new(:relative)
 		else
 
-			@value_lookup_map = StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES
-			@relativity_lookup_map = StockSeverityLevels::STOCK_SEVERITY_LEVELS_RELATIVE
+			@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

data/lib/pantheios/globals.rb

@@ -89,7 +89,8 @@ module Pantheios
 #
 module Globals
 
-	module Internals_
+	# @!visibility private
+	module Internals_ # :nodoc: all
 
 		BOOLEAN_CLASSES			=	[ ::FalseClass, ::TrueClass ]
 		TRUTHY_CLASSES			=	BOOLEAN_CLASSES + [ ::NilClass ]
@@ -97,7 +98,8 @@ module Globals
 		PROCESS_NAME_CLASSES	=	[ ::Symbol, ::String ]
 	end
 
-	module Helpers_
+	# @!visibility private
+	module Helpers_ # :nodoc: all
 
 		def self.cattr receiver, name, types, initial_value, **options
 
@@ -146,7 +148,8 @@ module Globals
 
 	Helpers_.cattr self, 'SYNCHRONISED_SEVERITY_LOGGED', nil, true, boolean: true
 
-	def self.included receiver
+	# @!visibility private
+	def self.included receiver # :nodoc:
 
 		abort "Attempt to include #{self} into #{receiver}. This is not allowed"
 	end

data/lib/pantheios/services/multiplexing_log_service.rb

@@ -60,7 +60,8 @@ module Services
 # +log(severity : Object, t : Time, prefix : String|Array, msg : String)+
 class MultiplexingLogService
 
-	module MultiplexingLogService_Internals_
+	# @!visibility private
+	module MultiplexingLogService_Internals_ # :nodoc: all
 
 		class ServiceManagementInfo
 

data/lib/pantheios/services/simple_file_log_service.rb

@@ -95,8 +95,6 @@ class SimpleFileLogService
 	#   - +: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]

data/lib/pantheios/util/process_util.rb

@@ -2,13 +2,13 @@
 module Pantheios
 module Util
 
+# process utilities
 module ProcessUtil
 
 	#
 	# * *Options:*
-	#   - +:style+:: (:script, :script_basename, :script_dirname,
-	#   :script_realpath, :script_stem) directs the inference of the process
-	#   name. If none specified, :script_stem is assumed
+	#   - +:style+:: (:script, :script_basename, :script_dirname, :script_realpath, :script_stem) directs
+	#   the inference of the process name. If none specified, :script_stem is assumed
 	def self.derive_process_name dollar0 = nil, **options
 
 		dollar0	||=	$0

data/lib/pantheios/util/reflection_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# reflection utilities
 module ReflectionUtil
 
 	module ReflectionUtil_Constants

data/lib/pantheios/util/thread_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# threading utilities
 module ThreadUtil
 
 	# Creates (if necessary) and sets the given thread's +thread_name+

data/lib/pantheios/util/version_util.rb

@@ -2,6 +2,7 @@
 module Pantheios
 module Util
 
+# version utilities
 module VersionUtil
 
 	# Compares two version designators and returns a spaceship comparison

data/lib/pantheios/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Pantheios.Ruby library
 #
 # Created:      2nd April 2011
-# Updated:      3rd June 2020
+# Updated:      4th June 2020
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
@@ -51,7 +51,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.22.0'
+	VERSION				=	'0.22.0.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pantheios-ruby
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.22.0.1
 platform: ruby
 authors:
 - Matt Wilson