xqsr3 0.37.3 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e140803e312c0a06fa78a8a99c170faf11cdc2ec
-  data.tar.gz: 639bbc9ea46908b0de04fc7eb011e112285258d7
+  metadata.gz: 3e4daad1c3c67fdf61c583a51ba736ff81e75b80
+  data.tar.gz: d6d61c42b272907440cd1050b24d86be9cada0b9
 SHA512:
-  metadata.gz: 91fe23e62c70ae6a91f000617572f058f4639c28d928c4e437167928eea835a8223b1f4fbb12d434719594942301acac70df54eafc9fdf99fd163bf15ea2183e
-  data.tar.gz: 62cb7f51f9233708a10c0d058bd982fad508b7e065c81baa3a88622bd7097141ba93839f024a47ff114a54e2e8590e10e6834e61d31a20f193d06f39a73a23a2
+  metadata.gz: 3a5986a93e709f33a02cfc1c90343b0f520ab4960c8b42b97df96fc71a34debfd41932a2012e98afcd6392e5d37b2b694bc7f6fc4fcefbd9c25b6a3587c8d5dc
+  data.tar.gz: 0d7d35382e452b1f104d04da69c7113e9f59e157357ff78efbaa0c9cb9f3a92c181122792b8fafcbb9ac5c6c6cb9c7da2e2ca432d02b1e55c5e4c93616baaa5e

data/lib/xqsr3/quality/parameter_checking.rb

@@ -5,13 +5,14 @@
 # Purpose:      Definition of the ParameterChecking module
 #
 # Created:      12th February 2015
-# Updated:      15th April 2019
+# Updated:      22nd July 2022
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2019, Matthew Wilson and Synesis Software
+# Copyright (c) 2019-2022, Matthew Wilson and Synesis Information Systems
+# Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -199,6 +200,22 @@ module ParameterChecking
 		Util_.check_parameter value, name, options, &block
 	end
 
+	# Specific form of the +check_parameter()+ that is used to check
+	# options, taking instead the hash and the key
+	#
+	# === Signature
+	#
+	# * *Parameters:*
+	#   - +h+ (::Hash) The options hash from which the named element is to be tested. May not be +nil+
+	#   - +name+ (::String, ::Symbol, [ ::String, ::Symbol ]) The options key name, or an array of names. May not be +nil+
+	#   - +options+ (::Hash) options that moderate the behaviour in the same way as for +check_parameter()+ except that the +:treat_as_option+ option (with the value +true+) is merged in before calling +check_parameter()+
+	#
+	# * *Options:*
+	def self.check_option h, name, options = {}, &block
+
+		Util_.check_option h, name, options, &block
+	end
+
 	private
 	def Util_.check_option h, names, options = {}, &block
 
@@ -381,6 +398,7 @@ module ParameterChecking
 			# messages
 
 			messages	=	options[:responds_to] || []
+			messages	=	[ messages ] unless messages.respond_to? :each
 
 			warn "#{self}::check_parameter: options[:responds_to] of type #{messages.class} - should be #{::Array}" unless messages.is_a?(Array)
 			warn "#{self}::check_parameter: options[:responds_to] should contain only symbols or strings" if messages.is_a?(::Array) && !messages.all? { |m| ::Symbol === m || ::String === m }

data/lib/xqsr3/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Xqsr3 library
 #
 # Created:      3rd April 2016
-# Updated:      19th July 2022
+# Updated:      25th July 2022
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -51,7 +51,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.37.3'
+	VERSION				=	'0.38.0'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/quality/tc_parameter_checking.rb

@@ -7,13 +7,39 @@ require 'xqsr3/quality/parameter_checking'
 require 'xqsr3/extensions/test/unit'
 require 'test/unit'
 
+
+class Test_check_option_multiple_option_names < Test::Unit::TestCase
+
+	include ::Xqsr3::Quality::ParameterChecking
+
+	def check_method_stringise_stringize **options
+
+		check_option options, [ :stringise, :stringize ], nil: true
+	end
+
+	def test_1
+
+		assert_nil check_method_stringise_stringize()
+
+		assert_nil check_method_stringise_stringize(abc: :abc)
+
+		assert_equal :stringize, check_method_stringise_stringize(stringize: :stringize)
+		assert_equal :stringise, check_method_stringise_stringize(stringise: :stringise)
+		assert_equal :stringise, check_method_stringise_stringize(stringize: :stringize, stringise: :stringise)
+		assert_equal :stringise, check_method_stringise_stringize(stringise: :stringise, stringize: :stringize)
+	end
+end
+
 class Test_parameter_checks_as_separate_module < Test::Unit::TestCase
 
 	PC = ::Xqsr3::Quality::ParameterChecking
 
 	# test 1
 
-	def check_method_1 a
+	def check_method_1 a, **options
+
+		PC.check_option options, :o1, nil: true
+		PC.check_option options, :o2, nil: false
 
 		PC.check_param a, 'a'
 	end
@@ -25,10 +51,10 @@ class Test_parameter_checks_as_separate_module < Test::Unit::TestCase
 			check_method_1(nil)
 		end
 
-		assert_equal true, check_method_1(true)
-		assert_equal '', check_method_1('')
-		assert_equal [], check_method_1([])
-		assert_equal Hash.new, check_method_1(Hash.new)
+		assert_equal true, check_method_1(true, o1: true, o2: false)
+		assert_equal '', check_method_1('', o1: true, o2: false)
+		assert_equal [], check_method_1([], o1: true, o2: false)
+		assert_equal Hash.new, check_method_1(Hash.new, o1: true, o2: false)
 	end
 
 
@@ -328,6 +354,11 @@ end
 
 			check_responds_to Hash.new, [ :this_is_not_a_Hash_method ]
 		end
+
+		# check can pass single types
+		assert check_responds_to Hash.new, :[]
+		assert check_responds_to Hash.new, :map
+		assert check_responds_to Hash.new, :to_s
 	end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.37.3
+  version: 0.38.0
 platform: ruby
 authors:
 - Matt Wilson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a