xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/internal_/test_unit_version_.rb

@@ -1,133 +1,176 @@
 
-# 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'
 
 begin
 
-	require 'test/unit/version'
+  require 'test/unit/version'
 
-	# :stopdoc:
-	# @!visibility private
-	module Xqsr3
-	# @!visibility private
-	module Internal_ # :nodoc:
-	# @!visibility private
-	module TestUnitVersion_ # :nodoc:
+  # :stopdoc:
+  # @!visibility private
+  module Xqsr3
+  # @!visibility private
+  module Internal_ # :nodoc:
+  # @!visibility private
+  module TestUnitVersion_ # :nodoc:
 
-		# @!visibility private
-		TEST_UNIT_VERSION_	=	Test::Unit::VERSION # :nodoc:
-	end # module TestUnitVersion_
-	end # module Internal_
-	end # module Xqsr3
+    # @!visibility private
+    TEST_UNIT_VERSION_ = Test::Unit::VERSION # :nodoc:
+  end # module TestUnitVersion_
+  end # module Internal_
+  end # module Xqsr3
 
-	# :startdoc:
-rescue LoadError
+  # :startdoc:
+  rescue LoadError
 
-	# :stopdoc:
-	# @!visibility private
-	module Xqsr3
-	# @!visibility private
-	module Internal_ # :nodoc:
-	# @!visibility private
-	module TestUnitVersion_ # :nodoc:
+  # :stopdoc:
+  # @!visibility private
+  module Xqsr3
+  # @!visibility private
+  module Internal_ # :nodoc:
+  # @!visibility private
+  module TestUnitVersion_ # :nodoc:
 
-		# @!visibility private
-		TEST_UNIT_VERSION_	=	:not_found # :nodoc:
-	end # module TestUnitVersion_
-	end # module Internal_
-	end # module Xqsr3
+    # @!visibility private
+    TEST_UNIT_VERSION_ = :not_found # :nodoc:
+  end # module TestUnitVersion_
+  end # module Internal_
+  end # module Xqsr3
 
-	# :startdoc:
-end
+  # :startdoc:
+  end
 
-# :stopdoc:
+  # :stopdoc:
 
-module Xqsr3
-module Internal_ # :nodoc:
-module TestUnitVersion_ # :nodoc:
+  module Xqsr3
+  module Internal_ # :nodoc:
+  module TestUnitVersion_ # :nodoc:
 
-	if TEST_UNIT_VERSION_ == :not_found
+  if TEST_UNIT_VERSION_ == :not_found
 
-		TEST_UNIT_VERSION_PARTS_	=	[]
+    TEST_UNIT_VERSION_PARTS_ = []
 
-		TEST_UNIT_VERSION_MAJOR_	=	nil # :nodoc:
-		TEST_UNIT_VERSION_MINOR_	=	nil # :nodoc:
-		TEST_UNIT_VERSION_PATCH_	=	nil # :nodoc:
-	else
+    TEST_UNIT_VERSION_MAJOR_ = nil # :nodoc:
+    TEST_UNIT_VERSION_MINOR_ = nil # :nodoc:
+    TEST_UNIT_VERSION_PATCH_ = nil # :nodoc:
+  else
 
-		TEST_UNIT_VERSION_PARTS_	=	TEST_UNIT_VERSION_.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+    TEST_UNIT_VERSION_PARTS_ = TEST_UNIT_VERSION_.split(/[.]/).collect { |n| n.to_i } # :nodoc:
 
-		TEST_UNIT_VERSION_MAJOR_	=	TEST_UNIT_VERSION_PARTS_[0] # :nodoc:
-		TEST_UNIT_VERSION_MINOR_	=	TEST_UNIT_VERSION_PARTS_[1] # :nodoc:
-		TEST_UNIT_VERSION_PATCH_	=	TEST_UNIT_VERSION_PARTS_[2] # :nodoc:
-	end
+    TEST_UNIT_VERSION_MAJOR_ = TEST_UNIT_VERSION_PARTS_[0] # :nodoc:
+    TEST_UNIT_VERSION_MINOR_ = TEST_UNIT_VERSION_PARTS_[1] # :nodoc:
+    TEST_UNIT_VERSION_PATCH_ = TEST_UNIT_VERSION_PARTS_[2] # :nodoc:
+  end
 
-	# @!visibility private
-	def self.less_ a1, a2 # :nodoc:
+  # @!visibility private
+  def self.less_ a1, a2 # :nodoc:
 
