xqsr3 0.8.6 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 033e7dfed425a1390d4fc09533d76e262e26b558
-  data.tar.gz: 2c08df8949635e57488dca7def484e4ad18ef100
+  metadata.gz: 9fc131e56227103bb95b7ccf5dfc3c19dd15b2a6
+  data.tar.gz: 4fb63d6d6d8f764e2ca09fc0fe0859897c16a807
 SHA512:
-  metadata.gz: 740820caf1bbe4c17bbc2c092e8bec3a6efbf88f0c2593a3dca47213a207802c235ab10c5fc27b4fcb4069b6881b8557f1c875d328d709186e140bfb3fc10d80
-  data.tar.gz: 0cfef03cd14cdebbb93b52243c28f9f3af187e7e55271fef0764bc5d2a38550ca13f15032fc3eb6d542f7a329ce7fb696161b411a98cd299f205a0ea7557cbc1
+  metadata.gz: ec36713f0a9cd50f16d826d3a6ca58a4c36d14ad5aeea9ab0c73a77fb2b90ad7c632dbafd7b9a4dfb4225e1e73c1d1f18bb7020b5b9e12cbc531f10d274ac270
+  data.tar.gz: e9c1695f3091a1bd265da1b8943e9a97d9de645c4efddae0798b1d9103508d212348e226330c1f9578f55f0e458390c09765a9243f4505d3028e92563f88691c

data/lib/xqsr3/containers/multi_map.rb

@@ -5,7 +5,7 @@
 # Purpose:      multimap container
 #
 # Created:      21st March 2007
-# Updated:      10th June 2016
+# Updated:      2nd October 2016
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -202,6 +202,16 @@ class MultiMap < ::Hash
 		@inner.each_key { |key| yield key }
 	end
 
+	def each_unflattened
+
+		@inner.each { |key, value| yield key, value }
+	end
+
+	def each_unflattened_with_index
+
+		@inner.each_with_index { |kv, index| yield kv, index }
+	end
+
 	def each_value
 
 		@inner.each do |key, values|

data/lib/xqsr3/quality/parameter_checking.rb

@@ -5,13 +5,13 @@
 # Purpose:      Definition of the ParameterChecking module
 #
 # Created:      12th February 2015
-# Updated:      10th June 2016
+# Updated:      26th February 2017
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2015-2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2015-2017, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -54,6 +54,23 @@ module Quality
 #
 module ParameterChecking
 
+	private
+	module Util_
+
+		def self.join_with_or a
+
+			case a.size
+			when 1
+				a[0]
+			when 2
+				"#{a[0]} or #{a[1]}"
+			else
+				"#{a[0...-1].join(', ')}, or #{a[-1]}"
+			end
+		end
+	end # module Util_
+
+	public
 	# Check a given parameter (value=+value+, name=+name+) for type and value
 	#
 	# @param +value+ the parameter whose value and type is to be checked
@@ -63,7 +80,9 @@ module ParameterChecking
 	# @option +:allow_nil+ the +value+ must not be +nil+ unless this option
 	#          is true
 	# @option +:types+ an array of types one of which +value+ must be (or
-	#          must be derived from)
+	#          must be derived from). One of these types may be an array
+	#          of types, in which case +value+ may be an array that must
+	#          consist wholly of those types
 	# @option +:values+ an array of values one of which +value+ must be
 	# @option +:reject_empty+ requires value to respond to +empty?+
 	#          message and to do so with false, unless +nil+
@@ -121,9 +140,22 @@ module ParameterChecking
 			type_found	=	false
 
 			warn "#{self}::check_parameter: options[:types] of type #{types.class} - should be #{::Array}" unless types.is_a?(Array)
-			warn "#{self}::check_parameter: options[:types] should contain only classes" if types.is_a?(Array) && !types.all? { |c| ::Class === c }
+			warn "#{self}::check_parameter: options[:types] should contain only classes or arrays of classes" if types.is_a?(::Array) && !types.all? { |c| ::Class === c || (::Array === c || c.all? { |c2| ::Class === c2 }) }
+
+			unless types.any? do |t|
 
