xqsr3 0.39.1 → 0.39.2.1

data/lib/xqsr3/string_utilities/ends_with.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::EndsWith module
 #
 # Created:  13th April 2016
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,99 +45,95 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::EndsWith
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# +include+-able module that provides ::string_ends_with? and #ends_with?
-# methods
-module EndsWith
+  # +include+-able module that provides ::string_ends_with? and #ends_with?
+  # 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
+      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
+            raise TypeError, "ends_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
           end
-
-          raise TypeError, "ends_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
         end
-      end
 
-      return nil
+        return nil
+      end
     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
-
-    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
-
-    EndsWith_Helper_.string_ends_with_array_ self, args
-  end
-end # module EndsWith
+    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
+
+      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
 
+      EndsWith_Helper_.string_ends_with_array_ self, args
+    end
+  end # module EndsWith
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/string_utilities/nil_if_empty.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::NilIfEmpty module
 #
 # Created:  25th January 2018
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,53 +45,49 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::NilIfEmpty
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# +include+-able module that provides ::string_nil_if_empty and
-# #nil_if_empty methods
-module NilIfEmpty
+  # +include+-able module that provides ::string_nil_if_empty and
+  # #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
+        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
+
+      NilIfEmpty_Helper_.string_nil_if_empty_array_ s
     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
-
-    NilIfEmpty_Helper_.string_nil_if_empty_array_ s
-  end
-
-  # Returns +nil+ if the instance is empty, otherwise returning self
-  def nil_if_empty
 
-    NilIfEmpty_Helper_.string_nil_if_empty_array_ self
-  end
-end # module NilIfEmpty
+    # Returns +nil+ if the instance is empty, otherwise returning self
+    def nil_if_empty
 
+      NilIfEmpty_Helper_.string_nil_if_empty_array_ self
+    end
+  end # module NilIfEmpty
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/string_utilities/nil_if_whitespace.rb

@@ -6,7 +6,7 @@
 #           module
 #
 # Created:  25th January 2018
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -46,54 +46,50 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::NilIfWhitespace
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# +include+-able module that provides ::string_nil_if_whitespace and
-# #nil_if_whitespace methods
-module NilIfWhitespace
+  # +include+-able module that provides ::string_nil_if_whitespace and
+  # #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
+        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
+
+      NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ 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
-
-    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
 
-    NilIfWhitespace_Helper_.string_nil_if_whitespace_array_ self
-  end
-end # module NilIfWhitespace
+    # 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
+  end # module NilIfWhitespace
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/string_utilities/quote_if.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::QuoteIf module
 #
 # Created:  3rd June 2017
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,81 +45,72 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::QuoteIf
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# +include+-able module that provides ::quote_if and #quote_if methods
-module QuoteIf
+  # +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]
+        return quotes[0] + s + quotes[1]
+      end
     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
-
-    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
-
-    QuoteIf_Helper_.string_quote_if_array_ self, options
-  end
-end # module QuoteIf
+    public
+
+    # Converts a string to a quoted form if necessary
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +s+ (+String+) The string to be evaluated;
+    #   - +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
+
+    # 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
+  end # module QuoteIf
 end # module StringUtilities
 end # module Xqsr3
 

data/lib/xqsr3/string_utilities/starts_with.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::StringUtilities::StartsWith module
 #
 # Created:  13th April 2016
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,99 +45,95 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::StringUtilities::StartsWith
-
 =begin
 =end
 
 module Xqsr3
 module StringUtilities
 
-# +include+-able module that provides ::string_starts_with? and #starts_with?
-# methods
-module StartsWith
+  # +include+-able module that provides ::string_starts_with? and #starts_with?
+  # 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
+      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
+            raise TypeError, "starts_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
           end
-
-          raise TypeError, "starts_with? can be passed instances of #{::String}, or nil, or types that respond to to_str"
         end
-      end
 
-      return nil
+        return nil
+      end
     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
-
-    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
-
-    StartsWith_Helper_.string_starts_with_array_ self, args
-  end
-end # module StartsWith
+    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
+
+      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
 
+      StartsWith_Helper_.string_starts_with_array_ self, args
+    end
+  end # module StartsWith
 end # module StringUtilities
 end # module Xqsr3