-		n_common	=	a1.size < a2.size ? a1.size : a2.size
+    n_common = a1.size < a2.size ? a1.size : a2.size
 
-		(0...n_common).each do |ix|
+    (0...n_common).each do |ix|
 
-			v1	=	a1[ix]
-			v2	=	a2[ix]
+      v1 = a1[ix]
+      v2 = a2[ix]
 
-			if v1 == v2
+      if v1 == v2
 
-				next
-			end
+        next
+      end
 
-			if v1 < v2
+      if v1 < v2
 
-				return true
-			else
+        return true
+      else
 
-				return false
-			end
-		end
+        return false
+      end
+    end
 
-		if n_common != a2.size
+    if n_common != a2.size
 
-			return true
-		else
+      return true
+    else
 
-			return false
-		end
-	end
+      return false
+    end
+  end
 
-	# @!visibility private
-	def self.is_major_at_least? j # :nodoc:
+  # @!visibility private
+  def self.is_major_at_least? j # :nodoc:
 
-		return unless TEST_UNIT_VERSION_MAJOR_
+    return unless TEST_UNIT_VERSION_MAJOR_
 
-		return j >= TEST_UNIT_VERSION_MAJOR_
-	end
+    return j >= TEST_UNIT_VERSION_MAJOR_
+  end
 
-	# @!visibility private
-	def self.is_minor_at_least? n # :nodoc:
+  # @!visibility private
+  def self.is_minor_at_least? n # :nodoc:
 
-		return unless TEST_UNIT_VERSION_MINOR_
+    return unless TEST_UNIT_VERSION_MINOR_
 
-		return n >= TEST_UNIT_VERSION_MINOR_
-	end
+    return n >= TEST_UNIT_VERSION_MINOR_
+  end
 
-	# @!visibility private
-	def self.is_at_least? v # :nodoc:
+  # @!visibility private
+  def self.is_at_least? v # :nodoc:
 
-		v	=	v.split(/\./).collect { |n| n.to_i } if String === v
+    v = v.split(/\./).collect { |n| n.to_i } if String === v
 
-		return !less_(TEST_UNIT_VERSION_PARTS_, v)
-	end
+    return !less_(TEST_UNIT_VERSION_PARTS_, v)
+  end
 
-	# @!visibility private
-	def self.is_less? v # :nodoc:
+  # @!visibility private
+  def self.is_less? v # :nodoc:
 
-		v	=	v.split(/\./).collect { |n| n.to_i } if String === v
+    v = v.split(/\./).collect { |n| n.to_i } if String === v
 
-		return less_(TEST_UNIT_VERSION_PARTS_, v)
-	end
+    return less_(TEST_UNIT_VERSION_PARTS_, v)
+  end
 
 end # module TestUnitVersion_
 end # module Internal_
@@ -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:  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) 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.
 #
@@ -55,177 +56,176 @@ require 'xqsr3/quality/parameter_checking'
 module Xqsr3
 module IO
 
-	private
-	# @!visibility private
-	module WriteLine_Constants_ #:nodoc: all
+  private
+  # @!visibility private
+  module WriteLine_Constants_ #:nodoc: all
 
-		NUMBER_OF_LINES_TO_EXAMINE	=	20
-	end # module WriteLine_Constants_
+    NUMBER_OF_LINES_TO_EXAMINE = 20
+  end # module WriteLine_Constants_
 
-	private
+  private
 
-	# @!visibility private
-	def self.write_to_target_ target, contents, line_separator, column_separator, no_last_eol # :nodoc:
+  # @!visibility private
+  def self.write_to_target_ target, contents, line_separator, column_separator, no_last_eol # :nodoc:
 
 $stderr.puts "#{self.class}.write_to_target_(target(#{target.class})='#{target}', contents(#{contents.class})='#{contents}', line_separator(#{line_separator.class})='#{line_separator}', column_separator(#{column_separator.class})='#{column_separator}', no_last_eol(#{no_last_eol.class})=#{no_last_eol})" if $DEBUG
 
-		if no_last_eol
+    if no_last_eol
 
-			first = true
+      first = true
 
-			if contents.instance_of? ::Hash
+      if contents.instance_of? ::Hash
 
-				contents.each do |k, v|
+        contents.each do |k, v|
 
-					target << line_separator unless first
+          target << line_separator unless first
 
-					target << "#{k}#{column_separator}#{v}"
+          target << "#{k}#{column_separator}#{v}"
 
