xqsr3 0.39.1 → 0.39.2.1

data/lib/xqsr3/string_utilities/to_symbol.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::ToSymbol module
 #
 # Created:  14th April 2016
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,118 +45,114 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::ToSymbol
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# To-symbol conversion facilities
-#
-module ToSymbol
+  # To-symbol conversion facilities
+  #
+  module ToSymbol
 
-  private
-  # @!visibility private
-  module ToSymbol_Helper_ # :nodoc: all
+    private
+    # @!visibility private
+    module ToSymbol_Helper_ # :nodoc: all
 
-    module Constants # :nodoc:
+      module Constants # :nodoc:
 
-      SymbolCharacters0 = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ'
-      SymbolCharactersN = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789'
-    end
+        SymbolCharacters0 = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+        SymbolCharactersN = 'abcdefghijklmnopqrstuvwxyz_ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789'
+      end
 
-    def self.string_to_symbol_with_options_ s, options # :nodoc:
+      def self.string_to_symbol_with_options_ s, options # :nodoc:
 
-      case s
-      when ::String
-        ;
-      else
+        case s
+        when ::String
+          ;
+        else
 
-        if s.respond_to? :to_str
+          if s.respond_to? :to_str
 
-          s = s.to_str
-        else
+            s = s.to_str
+          else
 
-          raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+            raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+          end
         end
-      end
 
-      case options
-      when ::Hash
-        ;
-      else
+        case options
+        when ::Hash
+          ;
+        else
 
-        raise TypeError, "options must be of type #{::Hash}, #{options.class} given"
-      end
+          raise TypeError, "options must be of type #{::Hash}, #{options.class} given"
+        end
 
-      return nil if s.empty?
+        return nil if s.empty?
 
-      transform_characters = options[:transform_characters] || []
+        transform_characters = options[:transform_characters] || []
 
-      s.chars.map.with_index do |c, index|
+        s.chars.map.with_index do |c, index|
 
-        if 0 != index && Constants::SymbolCharactersN.include?(c)
+          if 0 != index && Constants::SymbolCharactersN.include?(c)
 
-          c
-        elsif 0 == index && Constants::SymbolCharacters0.include?(c)
+            c
+          elsif 0 == index && Constants::SymbolCharacters0.include?(c)
 
-          c
-        else
+            c
+          else
 
-          case c
-          when '-'
+            case c
+            when '-'
 
-            return nil if options[:reject_hyphens]
-          when ' '
+              return nil if options[:reject_hyphens]
+            when ' '
 
-            return nil if options[:reject_spaces] || options[:reject_whitespace]
-          when ?\t
+              return nil if options[:reject_spaces] || options[:reject_whitespace]
+            when ?\t
 
-            return nil if options[:reject_tabs] || options[:reject_whitespace]
-          else
+              return nil if options[:reject_tabs] || options[:reject_whitespace]
+            else
 
-            return nil unless transform_characters.include? c
-          end
+              return nil unless transform_characters.include? c
+            end
 
-          '_'
-        end
-      end.join('').to_sym
+            '_'
+          end
+        end.join('').to_sym
+      end
+    end
+    public
+
+    # Converts the given string +s+ to a symbol according to the given
+    # +options+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +s+ (+String+) The string to convert;
+    #   - +options+ (+Hash+) Options that control the behaviour of the method;
+    #
+    # * *Options:*
+    #   - +:reject_hyphens+ (boolean);
+    #   - +:reject_spaces+ (boolean);
+    #   - +:reject_tabs+ (boolean);
+    #   - +:reject_whitespace+ (boolean);
+    #   - +:transform_characters+ (boolean);
+    def self.string_to_symbol s, options = {}
+
+      ToSymbol_Helper_.string_to_symbol_with_options_ s, options
     end
-  end
-  public
-
-  # Converts the given string +s+ to a symbol according to the given
-  # +options+
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #   - +s+ (String) The string to convert
-  #   - +options+ (Hash) Options hash
-  #
-  # * *Options:*
-  #   - +:reject_hyphens+ (boolean)
-  #   - +:reject_spaces+ (boolean)
-  #   - +:reject_tabs+ (boolean)
-  #   - +:reject_whitespace+ (boolean)
-  #   - +:transform_characters+ (boolean)
-  def self.string_to_symbol s, options = {}
-
-    ToSymbol_Helper_.string_to_symbol_with_options_ s, options
-  end
-
-  # Converts the instance to a symbol, according to the given +options+
-  #
-  # See Xqsr3::StringUtilities::ToSymbol::string_to_symbol for options
-  def to_symbol options = {}
 
