xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/quality.rb

@@ -1,10 +1,10 @@
 
 %w{
 
-	parameter_checking
+  parameter_checking
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'quality', name)
+  require File.join(File.dirname(__FILE__), 'quality', name)
 end
 
 

data/lib/xqsr3/string_utilities/ends_with.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/ends_with.rb
+# File:     lib/xqsr3/string_utilities/ends_with.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::EndsWith
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::EndsWith module
 #
-# Created:      13th April 2016
-# Updated:      15th April 2019
+# Created:  13th April 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.
 #
@@ -26,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,84 +58,84 @@ module StringUtilities
 # methods
 module EndsWith
 
-	private
-	# @!visibility private
-	module EndsWith_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module EndsWith_Helper_ # :nodoc: all
 
-		def self.string_ends_with_helper_ s, prefix # :nodoc:
+    def self.string_ends_with_helper_ s, prefix # :nodoc:
 
-			if prefix.nil? || prefix.empty?
+      if prefix.nil? || prefix.empty?
 
-				return ''
-			elsif prefix.size < s.size
+        return ''
+      elsif prefix.size < s.size
 
-				return prefix if s[(s.size - prefix.size) ... s.size] == prefix
-			elsif prefix.size == s.size
+        return prefix if s[(s.size - prefix.size) ... s.size] == prefix
+      elsif prefix.size == s.size
 
-				return prefix if prefix == s
-			else
+        return prefix if prefix == s
+      else
 
-				nil
-			end
+        nil
+      end
 
-			nil
-		end
+      nil
+    end
 
-		def self.string_ends_with_array_ s, args # :nodoc:
+    def self.string_ends_with_array_ s, args # :nodoc:
 
-			return '' if args.empty?
+      return '' if args.empty?
 
-			args.each do |prefix|
+      args.each do |prefix|
 
-				case	prefix
-				when	::NilClass
+        case prefix
+        when ::NilClass
 
-					return ''
-				when	::String
+          return ''
+        when ::String
 
-					r = self.string_ends_with_helper_ s, prefix
+          r = self.string_ends_with_helper_ s, prefix
 
-					return r if r
-				else
+          return r if r
+        else
 
-					if prefix.respond_to? :to_str
+          if prefix.respond_to? :to_str
 
-						return self.string_ends_with_helper_ s.prefix.to_str
-					end
+            return self.string_ends_with_helper_ s.prefix.to_str
+          end
 
-					raise TypeError, "ends_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
-				end
-			end
+          raise TypeError, "ends_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
+        end
+      end
 
-			return nil
-		end
-	end
-	public
+      return nil
+    end
+  end
+  public
 
-	# Reports on whether a string +s+ ends with a given prefix or set of
-	# prefixes (+args+)
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +s+ (String) The string to be evaluated
-	#   - +args+ 0+ arguments against which +s+ will be evaluated
-	def self.string_ends_with? s, *args
+  # Reports on whether a string +s+ ends with a given prefix or set of
+  # prefixes (+args+)
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +s+ (String) The string to be evaluated
+  #   - +args+ 0+ arguments against which +s+ will be evaluated
+  def self.string_ends_with? s, *args
 
-		EndsWith_Helper_.string_ends_with_array_ s, args
-	end
+    EndsWith_Helper_.string_ends_with_array_ s, args
+  end
 
-	# Reports on whether the instance ends with a given prefix or set of
-	# prefixes (+args+)
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +args+ 0+ arguments against which the instance will be evaluated
-	def ends_with? *args
+  # Reports on whether the instance ends with a given prefix or set of
+  # prefixes (+args+)
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +args+ 0+ arguments against which the instance will be evaluated
+  def ends_with? *args
 
-		EndsWith_Helper_.string_ends_with_array_ self, args
-	end
+    EndsWith_Helper_.string_ends_with_array_ self, args
+  end
 end # module EndsWith
 
 end # module StringUtilities

data/lib/xqsr3/string_utilities/nil_if_empty.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/nil_if_empty.rb
+# File:     lib/xqsr3/string_utilities/nil_if_empty.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfEmpty
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::NilIfEmpty module
 #
