pantheios-ruby 0.10.1 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 816145e8eb7825856f88eb9f633f27373353e35e
-  data.tar.gz: d9e671c63803cc71c6da15208b38f38ff3673cc4
+  metadata.gz: f17b99ae0e63f13c7cd21b0514d223e89308c4db
+  data.tar.gz: 78ab9f8852effb70635b021e2d766d2334748d51
 SHA512:
-  metadata.gz: f402e09916b1d4725918a3478427690e48132d5df8e5f193cce8c7cb661398fa8859c497b698ff51df902cd66ca911d4ec0b8cfc8f204c834c5ebdaa3add810d
-  data.tar.gz: 707f05267b790914b456be1ffd1ddc7121611c13d52072daf3ef10f09e55b98a57f25ed2fc677a2879ea4839cb5b3dfe90caa8043df19e3e714e0bf2aa0a5903
+  metadata.gz: 1194d7902fc8fe1989522618c2c6725d6be8828dcd023248586fe5b4fb35eeb706fc5b8f4f04398781477e3d94567d3f399d58814bae801ad844e3521623cda2
+  data.tar.gz: 979c17e7c5774c35e4d9558901648de1ae3ff1294f4ad68e1144524b02a7451677e5b3c87db5c8e964933ab7fdd17735776109bbe458c698448824fa32f28064

data/lib/pantheios/core.rb

@@ -5,13 +5,13 @@
 # Purpose:      The Pantheios.Ruby core (::Pantheios::Core)
 #
 # Created:      2nd April 2011
-# Updated:      25th December 2017
+# Updated:      6th January 2018
 #
 # Home:         http://github.com/synesissoftware/Pantheios-Ruby
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2011-2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2011-2018, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -213,7 +213,7 @@ module Core
 			return @@state.set_service inst
 		end
 
-		@@state.set_service ::Pantheios::Services::SimpleConsoleService.new
+		@@state.set_service ::Pantheios::Services::SimpleConsoleLogService.new
 	end
 
 	# Sets the front-end that will be used to evaluate whether a given log
@@ -443,4 +443,6 @@ module Core
 end # Core
 end # Pantheios
 
+# ############################## end of file ############################# #
+
 

data/lib/pantheios/services/null_log_service.rb

@@ -0,0 +1,77 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/services/simple_console_log_service.rb
+#
+# Purpose:      Version for Pantheios.Ruby library
+#
+# Created:      14th June 2015
+# Updated:      6th January 2018
+#
+# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2015-2018, 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 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Pantheios
+module Services
+
+# A class that fulfils the Pantheios *LogService* protocol that disallows all
+# severities and does nothing when asked to log
+#
+# NOTE: The *LogService* protocol is implemented by a class that provides
+# the instance methods +severity_logged?(severity : Object) : boolean+ and
+# +log(severity : Object, t : Time, prefix : String, msg : String)+
+class NullLogService
+
+	def severity_logged? severity
+
+		false
+	end
+
+	def log sev, t, pref, msg
+
+		;
+	end
+end
+
+end # module Services
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+

data/lib/pantheios/services/simple_console_log_service.rb

@@ -0,0 +1,84 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/services/simple_console_log_service.rb
+#
+# Purpose:      Version for Pantheios.Ruby library
+#
+# Created:      14th June 2015
+# Updated:      6th January 2018
+#
+# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2015-2018, 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 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.
+#
+# ######################################################################## #
+
+
+=begin
+=end
+
+module Pantheios
+module Services
+
+# A class that fulfils the Pantheios *LogService* protocol that sallows all
+# severities and logs to the console (via +$stdout+ and +$stderr+)
+#
+# NOTE: The *LogService* protocol is implemented by a class that provides
+# the instance methods +severity_logged?(severity : Object) : boolean+ and
+# +log(severity : Object, t : Time, prefix : String, msg : String)+
+class SimpleConsoleLogService
+
+	def severity_logged? severity
+
+		true
+	end
+
+	def log sev, t, pref, msg
+
+		stm = infer_stream sev
+
+		stm.puts "#{pref}#{msg}"
+	end
+
+	def infer_stream sev
+
+		(sev.to_i < 6) ? $stderr : $stdout
+	end
+end
+
+end # module Services
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+

data/lib/pantheios/version.rb

@@ -50,7 +50,7 @@
 module Pantheios
 
 	# Current version of the Pantheios.Ruby library
