xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/diagnostics/inspect_builder.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/diagnostics/inspect_builder.rb
+# File:     lib/xqsr3/diagnostics/inspect_builder.rb
 #
-# Purpose:      ::Xqsr3::Diagnostics::InspectBuilder module
+# Purpose:  ::Xqsr3::Diagnostics::InspectBuilder module
 #
-# Created:      4th September 2018
-# Updated:      12th April 2019
+# Created:  4th September 2018
+# 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) 2018-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,117 +55,117 @@ module Diagnostics
 
 module InspectBuilder
 
-	# @!visibility private
-	module InspectBuilder_Utilities # :nodoc: all
+  # @!visibility private
+  module InspectBuilder_Utilities # :nodoc: all
 
-		# @!visibility private
-		NORMALISE_FUNCTION	=	lambda { |ar| ar.map { |v| v.to_s }.map { |v| '@' == v[0] ? v : "@#{v}" } }
-	end # module InspectBuilder_Utilities
+    # @!visibility private
+    NORMALISE_FUNCTION = lambda { |ar| ar.map { |v| v.to_s }.map { |v| '@' == v[0] ? v : "@#{v}" } }
+  end # module InspectBuilder_Utilities
 
-	# Generates an inspect string for the +include+-ing class
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +o+ The target of the +inspect+ message for which a message will be built
-	#
-	# * *Options:*
-	#   - +:no_class+ (boolean) Elides the class qualification
-	#   - +:no_object_id+ (boolean) Elides the object id
-	#   - +:show_fields+ (boolean) Shows (all) object fields
-	#   - +:hidden_fields+ ([ String ]) Names of fields to be omitted (when +:show_fields+ is specified). Overridden by +:shown_fields+
-	#   - +:shown_fields+ ([ String ]) Names of fields to be shown (when +:show_fields+ is specified). Overrides +:hidden_fields+
-	#   - +:truncate_width+ (Integer) Specifies a maximum width for the values of fields
-	#   - +:deep_inspect+ (boolean) Causes fields' values to be obtained via their own +inspect+ methods
-	def self.make_inspect o, **options
+  # Generates an inspect string for the +include+-ing class
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +o+ The target of the +inspect+ message for which a message will be built
+  #
+  # * *Options:*
+  #   - +:no_class+ (boolean) Elides the class qualification
+  #   - +:no_object_id+ (boolean) Elides the object id
+  #   - +:show_fields+ (boolean) Shows (all) object fields
+  #   - +:hidden_fields+ ([ String ]) Names of fields to be omitted (when +:show_fields+ is specified). Overridden by +:shown_fields+
+  #   - +:shown_fields+ ([ String ]) Names of fields to be shown (when +:show_fields+ is specified). Overrides +:hidden_fields+
+  #   - +:truncate_width+ (Integer) Specifies a maximum width for the values of fields
+  #   - +:deep_inspect+ (boolean) Causes fields' values to be obtained via their own +inspect+ methods
+  def self.make_inspect o, **options
 
-		r	=	''
+    r = ''
 
-		unless options[:no_class]
+    unless options[:no_class]
 
-			r	+=	o.class.to_s
-		end
+      r += o.class.to_s
+    end
 
-		unless options[:no_object_id]
+    unless options[:no_object_id]
 
-			r	+=	':' unless r.empty?
-			r	+=	"0x#{o.object_id.to_s.rjust(16, '0')}"
-		end
+      r += ':' unless r.empty?
+      r += "0x#{o.object_id.to_s.rjust(16, '0')}"
+    end
 
-		if options[:show_fields]
+    if options[:show_fields]
 
-			normalise	=	InspectBuilder_Utilities::NORMALISE_FUNCTION
+      normalise = InspectBuilder_Utilities::NORMALISE_FUNCTION
 
-			hide_fields	=	normalise.call(options[:hidden_fields] || [])
-			show_fields	=	normalise.call(options[:shown_fields] || [])
-			trunc_w		=	options[:truncate_width]
-			ivars		=	normalise.call(o.instance_variables)
+      hide_fields = normalise.call(options[:hidden_fields] || [])
+      show_fields = normalise.call(options[:shown_fields] || [])
+      trunc_w = options[:truncate_width]
+      ivars = normalise.call(o.instance_variables)
 
-			unless show_fields.empty?
+      unless show_fields.empty?
 
-				ivars	=	ivars & show_fields
-			else
+        ivars = ivars & show_fields
+      else
 
-				o.class.ancestors.each do |ancestor|
+        o.class.ancestors.each do |ancestor|
 