-# Created:      25th January 2018
-# Updated:      15th April 2019
+# Created:  25th January 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.
 #
@@ -26,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,38 +58,38 @@ module StringUtilities
 # #nil_if_empty methods
 module NilIfEmpty
 
-	private
-	# @!visibility private
-	module NilIfEmpty_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module NilIfEmpty_Helper_ # :nodoc: all
 
-		def self.string_nil_if_empty_array_ s # :nodoc:
+    def self.string_nil_if_empty_array_ s # :nodoc:
 
-			return s if s && !s.empty?
+      return s if s && !s.empty?
 
-			nil
-		end
-	end
-	public
+      nil
+    end
+  end
+  public
 
-	# Returns +nil+ if the given string is empty, otherwise returning the
-	# given string
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#
-	# * *Required parameters*:
-	#   - +s+ (String) The string to be evaluated
-	def self.string_nil_if_empty s
+  # Returns +nil+ if the given string is empty, otherwise returning the
+  # given string
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #
+  # * *Required parameters*:
+  #   - +s+ (String) The string to be evaluated
+  def self.string_nil_if_empty s
 
-		NilIfEmpty_Helper_.string_nil_if_empty_array_ s
-	end
+    NilIfEmpty_Helper_.string_nil_if_empty_array_ s
+  end
 
-	# Returns +nil+ if the instance is empty, otherwise returning self
-	def nil_if_empty
+  # Returns +nil+ if the instance is empty, otherwise returning self
+  def nil_if_empty
 
-		NilIfEmpty_Helper_.string_nil_if_empty_array_ self
-	end
+    NilIfEmpty_Helper_.string_nil_if_empty_array_ self
+  end
 end # module NilIfEmpty
 
 end # module StringUtilities
@@ -97,4 +97,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities/nil_if_whitespace.rb

@@ -1,17 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/nil_if_whitespace.rb
+# File:     lib/xqsr3/string_utilities/nil_if_whitespace.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::NilIfWhitespace
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::NilIfWhitespace
+#           module
 #
-# Created:      25th January 2018
-# Updated:      15th April 2019
+# Created:  25th January 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.
 #
@@ -26,7 +27,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,39 +59,39 @@ module StringUtilities
 # #nil_if_whitespace methods
 module NilIfWhitespace
 
-	private
-	# @!visibility private
-	module NilIfWhitespace_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module NilIfWhitespace_Helper_ # :nodoc: all
 
-		def self.string_nil_if_whitespace_array_ s # :nodoc:
+    def self.string_nil_if_whitespace_array_ s # :nodoc:
 
-			return nil if s.strip.empty?
+      return nil if s.strip.empty?
 
-			s
-		end
-	end
-	public
+      s
+    end
+  end
+  public
 
-	# Returns +nil+ if the given string is empty or contains only whitespace,
-	# otherwise returning the given string
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#
-	# * *Required parameters*:
-	#   - +s+ (String) The string to be evaluated
-	def self.string_nil_if_whitespace s
+  # Returns +nil+ if the given string is empty or contains only whitespace,
+  # otherwise returning the given string
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #
+  # * *Required parameters*:
+  #   - +s+ (String) The string to be evaluated
+  def self.string_nil_if_whitespace s
 
-		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ s
-	end
+    NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ s
+  end
 
-	# Returns +nil+ if the instance is empty or contains only whitespace,
-	# otherwise returning self
-	def nil_if_whitespace
+  # Returns +nil+ if the instance is empty or contains only whitespace,
+  # otherwise returning self
+  def nil_if_whitespace
 
-		NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ self
-	end
+    NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ self
+  end
 end # module NilIfWhitespace
 
 end # module StringUtilities
@@ -98,4 +99,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities/quote_if.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/quote_if.rb
+# File:     lib/xqsr3/string_utilities/quote_if.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::QuoteIf
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::QuoteIf module
 #
