pantheios-ruby 0.19.2 → 0.22.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08cdda0f4237044c0b2681d2b1a5cf47ff2315f
-  data.tar.gz: b06b7ac4f43eead0c66d1253b72198ae1b63b28a
+  metadata.gz: ad32385bd72202625243bd53a0bb8016939ccc38
+  data.tar.gz: a96bedc8fa2604cf562ce2daa376ceaf929414c4
 SHA512:
-  metadata.gz: 8650e0cad32dcb92b16e677da6e7a09def7302c52465460fe431890827d074cd11d009ba22d06f85a2f0de9b5003f902882085ffc206233dd47dda0de9e65e69
-  data.tar.gz: 3ccbdfd84bf0b5ba7ada60754bd40e3a4361637da3f0c07e8ee225fd4fe1125c26f8bffcddbd8bcab58bd1ed37a97b1c02fd99a68a3e8eb9e2e5090e1ed5e940
+  metadata.gz: da221cb043bf8a6639497a913e219328e4c68abc53fc73cd76b1e80b0483a07dbecc11c5a36bb8bb2cccd5cbc5c6407c3fc3161e81a12651c46f2e6b9270aa74
+  data.tar.gz: 31182596ce8e65269a7ac3d64ca510d7430874208de1c81e94fce4db8722f30f52dcc0fabfe9792ee70194ab6ea2d7bea49cd739f68424be74fc5543d9eaa169

data/LICENSE

@@ -0,0 +1,31 @@
+Pantheios.Ruby
+
+Copyright (c) 2017-2019, 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 Pantheios or Pantheios.Ruby nor 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.
+

data/README.md

@@ -0,0 +1,5 @@
+# **Pantheios.Ruby**
+Pantheios, for Ruby
+
+T.B.C.
+

data/examples/coloured_console_log_service.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *(['..'] * 1), 'lib')
+
+# requires (0)
+
+require 'pantheios/globals'
+require 'pantheios/services/coloured_console_log_service'
+
+# globals
+
+Pantheios::Globals.INITIAL_SERVICE_CLASSES = [ Pantheios::Services::ColouredConsoleLogService ]
+Pantheios::Globals.MAIN_THREAD_NAME = [ Thread.current, 'main' ]
+Pantheios::Globals.PROCESS_NAME = :script_stem
+
+# requires (1)
+
+require 'pantheios'
+
+# includes
+
+include ::Pantheios
+
+# constants
+
+LEVELS = %i{ violation alert critical failure warning notice informational debug0 debug1 debug2 debug3 debug4 debug5 benchmark }
+
+# main
+
+LEVELS.each do |level|
+
+	log(level, "logging level #{level}")
+end
+
+# ############################## end of file ############################# #
+
+

data/examples/multiple_modules.md

