xqsr3 0.38.1.1 → 0.39.1

data/lib/xqsr3/extensions/test/unit/assert_type_has_instance_methods.rb

@@ -4,62 +4,60 @@ module Unit
 
 module Assertions
 
-	unless respond_to? :assert_type_has_instance_methods
+  unless respond_to? :assert_type_has_instance_methods
 
-		# Fails unless the given +type+ responds to all of the messages
-		# given by +message_spec+
-		#
-		# === Signature
-		#
-		# * *Parameters:*
-		#   - +type+ (::Class) The type
-		#   - +message_spec+ (::Symbol, ::Array, ::Hash) A specification of message(s) received by the instances of +type+. If a ::Symbol, then instances must respond to this single message.  If an ::Array (all elements of which must be ::Symbol), then instances must respond to _all_ messages. If a ::Hash, then instances must respond to _all_ messages represented by the keys; the values are available for specifying a custom failure message (or value is +nil+ for stock message)
-		#  - +failure_message+ (::String) If specified, is used when instances of +type+ do not respond to a message and no custom failure message is provided for it
-		def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
+    # Fails unless the given +type+ responds to all of the messages
+    # given by +message_spec+
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #   - +type+ (::Class) The type
+    #   - +message_spec+ (::Symbol, ::Array, ::Hash) A specification of message(s) received by the instances of +type+. If a ::Symbol, then instances must respond to this single message.  If an ::Array (all elements of which must be ::Symbol), then instances must respond to _all_ messages. If a ::Hash, then instances must respond to _all_ messages represented by the keys; the values are available for specifying a custom failure message (or value is +nil+ for stock message)
+    #  - +failure_message+ (::String) If specified, is used when instances of +type+ do not respond to a message and no custom failure message is provided for it
+    def assert_type_has_instance_methods(type, message_spec, failure_message = nil)
 
-			warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)
+      warn "type parameter - '#{type} (#{type.class})' - should be a Class" unless type.is_a?(::Class)
 
-			case message_spec
-			when ::Hash
+      case message_spec
+      when ::Hash
 
-				warn "every key in a Hash message_spec should be of type Symbol" unless message_spec.keys.all? { |k| ::Symbol === k }
-			when ::Array
+        warn "every key in a Hash message_spec should be of type Symbol" unless message_spec.keys.all? { |k| ::Symbol === k }
+      when ::Array
 
-				warn "every key in an Array message_spec should be of type Symbol" unless message_spec.all? { |k| ::Symbol === k }
+        warn "every key in an Array message_spec should be of type Symbol" unless message_spec.all? { |k| ::Symbol === k }
 
-				message_spec = Hash[message_spec.map { |s| [ s, nil ] }]
-			when ::Symbol
+        message_spec = Hash[message_spec.map { |s| [ s, nil ] }]
+      when ::Symbol
 
-				message_spec[message_spec] = nil
-			else
+        message_spec[message_spec] = nil
+      else
 
-				msg = "message_spec - '#{message_spec} (#{message_spec.class})' - should be a Symbol, an Array of Symbols, or a Hash of Symbol => message"
+        msg = "message_spec - '#{message_spec} (#{message_spec.class})' - should be a Symbol, an Array of Symbols, or a Hash of Symbol => message"
 
-				warn msg
+        warn msg
 
-				return assert false, msg
-			end
+        return assert false, msg
+      end
 
-			ims = type.instance_methods
+      ims = type.instance_methods
 
-			message_spec.each do |sym, message|
+      message_spec.each do |sym, message|
 
-				unless ims.include? sym
+        unless ims.include? sym
 
-					message ||= failure_message
-					message	||=	"type #{type} does not contain the instance method #{sym}"
+          message ||= failure_message
+          message ||= "type #{type} does not contain the instance method #{sym}"
 
-					return assert false, message
-				end
-			end
+          return assert false, message
+        end
+      end
 
-			assert true
-		end
-	end
+      assert true
+    end
+  end
 
 end # class Assertions
 end # module Unit
 end # module Test
 
-
-

data/lib/xqsr3/extensions.rb

@@ -1,13 +1,13 @@
 
 %w{
 
-	array
-	enumerable
-	hash
-	io
+  array
+  enumerable
+  hash
+  io
 }.each do |name|
 
-	require File.join(File.dirname(__FILE__), 'extensions', name)
+  require File.join(File.dirname(__FILE__), 'extensions', name)
 end
 
 

data/lib/xqsr3/hash_utilities/deep_transform.rb

@@ -1,18 +1,18 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/hash_utilities/deep_transform.rb
+# File:     lib/xqsr3/hash_utilities/deep_transform.rb
 #
-# Purpose:      Definition of the ::Xqsr3::HashUtilities::DeepTransform
-#               module
+# Purpose:  Definition of the ::Xqsr3::HashUtilities::DeepTransform module
 #