-# Created:      3rd June 2017
-# Updated:      15th April 2019
+# Created:  3rd June 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.
 #
@@ -26,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.
 #
@@ -57,67 +57,67 @@ module StringUtilities
 # +include+-able module that provides ::quote_if and #quote_if methods
 module QuoteIf
 
-	private
-	# @!visibility private
-	module QuoteIf_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module QuoteIf_Helper_ # :nodoc: all
 
-		def self.string_quote_if_array_ s, options # :nodoc:
+    def self.string_quote_if_array_ s, options # :nodoc:
 
-			s			=	s.to_s unless String === s
+      s = s.to_s unless String === s
 
-			quotes		=	options[:quotes] || [ '"', '"' ]
-			quotes		=	[ quotes, quotes ] if String === quotes
+      quotes = options[:quotes] || [ '"', '"' ]
+      quotes = [ quotes, quotes ] if String === quotes
 
-			quotables	=	options[:quotables] || /\s/
+      quotables = options[:quotables] || /\s/
 
-			case quotables
-			when ::String
+      case quotables
+      when ::String
 
-				return s unless s.include? quotables
-			when ::Array
+        return s unless s.include? quotables
+      when ::Array
 
-				return s unless quotables.any? { |quotable| s.include? quotable }
-			when ::Regexp
+        return s unless quotables.any? { |quotable| s.include? quotable }
+      when ::Regexp
 
-				return s unless s =~ quotables
-			else
+        return s unless s =~ quotables
+      else
 
-				raise ArgumentError, "Invalid type (#{quotables.class}) specified for quotables parameter"
-			end
+        raise ArgumentError, "Invalid type (#{quotables.class}) specified for quotables parameter"
+      end
 
-			return quotes[0] + s + quotes[1]
-		end
-	end
-	public
+      return quotes[0] + s + quotes[1]
+    end
+  end
+  public
 
-	# Converts a string to a quoted form if necessary
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#
-	# * *Required parameters*:
-	#   - +s+ (String) The string to be evaluated
-	#
-	# * *Options parameters*:
-	#   - +options+ (Hash) Options that control the behaviour of the method
-	#
-	# * *Options:*
-	#
-	#   - +:quotes+ (String, Array) A string that is used as the opening and closing quotes, or an array whose first two elements are used as the opening and closing quotes. Defaults to +'"'+
-	#   - +:quotables+ (String, Array, Regexp) A string representing the quotable character, or an array containing the quotable characters, or a regular expression that determines by match whether the string should be quoted. Defaults to the regular expression +/\s/+
-	def self.quote_if s, **options
+  # Converts a string to a quoted form if necessary
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #
+  # * *Required parameters*:
+  #   - +s+ (String) The string to be evaluated
+  #
+  # * *Options parameters*:
+  #   - +options+ (Hash) Options that control the behaviour of the method
+  #
+  # * *Options:*
+  #
+  #   - +:quotes+ (String, Array) A string that is used as the opening and closing quotes, or an array whose first two elements are used as the opening and closing quotes. Defaults to +'"'+
+  #   - +:quotables+ (String, Array, Regexp) A string representing the quotable character, or an array containing the quotable characters, or a regular expression that determines by match whether the string should be quoted. Defaults to the regular expression +/\s/+
+  def self.quote_if s, **options
 
-		QuoteIf_Helper_.string_quote_if_array_ s, options
-	end
+    QuoteIf_Helper_.string_quote_if_array_ s, options
+  end
 
-	# Converts the instance to a quoted form if necessary
-	#
-	# See Xqsr3::StringUtilities::QuoteIf::quite_if() for options
-	def quote_if **options
+  # Converts the instance to a quoted form if necessary
+  #
+  # See Xqsr3::StringUtilities::QuoteIf::quite_if() for options
+  def quote_if **options
 
-		QuoteIf_Helper_.string_quote_if_array_ self, options
-	end
+    QuoteIf_Helper_.string_quote_if_array_ self, options
+  end
 end # module QuoteIf
 
 end # module StringUtilities
@@ -125,4 +125,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-