xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/containers.rb

@@ -1,11 +1,11 @@
 
 %w{
 
-	frequency_map
-	multi_map
+  frequency_map
+  multi_map
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'containers', name)
+  require File.join(File.dirname(__FILE__), 'containers', name)
 end
 
 

data/lib/xqsr3/conversion/bool_parser.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/conversion/bool_parser.rb
+# File:     lib/xqsr3/conversion/bool_parser.rb
 #
-# Purpose:      Definition of the ::Xqsr3::Conversion::BoolParser
-#               module
+# Purpose:  Definition of the ::Xqsr3::Conversion::BoolParser module
 #
-# Created:      3rd June 2017
-# Updated:      12th 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,54 +57,54 @@ module Conversion
 # +include-able module that provides Boolean parsing
 module BoolParser
 
-	private
-	def self.matches_to_ s, expr
-
-		case expr
-		when ::Regexp
-			return expr =~ s
-		else
-			return s == expr
-		end
-	end
-
-	public
-
-	# Recognised truey values
-	DEFAULT_TRUE_VALUES		=	[ /true/i, '1' ]
-	# Recognised falsey values
-	DEFAULT_FALSE_VALUES	=	[ /false/i, '0' ]
-
-	# Attempts to parse the given string +s+ to a Boolean value, based on the
-	# given +options+
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +s+ The string to be parsed
-	#   - +options+ An options hash, containing any of the following options
-	#
-	# * *Options:*
-	#   - +:false_values+ (::Array) An array of strings or regular expressions against which to match for false value. Defaults to +DEFAULT_FALSE_VALUES+
-	#   - +:true_values+ (::Array) An array of strings or regular expressions against which to match for true value. Defaults to +DEFAULT_TRUE_VALUES+
-	#   - +:default_value+ An object to be returned if matching fails.  Defaults to +nil+
-	#   - +:false_value+ An object to be returned if matching succeeds to match against +:false_values+. Defaults to +false+
-	#   - +:true_value+ An object to be returned if matching succeeds to match against +:true_values+. Defaults to +true+
-	def self.to_bool s, **options
-
-		true_values		=	options[:true_values] || DEFAULT_TRUE_VALUES
-		true_values		=	[ true_values ] unless true_values.is_a? ::Array
-		false_values	=	options[:false_values] || DEFAULT_FALSE_VALUES
-		false_values	=	[ false_values ] unless false_values.is_a? ::Array
-		default_value	=	options[:default] || nil
-		true_value		=	options[:true] || true
-		false_value		=	options[:false] || false
-
-		return true_value if true_values.any? { |v| self.matches_to_ s, v }
-		return false_value if false_values.any? { |v| self.matches_to_ s, v }
-
-		return default_value
-	end
+  private
+  def self.matches_to_ s, expr
+
+    case expr
+    when ::Regexp
+      return expr =~ s
+    else
+      return s == expr
+    end
+  end
+
+  public
+
+  # Recognised truey values
+  DEFAULT_TRUE_VALUES   = [ /true/i, '1' ]
+  # Recognised falsey values
+  DEFAULT_FALSE_VALUES  = [ /false/i, '0' ]
+
+  # Attempts to parse the given string +s+ to a Boolean value, based on the
+  # given +options+
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +s+ The string to be parsed
+  #   - +options+ An options hash, containing any of the following options
+  #
+  # * *Options:*
+  #   - +:false_values+ (::Array) An array of strings or regular expressions against which to match for false value. Defaults to +DEFAULT_FALSE_VALUES+
+  #   - +:true_values+ (::Array) An array of strings or regular expressions against which to match for true value. Defaults to +DEFAULT_TRUE_VALUES+
+  #   - +:default_value+ An object to be returned if matching fails.  Defaults to +nil+
+  #   - +:false_value+ An object to be returned if matching succeeds to match against +:false_values+. Defaults to +false+
+  #   - +:true_value+ An object to be returned if matching succeeds to match against +:true_values+. Defaults to +true+
+  def self.to_bool s, **options
+
+    true_values   = options[:true_values] || DEFAULT_TRUE_VALUES
+    true_values   = [ true_values ] unless true_values.is_a? ::Array
+    false_values  = options[:false_values] || DEFAULT_FALSE_VALUES
+    false_values  = [ false_values ] unless false_values.is_a? ::Array
+    default_value = options[:default] || nil
+    true_value    = options[:true] || true
+    false_value   = options[:false] || false
+
+    return true_value if true_values.any? { |v| self.matches_to_ s, v }
+    return false_value if false_values.any? { |v| self.matches_to_ s, v }
+
+    return default_value
+  end
 
 end # module BoolParser
 
@@ -113,4 +113,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/conversion/integer_parser.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/conversion/integer_parser.rb
+# File:     lib/xqsr3/conversion/integer_parser.rb
 #
-# Purpose:      Definition of the ::Xqsr3::Conversion::IntegerParser
-#               module
+# Purpose:  Definition of the ::Xqsr3::Conversion::IntegerParser module
 #
-# Created:      21st November 2017
-# Updated:      15th April 2019
+# Created:  21st November 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,125 +57,125 @@ module Conversion
 # +include-able module that provides Integer parsing
 module IntegerParser
 
-	private
-	# @!visibility private
-	module IntegerParser_Helper_ # :nodoc: all
+  private
+  # @!visibility private
+  module IntegerParser_Helper_ # :nodoc: all
 
-		if Kernel.respond_to?(:xqsr3_Integer_original_method)
+    if Kernel.respond_to?(:xqsr3_Integer_original_method)
 
-			def self.invoke_Integer_1(arg)
+      def self.invoke_Integer_1(arg)
 