-    ToSymbol_Helper_.string_to_symbol_with_options_ self, options
-  end
-end # module ToSymbol
+    # Converts the instance to a symbol, according to the given +options+
+    #
+    # See Xqsr3::StringUtilities::ToSymbol::string_to_symbol for options
+    def to_symbol options = {}
 
+      ToSymbol_Helper_.string_to_symbol_with_options_ self, options
+    end
+  end # module ToSymbol
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/string_utilities/truncate.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::Truncate module
 #
 # Created:  12th April 2018
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,90 +45,86 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::Truncate
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# To-symbol conversion facilities
-#
-module Truncate
+  # To-symbol conversion facilities
+  #
+  module Truncate
 
-  private
-  # @!visibility private
-  module Truncate_Helper_ # :nodoc: all
+    private
+    # @!visibility private
+    module Truncate_Helper_ # :nodoc: all
 
-    def self.string_truncate_with_options_ s, width, options # :nodoc:
+      def self.string_truncate_with_options_ s, width, options # :nodoc:
 
-      case s
-      when ::String
-        ;
-      else
+        case s
+        when ::String
+          ;
+        else
 
-        if s.respond_to? :to_str
+          if s.respond_to? :to_str
 
-          s = s.to_str
-        else
+            s = s.to_str
+          else
 
-          raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+            raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+          end
         end
-      end
 
-      case options
-      when ::Hash
-        ;
-      else
+        case options
+        when ::Hash
+          ;
+        else
 
-        raise TypeError, "options must be of type #{::Hash}, #{options.class} given"
-      end
+          raise TypeError, "options must be of type #{::Hash}, #{options.class} given"
+        end
 
-      len = s.size
+        len = s.size
 
-      return s if len <= width
+        return s if len <= width
 
-      omission = options[:omission] || '...'
+        omission = options[:omission] || '...'
 
-      if width < omission.size
+        if width < omission.size
 
-        return omission[0...width]
-      else
+          return omission[0...width]
+        else
 
-        return s[0...(width - omission.size)] + omission
+          return s[0...(width - omission.size)] + omission
+        end
       end
     end
-  end
-  public
-
-  # Truncates the given string +s+ to the given +width+ according to the
-  # given +options+
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #   - +s+ (String) The string to convert
-  #   - +width+ (Integer) The truncation width
-  #   - +options+ (Hash) Options hash
-  #
-  # * *Options:*
-  #   - +:omission+ (String) Omission string. Defaults to "..."
-  def self.string_truncate s, width, options = {}
-
-    Truncate_Helper_.string_truncate_with_options_ s, width, options
-  end
-
-  # Truncates the instance, according to the given +width+ and +options+
-  #
-  # See Xqsr3::StringUtilities::ToSymbol::string_truncate for options
-  def truncate width, options = {}
+    public
+
+    # Truncates the given string +s+ to the given +width+ according to the
+    # given +options+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +s+ (+String+) The string to convert;
+    #   - +width+ (+Integer+) The truncation width;
+    #   - +options+ (+Hash+) Options that control the behaviour of the method;
+    #
+    # * *Options:*
+    #   - +:omission+ (+String+) Omission string. Defaults to "...";
+    def self.string_truncate s, width, options = {}
+
+      Truncate_Helper_.string_truncate_with_options_ s, width, options
+    end
 
-    Truncate_Helper_.string_truncate_with_options_ self, width, options
-  end
-end # module Truncate
+    # Truncates the instance, according to the given +width+ and +options+
+    #
+    # See Xqsr3::StringUtilities::ToSymbol::string_truncate for options
+    def truncate width, options = {}
 
+      Truncate_Helper_.string_truncate_with_options_ self, width, options
+    end
+  end # module Truncate
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/version.rb

@@ -5,7 +5,7 @@
 # Purpose:  Version for Xqsr3 library
 #
 # Created:  3rd April 2016
-# Updated:  30th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -51,7 +51,7 @@
 module Xqsr3
 
   # Current version of the Xqsr3 library
-  VERSION           = '0.39.1'
+  VERSION           = '0.39.2.1'
 
   private
   VERSION_PARTS_    = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/performance/frequency_map.rb

@@ -2,12 +2,15 @@
 
 $:.unshift File.join(File.dirname($0), *(['..'] * 2), 'lib')
 