-					first = false
-				end
-			else
+          first = false
+        end
+      else
 
-				contents.each do |element|
+        contents.each do |element|
 
-					target << line_separator unless first
+          target << line_separator unless first
 
-					target << "#{element}"
+          target << "#{element}"
 
-					first = false
-				end
-			end
-		else
+          first = false
+        end
+      end
+    else
 
-			if contents.instance_of? ::Hash
+      if contents.instance_of? ::Hash
 
-				contents.each do |k, v|
+        contents.each do |k, v|
 
-					target << "#{k}#{column_separator}#{v}#{line_separator}"
-				end
-			else
+          target << "#{k}#{column_separator}#{v}#{line_separator}"
+        end
+      else
 
-				contents.each do |element|
+        contents.each do |element|
 
-					target << "#{element}#{line_separator}"
-				end
-			end
-		end
+          target << "#{element}#{line_separator}"
+        end
+      end
+    end
 
-		contents.size
-	end
+    contents.size
+  end
 
-	# This function checks to see if any part of the entries contains an
-	# embedded eol, in which case the empty string is returned to force no
-	# (additional) separator will be used. Otherwise, it returns "\n" to
-	# ensure that that is used.
-	#
-	# @!visibility private
-	def self.deduce_line_separator_ contents, eol_lookahead_limit # :nodoc:
+  # This function checks to see if any part of the entries contains an
+  # embedded eol, in which case the empty string is returned to force no
+  # (additional) separator will be used. Otherwise, it returns "\n" to
+  # ensure that that is used.
+  #
+  # @!visibility private
+  def self.deduce_line_separator_ contents, eol_lookahead_limit # :nodoc:
 
-		if contents.instance_of? ::Hash
+    if contents.instance_of? ::Hash
 
-			contents.each_with_index do |k, v, index|
+      contents.each_with_index do |k, v, index|
 
-				if eol_lookahead_limit && eol_lookahead_limit == index
+        if eol_lookahead_limit && eol_lookahead_limit == index
 
-					break
-				else
+          break
+        else
 
-					return '' if v.to_s.include? "\n"
-					return '' if k.to_s.include? "\n"
-				end
-			end
-		else
+          return '' if v.to_s.include? "\n"
+          return '' if k.to_s.include? "\n"
+        end
+      end
+    else
 
-			contents.each_with_index do |element, index|
+      contents.each_with_index do |element, index|
 
-				if eol_lookahead_limit && eol_lookahead_limit == index
+        if eol_lookahead_limit && eol_lookahead_limit == index
 
-					break
-				else
+          break
+        else
 
-					return '' if element.to_s.include? "\n"
-				end
-			end
-		end
+          return '' if element.to_s.include? "\n"
+        end
+      end
+    end
 
-		"\n"
-	end
+    "\n"
+  end
 
-	public
+  public
 
-	# Writes the contents to the target, subject to the options
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +target+ The target of the write, which may be a string containing the path or a stream instance that supports write
-	#   - +contents+ The contents to be write, which may be a +Hash+, or an +Array+, or a +String+ containing delimited fields
-	#   - +options+ An options hash, containing any of the following options
-	#
-	# * *Options:*
-	#   - +:column_separator+ {optional} The column separator, to be applied between each field in the case where +contents+ is a +Hash+.
-	#   - +:eol_lookahead_limit+ {optional} The number of content elements (line/pair) to inspect to determine whether element has a terminating end-of-line sequence. Defaults to 20. If 0, and +:line_separator+ is not specified, then will default to <tt>"\n"</tt>. If +nil+, then every line will be inspected.
-	#   - +:line_separator+ {optional} The line separator, to be applied to the end of line created from each entry. When not specified, it will be deduced by inspecting +contents+ (according to +eol_lookahead_limit+).
-	#   - +:no_last_eol+ {optional} If present and _truey_, causes suppression of the addition of the +:line_separator+ on the last line.
-	#
-	# === Return
-	#
-	# The number of entries in +contents+
-	def self.writelines target, contents, options = {}
+  # Writes the contents to the target, subject to the options
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +target+ The target of the write, which may be a string containing the path or a stream instance that supports write
+  #   - +contents+ The contents to be write, which may be a +Hash+, or an +Array+, or a +String+ containing delimited fields
+  #   - +options+ An options hash, containing any of the following options
+  #
+  # * *Options:*
+  #   - +:column_separator+ {optional} The column separator, to be applied between each field in the case where +contents+ is a +Hash+.
+  #   - +:eol_lookahead_limit+ {optional} The number of content elements (line/pair) to inspect to determine whether element has a terminating end-of-line sequence. Defaults to 20. If 0, and +:line_separator+ is not specified, then will default to <tt>"\n"</tt>. If +nil+, then every line will be inspected.
+  #   - +:line_separator+ {optional} The line separator, to be applied to the end of line created from each entry. When not specified, it will be deduced by inspecting +contents+ (according to +eol_lookahead_limit+).
+  #   - +:no_last_eol+ {optional} If present and _truey_, causes suppression of the addition of the +:line_separator+ on the last line.
+  #
+  # === Return
+  #
+  # The number of entries in +contents+
+  def self.writelines target, contents, options = {}
 