-					ihf_constant = :INSPECT_HIDDEN_FIELDS
+          ihf_constant = :INSPECT_HIDDEN_FIELDS
 
-					if ancestor.const_defined? ihf_constant
+          if ancestor.const_defined? ihf_constant
 
-						ihfs	=	ancestor.const_get ihf_constant
+            ihfs = ancestor.const_get ihf_constant
 
-						if ::Array === ihfs && ihfs.all? { |c| ::String === c }
+            if ::Array === ihfs && ihfs.all? { |c| ::String === c }
 
-							hide_fields += normalise.call(ihfs)
-						else
+              hide_fields += normalise.call(ihfs)
+            else
 
-							warn "class/module #{ancestor}'s #{ihf_constant} should be an array of strings"
-						end
-					end
-				end
+              warn "class/module #{ancestor}'s #{ihf_constant} should be an array of strings"
+            end
+          end
+        end
 
-				ivars	=	ivars - hide_fields
-			end
+        ivars = ivars - hide_fields
+      end
 
-			els = ivars.sort.map do |iv_name|
+      els = ivars.sort.map do |iv_name|
 
-				iv_value	=	o.instance_variable_get(iv_name)
-				iv_class	=	iv_value.class
-				iv_value	=	::Xqsr3::StringUtilities::Truncate.string_truncate(iv_value.to_s, trunc_w) if trunc_w
-				if options[:deep_inspect]
+        iv_value = o.instance_variable_get(iv_name)
+        iv_class = iv_value.class
+        iv_value = ::Xqsr3::StringUtilities::Truncate.string_truncate(iv_value.to_s, trunc_w) if trunc_w
+        if options[:deep_inspect]
 
-					iv_value	=	iv_value.inspect
-				else
+          iv_value = iv_value.inspect
+        else
 
-					case iv_value
-					when ::Array
+          case iv_value
+          when ::Array
 
 
-					when ::String
+          when ::String
 
-						iv_value	=	"'#{iv_value}'"
-					end
-				end
+            iv_value = "'#{iv_value}'"
+          end
+        end
 
-				"#{iv_name}(#{iv_class})=#{iv_value}"
-			end.join('; ')
+        "#{iv_name}(#{iv_class})=#{iv_value}"
+      end.join('; ')
 
-			r	+=	': ' unless r.empty?
-			r	+=	els
-		end
+      r += ': ' unless r.empty?
+      r += els
+    end
 
-		r	=	'#<' + r + '>'
+    r = '#<' + r + '>'
 
-		r
-	end
+    r
+  end
 
-	# Creates an inspect string from self
-	#
-	# see InspectBuilder::make_inspect
-	def make_inspect **options
+  # Creates an inspect string from self
+  #
+  # see InspectBuilder::make_inspect
+  def make_inspect **options
 
-		::Xqsr3::Diagnostics::InspectBuilder.make_inspect self, **options
-	end
+    ::Xqsr3::Diagnostics::InspectBuilder.make_inspect self, **options
+  end
 
 end # module InspectBuilder
 
@@ -173,4 +174,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/diagnostics.rb

@@ -1,11 +1,11 @@
 
 %w{
 
-	exception_utilities
-	inspect_builder
+  exception_utilities
+  inspect_builder
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'diagnostics', name)
+  require File.join(File.dirname(__FILE__), 'diagnostics', name)
 end
 
 

data/lib/xqsr3/doc_.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/doc_.rb
+# File:     lib/xqsr3/doc_.rb
 #
-# Purpose:      Documentation of the ::Xqsr3 modules
+# Purpose:  Documentation of the ::Xqsr3 modules
 #
-# Created:      10th June 2016
-# Updated:      12th April 2019
+# Created:  10th June 2016
+# 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) 2016-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.
 #
@@ -58,119 +59,119 @@
 # * ::Xqsr3::StringUtilities
 module Xqsr3
 
