xqsr3 0.37.2 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f10bad46d3e4578fbf386537a6bf5e72e4b690d7
-  data.tar.gz: 71706b979d66b50232e82fe32259e4c69c1dd697
+  metadata.gz: 893916b4985f2cf4aacd3880f28d9199b3137f49
+  data.tar.gz: d611a888f54fc3d6bee966a040530637bdfe2423
 SHA512:
-  metadata.gz: c1cf52793a168a5be1102777e347b657fc12dab1549321fd028e66fa2c64523651b66c8c9669d17079b4824309a0217063c6876b82f0d44c1b909973478e88e1
-  data.tar.gz: 076ce8d398e4b0f67012bf6465b9a1ba005ef4d6fe60bc60736b42ea9269448535df9677da2702ac1b9c868f6f2bd3560dd92f2815d7c4cfc7fb20438f0a3528
+  metadata.gz: 222348a3e0621835acbb5df342e2625eb6f6c7d355b59e9aded4e105e3acdbfe27a13cff0af939964ecde0eab65f16a5bebd8560afb71781a653c98ba981cc0b
+  data.tar.gz: efd82ceb69653fcc88954b3fb03267d3719e00642de1c7a2de564fe008751e0476be9625da6037af8bdcc1aecbf242ceced924f29403858a9d5a3b8eff861391

data/README.md

@@ -23,7 +23,7 @@ It may be pronounced (lamely) as "excusers".
 Install via **gem** as in:
 
 ```
-	gem install libclimate-ruby
+gem install libclimate-ruby
 ```
 
 or add it to your `Gemfile`.

data/lib/xqsr3/command_line_utilities/map_option_string.rb

@@ -6,12 +6,13 @@
 #               ::Xqsr3::CommandLineUtilities::MapOptionString module
 #
 # Created:      15th April 2016
-# Updated:      15th April 2019
+# Updated:      19th July 2022
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
+# Copyright (c) 2019-2022, Matthew Wilson and Synesis Information Systems
 # Copyright (c) 2016-2019, Matthew Wilson and Synesis Software
 # All rights reserved.
 #

data/lib/xqsr3/containers/frequency_map.rb

@@ -285,9 +285,13 @@ class FrequencyMap
 	# keys must be created and sorted from which enumeration is directed
 	def each_by_key
 
-		@elements.keys.sort.each do |key|
+		sorted_elements = @elements.sort { |a, b| a[0] <=> b[0] }
 
-			yield key, @elements[key]
+		return sorted_elements.each unless block_given?
+
+		sorted_elements.each do |k, v|
+
+			yield k, v
 		end
 	end
 
@@ -298,22 +302,13 @@ class FrequencyMap
 	# and map all entries into it in order to achieve the ordering
 	def each_by_frequency
 
-		tm = {}
-		@elements.each do |element, frequency|
-
-			tm[frequency]	=	[]	unless tm.has_key?(frequency)
+		ar = @elements.to_a.sort { |a, b| b[1] <=> a[1] }
 
-			tm[frequency].push element
-		end
-
-		keys = tm.keys.sort.reverse
-		keys.each do |frequency|
+		return ar.each unless block_given?
 
-			elements = tm[frequency].sort
-			elements.each do |element|
+		ar.each do |k, v|
 
-				yield element, frequency
-			end
+			yield k, v
 		end
 	end
 

data/lib/xqsr3/extensions/string/map_option_string.rb

@@ -6,3 +6,12 @@ class String
 	include ::Xqsr3::CommandLineUtilities::MapOptionString
 end # class String
 
+class NilClass
+
+	def map_option_string *args
+
+		nil
+	end
+end
+
+

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:      26th June 2022
+# Updated:      26th July 2022
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -51,7 +51,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.37.2'
+	VERSION				=	'0.38.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/command_line_utilities/tc_map_option_string.rb

@@ -35,5 +35,10 @@ class Test_Xqsr3_CommandLineUtilities_map_option_string < Test::Unit::TestCase
 			assert_nil MapOptionString.map_option_string_from_string(shortcut, option_strings)
 		end
 	end
+
+	def test_nil
+
+		assert_nil nil.map_option_string []
+	end
 end
 

