xqsr3 0.38.1.1 → 0.39.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d79a8cd3b6c08ec9a3a6a651c59ffd38696ed67cddedff283c3b66ff9c1b2e8
-  data.tar.gz: a4e9ba8e5b9923122f3fe9cd583d69588b09d60b67f95cc1bb1e1a9630b537b0
+  metadata.gz: 14aa286501609225e115c827067c4c28e95bddbdf0627fdc12cf3d2d97bf46b5
+  data.tar.gz: 50b100e12c9e6e13408a32da41f5a24a600b776ac04351c602b2084727dc71d1
 SHA512:
-  metadata.gz: ed91a12776bccced75b2f278eb424e7e868370732139441e40ea6c76baa8cd61b1f00fbc49b932eb59763ebf0dbf42554748715d3a182cc9f695aca18816fa4e
-  data.tar.gz: df3c844552eadc9c66496ac21e1d979aedd3fec2dbce2fa25e6a1e631b957cf58ffd7c7c4fa072a5a102f1d58f99e4c1334fdc1c1240b2a3af0cd5e31e16efaf
+  metadata.gz: 21121329a55503ed6c7f7482adcb939ca57fb949db08542434062b656e2cbaa635eeb69efb33863576d3818e0a0cf670816fb4ed8c1d6b37e188a9ed3b60d222
+  data.tar.gz: 2f77fe88582f91560deb35660f6c0829a63fbc45c0c8051531b609dfec1c6f2abe4a875d6601851928c3cb80174073dddc0bcb9549a71a6d8f9046a95663d44d

data/README.md

@@ -1,4 +1,5 @@
-# xqsr3
+# xqsr3 <!-- omit in toc -->
+
 e**X**tensions by fine **Q**uantum for **S**tandard **R**uby and **3**rd-party libraries
 
 [![Gem Version](https://badge.fury.io/rb/xqsr3.svg)](https://badge.fury.io/rb/xqsr3)
@@ -11,12 +12,17 @@ It has **no dependencies** on any other non-standard library.
 
 It may be pronounced (lamely) as "excusers".
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-1. [Introduction](#introduction)
-2. [Installation](#installation)
-3. [Components](#components)
-4. [Project Information](#project-information)
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Components](#components)
+- [Examples](#examples)
+- [Project Information](#project-information)
+  - [Where to get help](#where-to-get-help)
+  - [Contribution guidelines](#contribution-guidelines)
+  - [Related projects](#related-projects)
+  - [License](#license)
 
 ## Installation
 
@@ -104,3 +110,6 @@ and a development dependency of:
 
 **xqsr3** is released under the 3-clause BSD license. See [LICENSE](./LICENSE) for details.
 
+
+<!-- ########################### end of file ########################### -->
+

data/examples/count_word_frequencies.md

@@ -8,7 +8,7 @@ Simple example illustrating use of ``FrequencyMap`` class.
 
 ```ruby
 
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/count_word_frequencies.rb
 
@@ -32,9 +32,9 @@ words.each { |word| fm << word }
 
 fm.each_by_frequency do |word, frequency|
 
-	next if 1 == frequency
+  next if 1 == frequency
 
-	$stdout.puts "\t#{word}\t#{frequency}"
+  $stdout.puts "\t#{word}\t#{frequency}"
 end
 puts
 
@@ -45,9 +45,9 @@ fm = FrequencyMap::ByElement[*words]
 
 fm.each_by_frequency do |word, frequency|
 
-	next if 1 == frequency
+  next if 1 == frequency
 
-	$stdout.puts "\t#{word}\t#{frequency}"
+  $stdout.puts "\t#{word}\t#{frequency}"
 end
 puts
 
@@ -67,16 +67,16 @@ When run, this produces the following output:
 Analyse DATA words via FrequencyMap
 
 1. Manually (showing items with 2+ occurrences):
-	in	3
-	dolor	2
-	dolore	2
-	ut	2
+  in  3
+  dolor 2
+  dolore  2
+  ut  2
 
 2. Via ByElement (showing items with 2+ occurrences):
-	in	3
-	dolor	2
-	dolore	2
-	ut	2
+  in  3
+  dolor 2
+  dolore  2
+  ut  2
 ```
 
 

data/examples/count_word_frequencies.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 # examples/count_word_frequencies.rb
 
@@ -23,9 +23,9 @@ words.each { |word| fm << word }
 
 fm.each_by_frequency do |word, frequency|
 
-	next if 1 == frequency
+  next if 1 == frequency
 
-	$stdout.puts "\t#{word}\t#{frequency}"
+  $stdout.puts "\t#{word}\t#{frequency}"
 end
 puts
 
@@ -36,9 +36,9 @@ fm = FrequencyMap::ByElement[*words]
 
 fm.each_by_frequency do |word, frequency|
 
-	next if 1 == frequency
+  next if 1 == frequency
 
-	$stdout.puts "\t#{word}\t#{frequency}"
+  $stdout.puts "\t#{word}\t#{frequency}"
 end
 puts
 

data/lib/xqsr3/array_utilities/join_with_or.rb

@@ -1,18 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/array_utilities/join_with_or.rb
+# File:     lib/xqsr3/array_utilities/join_with_or.rb
 #
-# Purpose:      Definition of the ::Xqsr3::ArrayUtilities::JoinWithOr
-#               module
+# Purpose:  Definition of the ::Xqsr3::ArrayUtilities::JoinWithOr module
 #
-# Created:      7th December 2017
-# Updated:      12th April 2019
+# Created:  7th December 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) 2017, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2024, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2017-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -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.
 #
@@ -59,50 +59,50 @@ 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]}"
-		end
-	end
+  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 # module JoinWithOr
 
@@ -111,4 +111,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/array_utilities.rb

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

data/lib/xqsr3/command_line_utilities/map_option_string.rb

@@ -1,18 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/command_line_utilities/map_option_string.rb
+# File:     lib/xqsr3/command_line_utilities/map_option_string.rb
 #
-# Purpose:      Definition of the
-#               ::Xqsr3::CommandLineUtilities::MapOptionString module
+# Purpose:  Definition of the ::Xqsr3::CommandLineUtilities::MapOptionString
+#           module
 #
-# Created:      15th April 2016
-# Updated:      19th July 2022
+# Created:  15th 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-2022, 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.
 #
@@ -27,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.
 #
@@ -64,85 +64,85 @@ module CommandLineUtilities
 # * ::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
+        end
 
-				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
+      end
 
-			r
-		end
-	end
-	public
+      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 = {}
+  # 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
+    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 = {}
+  # 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 = {}
 
-		s = self.kind_of?(::String) ? self : self.to_str
+    s = self.kind_of?(::String) ? self : self.to_str
 
-		MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
-	end
+    MapOptionString_Helper_.map_option_string_with_options_ s, option_strings, options
+  end
 end # module MapOptionString
 
 end # module CommandLineUtilities
@@ -150,4 +150,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/command_line_utilities.rb

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