xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/extensions/kernel/integer.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/extensions/kernel/integer.rb
+# File:     lib/xqsr3/extensions/kernel/integer.rb
 #
-# Purpose:      Adds a Integer 'overload' to the Kernel module
+# Purpose:  Adds a Integer 'overload' to the Kernel module
 #
-# Created:      21st November 2017
-# Updated:      12th April 2019
+# Created:  21st November 2017
+# Updated:  29th March 2024
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2017-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.
 #
@@ -54,29 +55,28 @@ require 'xqsr3/conversion/integer_parser'
 
 module Kernel
 
-	alias xqsr3_Integer_original_method Integer
+  alias xqsr3_Integer_original_method Integer
 
-	# A monkey-patch extension of +Kernel#Integer+ with +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+)
-	#   - +base+ A value of 0, or between 2 and 36. Defaults to 0
-	#   - +options+ An options hash, containing any of the following options
-	#   - +block+ An optional caller-supplied block that will be invoked with the +ArgumentError+ exception, allowing the caller to take additional action. If the block returns then its return value will be returned to the caller
-	#
-	# * *Options:*
-	#   - +:default+ A default value to be used when +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+
-	#   - +:nil+ Returns +nil+ if +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+. Ignored if +:default+ is specified
-	def Integer(arg, base = 0, **options, &block)
+  # A monkey-patch extension of +Kernel#Integer+ with +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+)
+  #   - +base+ A value of 0, or between 2 and 36. Defaults to 0
+  #   - +options+ An options hash, containing any of the following options
+  #   - +block+ An optional caller-supplied block that will be invoked with the +ArgumentError+ exception, allowing the caller to take additional action. If the block returns then its return value will be returned to the caller
+  #
+  # * *Options:*
+  #   - +:default+ A default value to be used when +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+
+  #   - +:nil+ Returns +nil+ if +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+. Ignored if +:default+ is specified
+  def Integer(arg, base = 0, **options, &block)
 
-		::Xqsr3::Conversion::IntegerParser.to_integer arg, base = 0, **options, &block
-	end
+    ::Xqsr3::Conversion::IntegerParser.to_integer arg, base = 0, **options, &block
+  end
 
-	private :xqsr3_Integer_original_method
+  private :xqsr3_Integer_original_method
 end # module Kernel
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/extensions/kernel/raise_with_options.rb

@@ -1,17 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/extensions/kernel/raise_with_options.rb
+# File:     lib/xqsr3/extensions/kernel/raise_with_options.rb
 #
-# Purpose:      Adds a raise_with_options() method to the Kernel module
+# Purpose:  Adds a raise_with_options() method to the Kernel module
 #
-# Created:      12th February 2015
-# Updated:      22nd June 2017
+# Created:  12th February 2015
+# Updated:  29th March 2024
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
-# Copyright (c) 2015-2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -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.
 #
@@ -54,14 +55,14 @@ require 'xqsr3/diagnostics/exception_utilities'
 
 module Kernel
 
-	# Extends +Kernel+ module with the ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
-	# method
-	def raise_with_options *args, **options
+  # Extends +Kernel+ module with the ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
+  # method
+  def raise_with_options *args, **options
 
-		options	||=	{}
+    options ||= {}
 
-		::Xqsr3::Diagnostics::ExceptionUtilities.raise_with_options(*args, **(options.merge({ :called_indirectly_06d353cb_5a6c_47ca_8dbe_ff76359c7e96 => 1})))
-	end
+    ::Xqsr3::Diagnostics::ExceptionUtilities.raise_with_options(*args, **(options.merge({ :called_indirectly_06d353cb_5a6c_47ca_8dbe_ff76359c7e96 => 1})))
+  end
 end # module Kernel
 
 # ############################## end of file ############################# #

data/lib/xqsr3/extensions/kernel.rb

@@ -1,3 +1,4 @@
 
+require 'xqsr3/extensions/kernel/integer'
 require 'xqsr3/extensions/kernel/raise_with_options'
 

data/lib/xqsr3/extensions/string/ends_with.rb

@@ -3,6 +3,6 @@ require 'xqsr3/string_utilities/ends_with'
 
 class String
 
-	include ::Xqsr3::StringUtilities::EndsWith
+  include ::Xqsr3::StringUtilities::EndsWith
 end # class String
 

data/lib/xqsr3/extensions/string/map_option_string.rb

@@ -3,15 +3,14 @@ require 'xqsr3/command_line_utilities/map_option_string'
 
 class String
 
-	include ::Xqsr3::CommandLineUtilities::MapOptionString
+  include ::Xqsr3::CommandLineUtilities::MapOptionString
 end # class String
 
 class NilClass
 
-	def map_option_string *args
+  def map_option_string *args
 
-		nil
-	end
+    nil
+  end
 end
 
-

data/lib/xqsr3/extensions/string/nil_if_empty.rb

@@ -3,6 +3,6 @@ require 'xqsr3/string_utilities/nil_if_empty'
 
 class String
 
-	include ::Xqsr3::StringUtilities::NilIfEmpty
+  include ::Xqsr3::StringUtilities::NilIfEmpty
 end # class String
 