-		# validate parameters
+    # validate parameters
 
-		::Xqsr3::Quality::ParameterChecking.check_parameter(target, 'target', allow_nil: false) do |v|
+    ::Xqsr3::Quality::ParameterChecking.check_parameter(target, 'target', allow_nil: false) do |v|
 
-			raise TypeError, "#{self}#writeline() 'target' parameter must be a #{::String} or respond to <<" unless ::String === v || v.respond_to?(:<<)
-			true
-		end
-		::Xqsr3::Quality::ParameterChecking.check_parameter(contents, 'contents', allow_nil: false, types: [ ::String, ::Hash, ::Array ])
+      raise TypeError, "#{self}#writeline() 'target' parameter must be a #{::String} or respond to <<" unless ::String === v || v.respond_to?(:<<)
+      true
+    end
+    ::Xqsr3::Quality::ParameterChecking.check_parameter(contents, 'contents', allow_nil: false, types: [ ::String, ::Hash, ::Array ])
 
-		# process parameters
+    # process parameters
 
-		if contents.instance_of? String
+    if contents.instance_of? String
 
-			if contents.include? "\n"
+      if contents.include? "\n"
 
-				contents = contents.split(/\r?\n/, -1)
-			else
+        contents = contents.split(/\r?\n/, -1)
+      else
 
-				contents = [ contents ]
-			end
-		end
+        contents = [ contents ]
+      end
+    end
 
-		options				||=	{}
-		eol_lookahead_limit	=	options[:eol_lookahead_limit] || WriteLine_Constants_::NUMBER_OF_LINES_TO_EXAMINE
-		column_separator	=	options[:column_separator] || ''
-		no_last_eol			=	options[:no_last_eol] || false
-		line_separator		=	nil
-		line_separator		||=	options[:line_separator]
-		line_separator		||=	self.deduce_line_separator_(contents, eol_lookahead_limit) unless !eol_lookahead_limit.kind_of?(::Integer) || 0 == eol_lookahead_limit
-		line_separator		||=	"\n"
+    options             ||= {}
+    eol_lookahead_limit =   options[:eol_lookahead_limit] || WriteLine_Constants_::NUMBER_OF_LINES_TO_EXAMINE
+    column_separator    =   options[:column_separator] || ''
+    no_last_eol         =   options[:no_last_eol] || false
+    line_separator      =   nil
+    line_separator      ||= options[:line_separator]
+    line_separator      ||= self.deduce_line_separator_(contents, eol_lookahead_limit) unless !eol_lookahead_limit.kind_of?(::Integer) || 0 == eol_lookahead_limit
+    line_separator      ||= "\n"
 
-		if not contents.kind_of? ::Enumerable and not contents.instance_of? ::Hash
+    if not contents.kind_of? ::Enumerable and not contents.instance_of? ::Hash
 
-			raise ArgumentError, "writelines() must be passed a #{::String}, or a #{::Hash}, or an #{::Enumerable} (or derived)"
-		end
+      raise ArgumentError, "writelines() must be passed a #{::String}, or a #{::Hash}, or an #{::Enumerable} (or derived)"
+    end
 
-		# do the writing
+    # do the writing
 
-		if ::String === target
+    if ::String === target
 
-			File.open(target, "w") do |io|
+      File.open(target, "w") do |io|
 
-				self.write_to_target_ io, contents, line_separator, column_separator, no_last_eol
-			end
-		else
+        self.write_to_target_ io, contents, line_separator, column_separator, no_last_eol
+      end
+    else
 
-			self.write_to_target_ target, contents, line_separator, column_separator, no_last_eol
-		end
-	end # writelines
+      self.write_to_target_ target, contents, line_separator, column_separator, no_last_eol
+    end
+  end # writelines
 end # module IO
 end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-