-	VERSION				=	'0.10.1'
+	VERSION				=	'0.11.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/services/tc_null_log_service.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+#
+# test/unit/services/tc_null_log_service.rb
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/services/null_log_service'
+
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_NullLogservice < Test::Unit::TestCase
+
+	include ::Pantheios::Services
+
+	def test_NullLogService_type_exists
+
+		assert defined? NullLogService
+	end
+
+	if  defined?(NullLogService)
+
+		def test_NullLogService_type_is_a_class
+
+			assert_kind_of(::Class, NullLogService)
+		end
+
+		def test_NullLogService_type_has_expected_instance_methods
+
+			assert_type_has_instance_methods NullLogService, [ :severity_logged?, :log ]
+		end
+
+		def test_severity_logged_false_with_large_range_of_integers
+
+			svc = NullLogService.new
+
+			(-10000 .. 10000).each do |sev|
+
+				assert_false(svc.severity_logged?(sev), "severity '#{sev}' (#{sev.class}) was logged")
+			end
+		end
+
+		def test_severity_logged_false_with_stock_severity_levels
+
+			svc = NullLogService.new
+
+			::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS.each do |sev|
+
+				assert_false(svc.severity_logged?(sev), "severity '#{sev}' (#{sev.class}) was logged")
+			end
+		end
+
+		def test_log_does_nothing_to_standard_streams
+
+			prev_stdout, prev_stderr = $stdout, $stderr
+
+			begin
+
+				$stdout	=	StringIO.new
+				$stderr	=	StringIO.new
+
+				svc		=	NullLogService.new
+				t		=	Time.now
+
+				(-1000..1000).each do |sev|
+
+					svc.log sev, t, 'some-prefix', 'some-message'
+				end
+
+				stdout_s	=	$stdout.string
+				stderr_s	=	$stderr.string
+
+				assert_empty stdout_s, "NullLogService has written to $stdout!"
+				assert_empty stderr_s, "NullLogService has written to $stderr!"
+			ensure
+
+				$stdout, $stderr = prev_stdout, prev_stderr
+			end
+		end
+	end
+end
+
+

data/test/unit/services/tc_simple_console_log_service.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+#
+# test/unit/services/tc_simple_console_log_service.rb
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/services/simple_console_log_service'
+
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+require 'stringio'
+
+class Test_SimpleConsoleLogservice < Test::Unit::TestCase
+
+	include ::Pantheios::Services
+
+	def test_SimpleConsoleLogService_type_exists
+
+		assert defined? SimpleConsoleLogService
+	end
+
+	if  defined?(SimpleConsoleLogService)
+
+		def test_SimpleConsoleLogService_type_is_a_class
+
+			assert_kind_of(::Class, SimpleConsoleLogService)
+		end
+
+		def test_SimpleConsoleLogService_type_has_expected_instance_methods
+
+			assert_type_has_instance_methods SimpleConsoleLogService, [ :severity_logged?, :log ]
+		end
+
+		def test_severity_logged_false_with_large_range_of_integers
+
+			svc = SimpleConsoleLogService.new
+
+			(-10000 .. 10000).each do |sev|
+
+				assert_true(svc.severity_logged?(sev), "severity '#{sev}' (#{sev.class}) was not logged")
+			end
+		end
+
+		def test_severity_logged_false_with_stock_severity_levels
+
+			svc = SimpleConsoleLogService.new
+
+			::Pantheios::ApplicationLayer::StockSeverityLevels::STOCK_SEVERITY_LEVELS.each do |sev|
+
+				assert_true(svc.severity_logged?(sev), "severity '#{sev}' (#{sev.class}) was not logged")
+			end
+		end
+
+		def test_log_does_nothing_to_standard_streams
+
+			prev_stdout, prev_stderr = $stdout, $stderr
+
+			begin
+
+				$stdout	=	StringIO.new
+				$stderr	=	StringIO.new
+
+				svc		=	SimpleConsoleLogService.new
+				t		=	Time.now
+
+				(-1000..1000).each do |sev|
+
+					svc.log sev, t, 'some-prefix', 'some-message'
+				end
+
+				stdout_s	=	$stdout.string
+				stderr_s	=	$stderr.string
+
+				assert_not_empty stdout_s, "NullLogService has not written to $stdout!"
+				assert_not_empty stderr_s, "NullLogService has not written to $stderr!"
+			ensure
+
+				$stdout, $stderr = prev_stdout, prev_stderr
+			end
+		end
+	end
+end
+

data/test/unit/services/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir = File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pantheios-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.1
 platform: ruby
 authors:
 - Matt Wilson
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.1
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.1
     - - <
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -44,7 +44,8 @@ files:
 - lib/pantheios/application_layer/stock_severity_levels.rb
 - lib/pantheios/core.rb
 - lib/pantheios/globals.rb
-- lib/pantheios/services/simple_console_service.rb
+- lib/pantheios/services/null_log_service.rb
+- lib/pantheios/services/simple_console_log_service.rb
 - lib/pantheios/util.rb
 - lib/pantheios/util/process_util.rb
 - lib/pantheios/util/thread_util.rb
@@ -53,6 +54,9 @@ files:
 - test/unit/application_layer/tc_param_name_list.rb
 - test/unit/application_layer/tc_stock_severity_levels.rb
 - test/unit/application_layer/ts_all.rb
+- test/unit/services/tc_null_log_service.rb
+- test/unit/services/tc_simple_console_log_service.rb
+- test/unit/services/ts_all.rb
 - test/unit/ts_all.rb
 - test/unit/util/tc_thread_util.rb
 - test/unit/util/tc_version_util.rb

data/lib/pantheios/services/simple_console_service.rb

@@ -1,20 +0,0 @@
-
-module Pantheios
-module Services
-
-class SimpleConsoleService
-
-	def severity_logged? severity
-
-		true
-	end
-
-	def log sev, t, pref, msg
-
-		$stderr.puts "#{pref}#{msg}"
-	end
-end
-
-end # module Services
-end # module Pantheios
-