xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/string_utilities/starts_with.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/starts_with.rb
+# File:     lib/xqsr3/string_utilities/starts_with.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::StartsWith
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::StartsWith 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 StartsWith
 
-	private
-	# @!visibility private
-	module StartsWith_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module StartsWith_Helper_ # :nodoc: all
 
-		def self.string_starts_with_helper_ s, prefix # :nodoc:
+    def self.string_starts_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[0 ... prefix.size] == prefix
-			elsif prefix.size == s.size
+        return prefix if s[0 ... prefix.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_starts_with_array_ s, args # :nodoc:
+    def self.string_starts_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_starts_with_helper_ s, prefix
+          r = self.string_starts_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_starts_with_helper_ s.prefix.to_str
-					end
+            return self.string_starts_with_helper_ s.prefix.to_str
+          end
 
-					raise TypeError, "starts_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
-				end
-			end
+          raise TypeError, "starts_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+ starts 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_starts_with? s, *args
+  # Reports on whether a string +s+ starts 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_starts_with? s, *args
 
-		StartsWith_Helper_.string_starts_with_array_ s, args
-	end
+    StartsWith_Helper_.string_starts_with_array_ s, args
+  end
 
-	# Reports on whether the instance starts with a given prefix or set of
-	# prefixes (+args+)
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +args+ 0+ arguments against which the instance will be evaluated
-	def starts_with? *args
+  # Reports on whether the instance starts with a given prefix or set of
+  # prefixes (+args+)
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +args+ 0+ arguments against which the instance will be evaluated
+  def starts_with? *args
 
-		StartsWith_Helper_.string_starts_with_array_ self, args
-	end
+    StartsWith_Helper_.string_starts_with_array_ self, args
+  end
 end # module StartsWith
 
 end # module StringUtilities

data/lib/xqsr3/string_utilities/to_symbol.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/to_symbol.rb
+# File:     lib/xqsr3/string_utilities/to_symbol.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::ToSymbol
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::ToSymbol module
 #
-# Created:      14th April 2016
-# Updated:      15th April 2019
+# Created:  14th 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,103 +58,103 @@ module StringUtilities
 #
 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"
-				end
-			end
+          raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+        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
-	public
+          '_'
+        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 hash
-	#
-	# * *Options:*
-	#   - +:reject_hyphens+ (boolean)
-	#   - +:reject_spaces+ (boolean)
-	#   - +:reject_tabs+ (boolean)
-	#   - +:reject_whitespace+ (boolean)
-	#   - +:transform_characters+ (boolean)
-	def self.string_to_symbol s, options = {}
+  # 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
+    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 = {}
+  # 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
+    ToSymbol_Helper_.string_to_symbol_with_options_ self, options
+  end
 end # module ToSymbol
 
 end # module StringUtilities

data/lib/xqsr3/string_utilities/truncate.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/string_utilities/truncate.rb
+# File:     lib/xqsr3/string_utilities/truncate.rb
 #
-# Purpose:      Definition of the ::Xqsr3::StringUtilities::Truncate
-#               module
+# Purpose:  Definition of the ::Xqsr3::StringUtilities::Truncate module
 #
-# Created:      12th April 2018
-# Updated:      15th April 2019
+# Created:  12th April 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,75 +58,75 @@ module StringUtilities
 #
 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"
-				end
-			end
+          raise TypeError, "string argument must be of type #{::String} or a type that will respond to to_str"
+        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
-			end
-		end
-	end
-	public
+        return s[0...(width - omission.size)] + omission
+      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 = {}
+  # 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
+    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 = {}
+  # 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
+    Truncate_Helper_.string_truncate_with_options_ self, width, options
+  end
 end # module Truncate
 
 end # module StringUtilities
@@ -134,4 +134,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/string_utilities.rb

@@ -1,16 +1,16 @@
 
 %w{
 
-	ends_with
-	nil_if_empty
-	nil_if_whitespace
-	quote_if
-	starts_with
-	to_symbol
-	truncate
+  ends_with
+  nil_if_empty
+  nil_if_whitespace
+  quote_if
+  starts_with
+  to_symbol
+  truncate
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'string_utilities', name)
+  require File.join(File.dirname(__FILE__), 'string_utilities', name)
 end
 
 

data/lib/xqsr3/version.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/version.rb
+# File:     lib/xqsr3/version.rb
 #
-# Purpose:      Version for Xqsr3 library
+# Purpose:  Version for Xqsr3 library
 #
-# Created:      3rd April 2016
-# Updated:      4th November 2023
+# Created:  3rd April 2016
+# Updated:  30th March 2024
 #
-# Home:         http://github.com/synesissoftware/xqsr3
+# Home:     http://github.com/synesissoftware/xqsr3
 #
-# Author:       Matthew Wilson
+# Author:   Matthew Wilson
 #
-# Copyright (c) 2019-2023, Matthew Wilson and Synesis Information Systems
+# 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.
 #
@@ -50,21 +50,20 @@
 
 module Xqsr3
 
-	# Current version of the Xqsr3 library
-	VERSION				=	'0.38.1.1'
+  # Current version of the Xqsr3 library
+  VERSION           = '0.39.1'
 
-	private
-	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
-	public
-	# Major version of the Xqsr3 library
-	VERSION_MAJOR		=	VERSION_PARTS_[0] # :nodoc:
-	# Minor version of the Xqsr3 library
-	VERSION_MINOR		=	VERSION_PARTS_[1] # :nodoc:
-	# Revision version of the Xqsr3 library
-	VERSION_REVISION	=	VERSION_PARTS_[2] # :nodoc:
+  private
+  VERSION_PARTS_    = VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:
+  public
+  # Major version of the Xqsr3 library
+  VERSION_MAJOR     = VERSION_PARTS_[0] # :nodoc:
+  # Minor version of the Xqsr3 library
+  VERSION_MINOR     = VERSION_PARTS_[1] # :nodoc:
+  # Revision version of the Xqsr3 library
+  VERSION_REVISION  = VERSION_PARTS_[2] # :nodoc:
 
 end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-