+
 require 'xqsr3/containers/frequency_map'
 
 require 'benchmark'
 
+
 include ::Xqsr3::Containers
 
+
 Benchmark.bm do |bm|
 
   fm = FrequencyMap.new

data/test/scratch/test_assert_raise_with_message.rb

@@ -2,10 +2,12 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../lib')
 
+
 require 'xqsr3/extensions/test/unit/assert_raise_with_message'
 
 require 'test/unit'
 
+
 class Test_assert_raise_with_message < Test::Unit::TestCase
 
   class UnusedException < RuntimeError; end

data/test/unit/array_utilities/tc_join_with_or.rb

@@ -2,10 +2,10 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/array_utilities/join_with_or'
 
 require 'xqsr3/extensions/test/unit'
-
 require 'test/unit'
 
 
@@ -109,8 +109,10 @@ class Test_Xqsr3_ArrayUtilities_join_with_or_by_module < Test::Unit::TestCase
   end
 end
 
+
 require 'xqsr3/extensions/array/join_with_or'
 
+
 class Test_Xqsr3_ArrayUtilities_join_with_or_by_include < Test::Unit::TestCase
 
   include ::Xqsr3::ArrayUtilities::JoinWithOr

data/test/unit/command_line_utilities/tc_map_option_string.rb

@@ -2,13 +2,16 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/command_line_utilities/map_option_string'
 
 require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
+
 include ::Xqsr3::CommandLineUtilities
 
+
 class Test_Xqsr3_CommandLineUtilities_map_option_string < Test::Unit::TestCase
 
   def test_simple_uses

data/test/unit/containers/tc_frequency_map.rb

@@ -2,13 +2,16 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/containers/frequency_map'
 
 require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
+
 include ::Xqsr3::Containers
 
+
 class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 
   def test_class_operator_subscript_1
@@ -21,7 +24,7 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 
     assert_nil fm1.default
 