data/lib/xqsr3/extensions/string/nil_if_whitespace.rb

@@ -3,6 +3,6 @@ require 'xqsr3/string_utilities/nil_if_whitespace'
 
 class String
 
-	include ::Xqsr3::StringUtilities::NilIfWhitespace
+  include ::Xqsr3::StringUtilities::NilIfWhitespace
 end # class String
 

data/lib/xqsr3/extensions/string/quote_if.rb

@@ -3,7 +3,6 @@ require 'xqsr3/string_utilities/quote_if'
 
 class String
 
-	include ::Xqsr3::StringUtilities::QuoteIf
+  include ::Xqsr3::StringUtilities::QuoteIf
 end # class String
 
-

data/lib/xqsr3/extensions/string/starts_with.rb

@@ -3,6 +3,6 @@ require 'xqsr3/string_utilities/starts_with'
 
 class String
 
-	include ::Xqsr3::StringUtilities::StartsWith
+  include ::Xqsr3::StringUtilities::StartsWith
 end # class String
 

data/lib/xqsr3/extensions/string/to_bool.rb

@@ -3,14 +3,13 @@ require 'xqsr3/conversion/bool_parser'
 
 class String
 
-	# Attempts to convert instance to a Boolean value, based on the given
-	# +options+
-	#
-	# See Xqsr3::Conversion::BoolParser
-	def to_bool **options
-
-		return ::Xqsr3::Conversion::BoolParser.to_bool self, **options
-	end
+  # Attempts to convert instance to a Boolean value, based on the given
+  # +options+
+  #
+  # See Xqsr3::Conversion::BoolParser
+  def to_bool **options
+
+    return ::Xqsr3::Conversion::BoolParser.to_bool self, **options
+  end
 end # class String
 
-

data/lib/xqsr3/extensions/string/to_symbol.rb

@@ -3,6 +3,6 @@ require 'xqsr3/string_utilities/to_symbol'
 
 class String
 
-	include ::Xqsr3::StringUtilities::ToSymbol
+  include ::Xqsr3::StringUtilities::ToSymbol
 end # class String
 

data/lib/xqsr3/extensions/string/truncate.rb

@@ -3,7 +3,6 @@ require 'xqsr3/string_utilities/truncate'
 
 class String
 
-	include ::Xqsr3::StringUtilities::Truncate
+  include ::Xqsr3::StringUtilities::Truncate
 end # class String
 
-

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

@@ -4,17 +4,17 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_eql
+  unless respond_to? :assert_eql
 
-		# Assert that +expected+ and +actual+ have the same hash key
-		def assert_eql(expected, actual, failure_message = '')
+    # Assert that +expected+ and +actual+ have the same hash key, as
+    # evaluated by the instance method +eq?+
+    def assert_eql(expected, actual, failure_message = '')
 
-			assert expected.eql?(actual), failure_message
-		end
-	end
+      assert expected.eql?(actual), failure_message
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-

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

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

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

@@ -4,17 +4,16 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_not
+  unless respond_to? :assert_not
 
-		# Assert that +expression+ is _falsey_
-		def assert_not(expression, failure_message = '')
+    # Assert that +expression+ is _falsey_
+    def assert_not(expression, failure_message = '')
 
-			assert !(expression), failure_message
-		end
-	end
+      assert !(expression), failure_message
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-

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

@@ -4,17 +4,17 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_not_eql
+  unless respond_to? :assert_not_eql
 
-		# Assert that +expected+ and +actual+ have different hash keys
-		def assert_not_eql(expected, actual, failure_message = '')
+    # 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
-		end
-	end
+      assert !(expected.eql?(actual)), failure_message
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-

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

@@ -9,13 +9,13 @@ module Internal_ # :nodoc: all
 # @!visibility private
 module X_assert_raise_with_message_ # :nodoc: all
 
-	if TestUnitVersion_.is_at_least? [ 3, 0, 8 ]
+  if TestUnitVersion_.is_at_least? [ 3, 0, 8 ]
 
-		AssertionFailedError_	=	Test::Unit::AssertionFailedError # :nodoc:
-	else
+    AssertionFailedError_ = Test::Unit::AssertionFailedError # :nodoc:
+  else
 
-		class AssertionFailedError_	< ArgumentError; end # :nodoc:
-	end
+    class AssertionFailedError_ < ArgumentError; end # :nodoc:
+  end
 
 end # module X_assert_raise_with_message_
 end # module Internal_
@@ -28,91 +28,90 @@ module Unit
 
 module Assertions
 
-	undef :assert_raise_with_message if respond_to? :assert_raise_with_message
+  undef :assert_raise_with_message if respond_to? :assert_raise_with_message
 