-	# Array utilities
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::ArrayUtilities::JoinWithOr
-	module ArrayUtilities
-	end # module ArrayUtilities
-
-	# Command-line Utilities
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::CommandLineUtilities::MapOptionString
-	module CommandLineUtilities
-	end # module CommandLineUtilities
-
-	# Containers
-	#
-	module Containers
-	end # module Containers
-
-	# Conversion
-	#
-	module Conversion
-	end # module Conversion
-
-	# Diagnostic facilities
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::Diagnostics::ExceptionUtilities
-	# * ::Xqsr3::Diagnostics::InspectBuilder
-	# * ::Xqsr3::Diagnostics::Exceptions::WithCause
-	#
-	module Diagnostics
-
-		# Exception-related utilities
-		#
-		# === Components of interest
-		# * ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
-		#
-		module ExceptionUtilities
-		end # module ExceptionUtilities
-
-		# Inspect builder
-		#
-		module InspectBuilder
-		end # module InspectBuilder
-
-		# Exception-related utilities
-		#
-		# === Components of interest
-		# * ::Xqsr3::Diagnostics::Exceptions::WithCause
-		#
-		module Exceptions
-		end # module Exceptions
-	end # module Diagnostics
-
-	# Hash utilities
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::HashUtilities::DeepTransform
-	# * ::Xqsr3::HashUtilities::KeyMatching
-	module HashUtilities
-
-		# Exception-related utilities
-		#
-		# === Components of interest
-		# * ::Xqsr3::Diagnostics::HashUtilities::deep_transform
-		# * ::Xqsr3::Diagnostics::HashUtilities::deep_transform!
-		#
-		module DeepTransform
-		end # module DeepTransform
-	end # module HashUtilities
-
-	# IO
-	#
-	class IO
-	end # class IO
-
-	# Quality
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::Quality::ParameterChecking
-	module Quality
-	end # module Quality
-
-	# String utilities
-	#
-	# === Subordinate modules of interest
-	# * ::Xqsr3::StringUtilities::EndsWith
-	# * ::Xqsr3::StringUtilities::NilIfEmpty
-	# * ::Xqsr3::StringUtilities::NilIfWhitespace
-	# * ::Xqsr3::StringUtilities::QuoteIf
-	# * ::Xqsr3::StringUtilities::StartsWith
-	# * ::Xqsr3::StringUtilities::ToSymbol
-	# * ::Xqsr3::StringUtilities::Truncate
-	module StringUtilities
+  # Array utilities
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::ArrayUtilities::JoinWithOr
+  module ArrayUtilities
+  end # module ArrayUtilities
+
+  # Command-line Utilities
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::CommandLineUtilities::MapOptionString
+  module CommandLineUtilities
+  end # module CommandLineUtilities
+
+  # Containers
+  #
+  module Containers
+  end # module Containers
+
+  # Conversion
+  #
+  module Conversion
+  end # module Conversion
+
+  # Diagnostic facilities
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::Diagnostics::ExceptionUtilities
+  # * ::Xqsr3::Diagnostics::InspectBuilder
+  # * ::Xqsr3::Diagnostics::Exceptions::WithCause
+  #
+  module Diagnostics
+
+    # Exception-related utilities
+    #
+    # === Components of interest
+    # * ::Xqsr3::Diagnostics::ExceptionUtilities::raise_with_options
+    #
+    module ExceptionUtilities
+    end # module ExceptionUtilities
+
+    # Inspect builder
+    #
+    module InspectBuilder
+    end # module InspectBuilder
+
+    # Exception-related utilities
+    #
+    # === Components of interest
+    # * ::Xqsr3::Diagnostics::Exceptions::WithCause
+    #
+    module Exceptions
+    end # module Exceptions
+  end # module Diagnostics
+
+  # Hash utilities
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::HashUtilities::DeepTransform
+  # * ::Xqsr3::HashUtilities::KeyMatching
+  module HashUtilities
+
+    # Exception-related utilities
+    #
+    # === Components of interest
+    # * ::Xqsr3::Diagnostics::HashUtilities::deep_transform
+    # * ::Xqsr3::Diagnostics::HashUtilities::deep_transform!
+    #
+    module DeepTransform
+    end # module DeepTransform
+  end # module HashUtilities
+
+  # IO
+  #
+  class IO
+  end # class IO
+
+  # Quality
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::Quality::ParameterChecking
+  module Quality
+  end # module Quality
+
+  # String utilities
+  #
+  # === Subordinate modules of interest
+  # * ::Xqsr3::StringUtilities::EndsWith
+  # * ::Xqsr3::StringUtilities::NilIfEmpty
+  # * ::Xqsr3::StringUtilities::NilIfWhitespace
+  # * ::Xqsr3::StringUtilities::QuoteIf
+  # * ::Xqsr3::StringUtilities::StartsWith
+  # * ::Xqsr3::StringUtilities::ToSymbol
+  # * ::Xqsr3::StringUtilities::Truncate
+  module StringUtilities
 
 =begin
