xqsr3 0.39.1 → 0.39.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14aa286501609225e115c827067c4c28e95bddbdf0627fdc12cf3d2d97bf46b5
-  data.tar.gz: 50b100e12c9e6e13408a32da41f5a24a600b776ac04351c602b2084727dc71d1
+  metadata.gz: 45e7be3a60a6d9752fee2e9923806d69cec535c99ecce3c3207497e4df761735
+  data.tar.gz: d1be5a5d287f913bd5f4396f2ecfc32b06185e7ab64f4a4748500c4f47249932
 SHA512:
-  metadata.gz: 21121329a55503ed6c7f7482adcb939ca57fb949db08542434062b656e2cbaa635eeb69efb33863576d3818e0a0cf670816fb4ed8c1d6b37e188a9ed3b60d222
-  data.tar.gz: 2f77fe88582f91560deb35660f6c0829a63fbc45c0c8051531b609dfec1c6f2abe4a875d6601851928c3cb80174073dddc0bcb9549a71a6d8f9046a95663d44d
+  metadata.gz: cdaaf454c457db16d69d8ecba4923fa16afeb2d01dfec6eab300d53d38907d21559b845e87605c901f9a76982b12567bc8ecfe765aef7d4a42c490bce0ba9cf1
+  data.tar.gz: fc31c9538d65af1747b3f8e51a8cb81a9beb45bce9a5170b71da3a603611ec99672ee5efe71b498b242738d8092f02353542ea4f98ab870f721d7616324a2668

data/examples/count_word_frequencies.rb

@@ -2,8 +2,10 @@
 
 # examples/count_word_frequencies.rb
 
+
 require 'xqsr3/containers/frequency_map'
 
+
 include Xqsr3::Containers
 
 

data/lib/xqsr3/array_utilities/join_with_or.rb

@@ -5,7 +5,7 @@
 # Purpose:  Definition of the ::Xqsr3::ArrayUtilities::JoinWithOr module
 #
 # Created:  7th December 2017
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -45,67 +45,64 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::ArrayUtilities::JoinWithOr
+require 'xqsr3/quality/parameter_checking'
+
 
 =begin
 =end
 
-require 'xqsr3/quality/parameter_checking'
-
 module Xqsr3
 module ArrayUtilities
 
