xqsr3 0.38.1 → 0.38.2

data/lib/xqsr3/extensions/test/unit/assert_false.rb

@@ -6,7 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_false
 
-		# Assert that +expression+ is +false+
+		# Assert that +expression+ is +false+ (and not merely _falsey_)
 		def assert_false(expression, failure_message = '')
 
 			assert ::FalseClass === (expression), failure_message
@@ -17,4 +17,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_not.rb

@@ -17,4 +17,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_not_eql.rb

@@ -6,7 +6,8 @@ module Assertions
 
 	unless respond_to? :assert_not_eql
 
-		# Assert that +expected+ and +actual+ have different hash keys
+		# Assert that +expected+ and +actual+ have different hash keys, as
+		# evaluated by the instance method +eq?+
 		def assert_not_eql(expected, actual, failure_message = '')
 
 			assert !(expected.eql?(actual)), failure_message
@@ -17,4 +18,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_raise_with_message.rb

@@ -115,4 +115,3 @@ end # module Test
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/extensions/test/unit/assert_subclass_of.rb

@@ -19,4 +19,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_superclass_of.rb

@@ -19,4 +19,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_true.rb

@@ -6,7 +6,7 @@ module Assertions
 
 	unless respond_to? :assert_true
 
-		# Assert that +expression+ is +true+
+		# Assert that +expression+ is +true+ (and not merely _truey_)
 		def assert_true(expression, failure_message = '')
 
 			assert ::TrueClass === (expression), failure_message
@@ -17,4 +17,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-

data/lib/xqsr3/extensions/test/unit/assert_type_has_instance_methods.rb

@@ -61,5 +61,3 @@ end # class Assertions
 end # module Unit
 end # module Test
 
-
-

data/lib/xqsr3/hash_utilities/deep_transform.rb

@@ -1,18 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/hash_utilities/deep_transform.rb
+# File:     lib/xqsr3/hash_utilities/deep_transform.rb
 #
-# Purpose:      Definition of the ::Xqsr3::HashUtilities::DeepTransform
-#               module
+# Purpose:  Definition of the Xqsr3::HashUtilities::DeepTransform module
 #
-# Created:      3rd June 2017
-# Updated:      14th March 2018
+# Created:  3rd June 2017
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
-# Copyright (c) 2017-2018, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -66,7 +66,7 @@ module DeepTransform
 		case block.arity
 		when 1
 
-			h = 
+			h =
 			Hash[h.map do |k, v|
 
 				k = k.deep_transform(&block) if ::Hash === k
@@ -76,7 +76,7 @@ module DeepTransform
 			end]
 		when 2
 