-			unless types.any? { |t| value.is_a?(t) }
+					case t
+					when ::Class
+
+						# the (presumed) scalar argument is of type t?
+						value.is_a?(t)
+					when ::Array
+
+						# the (presumed) vector argument's elements are the
+						# possible types
+						value.all? { |v| t.any? { |t2| v.is_a?(t2) }}
+					end
+				end
 
 				failed_check	=	true
 
@@ -132,20 +164,29 @@ module ParameterChecking
 					unless message
 
 						s_name		=	name.is_a?(String) ? "'#{name}' " : ''
+						s_be		=	'be' #::Array === value ? 'contain' : 'be'
+
+						types_0		=	types.select { |t| ::Class === t }.uniq
+						types_ar	=	types.select { |t| ::Array === t }.flatten.uniq
+
+						if types_ar.empty?
 
-						case	types.size
-						when	1
+							s_types_0	=	Util_.join_with_or types_0
 
-							s_types	=	"#{types[0]}"
-						when	2
+							message		=	"#{param_s} #{s_name}(#{value.class}) must be an instance of #{s_types_0}"
+						elsif types_0.empty?
 
-							s_types	=	"#{types[0]} or #{types[1]}"
+							s_types_ar	=	Util_.join_with_or types_ar
+
+							message		=	"#{param_s} #{s_name}(#{value.class}) must be an array containing instance(s) of #{s_types_ar}"
 						else
 
-							s_types	=	"#{types[0...-1].join(', ')}, or #{types[-1]}"
-						end
+							s_types_0	=	Util_.join_with_or types_0
 
-						message		=	"#{param_s} #{s_name}(#{value.class}) must be an instance of #{s_types}"
+							s_types_ar	=	Util_.join_with_or types_ar
+
+							message		=	"#{param_s} #{s_name}(#{value.class}) must be an instance of #{s_types_0}, or an array containing instance(s) of #{s_types_ar}"
+						end
 					end
 
 					raise TypeError, message

data/lib/xqsr3/version.rb

@@ -5,13 +5,13 @@
 # Purpose:      Version for Xqsr3 library
 #
 # Created:      3rd April 2016
-# Updated:      19th May 2016
+# Updated:      26th February 2017
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
 # Author:       Matthew Wilson
 #
-# Copyright (c) 2016, Matthew Wilson and Synesis Software
+# Copyright (c) 2016-2017, Matthew Wilson and Synesis Software
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.8.6'
+	VERSION				=	'0.10.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/command_line_utilities/tc_map_option_string.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 

data/test/unit/command_line_utilities/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/containers/tc_frequency_map.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 

data/test/unit/containers/tc_multi_map.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 
@@ -59,6 +59,36 @@ class Test_Xqsr3_Containers_MultiMap < Test::Unit::TestCase
 		assert_raise(::ArgumentError) { MultiMap[ [ :abc ], [] ] }
 	end
 
+	def test_class_operator_subscript_6
+
+		ar = [ [ :abc, '1' ] ]
+
+		mm = MultiMap[ar]
+
+		assert_equal 1, ar.size
+		assert_equal 1, mm.size
+		assert_equal [ '1' ], mm[:abc]
+
+		ar = [ [ :abc, '1' ], [ :def, '2' ] ]
+
+		mm = MultiMap[ar]
+
+		assert_equal 2, ar.size
+		assert_equal 2, mm.size
+		assert_equal [ '1' ], mm[:abc]
+		assert_equal [ '2' ], mm[:def]
+
+		ar = [ [ 1, 11 ], [ 1, 111 ], [ 2, 22 ], [ 3, 333 ], [ 1, 1111 ] ]
+
+		mm = MultiMap[ar]
+
+		assert_equal 5, ar.size
+		assert_equal 3, mm.size
+		assert_equal [ 11, 111, 1111 ], mm[1]
+		assert_equal [ 22 ], mm[2]
+		assert_equal [ 333 ], mm[3]
+	end
+
 	def test_instance_operator_equals
 
 		mm1 = MultiMap.new