-    assert_match /^#<Xqsr3::Containers::FrequencyMap:0x\d+:\s*@count\(\w+\)=0; @elements\(Hash\)={}\s*>$/, fm1.inspect
+    assert_match (/^#<Xqsr3::Containers::FrequencyMap:0x\d+:\s*@count\(\w+\)=0; @elements\(Hash\)={}\s*>$/), fm1.inspect
   end
 
   def test_class_operator_subscript_2
@@ -32,7 +35,7 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
     assert_not fm2.empty?
     assert_equal 2, fm2.size
 
-    assert_match /^#<Xqsr3::Containers::FrequencyMap:0x\d+:\s*@count\(\w+\)=3; @elements\(Hash\)={.*abc.*def.*}\s*>$/, fm2.inspect
+    assert_match (/^#<Xqsr3::Containers::FrequencyMap:0x\d+:\s*@count\(\w+\)=3; @elements\(Hash\)={.*abc.*def.*}\s*>$/), fm2.inspect
   end
 
   def test_class_operator_subscript_3

data/test/unit/containers/tc_multi_map.rb

@@ -2,13 +2,16 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/containers/multi_map'
 
 require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
+
 include ::Xqsr3::Containers
 
+
 class Test_Xqsr3_Containers_MultiMap < Test::Unit::TestCase
 
   def test_class_operator_subscript_1

data/test/unit/conversion/tc_integer_parser.rb

@@ -2,12 +2,13 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/conversion/integer_parser'
 
 require 'xqsr3/extensions/test/unit'
-
 require 'test/unit'
 
+
 class Test_IntegerParser < Test::Unit::TestCase
 
   IP = ::Xqsr3::Conversion::IntegerParser
@@ -16,15 +17,15 @@ class Test_IntegerParser < Test::Unit::TestCase
 
   def test_show_base_being_ignored
 
-    assert_equal -100, IP.to_integer(-100)
-    assert_equal -100, IP.to_integer(-100, 0)
-    assert_equal -100, IP.to_integer(-100.0, 0)
-    assert_equal -100, IP.to_integer(-100.0, 10)
+    assert_equal(-100, IP.to_integer(-100))
+    assert_equal(-100, IP.to_integer(-100, 0))
+    assert_equal(-100, IP.to_integer(-100.0, 0))
+    assert_equal(-100, IP.to_integer(-100.0, 10))
 
-    assert_equal -100, IP.to_integer('-100')
-    assert_equal -100, IP.to_integer('-100', 0)
-    assert_equal -100, IP.to_integer('-100', 10)
-    assert_equal -4, IP.to_integer('-100', 2)
+    assert_equal(-100, IP.to_integer('-100'))
+    assert_equal(-100, IP.to_integer('-100', 0))
+    assert_equal(-100, IP.to_integer('-100', 10))
+    assert_equal(-4, IP.to_integer('-100', 2))
   end
 
   def test_default_for_invalid_type
@@ -34,15 +35,15 @@ class Test_IntegerParser < Test::Unit::TestCase
 
   def test_to_integer_with_valid_values
 
-    assert_equal 0, IP.to_integer(0)
-    assert_equal +1, IP.to_integer(1)
-    assert_equal +1, IP.to_integer(+1)
-    assert_equal -1, IP.to_integer(-1)
+    assert_equal(0, IP.to_integer(0))
+    assert_equal(+1, IP.to_integer(1))
+    assert_equal(+1, IP.to_integer(+1))
+    assert_equal(-1, IP.to_integer(-1))
 
-    assert_equal 0, IP.to_integer('0')
-    assert_equal +1, IP.to_integer('1')
-    assert_equal +1, IP.to_integer('+1')
-    assert_equal -1, IP.to_integer('-1')
+    assert_equal(0, IP.to_integer('0'))
+    assert_equal(+1, IP.to_integer('1'))
+    assert_equal(+1, IP.to_integer('+1'))
+    assert_equal(-1, IP.to_integer('-1'))
   end
 
   def test_to_integer_with_invalid_values

data/test/unit/conversion/tc_to_bool.rb

@@ -2,11 +2,13 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/conversion/bool_parser'
 
 require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
+
 class Test_Xqsr3_ConversionMultiMap < Test::Unit::TestCase
 
   include ::Xqsr3::Conversion

data/test/unit/diagnostics/exceptions/tc_with_cause.rb

@@ -2,10 +2,12 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../../lib')
 
+
 require 'xqsr3/diagnostics/exceptions/with_cause'
 
 require 'test/unit'
 
+
 class Test_WithCause < Test::Unit::TestCase
 
   class SomeExceptionWithCause < ::Exception
@@ -138,7 +140,7 @@ class Test_WithCause < Test::Unit::TestCase
 
     def initialize(*args, **options)
 
-      super *args, **options
+      super(*args, **options)
     end
 
     include ::Xqsr3::Diagnostics::Exceptions::WithCause
@@ -150,7 +152,7 @@ class Test_WithCause < Test::Unit::TestCase
 
     def initialize(*args, **options)
 
-      super *args, **options
+      super(*args, **options)
     end
   end
 
@@ -226,7 +228,7 @@ class Test_WithCause_throwing < Test::Unit::TestCase
 
       x_bt0 = x.backtrace[0]
 
-      assert /:in\s+\`f\'\s*$/ =~ x_bt0, 'not receieved from f()'
+      assert (/:in\s+\`f\'\s*$/ =~ x_bt0), 'not receieved from f()'
     end
   end
 
@@ -249,11 +251,11 @@ class Test_WithCause_throwing < Test::Unit::TestCase
 
       x_bt0 = x.backtrace[0]
 
-      assert /:in\s+\`rescue in g\'\s*$/ =~ x_bt0, 'not receieved from g()'
+      assert (/:in\s+\`rescue in g\'\s*$/ =~ x_bt0), 'not receieved from g()'
 
       c_bt0 = x.cause.backtrace[0]
 
-      assert /:in\s+\`f\'\s*$/ =~ c_bt0, 'not receieved from f()'
+      assert (/:in\s+\`f\'\s*$/ =~ c_bt0), 'not receieved from f()'
 
       assert_not_empty x.chained_backtrace
     end

data/test/unit/diagnostics/tc_exception_utilities.rb

@@ -2,10 +2,12 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
+
 require 'xqsr3/diagnostics/exception_utilities'
 
 require 'test/unit'
 
+
 class Test_ExceptionUtilities_raise_with_options < Test::Unit::TestCase
 
   include ::Xqsr3::Diagnostics

data/test/unit/extensions/enumerable/tc_collect_with_index.rb

@@ -2,10 +2,12 @@
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../../lib')
 
+
 require 'xqsr3/extensions/enumerable/collect_with_index'
 
 require 'test/unit'
 
+
 class Test_Enumerable_collect_with_index < Test::Unit::TestCase
 
   def test_simple