xqsr3 0.39.1 → 0.39.2.1

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

@@ -5,7 +5,7 @@
 # Purpose:  Adds a Integer 'overload' to the Kernel module
 #
 # Created:  21st November 2017
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -47,8 +47,6 @@
 
 require 'xqsr3/conversion/integer_parser'
 
-# ##########################################################
-# ::Kernel
 
 =begin
 =end
@@ -62,14 +60,14 @@ module Kernel
   # === 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
+  #   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+);
+  #   - +base+ A value of 0, or between 2 and 36. Defaults to 0;
+  #   - +options+ (+Hash+) Options that control the behaviour of the method;
+  #   - +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
+  #   - +: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

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

@@ -5,7 +5,7 @@
 # Purpose:  Adds a raise_with_options() method to the Kernel module
 #
 # Created:  12th February 2015
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -47,8 +47,6 @@
 
 require 'xqsr3/diagnostics/exception_utilities'
 
-# ##########################################################
-# ::Kernel
 
 =begin
 =end

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/string_utilities/ends_with'
 
+
 class String
 
   include ::Xqsr3::StringUtilities::EndsWith

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/command_line_utilities/map_option_string'
 
+
 class String
 
   include ::Xqsr3::CommandLineUtilities::MapOptionString

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/string_utilities/nil_if_empty'
 
+
 class String
 
   include ::Xqsr3::StringUtilities::NilIfEmpty

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/string_utilities/nil_if_whitespace'
 
+
 class String
 
   include ::Xqsr3::StringUtilities::NilIfWhitespace

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

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

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/string_utilities/starts_with'
 
+
 class String
 
   include ::Xqsr3::StringUtilities::StartsWith

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/conversion/bool_parser'
 
+
 class String
 
   # Attempts to convert instance to a Boolean value, based on the given

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/string_utilities/to_symbol'
 
+
 class String
 
   include ::Xqsr3::StringUtilities::ToSymbol

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

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

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

@@ -1,20 +1,22 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_eql
+    unless self.method_defined? :assert_eql
 
-    # 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 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
+        assert expected.eql?(actual), failure_message
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,19 +1,21 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_false
+    unless self.method_defined? :assert_false
 
-    # Assert that +expression+ is +false+ (and not merely _falsey_)
-    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
+        assert ::FalseClass === (expression), failure_message
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,19 +1,21 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_not
+    unless self.method_defined? :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
+        assert !(expression), failure_message
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,20 +1,22 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_not_eql
+    unless self.method_defined? :assert_not_eql
 
-    # 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 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
+        assert !(expected.eql?(actual)), failure_message
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,6 +1,7 @@
 
 require 'xqsr3/internal_/test_unit_version_'
 
+
 # :stopdoc:
 
 module Xqsr3
@@ -23,93 +24,95 @@ end # module Xqsr3
 
 # :startdoc:
 
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  undef :assert_raise_with_message if respond_to? :assert_raise_with_message
+    undef :assert_raise_with_message if self.method_defined? :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;
+    #   - +options+ (+Hash+) Options that control the behaviour of the method;
+    #
+    # * *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, **options, &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})"
+              warn "\nunsupported message_spec entry '#{m}' (#{m.class})"
+            end
           end
         end
-      end
 
-      assert true
+        assert true
+      end
     end
-  end
-end # class Assertions
+  end # module Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,21 +1,23 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_subclass_of
+    unless self.method_defined? :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)
+        assert(tested_class < parent_class, failure_message)
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,21 +1,23 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_superclass_of
+    unless self.method_defined? :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)
+        assert(child_class < tested_class, failure_message)
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,19 +1,21 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_true
+    unless self.method_defined? :assert_true
 
-    # Assert that +expression+ is +true+ (and not merely _truey_)
-    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
+        assert ::TrueClass === (expression), failure_message
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test
 

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

@@ -1,63 +1,65 @@
 
+require 'test/unit/assertions'
+
+
 module Test
 module Unit
 
-module Assertions
+  module Assertions
 
-  unless respond_to? :assert_type_has_instance_methods
+    unless self.method_defined? :assert_type_has_instance_methods
 
-    # Fails unless the given +type+ responds to all of the messages
-    # given by +message_spec+
-    #
-    # === Signature
-    #
-    # * *Parameters:*
-    #   - +type+ (::Class) The type
-    #   - +message_spec+ (::Symbol, ::Array, ::Hash) A specification of message(s) received by the instances of +type+. If a ::Symbol, then instances must respond to this single message.  If an ::Array (all elements of which must be ::Symbol), then instances must respond to _all_ messages. If a ::Hash, then instances must respond to _all_ messages represented by the keys; the values are available for specifying a custom failure message (or value is +nil+ for stock message)
-    #  - +failure_message+ (::String) If specified, is used when instances of +type+ do not respond to a message and no custom failure message is provided for it
-    def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
+      # Fails unless the given +type+ responds to all of the messages
+      # given by +message_spec+
+      #
+      # === Signature
+      #
+      # * *Parameters:*
+      #   - +type+ (+Class+) The type;
+      #   - +message_spec+ (+Symbol+, +Array+, +Hash+) A specification of message(s) received by the instances of +type+. If a +Symbol+, then instances must respond to this single message.  If an ::Array (all elements of which must be +Symbol+), then instances must respond to _all_ messages. If a ::Hash, then instances must respond to _all_ messages represented by the keys; the values are available for specifying a custom failure message (or value is +nil+ for stock message);
+      #   - +failure_message+ (+String+) If specified, is used when instances of +type+ do not respond to a message and no custom failure message is provided for it;
+      def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
 
-      warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)
+        warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)
 
-      case message_spec
-      when ::Hash
+        case message_spec
+        when ::Hash
 
-        warn "every key in a Hash message_spec should be of type Symbol" unless message_spec.keys.all? { |k| ::Symbol === k }
-      when ::Array
+          warn "every key in a Hash message_spec should be of type Symbol" unless message_spec.keys.all? { |k| ::Symbol === k }
+        when ::Array
 
-        warn "every key in an Array message_spec should be of type Symbol" unless message_spec.all? { |k| ::Symbol === k }
+          warn "every key in an Array message_spec should be of type Symbol" unless message_spec.all? { |k| ::Symbol === k }
 
-        message_spec = Hash[message_spec.map { |s| [ s, nil ] }]
-      when ::Symbol
+          message_spec = Hash[message_spec.map { |s| [ s, nil ] }]
+        when ::Symbol
 
-        message_spec[message_spec] = nil
-      else
+          message_spec[message_spec] = nil
+        else
 
-        msg = "message_spec - '#{message_spec} (#{message_spec.class})' - should be a Symbol, an Array of Symbols, or a Hash of Symbol => message"
+          msg = "message_spec - '#{message_spec} (#{message_spec.class})' - should be a Symbol, an Array of Symbols, or a Hash of Symbol => message"
 
-        warn msg
+          warn msg
 
-        return assert false, msg
-      end
+          return assert false, msg
+        end
 
-      ims = type.instance_methods
+        ims = type.instance_methods
 
-      message_spec.each do |sym, message|
+        message_spec.each do |sym, message|
 
-        unless ims.include? sym
+          unless ims.include? sym
 
-          message ||= failure_message
-          message ||= "type #{type} does not contain the instance method #{sym}"
+            message ||= failure_message
+            message ||= "type #{type} does not contain the instance method #{sym}"
 
-          return assert false, message
+            return assert false, message
+          end
         end
-      end
 
-      assert true
+        assert true
+      end
     end
-  end
-
-end # class Assertions
+  end # class Assertions
 end # module Unit
 end # module Test