-# +include+-able module that provides sequence-joining functionality
-module JoinWithOr
-
-  extend self
-
-  # Joins an array with grammatical appropriateness (with an 'or')
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #   - +ar+ (Array) The array whose contents are to be joined
-  #   - +options+ (Hash) Options that control the behaviour of the method
-  #
-  # * *Options:*
-  #   - +:or+ (String) A string that is used instead of 'or'
-  #   - +:oxford_comma+ (boolean) Determines whether an Oxford comma will be used. Default is +true+
-  #   - +:quote_char+ (String) The quote character. Default is empty string ''
-  #   - +:separator+ (String) The separator character. Default is ','
-  def join_with_or ar, **options
-
-    ::Xqsr3::Quality::ParameterChecking.check_parameter ar, 'ar', type: ::Array, allow_nil: true
-    ::Xqsr3::Quality::ParameterChecking.check_parameter options, 'options', type: ::Hash, allow_nil: false
-
-    ::Xqsr3::Quality::ParameterChecking.check_parameter options[:or], ':or', type: ::String, option: true, allow_nil: true
-    ::Xqsr3::Quality::ParameterChecking.check_parameter options[:oxford_comma], ':oxford_comma', types: [ ::FalseClass, ::TrueClass ], option: true, allow_nil: true
-    ::Xqsr3::Quality::ParameterChecking.check_parameter options[:quote_char], ':quote_char', type: ::String, option: true, allow_nil: true
-    ::Xqsr3::Quality::ParameterChecking.check_parameter options[:separator], ':separator', type: ::String, option: true, allow_nil: true
-
-    return '' if ar.nil?
-    return '' if ar.empty?
-
-    separator   = options[:separator] || ','
-    or_word     = options[:or] || 'or'
-    ox_comma    = (options.has_key?(:oxford_comma) && !options[:oxford_comma]) ? '' : separator
-    quote_char  = options[:quote_char]
-
-    ar = ar.map { |v| "#{quote_char}#{v}#{quote_char}" } if quote_char
-
-    case ar.size
-    when 1
-      ar[0]
-    when 2
-      "#{ar[0]} #{or_word} #{ar[1]}"
-    else
-      "#{ar[0...-1].join(separator + ' ')}#{ox_comma} #{or_word} #{ar[-1]}"
+  # +include+-able module that provides sequence-joining functionality
+  module JoinWithOr
+
+    extend self
+
+    # Joins an array with grammatical appropriateness (with an 'or')
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +ar+ (+Array+) The array whose contents are to be joined;
+    #   - +options+ (+Hash+) Options that control the behaviour of the method;
+    #
+    # * *Options:*
+    #   - +:or+ (+String+) A string that is used instead of 'or';
+    #   - +:oxford_comma+ (boolean) Determines whether an Oxford comma will be used. Default is +true+;
+    #   - +:quote_char+ (+String+) The quote character. Default is empty string '';
+    #   - +:separator+ (+String+) The separator character. Default is ',';
+    def join_with_or ar, **options
+
+      ::Xqsr3::Quality::ParameterChecking.check_parameter ar, 'ar', type: ::Array, allow_nil: true
+      ::Xqsr3::Quality::ParameterChecking.check_parameter options, 'options', type: ::Hash, allow_nil: false
+
+      ::Xqsr3::Quality::ParameterChecking.check_parameter options[:or], ':or', type: ::String, option: true, allow_nil: true
+      ::Xqsr3::Quality::ParameterChecking.check_parameter options[:oxford_comma], ':oxford_comma', types: [ ::FalseClass, ::TrueClass ], option: true, allow_nil: true
+      ::Xqsr3::Quality::ParameterChecking.check_parameter options[:quote_char], ':quote_char', type: ::String, option: true, allow_nil: true
+      ::Xqsr3::Quality::ParameterChecking.check_parameter options[:separator], ':separator', type: ::String, option: true, allow_nil: true
+
+      return '' if ar.nil?
+      return '' if ar.empty?
+
+      separator   = options[:separator] || ','
+      or_word     = options[:or] || 'or'
+      ox_comma    = (options.has_key?(:oxford_comma) && !options[:oxford_comma]) ? '' : separator
+      quote_char  = options[:quote_char]
+
+      ar = ar.map { |v| "#{quote_char}#{v}#{quote_char}" } if quote_char
+
+      case ar.size
+      when 1
+        ar[0]
+      when 2
+        "#{ar[0]} #{or_word} #{ar[1]}"
+      else
+        "#{ar[0...-1].join(separator + ' ')}#{ox_comma} #{or_word} #{ar[-1]}"
+      end
     end
-  end
-
-end # module JoinWithOr
 
+  end # module JoinWithOr
 end # module ArrayUtilities
 end # module Xqsr3
 

data/lib/xqsr3/command_line_utilities/map_option_string.rb

@@ -6,7 +6,7 @@
 #           module
 #
 # Created:  15th April 2016
-# Updated:  29th March 2024
+# Updated:  12th April 2024
 #
 # Home:     http://github.com/synesissoftware/xqsr3
 #
@@ -46,105 +46,102 @@
 # ######################################################################## #
 
 
-# ##########################################################
-# ::Xqsr3::CommandLineUtilities::MapOptionString
-
 require 'xqsr3/string_utilities/to_symbol'
 
+
 =begin
 =end
 
 module Xqsr3
 module CommandLineUtilities
 