@@ -0,0 +1,204 @@
+# Pantheios.Ruby Example - **multiple_modules**
+
+## Summary
+
+Example showing application of Pantheios into multiple modules and
+suppression of arbitrary severity levels specified as command line
+arguments
+
+## Source
+
+```ruby
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *([ '..' ] * 1), 'lib')
+
+# ######################################
+# requires
+
+require 'pantheios'
+
+# ######################################
+# modules
+
+module Organisation
+
+module Helpers
+
+	include ::Pantheios
+
+	def with_trace
+
+		trace
+	end
+
+	def with_debug0; log(:debug0); end
+	def with_debug1; log(:debug1); end
+	def with_informational; log(:informational); end
+	def with_notice; log(:notice); end
+	def with_warning; log(:warning); end
+	def with_failure; log(:failure); end
+	def with_critical; log(:critical); end
+	def with_alert; log(:alert); end
+
+	def helper1
+
+		trace
+
+		with_debug0
+
+		with_notice
+	end
+
+end # module Helpers
+
+class OrgClass
+
+	include Helpers
+	include ::Pantheios
+
+	def initialize()
+
+		trace
+
+		log(:debug2) { 'initialised instance of OrgClass' }
+
+		helper1
+	end
+
+end # class OrgClas
+
+end # module Organisation
+
+# ######################################
+# includes
+
+include ::Organisation::Helpers
+
+include ::Pantheios
+
+# ######################################
+# constants
+
+SUPPRESSED_SEVERITIES = %i{
+
+
+}
+
+# ######################################
+# diagnostics
+
+def detect_suppression argv
+
+	argv.each do |arg|
+
+		SUPPRESSED_SEVERITIES << arg.to_sym
+	end
+end
+
+class FrontEnd
+
+	def severity_logged? severity
+
+		case severity
+		when ::Symbol
+
+			!SUPPRESSED_SEVERITIES.include?(severity)
+		else
+
+			true
+		end
+	end
+end
+
+Pantheios::Core.set_front_end FrontEnd.new
+
+# ######################################
+# main
+
+detect_suppression ARGV
+
+log(:some_level)
+
+log(:notice, 'starting up')
+
+puts "Suppressed severities: #{SUPPRESSED_SEVERITIES}"
+
+log(:info) { "Calling helpers" }
+
+with_trace
+
+with_debug0
+with_debug1
+helper1
+with_critical
+with_alert
+
+log(:info) { "Creating instance of OrgClass" }
+
+oc = Organisation::OrgClass.new
+
+# ############################## end of file ############################# #
+
+```
+
+
+## Usage
+
+### No arguments
+
+When executed as follows
+
+```
+$ ./examples/multiple_modules.rb
+```
+
+it gives the following output:
+
+```
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.853720, some_level]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.853882, Notice]: starting up
+Suppressed severities: []
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.853971, Informational]: Calling helpers
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854134, Trace]: ./examples/multiple_modules.rb:21: Object#with_trace()
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854200, Debug-0]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854255, Debug-1]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854333, Trace]: ./examples/multiple_modules.rb:35: Object#helper1()
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854386, Debug-0]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854522, Notice]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854582, Critical]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854631, Alert]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854684, Informational]: Creating instance of OrgClass
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854772, Trace]: ./examples/multiple_modules.rb:51: Organisation::OrgClass#initialize()
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854852, Debug-2]: initialised instance of OrgClass
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854930, Trace]: ./examples/multiple_modules.rb:35: Organisation::OrgClass#helper1()
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.854985, Debug-0]:
+[multiple_modules, 70123884951220, 2020-06-03 20:30:15.855035, Notice]:
+```
+
+### Some named suppressed levels
+
+When executed as follows
+
+```
+$ ./examples/multiple_modules.rb trace debug2
+```
+
+it gives the following output:
+
+```
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.201933, some_level]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202013, Notice]: starting up
+Suppressed severities: [:trace, :debug2]
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202050, Informational]: Calling helpers
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202073, Debug-0]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202091, Debug-1]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202110, Debug-0]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202125, Notice]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202167, Critical]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202199, Alert]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202243, Informational]: Creating instance of OrgClass
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202269, Debug-0]:
+[multiple_modules, 70350289450660, 2020-06-03 20:25:49.202286, Notice]:
+```
+

data/examples/multiple_modules.rb