-			h = 
+			h =
 			Hash[h.map do |k, v|
 
 				k = k.deep_transform(&block) if ::Hash === k

data/lib/xqsr3/hash_utilities/key_matching.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/hash_utilities/key_matching.rb
+# File:     lib/xqsr3/hash_utilities/key_matching.rb
 #
-# Purpose:      Definition of the ::Xqsr3::HashUtilities::KeyMatching
-#               module
+# Purpose:  Definition of the Xqsr3::HashUtilities::KeyMatching module
 #
-# Created:      15th November 2017
-# Updated:      15th April 2019
+# Created:  15th November 2017
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #

data/lib/xqsr3/internal_/test_unit_version_.rb

@@ -1,6 +1,49 @@
 
-# provides reliable mechanism for checking the version of the
-# Test::Unit module
+# ######################################################################## #
+# File:     lib/xqsr3/internal_/test_unit_version_.rb
+#
+# Purpose:  Provides reliable mechanism for checking the version of the
+#           Test::Unit module
+#
+# Created:  March 2nd 2019
+# Updated:  11th December 2023
+#
+# Home:     http://github.com/synesissoftware/xqsr3
+#
+# Author:   Matthew Wilson
+#
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
+# 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 name 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.
+#
+# ######################################################################## #
+
 
 require 'test/unit'
 
@@ -137,4 +180,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/io/writelines.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/io/writelines.rb
+# File:     lib/xqsr3/io/writelines.rb
 #
-# Purpose:      Adds a writelines() method to the IO module
+# Purpose:  Adds a writelines() method to the IO module
 #
-# Created:      13th April 2007
-# Updated:      31st October 2019
+# Created:  13th April 2007
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2007-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -25,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -228,4 +229,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/quality/parameter_checking.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/quality/parameter_checking.rb
+# File:     lib/xqsr3/quality/parameter_checking.rb
 #
-# Purpose:      Definition of the ParameterChecking module
+# Purpose:  Definition of the ParameterChecking module
 #
-# Created:      12th February 2015
-# Updated:      22nd July 2022
+# Created:  12th February 2015
+# Updated:  1st January 2024
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2022, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -54,8 +54,9 @@
 module Xqsr3
 module Quality
 
-# Inclusion module that creates class and instance methods +check_parameter+
-# that may be used to check parameter values and types
+# Inclusion module that creates class and instance methods +check_option()+
+# and +check_parameter()+ that may be used to check option/parameter values
+# and types.
 #
 module ParameterChecking
 
@@ -282,7 +283,6 @@ module ParameterChecking
 		options			||=	{}
 		message			=	options[:message]
 		treat_as_option	=	options[:treat_as_option]
-		return_value	=	value
 		param_s			=	treat_as_option	? 'option' : 'parameter'
 		allow_nil		=	options[:allow_nil] || options[:nil]
 
@@ -463,6 +463,94 @@ module ParameterChecking
 			end
 		end
 
+		# run block
+
+		if value and block
+
+			warn "#{self}::check_parameter: block arity must be 1 or 2" unless (1..2).include? block.arity
+
+			r	=	nil
+
+			begin
+
+				if 1 == block.arity
+
+					r = block.call(value)
+				else
+
+					r = block.call(value, options)
+				end
+
+			rescue StandardError => x
+
+				xmsg	=	x.message || ''
+
+				if xmsg.empty?
+
+					xmsg	||=	message
+
+					if xmsg.empty?
+
+						s_name	=	name.is_a?(String) ? "'#{name}' " : ''
+						xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
+					end
+
+					raise $!, xmsg, $!.backtrace
+				end
+
+				raise
+			end
+
+			if r.is_a?(::Exception)
+
+				# An exception returned from the block, so raise it, with
+				# its message or a custom message
+
+				x		=	r
+				xmsg	=	x.message || ''
+
+				if xmsg.empty?
+
+					xmsg	||=	message
+
+					if xmsg.empty?
+
+						s_name	=	name.is_a?(String) ? "'#{name}' " : ''
+						xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
+					end
+
+					raise x, xmsg
+				end
+
+				raise x
+
+			elsif !r
+
+				failed_check	=	true
+
+				unless options[:nothrow]
+
+					s_name	=	name.is_a?(String) ? "'#{name}' " : ''
+					xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
+
+					if value.is_a?(::Numeric)
+
+						raise RangeError, xmsg
+					else
+
+						raise ArgumentError, xmsg
+					end
+				end
+
+			elsif r.is_a?(::TrueClass)
+
+				;
+			else
+
+				value	=	r
+			end
+		end
+
 		# check value(s)
 
 		unless value.nil? || !(values = options[:values])
@@ -478,13 +566,14 @@ module ParameterChecking
 				case v
 				when ::String
 
-					return :string
+					:string
 				when ::Array
 
-					return :array_of_strings if v.all? { |s| ::String === s }
-				end
+					:array_of_strings if v.all? { |s| ::String === s }
+				else
 
-				nil
+					nil
+				end
 			end : lambda { |v| nil }
 
 			value_ic	=	do_case.call(value)
@@ -590,95 +679,7 @@ module ParameterChecking
 			end
 		end
 
-		# run block
-
-		if value and block
-
-			warn "#{self}::check_parameter: block arity must be 1 or 2" unless (1..2).include? block.arity
-
-			r	=	nil
-
-			begin
-
-				if 1 == block.arity
-
-					r = block.call(value)
-				else
-
-					r = block.call(value, options)
-				end
-
-			rescue StandardError => x
-
-				xmsg	=	x.message || ''
-
-				if xmsg.empty?
-
-					xmsg	||=	message
-
-					if xmsg.empty?
-
-						s_name	=	name.is_a?(String) ? "'#{name}' " : ''
-						xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
-					end
-
-					raise $!, xmsg, $!.backtrace
-				end
-
-				raise
-			end
-
-			if r.is_a?(::Exception)
-
-				# An exception returned from the block, so raise it, with
-				# its message or a custom message
-
-				x		=	r
-				xmsg	=	x.message || ''
-
-				if xmsg.empty?
-
-					xmsg	||=	message
-
-					if xmsg.empty?
-
-						s_name	=	name.is_a?(String) ? "'#{name}' " : ''
-						xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
-					end
-
-					raise x, xmsg
-				end
-
-				raise x
-
-			elsif !r
-
-				failed_check	=	true
-
-				unless options[:nothrow]
-
-					s_name	=	name.is_a?(String) ? "'#{name}' " : ''
-					xmsg	=	"#{param_s} #{s_name}failed validation against caller-supplied block"
-
-					if value.is_a?(::Numeric)
-
-						raise RangeError, xmsg
-					else
-
-						raise ArgumentError, xmsg
-					end
-				end
-
-			elsif r.is_a?(::TrueClass)
-
-				;
-			else
-
-				return_value	=	r
-			end
-		end
-
-		failed_check ? nil : return_value
+		failed_check ? nil : value
 	end
 
 end # module ParameterChecking
@@ -688,4 +689,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities/ends_with.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/ends_with.rb
+# File:     lib/xqsr3/string_utilities/ends_with.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::EndsWith
-#               module
+# Purpose:  Definition of the Xqsr3::StringUtilities::EndsWith module
 #
-# Created:      13th April 2016
-# Updated:      15th April 2019
+# Created:  13th April 2016
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #

data/lib/xqsr3/string_utilities/nil_if_empty.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/nil_if_empty.rb
+# File:     lib/xqsr3/string_utilities/nil_if_empty.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfEmpty
-#               module
+# Purpose:  Definition of the Xqsr3::StringUtilities::NilIfEmpty module
 #
-# Created:      25th January 2018
-# Updated:      15th April 2019
+# Created:  25th January 2018
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2018-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -97,4 +97,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities/nil_if_whitespace.rb

@@ -1,17 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/nil_if_whitespace.rb
+# File:     lib/xqsr3/string_utilities/nil_if_whitespace.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfWhitespace
-#               module
+# Purpose:  Definition of the Xqsr3::StringUtilities::NilIfWhitespace
+#           module
 #
-# Created:      25th January 2018
-# Updated:      15th April 2019
+# Created:  25th January 2018
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2018-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +27,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -98,4 +99,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities/quote_if.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/quote_if.rb
+# File:     lib/xqsr3/string_utilities/quote_if.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::QuoteIf
-#               module
+# Purpose:  Definition of the Xqsr3::StringUtilities::QuoteIf module
 #
-# Created:      3rd June 2017
-# Updated:      15th April 2019
+# Created:  3rd June 2017
+# Updated:  11th December 2023
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
@@ -26,7 +26,7 @@
 #   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
+# * Neither the names of the copyright holders nor the names of its
 #   contributors may be used to endorse or promote products derived from
 #   this software without specific prior written permission.
 #
@@ -125,4 +125,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-