data/test/unit/containers/tc_frequency_map.rb

@@ -335,7 +335,7 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_eql fm1, fm3
 	end
 
-	def test_each
+	def test_each_WITH_BLOCK
 
 		fm = FrequencyMap.new
 
@@ -358,7 +358,25 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_equal [:ghi, 2], r[2]
 	end
 
-	def test_each_by_key
+	def test_each_WITHOUT_BLOCK
+
+		fm = FrequencyMap.new
+
+		fm << :def
+		fm << :abc << :abc << :abc << :abc
+		fm << :ghi << :ghi
+
+		r = fm.each.to_a
+
+		r.sort! { |a, b| a[0] <=> b[0] }
+
+		assert_equal 3, r.size
+		assert_equal [:abc, 4], r[0]
+		assert_equal [:def, 1], r[1]
+		assert_equal [:ghi, 2], r[2]
+	end
+
+	def test_each_by_key_WITH_BLOCK
 
 		fm = FrequencyMap.new
 
@@ -379,7 +397,23 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_equal [:ghi, 2], r[2]
 	end
 
-	def test_each_by_frequency
+	def test_each_by_key_WITHOUT_BLOCK
+
+		fm = FrequencyMap.new
+
+		fm << :def
+		fm << :abc << :abc << :abc << :abc
+		fm << :ghi << :ghi
+
+		r = fm.each_by_key.to_a
+
+		assert_equal 3, r.size
+		assert_equal [:abc, 4], r[0]
+		assert_equal [:def, 1], r[1]
+		assert_equal [:ghi, 2], r[2]
+	end
+
+	def test_each_by_frequency_WITH_BLOCK
 
 		fm = FrequencyMap.new
 
@@ -400,7 +434,23 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_equal [:def, 1], r[2]
 	end
 
-	def each_value
+	def test_each_by_frequency_WITHOUT_BLOCK
+
+		fm = FrequencyMap.new
+
+		fm << :def
+		fm << :abc << :abc << :abc << :abc
+		fm << :ghi << :ghi
+
+		r = fm.each_by_frequency.to_a
+
+		assert_equal 3, r.size
+		assert_equal [:abc, 4], r[0]
+		assert_equal [:ghi, 2], r[1]
+		assert_equal [:def, 1], r[2]
+	end
+
+	def test_each_value_WITH_BLOCK
 
 		fm = FrequencyMap.new
 
@@ -412,7 +462,7 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 
 		fm.each_value do |v|
 
-			r << [v]
+			r << v
 		end
 
 		r.sort!
@@ -421,7 +471,7 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		assert_equal [1, 2, 4], r
 	end
 
-	def each_with_index
+	def test_each_value_WITHOUT_BLOCK
 
 		fm = FrequencyMap.new
 
@@ -429,19 +479,37 @@ class Test_Xqsr3_Containers_FrequencyMap < Test::Unit::TestCase
 		fm << :abc << :abc << :abc << :abc
 		fm << :ghi << :ghi
 
-		fm.each_with_index do |k, v, index|
-
-			case	index
-			when	0
-				assert_equal :abc, k
-				assert_equal 2, v
-			when	1
-				assert_equal :def, k
-				assert_equal 1, v
-			else
-				assert false, "should never get here"
-			end
+		r = fm.each_value.to_a
+
+		r.sort!
+
+		assert_equal 3, r.size
+		assert_equal [1, 2, 4], r
+	end
+
+	def test_each_with_index_WITH_BLOCK
+
+		fm = FrequencyMap.new
+
+		fm << :def
+		fm << :abc << :abc << :abc << :abc
+		fm << :ghi << :ghi
+
+		indexes = []
+		kvs = {}
+
+		fm.each_with_index do |kv, index|
+
+			k = kv[0]
+			v = kv[1]
+
+			indexes << index
+
+			kvs[k] = v
 		end
+
+		assert_equal [ 0, 1, 2 ], indexes
+		assert_equal Hash[ :abc, 4, :def, 1, :ghi, 2 ], kvs
 	end
 
 	def test_empty

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.2
+  version: 0.38.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a