@@ -323,6 +353,52 @@ class Test_Xqsr3_Containers_MultiMap < Test::Unit::TestCase
 		assert_equal [ [ :abc, 'a1', 0 ], [ :abc, 'a2', 1 ], [ :abc, 'a3', 2 ], [ :abc, 'a4', 3 ], [ :ghi, 'g1', 4 ], [ :ghi, 'g2', 5 ] ], r
 	end
 
+	def test_each_unflattened
+
+		mm = MultiMap.new
+
+		mm.push :def
+		mm.push :abc, 'a1', 'a2', 'a3', 'a4'
+		mm.push :ghi, 'g1', 'g2'
+
+		r = []
+
+		mm.each_unflattened do |key, value|
+
+			r << [ key, value ]
+		end
+
+		r.sort!
+
+		assert_equal 3, r.size
+		assert_equal [ :abc, [ 'a1', 'a2', 'a3', 'a4' ] ], r[0]
+		assert_equal [ :def, [] ], r[1]
+		assert_equal [ :ghi, [ 'g1', 'g2' ] ], r[2]
+	end
+
+	def test_each_unflattened_with_index
+
+		mm = MultiMap.new
+
+		mm.push :def
+		mm.push :abc, 'a1', 'a2', 'a3', 'a4'
+		mm.push :ghi, 'g1', 'g2'
+
+		r = []
+
+		mm.each_unflattened_with_index do |(key, value), index|
+
+			r << [ key, value, index ]
+		end
+
+		r.sort!
+
+		assert_equal 3, r.size
+		assert_equal [ :abc, [ 'a1', 'a2', 'a3', 'a4' ], 1 ], r[0]
+		assert_equal [ :def, [], 0 ], r[1]
+		assert_equal [ :ghi, [ 'g1', 'g2' ], 2 ], r[2]
+	end
+
 	def test_empty
 
 		mm = MultiMap.new

data/test/unit/containers/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/diagnostics/tc_exception_utilities.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 

data/test/unit/diagnostics/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/extensions/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/io/tc_writelines.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../lib')
 

data/test/unit/io/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/quality/tc_parameter_checking.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../../..', 'lib')
 
@@ -159,7 +159,7 @@ end
 			assert_match /^parameter 'a' \(String\) must be an instance of Hash$/, ax.message
 		rescue => x
 
-			assert(false, "wrong exception type (#{x.class})")
+			assert(false, "wrong exception type #{x.class} (with message '#{x.message}')")
 		end
 
 
@@ -172,10 +172,56 @@ end
 			assert_match /^parameter 'a' value '' not found equal\/within any of required values or ranges$/, ax.message
 		rescue => x
 
-			assert(false, "wrong exception type (#{x.class})")
+			assert(false, "wrong exception type #{x.class} (with message '#{x.message}')")
 		end
+	end
+
+
+	# test 7 - verify that can include an array of types in the array of types
+
+	def check_method_7 a, types, values, options = {}, &block
 
+		self.class.check_param a, 'a', options.merge({ types: types, values: values }), &block
 	end
 