-	# Asserts that the attached block raises an exception of one of the
-	# exceptions defined by +type_spec+ and/or has a message matching
-	# +message_spec+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +type_spec+ (String, Regexp, [String], [Regexp], nil) Specification of type expectation(s)
-	#   - +message_spec+ (String, Regexp, [String], [Regexp], nil) Specification of message expectation(s)
-	#   - +failure_message+ (String, nil) Optional message to be used if the matching fails
-	#
-	# * *Block*
-	# A required block containing code that is expected to raise an exception
-	def assert_raise_with_message(type_spec, message_spec, failure_message = nil, &block)
+  # Asserts that the attached block raises an exception of one of the
+  # exceptions defined by +type_spec+ and/or has a message matching
+  # +message_spec+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +type_spec+ (String, Regexp, [String], [Regexp], nil) Specification of type expectation(s)
+  #   - +message_spec+ (String, Regexp, [String], [Regexp], nil) Specification of message expectation(s)
+  #   - +failure_message+ (String, nil) Optional message to be used if the matching fails
+  #
+  # * *Block*
+  # A required block containing code that is expected to raise an exception
+  def assert_raise_with_message(type_spec, message_spec, failure_message = nil, &block)
 
-		unless block_given?
+    unless block_given?
 
-			msg = "WARNING: no block_given to assert_raise_with_message() called from: #{caller[0]}"
+      msg = "WARNING: no block_given to assert_raise_with_message() called from: #{caller[0]}"
 
-			warn "\n#{msg}"
+      warn "\n#{msg}"
 
-			assert false, msg
-		end
+      assert false, msg
+    end
 
-		case type_spec
-		when ::Array, nil
+    case type_spec
+    when ::Array, nil
 
-			;
-		else
+      ;
+    else
 
-			type_spec = [ type_spec ]
-		end
+      type_spec = [ type_spec ]
+    end
 
-		case message_spec
-		when ::Array, nil
+    case message_spec
+    when ::Array, nil
 
-			;
-		else
+      ;
+    else
 
-			message_spec = [ message_spec ]
-		end
+      message_spec = [ message_spec ]
+    end
 
 
-		begin
+    begin
 
-			yield
+      yield
 
-			assert false, 'the block did not throw an exception as was expected'
-		rescue ::Xqsr3::Internal_::X_assert_raise_with_message_::AssertionFailedError_
+      assert false, 'the block did not throw an exception as was expected'
+    rescue ::Xqsr3::Internal_::X_assert_raise_with_message_::AssertionFailedError_
 
-			raise
-		rescue Exception => x
+      raise
+    rescue Exception => x
 
-			if type_spec
+      if type_spec
 
-				assert false, "exception (#{x.class}) - message: '#{x.message}' - not of any of required types (#{type_spec.join(', ')}); #{x.class} given" unless type_spec.any? { |c| x.is_a? c}
-			end
+        assert false, "exception (#{x.class}) - message: '#{x.message}' - not of any of required types (#{type_spec.join(', ')}); #{x.class} given" unless type_spec.any? { |c| x.is_a? c}
+      end
 
-			if message_spec
+      if message_spec
 
-				assert false, "exception message not of any of required messages; '#{x.message}' given" unless message_spec.any? do |m|
+        assert false, "exception message not of any of required messages; '#{x.message}' given" unless message_spec.any? do |m|
 
-					case m
-					when ::Regexp
+          case m
+          when ::Regexp
 
-						x.message =~ m
-					when ::String
+            x.message =~ m
+          when ::String
 
-						x.message == m
-					else
+            x.message == m
+          else
 
-						warn "\nunsupported message_spec entry '#{m}' (#{m.class})"
-					end
-				end
-			end
+            warn "\nunsupported message_spec entry '#{m}' (#{m.class})"
+          end
+        end
+      end
 
-			assert true
-		end
-	end
+      assert true
+    end
+  end
 end # class Assertions
 end # module Unit
 end # module Test
 
 # ############################## end of file ############################# #
 
-

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

@@ -4,19 +4,18 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_subclass_of
+  unless respond_to? :assert_subclass_of
 
-		# Assert that +tested_class+ is a sub-class of +parent_class+
-		def assert_subclass_of(parent_class, tested_class, failure_message = nil)
+    # Assert that +tested_class+ is a sub-class of +parent_class+
+    def assert_subclass_of(parent_class, tested_class, failure_message = nil)
 
-			failure_message ||= "#{tested_class} is not a subclass of #{parent_class}"
+      failure_message ||= "#{tested_class} is not a subclass of #{parent_class}"
 
-			assert(tested_class < parent_class, failure_message)
-		end
-	end
+      assert(tested_class < parent_class, failure_message)
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-

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

@@ -4,19 +4,18 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_superclass_of
+  unless respond_to? :assert_superclass_of
 
-		# Assert that +tested_class+ is a super-class of +child_class+
-		def assert_superclass_of(child_class, tested_class, failure_message = nil)
+    # Assert that +tested_class+ is a super-class of +child_class+
+    def assert_superclass_of(child_class, tested_class, failure_message = nil)
 
-			failure_message ||= "#{tested_class} is not a superclass of #{child_class}"
+      failure_message ||= "#{tested_class} is not a superclass of #{child_class}"
 
-			assert(child_class < tested_class, failure_message)
-		end
-	end
+      assert(child_class < tested_class, failure_message)
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-

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

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