-# Created:      3rd June 2017
-# Updated:      14th March 2018
+# 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) 2017-2018, 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.
 #
@@ -58,94 +58,94 @@ module HashUtilities
 
 module DeepTransform
 
-	private
-	def self.do_deep_transform_on_hashlike_ h, &block # :nodoc:
+  private
+  def self.do_deep_transform_on_hashlike_ h, &block # :nodoc:
 
-		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :map ]
+    ::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :map ]
 
-		case block.arity
-		when 1
+    case block.arity
+    when 1
 
-			h = 
-			Hash[h.map do |k, v|
+      h =
+      Hash[h.map do |k, v|
 
-				k = k.deep_transform(&block) if ::Hash === k
-				v = v.deep_transform(&block) if ::Hash === v
+        k = k.deep_transform(&block) if ::Hash === k
+        v = v.deep_transform(&block) if ::Hash === v
 
-				[yield(k), v]
-			end]
-		when 2
+        [yield(k), v]
+      end]
+    when 2
 
-			h = 
-			Hash[h.map do |k, v|
+      h =
+      Hash[h.map do |k, v|
 
-				k = k.deep_transform(&block) if ::Hash === k
-				v = v.deep_transform(&block) if ::Hash === v
+        k = k.deep_transform(&block) if ::Hash === k
+        v = v.deep_transform(&block) if ::Hash === v
 
-				yield(k, v)
-			end]
-		else
+        yield(k, v)
+      end]
+    else
 
-			raise ArgumentError, "block arity must be 1 or 2"
-		end
+      raise ArgumentError, "block arity must be 1 or 2"
+    end
 
-		h
-	end
+    h
+  end
 
-	def do_deep_transform_on_self_ &block # :nodoc:
+  def do_deep_transform_on_self_ &block # :nodoc:
 
-		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[]=, :delete, :keys ]
+    ::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[]=, :delete, :keys ]
 
-		case block.arity
-		when 1
+    case block.arity
+    when 1
 
-			self.keys.each do |k|
+      self.keys.each do |k|
 
-				v	=	self.delete k
+        v = self.delete k
 
-				k	=	k.deep_transform(&block) if ::Hash === k
-				v	=	v.deep_transform(&block) if ::Hash === v
+        k = k.deep_transform(&block) if ::Hash === k
+        v = v.deep_transform(&block) if ::Hash === v
 
-				self[yield(k)] = v
-			end
-		when 2
+        self[yield(k)] = v
+      end
+    when 2
 
-			self.keys.each do |k|
+      self.keys.each do |k|
 
-				v	=	self.delete k
+        v = self.delete k
 
-				k	=	k.deep_transform(&block) if ::Hash === k
-				v	=	v.deep_transform(&block) if ::Hash === v
+        k = k.deep_transform(&block) if ::Hash === k
+        v = v.deep_transform(&block) if ::Hash === v
 
-				k, v	=	yield(k, v)
-			end
-		else
+        k, v = yield(k, v)
+      end
+    else
 
-			raise ArgumentError, "block arity must be 1 or 2"
-		end
-	end
-	public
+      raise ArgumentError, "block arity must be 1 or 2"
+    end
+  end
+  public
 
-	# Executes the given mandatory 1- or 2-parameter block on the receiving
-	# instance, which must be a Hash or a type that responds to the +map+
-	# message, returning a copy of the instance in which keys (1-parameter
-	# block) or keys and values (2-parameter block) are transformed.
-	def deep_transform &block
+  # Executes the given mandatory 1- or 2-parameter block on the receiving
+  # instance, which must be a Hash or a type that responds to the +map+
+  # message, returning a copy of the instance in which keys (1-parameter
+  # block) or keys and values (2-parameter block) are transformed.
+  def deep_transform &block
 
-		DeepTransform.do_deep_transform_on_hashlike_(self, &block)
-	end
+    DeepTransform.do_deep_transform_on_hashlike_(self, &block)
+  end
 
-	# Executes the given mandatory 1- or 2-parameter block on the receiving
-	# instance, whihc must be a Hash or a type that responds to +[]+,
-	# +delete+, and +keys+ messages, changing the keys (1-parameter block)
-	# or keys and values (2-parameter block).
-	#
-	# @note This method is not strongly exception-safe - failure during
-	#  transformation can result in a partially transformed instance
-	def deep_transform! &block
+  # Executes the given mandatory 1- or 2-parameter block on the receiving
+  # instance, whihc must be a Hash or a type that responds to +[]+,
+  # +delete+, and +keys+ messages, changing the keys (1-parameter block)
+  # or keys and values (2-parameter block).
+  #
+  # @note This method is not strongly exception-safe - failure during
+  #  transformation can result in a partially transformed instance
+  def deep_transform! &block
 
-		do_deep_transform_on_self_(&block)
-	end
+    do_deep_transform_on_self_(&block)
+  end
 
 end # module DeepTransform
 

data/lib/xqsr3/hash_utilities/key_matching.rb