@@ -0,0 +1,132 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *([ '..' ] * 1), 'lib')
+
+# ######################################
+# requires
+
+require 'pantheios'
+
+# ######################################
+# modules
+
+module Organisation
+
+module Helpers
+
+	include ::Pantheios
+
+	def with_trace
+
+		trace
+	end
+
+	def with_debug0; log(:debug0); end
+	def with_debug1; log(:debug1); end
+	def with_informational; log(:informational); end
+	def with_notice; log(:notice); end
+	def with_warning; log(:warning); end
+	def with_failure; log(:failure); end
+	def with_critical; log(:critical); end
+	def with_alert; log(:alert); end
+
+	def helper1
+
+		trace
+
+		with_debug0
+
+		with_notice
+	end
+
+end # module Helpers
+
+class OrgClass
+
+	include Helpers
+	include ::Pantheios
+
+	def initialize()
+
+		trace
+
+		log(:debug2) { 'initialised instance of OrgClass' }
+
+		helper1
+	end
+
+end # class OrgClas
+
+end # module Organisation
+
+# ######################################
+# includes
+
+include ::Organisation::Helpers
+
+include ::Pantheios
+
+# ######################################
+# constants
+
+SUPPRESSED_SEVERITIES = %i{
+
+
+}
+
+# ######################################
+# diagnostics
+
+def detect_suppression argv
+
+	argv.each do |arg|
+
+		SUPPRESSED_SEVERITIES << arg.to_sym
+	end
+end
+
+class FrontEnd
+
+	def severity_logged? severity
+
+		case severity
+		when ::Symbol
+
+			!SUPPRESSED_SEVERITIES.include?(severity)
+		else
+
+			true
+		end
+	end
+end
+
+Pantheios::Core.set_front_end FrontEnd.new
+
+# ######################################
+# main
+
+detect_suppression ARGV
+
+log(:some_level)
+
+log(:notice, 'starting up')
+
+puts "Suppressed severities: #{SUPPRESSED_SEVERITIES}"
+
+log(:info) { "Calling helpers" }
+
+with_trace
+
+with_debug0
+with_debug1
+helper1
+with_critical
+with_alert
+
+log(:info) { "Creating instance of OrgClass" }
+
+oc = Organisation::OrgClass.new
+
+# ############################## end of file ############################# #
+
+

data/examples/simple_logging.md

@@ -0,0 +1,65 @@
+# Pantheios.Ruby Example - **simple_logging**
+
+## Summary
+
+Simple example supporting ```--help``` and ```--version```.
+
+## Source
+
+```ruby
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *([ '..' ] * 1), 'lib')
+
+# requires (0)
+
+require 'pantheios/globals'
+
+# globals
+
+Pantheios::Globals.MAIN_THREAD_NAME = [ Thread.current, 'main' ]
+Pantheios::Globals.PROCESS_NAME = :script_stem
+
+# requires (1)
+
+require 'pantheios'
+
+# includes
+
+include ::Pantheios
+
+# constants
+
+LEVELS = %i{ violation alert critical failure warning notice informational debug0 debug1 debug2 debug3 debug4 }
+
+# main
+
+LEVELS.each do |level|
+
+	log(level, "logging level #{level}")
+end
+
+# ############################## end of file ############################# #
+```
+
+## Usage
+
+### No arguments
+
+When executed gives the following output:
+
+```
+[simple_logging, main, 2019-06-05 13:18:52.517479, Violation]: logging level violation
+[simple_logging, main, 2019-06-05 13:18:52.517615, Alert]: logging level alert
+[simple_logging, main, 2019-06-05 13:18:52.517653, Critical]: logging level critical
+[simple_logging, main, 2019-06-05 13:18:52.517681, Failure]: logging level failure
+[simple_logging, main, 2019-06-05 13:18:52.517709, Warning]: logging level warning
+[simple_logging, main, 2019-06-05 13:18:52.517735, Notice]: logging level notice
+[simple_logging, main, 2019-06-05 13:18:52.517763, Informational]: logging level informational
+[simple_logging, main, 2019-06-05 13:18:52.517789, Debug-0]: logging level debug0
+[simple_logging, main, 2019-06-05 13:18:52.517837, Debug-1]: logging level debug1
+[simple_logging, main, 2019-06-05 13:18:52.517876, Debug-2]: logging level debug2
+[simple_logging, main, 2019-06-05 13:18:52.517905, Debug-3]: logging level debug3
+[simple_logging, main, 2019-06-05 13:18:52.517931, Debug-4]: logging level debug4
+```
+