+	def test_7
+
+		assert_equal [], check_method_7([], [ ::Array ], nil)
+
+		assert_equal [ 'abc' ], check_method_7([ 'abc' ], [ ::Array ], nil)
+
+		assert_equal [ 'abc' ], check_method_7([ 'abc' ], [ [ ::String ] ], nil)
+
+		assert_equal [ 'abc' ], check_method_7([ 'abc' ], [ [ ::Regexp, ::String ] ], nil)
+
+		assert_equal [ :'abc' ], check_method_7([ :'abc' ], [ [ ::Regexp, ::Symbol ] ], nil)
+
+
+		begin
+			check_method_7 [ 'abc' ], [ ::Symbol, [ ::Regexp, ::Symbol ], ::Hash ], nil
+
+			assert(false, 'should not get here')
+		rescue TypeError => ax
+
+			assert_match /^parameter 'a' \(Array\) must be an instance of Symbol or Hash, or an array containing instance\(s\) of Regexp or Symbol$/, ax.message
+		rescue => x
+
+			assert(false, "wrong exception type #{x.class}) (with message '#{x.message}'")
+		end
+
+
+		begin
+			check_method_7 [ 'abc' ], [ [ ::Regexp, ::Symbol ] ], nil
+
+			assert(false, 'should not get here')
+		rescue TypeError => ax
+
+			assert_match /^parameter 'a' \(Array\) must be an array containing instance\(s\) of Regexp or Symbol$/, ax.message
+		rescue => x
+
+			assert(false, "wrong exception type #{x.class}) (with message '#{x.message}'")
+		end
+
+	end
 end
 

data/test/unit/quality/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

data/test/unit/tc_version.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 
 $:.unshift File.join(File.dirname(__FILE__), '../../lib')
 
@@ -34,4 +34,3 @@ class Test_version < Test::Unit::TestCase
 	end
 end
 
-

data/test/unit/ts_all.rb

@@ -1,4 +1,4 @@
-#! /usr/bin/ruby
+#! /usr/bin/env ruby
 #
 # executes all other tests
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.10.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-19 00:00:00.000000000 Z
+date: 2017-02-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a
@@ -19,32 +19,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
 - lib/xqsr3/command_line_utilities/map_option_string.rb
 - lib/xqsr3/containers/frequency_map.rb
 - lib/xqsr3/containers/multi_map.rb
 - lib/xqsr3/diagnostics/exception_utilities.rb
 - lib/xqsr3/doc_.rb
-- lib/xqsr3/extensions/enumerable.rb
 - lib/xqsr3/extensions/enumerable/collect_with_index.rb
 - lib/xqsr3/extensions/enumerable/unique.rb
-- lib/xqsr3/extensions/io.rb
+- lib/xqsr3/extensions/enumerable.rb
 - lib/xqsr3/extensions/io/writelines.rb
-- lib/xqsr3/extensions/kernel.rb
+- lib/xqsr3/extensions/io.rb
 - lib/xqsr3/extensions/kernel/raise_with_options.rb
-- lib/xqsr3/extensions/string.rb
+- lib/xqsr3/extensions/kernel.rb
 - lib/xqsr3/extensions/string/ends_with.rb
 - lib/xqsr3/extensions/string/map_option_string.rb
 - lib/xqsr3/extensions/string/starts_with.rb
 - lib/xqsr3/extensions/string/to_symbol.rb
-- lib/xqsr3/extensions/test/unit.rb
+- lib/xqsr3/extensions/string.rb
 - lib/xqsr3/extensions/test/unit/assert_eql.rb
 - lib/xqsr3/extensions/test/unit/assert_not.rb
 - lib/xqsr3/extensions/test/unit/assert_not_eql.rb
+- lib/xqsr3/extensions/test/unit.rb
 - lib/xqsr3/io/writelines.rb
-- lib/xqsr3/quality.rb
 - lib/xqsr3/quality/parameter_checking.rb
+- lib/xqsr3/quality.rb
 - lib/xqsr3/string_utilities/ends_with.rb
 - lib/xqsr3/string_utilities/starts_with.rb
 - lib/xqsr3/string_utilities/to_symbol.rb
@@ -75,6 +73,8 @@ files:
 - test/unit/quality/ts_all.rb
 - test/unit/tc_version.rb
 - test/unit/ts_all.rb
+- README.md
+- LICENSE
 homepage: http://github.com/synesissoftware/xqsr3
 licenses:
 - 3-clause BSD
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: xqsr3