@@ -1,17 +1,17 @@
 
 # ######################################################################## #
-# File:         lib/xqsr3/hash_utilities/key_matching.rb
+# File:     lib/xqsr3/hash_utilities/key_matching.rb
 #
-# Purpose:      Definition of the ::Xqsr3::HashUtilities::KeyMatching
-#               module
+# Purpose:  Definition of the ::Xqsr3::HashUtilities::KeyMatching module
 #
-# Created:      15th November 2017
-# Updated:      15th April 2019
+# Created:  15th 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.
 #
@@ -60,113 +60,113 @@ module HashUtilities
 # and #match methods
 module KeyMatching
 
-	private
-	def self.do_match_ h, re, **options # :nodoc:
+  private
+  def self.do_match_ h, re, **options # :nodoc:
 
-		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
+    ::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
 
-		return h[re] if h.has_key? re
+    return h[re] if h.has_key? re
 
-		case re
-		when ::Regexp
+    case re
+    when ::Regexp
 
-			h.each do |k, v|
+      h.each do |k, v|
 
-				case k
-				when ::Regexp
+        case k
+        when ::Regexp
 
-					next
-				else
+          next
+        else
 
-					return v if k.to_s =~ re
-				end
-			end
-		else
+          return v if k.to_s =~ re
+        end
+      end
+    else
 
-			h.each do |k, v|
+      h.each do |k, v|
 
-				case k
-				when ::Regexp
+        case k
+        when ::Regexp
 
-					return v if re.to_s =~ k
-				else
+          return v if re.to_s =~ k
+        else
 
-					next
-				end
-			end
-		end
+          next
+        end
+      end
+    end
 
-		nil
-	end
+    nil
+  end
 
-	def self.do_has_match_ h, re, **options # :nodoc:
+  def self.do_has_match_ h, re, **options # :nodoc:
 
-		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
+    ::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
 
-		return true if h.has_key? re
+    return true if h.has_key? re
 
-		case re
-		when ::Regexp
+    case re
+    when ::Regexp
 
-			h.each do |k, v|
+      h.each do |k, v|
 
-				case k
-				when ::Regexp
+        case k
+        when ::Regexp
 
-					next
-				else
+          next
+        else
 
-					return true if k.to_s =~ re
-				end
-			end
-		else
+          return true if k.to_s =~ re
+        end
+      end
+    else
 
-			h.each do |k, v|
+      h.each do |k, v|
 
-				case k
-				when ::Regexp
+        case k
+        when ::Regexp
 
-					return true if re.to_s =~ k
-				else
+          return true if re.to_s =~ k
+        else
 
-					next
-				end
-			end
-		end
+          next
+        end
+      end
+    end
 
-		false
-	end
-	public
+    false
+  end
+  public
 
-	# Retrieves the value object corresponding to the first key object that
-	# matches the given +re+, in the hash +h+, according to the given
-	# options.
-	def self.match h, re, **options
+  # Retrieves the value object corresponding to the first key object that
+  # matches the given +re+, in the hash +h+, according to the given
+  # options.
+  def self.match h, re, **options
 
-		Xqsr3::HashUtilities::KeyMatching.do_match_ h, re, **options
-	end
+    Xqsr3::HashUtilities::KeyMatching.do_match_ h, re, **options
+  end
 
-	# Returns true if the hash +h+ contains a key object that matches the
-	# given +re+, according to the given options
-	def self.has_match? h, re, **options
+  # Returns true if the hash +h+ contains a key object that matches the
+  # given +re+, according to the given options
+  def self.has_match? h, re, **options
 
-		Xqsr3::HashUtilities::KeyMatching.do_has_match_ h, re, **options
-	end
+    Xqsr3::HashUtilities::KeyMatching.do_has_match_ h, re, **options
+  end
 
-	# Retrieves the value object corresponding to the first key object that
-	# matches the given +re+, in the hash +h+, according to the given
-	# options.
-	def match h, re, **options
+  # Retrieves the value object corresponding to the first key object that
+  # matches the given +re+, in the hash +h+, according to the given
+  # options.
+  def match h, re, **options
 
-		Xqsr3::HashUtilities::KeyMatching.do_match_ h, re, **options
-	end
+    Xqsr3::HashUtilities::KeyMatching.do_match_ h, re, **options
+  end
 
-	# Returns true if the hash +h+ contains a key object that matches the
-	# given +re+, according to the given options
-	def has_match? h, re, **options
+  # Returns true if the hash +h+ contains a key object that matches the
+  # given +re+, according to the given options
+  def has_match? h, re, **options
 
-		Xqsr3::HashUtilities::KeyMatching.do_has_match_ h, re, **options
-	end
+    Xqsr3::HashUtilities::KeyMatching.do_has_match_ h, re, **options
+  end
 
 end # module KeyMatching
 

data/lib/xqsr3/hash_utilities.rb

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