-		 module EndsWith
-		 end # module EndsWith
-		 module NilIfEmpty
-		 end # module NilIfEmpty
-		 module NilIfWhitespace
-		 end # module NilIfWhitespace
-		 module QuoteIf
-		 end # module QuoteIf
-		 module StartsWith
-		 end # module StartsWith
-		 module ToSymbol
-		 end # module ToSymbol
-		 module Truncate
-		 end # module Truncate
+     module EndsWith
+     end # module EndsWith
+     module NilIfEmpty
+     end # module NilIfEmpty
+     module NilIfWhitespace
+     end # module NilIfWhitespace
+     module QuoteIf
+     end # module QuoteIf
+     module StartsWith
+     end # module StartsWith
+     module ToSymbol
+     end # module ToSymbol
+     module Truncate
+     end # module Truncate
 =end
-	end # module StringUtilities
+  end # module StringUtilities
 end # module Xqsr3
 
 # Standard class, extended with methods:
@@ -219,27 +220,26 @@ class String; end
 # Standard module
 module Test
 
-	# Standard module
-	module Unit
-
-		# Standard module
-		#
-		# === Components of interest
-		# * ::Test::Unit::Assertions#assert_eql
-		# * ::Test::Unit::Assertions#assert_false
-		# * ::Test::Unit::Assertions#assert_not
-		# * ::Test::Unit::Assertions#assert_not_eql
-		# * ::Test::Unit::Assertions#assert_raise_with_message
-		# * ::Test::Unit::Assertions#assert_subclass_of
-		# * ::Test::Unit::Assertions#assert_superclass_of
-		# * ::Test::Unit::Assertions#assert_true
-		# * ::Test::Unit::Assertions#assert_type_has_instance_methods
-		module Assertions
-		end # module Assertions
-	end # module Unit
+  # Standard module
+  module Unit
+
+    # Standard module
+    #
+    # === Components of interest
+    # * ::Test::Unit::Assertions#assert_eql
+    # * ::Test::Unit::Assertions#assert_false
+    # * ::Test::Unit::Assertions#assert_not
+    # * ::Test::Unit::Assertions#assert_not_eql
+    # * ::Test::Unit::Assertions#assert_raise_with_message
+    # * ::Test::Unit::Assertions#assert_subclass_of
+    # * ::Test::Unit::Assertions#assert_superclass_of
+    # * ::Test::Unit::Assertions#assert_true
+    # * ::Test::Unit::Assertions#assert_type_has_instance_methods
+    module Assertions
+    end # module Assertions
+  end # module Unit
 end # module Test
 
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/extensions/array/join_with_or.rb

@@ -3,16 +3,16 @@ require 'xqsr3/array_utilities/join_with_or'
 
 class Array
 
-	# Extended method implemented by JoinWithOr
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +options+ (Hash) See Xqsr3::ArrayUtilities
-	def join_with_or **options
+  # Extended method implemented by JoinWithOr
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +options+ (Hash) See Xqsr3::ArrayUtilities
+  def join_with_or **options
 
-		return ::Xqsr3::ArrayUtilities::JoinWithOr.join_with_or self, **options
-	end
+    return ::Xqsr3::ArrayUtilities::JoinWithOr.join_with_or self, **options
+  end
 end
 
 

data/lib/xqsr3/extensions/enumerable/collect_with_index.rb

@@ -1,16 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/extensions/enumerable/collect_with_index.rb
+# File:     lib/xqsr3/extensions/enumerable/collect_with_index.rb
 #
-# Purpose:      Adds a collect_with_index() method to the Enumerable module
+# Purpose:  Adds a collect_with_index() method to the Enumerable module
 #
-# Created:      24th October 2010
-# Updated:      12th April 2019
+# Created:  24th October 2010
+# 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) 2010-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.
 #
@@ -52,20 +53,20 @@
 
 module Enumerable
 
-	# Two-parameter variant of +Enumerable+#+collect+, where the second
-	# parameter is a +base+-based index, which increments by 1 for each
-	# enumerated element.
-	def collect_with_index(base = 0)
+  # Two-parameter variant of +Enumerable+#+collect+, where the second
+  # parameter is a +base+-based index, which increments by 1 for each
+  # enumerated element.
+  def collect_with_index(base = 0)
 
-		a = []
+    a = []
 
-		self.each_with_index do |element, index|
+    self.each_with_index do |element, index|
 
-			a.push yield(element, base + index)
-		end
+      a.push yield(element, base + index)
+    end
 
-		a
-	end
+    a
+  end
 end # module Enumerable
 
 # ############################## end of file ############################# #