pantheios-ruby 0.9.6

data/lib/pantheios/services/simple_console_service.rb

@@ -0,0 +1,20 @@
+
+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
+

data/lib/pantheios/util.rb

@@ -0,0 +1,5 @@
+
+require 'pantheios/util/process_util'
+require 'pantheios/util/thread_util'
+require 'pantheios/util/version_util'
+

data/lib/pantheios/util/process_util.rb

@@ -0,0 +1,22 @@
+
+module Pantheios
+module Util
+
+module ProcessUtil
+
+	def self.derive_process_name dollar0 = nil
+
+		dollar0 ||= $0
+
+		bn = File.basename dollar0
+
+		bn =~ /\.rb$/ ? $` : bn
+	end
+
+end # module ProcessUtil
+
+end # module Util
+end # module Pantheios
+
+
+

data/lib/pantheios/util/thread_util.rb

@@ -0,0 +1,83 @@
+
+module Pantheios
+module Util
+
+module ThreadUtil
+
+	# Creates (if necessary) and sets the given thread's +thread_name+
+	# attribute to the given name
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#  - +t+ [Thread, nil] The thread to be named, or +nil+ if it should
+	#    operate on the current (invoking) thread
+	#  - +name+ [String] The thread's name
+	def self.set_thread_name t, name
+
+		t ||= Thread.current
+
+		class << t; attr_accessor :thread_name; end unless t.respond_to? :thread_name
+
+		t.thread_name = name
+	end
+
+	def self.get_thread_name t
+
+		t ||= Thread.current
+
+		return t.thread_name if t.respond_to? :thread_name
+
+		t.to_s
+	end
+
+	# Inclusion module for giving the included type the +thread_name+
+	# attribute
+	#
+	# If included into a thread type, or a thread instance, then
+	module ThreadName
+
+		def self.included receiver
+
+			if receiver < ::Thread
+
+				receiver.instance_eval do
+
+					define_method(:thread_name) { @thread_name || self.to_s }
+					define_method(:thread_name=) { |name| @thread_name = name }
+				end
+			else
+
+				receiver.instance_eval do
+
+					define_method :thread_name do |name = (name_not_given_ = true)|
+
+						t = Thread.current
+
+						has_tn = t.respond_to? :thread_name
+
+						if name_not_given_
+
+							return t.thread_name if has_tn
+
+							t.to_s
+						else
+
+							class << t; attr_accessor :thread_name; end unless has_tn
+
+							t.thread_name = name
+						end
+					end
+
+					define_method(:thread_name=) { |name| thread_name name }
+				end
+			end
+		end
+	end
+
+end # module ThreadUtil
+
+end # module Util
+end # module Pantheios
+
+

data/lib/pantheios/util/version_util.rb

@@ -0,0 +1,44 @@
+
+module Pantheios
+module Util
+
+module VersionUtil
+
+	# Compares two version designators and returns a spaceship comparison
+	# result
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#  - +lhs+ [String, Array[Integer|String]] The left-hand comparand
+	#  - +rhs+ [String, Array[Integer|String]] The right-hand comparand
+	#
+	# * *Returns:*
+	#  - 0 if the two version designators represent exactly the same version
+	#  - <0 if the +lhs+ version designator represents an earlier version
+	#    than the +rhs+ version designator
+	#  - >0 if the +lhs+ version designator represents a later version
+	#    than the +rhs+ version designator
+	def self.version_compare lhs, rhs
+
+		lhs	=	lhs.split('.') if String === lhs
+		rhs	=	rhs.split('.') if String === rhs
+
+		lhs	=	lhs.map { |n| n.to_i }
+		rhs	=	rhs.map { |n| n.to_i }
+
+		if lhs.size < rhs.size
+
+			lhs += [ 0 ] * (rhs.size - lhs.size)
+		else
+
+			rhs += [ 0 ] * (lhs.size - rhs.size)
+		end
+
+		lhs <=> rhs
+	end
+end # module VersionUtil
+
+end # module Util
+end # module Pantheios
+

data/lib/pantheios/version.rb

@@ -0,0 +1,69 @@
+
+# ######################################################################## #
+# File:         lib/pantheios/version.rb
+#
+# Purpose:      Version for Pantheios.Ruby library
+#
+# Created:      2nd April 2011
+# Updated:      6th January 2018
+#
+# Home:         http://github.com/synesissoftware/Pantheios-Ruby
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2011-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
+
+	# Current version of the Pantheios.Ruby library
+	VERSION				=	'0.9.6'
+
+	private
+	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+	public
+	# Major version of the Pantheios.Ruby library
+	VERSION_MAJOR		=	VERSION_PARTS_[0] # :nodoc:
+	# Minor version of the Pantheios.Ruby library
+	VERSION_MINOR		=	VERSION_PARTS_[1] # :nodoc:
+	# Revision version of the Pantheios.Ruby library
+	VERSION_REVISION	=	VERSION_PARTS_[2] # :nodoc:
+
+end # module Pantheios
+
+# ############################## end of file ############################# #
+
+

data/test/unit/application_layer/tc_param_name_list.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/application_layer/param_name_list'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+class Test_ParamNameList_type_characteristics < Test::Unit::TestCase
+
+	include ::Pantheios::ApplicationLayer
+
+	def test_ParamNameList_type_exists
+
+		assert defined? ParamNameList
+	end
+
+	def test_ParamNames_type_exists
+
+		assert defined? ParamNames
+	end
+
+	def test_ParamNameList_type_is_a_class
+
+		assert ParamNameList.is_a? ::Class
+	end
+
+	def test_ParamNames_type_is_a_class
+
+		assert ParamNames.is_a? ::Class
+	end
+end
+

data/test/unit/application_layer/tc_stock_severity_levels.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/application_layer/stock_severity_levels'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+class Test_StockSeverityLevels < Test::Unit::TestCase
+
+	include ::Pantheios::ApplicationLayer
+
+	EXPECTED_LEVELS_PRIME = %w{
+
+		violation
+		alert
+		critical
+		failure
+		warning
+		notice
+		informational
+		debug0
+		debug1
+		debug2
+		debug3
+		debug4
+		trace
+	}.map { |s| s.to_sym }
+
+	EXPECTED_LEVELS = %w{
+
+		emergency
+		info
+		warn
+	}.map { |s| s.to_sym } + EXPECTED_LEVELS_PRIME
+
+	def test_StockSeverityLevels_type_exists
+
+		assert defined? StockSeverityLevels
+	end
+
+	def test_StockSeverityLevels_type_is_a_module
+
+		assert_kind_of(::Module, StockSeverityLevels) if defined?(StockSeverityLevels)
+	end
+
+	def test_StockSeverityLevels_has_constants
+
+		if defined? StockSeverityLevels
+
+			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVELS)
+			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_VALUES)
+			assert StockSeverityLevels.const_defined?(:STOCK_SEVERITY_LEVEL_STRINGS)
+		end
+	end
+
+	def test_StockSeverityLevels_expected_levels
+
+		EXPECTED_LEVELS.each do |sev|
+
+			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
+	end
+
+	def test_StockSeverityLevels_expected_prime_levels
+
+		EXPECTED_LEVELS_PRIME.each do |sev|
+
+			assert(StockSeverityLevels::STOCK_SEVERITY_LEVELS_PRIME.include?(sev), "did not find level #{::Symbol === sev ? ':' : ''}#{sev} in #{StockSeverityLevels}::STOCK_SEVERITY_LEVELS")
+		end
+	end
+
+	def test_StockSeverityLevels_expected_prime_levels_have_distinct_values
+
+		values = {}
+
+		EXPECTED_LEVELS_PRIME.each do |sev|
+
+			value = StockSeverityLevels::STOCK_SEVERITY_LEVEL_VALUES[sev]
+
+			assert(false, "value #{value} for severity '#{sev}' is not unique") if values.has_key?(value)
+
+			values[value] = value
+		end
+	end
+
+	def test_StockSeverityLevels_expected_prime_levels_have_distinct_strings
+
+		strings = {}
+
+		EXPECTED_LEVELS_PRIME.each do |sev|
+
+			string = StockSeverityLevels::STOCK_SEVERITY_LEVEL_STRINGS[sev]
+
+			assert(false, "string '#{string}' for severity '#{sev}' is not unique") if strings.has_key?(string)
+
+			strings[string] = string
+		end
+	end
+end
+

data/test/unit/application_layer/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 }
+

data/test/unit/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 }
+

data/test/unit/util/tc_thread_util.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../..', 'lib')
+
+require 'pantheios/util/thread_util'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+class Test_ThreadUtil_set_thread_name < Test::Unit::TestCase
+
+	TU = ::Pantheios::Util::ThreadUtil
+
+	def test_new_Thread_does_not_have_attribute
+
+		t = Thread.new {}
+
+		assert_not t.respond_to? :thread_name
+	end
+
+	def test_new_Thread_can_accept_attribute
+
+		t = Thread.new {}
+
+		assert_not t.respond_to? :thread_name
+
+		TU.set_thread_name t, ''
+
+		assert_true t.respond_to? :thread_name
+
+		assert_equal '', t.thread_name
+	end
+
+	def test_attribute_can_be_changed
+
+		t = Thread.new {}
+
+		TU.set_thread_name t, 'name-1'
+
+		assert_equal 'name-1', t.thread_name
+
+		TU.set_thread_name t, 'name-2'
+
+		assert_equal 'name-2', t.thread_name
+	end
+end
+
+class Test_parameter_checks_as_included_module < Test::Unit::TestCase
+
+	class NonThread1
+
+		include ::Pantheios::Util::ThreadUtil::ThreadName
+	end
+
+	class Thread1 < Thread
+
+		include ::Pantheios::Util::ThreadUtil::ThreadName
+
+		def initialize
+
+			super
+		end
+	end
+
+
+	def test_NonThread1_1
+
+		t = NonThread1.new
+
+		assert_equal Thread.current.to_s, t.thread_name
+	end
+
+	def test_NonThread1_2
+
+		t = NonThread1.new
+
+		t.thread_name = 'the-thread'
+
+		assert_equal 'the-thread', t.thread_name
+	end
+
+
+	def test_Thread1_1
+
+		t = Thread1.new {}
+
+		assert_equal t.to_s, t.thread_name
+	end
+
+	def test_Thread1_2
+
+		t = Thread1.new {}
+
+		t.thread_name = 'another-thread'
+
+		assert_equal 'another-thread', t.thread_name
+	end
+end
+