-				Kernel.xqsr3_Integer_original_method(arg)
-			end
+        Kernel.xqsr3_Integer_original_method(arg)
+      end
 
-			def self.invoke_Integer_2(arg, base)
+      def self.invoke_Integer_2(arg, base)
 
-				Kernel.xqsr3_Integer_original_method(arg, base)
-			end
-		else
+        Kernel.xqsr3_Integer_original_method(arg, base)
+      end
+    else
 
-			def self.invoke_Integer_1(arg)
+      def self.invoke_Integer_1(arg)
 
-				Kernel.Integer(arg)
-			end
+        Kernel.Integer(arg)
+      end
 
-			def self.invoke_Integer_2(arg, base)
+      def self.invoke_Integer_2(arg, base)
 
-				Kernel.Integer(arg, base)
-			end
-		end
+        Kernel.Integer(arg, base)
+      end
+    end
 
-		def self.invoke_Integer(arg, base)
+    def self.invoke_Integer(arg, base)
 
-			case arg
-			when ::String
+      case arg
+      when ::String
 
-				self.invoke_Integer_2 arg, base
-			else
+        self.invoke_Integer_2 arg, base
+      else
 
-				if $DEBUG
+        if $DEBUG
 
-					case base
-					when nil, 0
+          case base
+          when nil, 0
 
-						;
-					else
+            ;
+          else
 
-						warn "WARNING: #{self}::#{__method__}: " + 'base specified for non string value'
-					end
-				end
+            warn "WARNING: #{self}::#{__method__}: " + 'base specified for non string value'
+          end
+        end
 
-				self.invoke_Integer_1 arg
-			end
-		end
+        self.invoke_Integer_1 arg
+      end
+    end
 
-		def self.to_integer_ arg, base, options, &block
+    def self.to_integer_ arg, base, options, &block
 
-			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
 
-			if block_given?
+      if block_given?
 
-				begin
+        begin
 
-					return self.invoke_Integer arg, base
-				rescue ArgumentError, TypeError => x
+          return self.invoke_Integer arg, base
+        rescue ArgumentError, TypeError => x
 
-					return yield x, arg, base, options
-				end
-			end
+          return yield x, arg, base, options
+        end
+      end
 
-			if options.has_key?(:default) || options[:nil]
+      if options.has_key?(:default) || options[:nil]
 
-				unless arg.nil?
+        unless arg.nil?
 
-					begin
+          begin
 
-						return self.invoke_Integer arg, base
-					rescue ArgumentError, TypeError
-					end
-				end
+            return self.invoke_Integer arg, base
+          rescue ArgumentError, TypeError
+          end
+        end
 
-				return options[:default] if options.has_key? :default
+        return options[:default] if options.has_key? :default
 
-				return nil
-			else
+        return nil
+      else
 
-				self.invoke_Integer arg, base
-			end
-		end
-	end # module IntegerParser_Helper_
-	public
+        self.invoke_Integer arg, base
+      end
+    end
+  end # module IntegerParser_Helper_
+  public
 
-	# Attempts to convert a variable to an integer, according to the given
-	# options and block
-	#
-	# === Signature
-	#
-	# * *Parameters:*
-	#   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+)
-	#   - +base+ A value of 0, or between 2 and 36. Defaults to 0
-	#   - +options+ An options hash, containing any of the following options
-	#   - +block+ An optional caller-supplied 4-parameter block - taking the exception, +arg+, +base+, and +options+ - that will be invoked with the +ArgumentError+ exception, allowing the caller to take additional action. If the block returns then its return value will be returned to the caller
-	#
-	# * *Options:*
-	#   - +:default+ A default value to be used when +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+
-	#   - +:nil+ Returns +nil+ if +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+. Ignored if +:default+ is specified
-	def self.to_integer arg, base = 0, **options, &block
+  # Attempts to convert a variable to an integer, according to the given
+  # options and block
+  #
+  # === Signature
+  #
+  # * *Parameters:*
+  #   - +arg+ The argument to be converted (to +Fixnum+ or +Bignum+)
+  #   - +base+ A value of 0, or between 2 and 36. Defaults to 0
+  #   - +options+ An options hash, containing any of the following options
+  #   - +block+ An optional caller-supplied 4-parameter block - taking the exception, +arg+, +base+, and +options+ - that will be invoked with the +ArgumentError+ exception, allowing the caller to take additional action. If the block returns then its return value will be returned to the caller
+  #
+  # * *Options:*
+  #   - +:default+ A default value to be used when +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+
+  #   - +:nil+ Returns +nil+ if +arg+ is +nil+ or cannot be converted by (the original) +Kernel#Integer+. Ignored if +:default+ is specified
+  def self.to_integer arg, base = 0, **options, &block
 
-		IntegerParser_Helper_.to_integer_ arg, base, options, &block
-	end
+    IntegerParser_Helper_.to_integer_ arg, base, options, &block
+  end
 
-	# Instance form of ::Xqsr3::Conversion::IntegerParser.to_integer
-	def to_integer base = 0, **options, &block
+  # Instance form of ::Xqsr3::Conversion::IntegerParser.to_integer
+  def to_integer base = 0, **options, &block
 
-		IntegerParser_Helper_.to_integer_ self, base, options, &block
-	end
+    IntegerParser_Helper_.to_integer_ self, base, options, &block
+  end
 
 end # module IntegerParser
 
@@ -184,4 +184,3 @@ end # module Xqsr3
 
 # ############################## end of file ############################# #
 
-

data/lib/xqsr3/conversion.rb

@@ -1,11 +1,11 @@
 
 %w{
 
-	bool_parser
-	integer_parser
+  bool_parser
+  integer_parser
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'conversion', name)
+  require File.join(File.dirname(__FILE__), 'conversion', name)
 end