-# +include+-able module providing facilities for mapping strings to options
-#
-# === Components of interest
-# * ::Xqsr3::CommandLineUtilities::MapOptionString.map_option_string_from_string
-# * ::Xqsr3::CommandLineUtilities::MapOptionString#map_option_string
-module MapOptionString
+  # +include+-able module providing facilities for mapping strings to options
+  #
+  # === Components of interest
+  # * ::Xqsr3::CommandLineUtilities::MapOptionString.map_option_string_from_string
+  # * ::Xqsr3::CommandLineUtilities::MapOptionString#map_option_string
+  module MapOptionString
+
+    def self.included includer # :nodoc:
 
-  def self.included includer # :nodoc:
+      raise TypeError, "module #{self} cannot be included into #{includer} because it does not respond to to_str" unless includer.method_defined? :to_str
+    end
 
-    raise TypeError, "module #{self} cannot be included into #{includer} because it does not respond to to_str" unless includer.method_defined? :to_str
-  end
+    private
+    # @!visibility private
+    module MapOptionString_Helper_ # :nodoc: all
 
-  private
-  # @!visibility private
-  module MapOptionString_Helper_ # :nodoc: all
+      def self.map_option_string_with_options_ s, option_strings, options
 
-    def self.map_option_string_with_options_ s, option_strings, options
+        h = {}
 
-      h = {}
+        option_strings.each do |os|
 
-      option_strings.each do |os|
+          t = os.dup
+          v = os.dup
 
-        t = os.dup
-        v = os.dup
+          if t =~ /\[.+?\]/
 
-        if t =~ /\[.+?\]/
+            k = ''
+            v = ''
 
-          k = ''
-          v = ''
+            while t =~ /\[(.+?)\]/
 
-          while t =~ /\[(.+?)\]/
+              k += $1
+              v += "#$`#$1"
+              t = $'
+            end
 
-            k += $1
-            v += "#$`#$1"
-            t = $'
-          end
+            v += t
+          else
 
-          v += t
-        else
+            k = v
+          end
 
-          k = v
+          h[k] = v
+          h[v] = v
         end
 
-        h[k] = v
-        h[v] = v
-      end
+        r = h[s]
 
-      r = h[s]
+        if r
 
-      if r
+          r = ::Xqsr3::StringUtilities::ToSymbol.string_to_symbol r
+        end
 
-        r = ::Xqsr3::StringUtilities::ToSymbol.string_to_symbol r
+        r
       end
-
-      r
     end
-  end
-  public
-
-  # Attempts to translate the value of a given string according
-  # to a collection of options strings
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #   - +s+ (::String) The string to be mapped
-  #   - +option_strings+ ([::String]) An array of strings against which the mapping will be performed
-  #   - +options+ (Hash) Options that control the behaviour of the method
-  def self.map_option_string_from_string s, option_strings, options = {}
-
-    MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
-  end
-
-  # Attempts to translate the (string) value of the receiver according
-  # to a collection of options strings
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #   - +option_strings+ ([::String]) An array of strings against which the mapping will be performed
-  def map_option_string option_strings, options = {}
+    public
+
+    # Attempts to translate the value of a given string according
+    # to a collection of options strings
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +s+ (+String+) The string to be mapped;
+    #   - +option_strings+ (+[ String ]+) An array of strings against which the mapping will be performed;
+    #   - +options+ (+Hash+) Options that control the behaviour of the method;
+    def self.map_option_string_from_string s, option_strings, options = {}
+
+      MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
+    end
 
-    s = self.kind_of?(::String) ? self : self.to_str
+    # Attempts to translate the (string) value of the receiver according
+    # to a collection of options strings
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +option_strings+ (+[ String ]+) An array of strings against which the mapping will be performed;
+    def map_option_string option_strings, options = {}
 
-    MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
-  end
-end # module MapOptionString
+      s = self.kind_of?(::String) ? self : self.to_str
 
+      MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
+    end
+  end # module MapOptionString
 end # module CommandLineUtilities
 end # module Xqsr3