xqsr3 0.13.3 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a62fcdc4c1aa7176aa20acf04a477f9ce9e32dde
-  data.tar.gz: 9e3085307d16b630cbe34d5e7d243b4f3ec18622
+  metadata.gz: 1d2428b61c6d1ffe6859382fac62b8ab460cafb8
+  data.tar.gz: c8b15079affd7d14f1fc68fa64aa83b14ccc0c3c
 SHA512:
-  metadata.gz: 947e35e638cbd5ce7bdef5811d8c3f9de6923f697aff9212f371fda83b049b4032dd7f789f7183720c53714967c13e5ce62501071dbc11c93bb85a06adea8e41
-  data.tar.gz: b458cea2b2fb99ceb8a42b5262f6556fa926aecb2c2489212ede046d503d82a60acc1fb735049bf5e4eff8815aee6caab20dc23f71abae962f560bb12b4b4f3c
+  metadata.gz: f8e73c19d7d688d02e22a4db0d121d0d1da5b9432d1fe801ee55667f2f90eb8079ff622ae4d924dbb0e71e2d63b2f9d5c149923c979261acfddd768e8c40c711
+  data.tar.gz: f208ebf0cabcb05ec49064db7478f0f5b37a0de948207cadec78662e66127593c9e08a25b456b816282a9998738860dc83f3919b88bd5ec542f55bbef8230a80

data/lib/xqsr3/extensions/hash/has_match.rb

@@ -0,0 +1,11 @@
+
+require 'xqsr3/hash_utilities/key_matching'
+
+class Hash
+
+	def has_match? re, **options
+
+		return ::Xqsr3::HashUtilities::KeyMatching.has_match? self, re, **options
+	end
+end
+

data/lib/xqsr3/extensions/hash/match.rb

@@ -0,0 +1,11 @@
+
+require 'xqsr3/hash_utilities/key_matching'
+
+class Hash
+
+	def match re, **options
+
+		return ::Xqsr3::HashUtilities::KeyMatching.match self, re, **options
+	end
+end
+

data/lib/xqsr3/extensions/hash.rb

@@ -0,0 +1,5 @@
+
+require 'xqsr3/extensions/hash/deep_transform'
+require 'xqsr3/extensions/hash/has_match'
+require 'xqsr3/extensions/hash/match'
+

data/lib/xqsr3/hash_utilities/key_matching.rb

@@ -0,0 +1,175 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/hash_utilities/key_matching.rb
+#
+# Purpose:      Definition of the ::Xqsr3::HashUtilities::KeyMatching
+#               module
+#
+# Created:      15th November 2017
+# Updated:      15th November 2017
+#
+# Home:         http://github.com/synesissoftware/xqsr3
+#
+# Author:       Matthew Wilson
+#
+# Copyright (c) 2017, Matthew Wilson and Synesis Software
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+#   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
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# ######################################################################## #
+
+
+require 'xqsr3/quality/parameter_checking'
+
+# ##########################################################
+# ::Xqsr3::HashUtilities::KeyMatching
+
+=begin
+=end
+
+module Xqsr3
+module HashUtilities
+
+module KeyMatching
+
+	private
+	def self.do_match_ h, re, **options
+
+		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
+
+		return h[re] if h.has_key? re
+
+		case re
+		when ::Regexp
+
+			h.each do |k, v|
+
+				case k
+				when ::Regexp
+
+					next
+				else
+
+					return v if k.to_s =~ re
+				end
+			end
+		else
+
+			h.each do |k, v|
+
+				case k
+				when ::Regexp
+
+					return v if re.to_s =~ k
+				else
+
+					next
+				end
+			end
+		end
+
+		nil
+	end
+
+	def self.do_has_match_ h, re, **options
+
+		::Xqsr3::Quality::ParameterChecking.check_parameter h, 'h', responds_to: [ :[], :has_key?, :each ]
+
+		return true if h.has_key? re
+
+		case re
+		when ::Regexp
+
+			h.each do |k, v|
+
+				case k
+				when ::Regexp
+
+					next
+				else
+
+					return true if k.to_s =~ re
+				end
+			end
+		else
+
+			h.each do |k, v|
+
+				case k
+				when ::Regexp
+
+					return true if re.to_s =~ k
+				else
+
+					next
+				end
+			end
+		end
+
+		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
+
+		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
+
+		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
+
+		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
+
+		Xqsr3::HashUtilities::KeyMatching.do_has_match_ h, re, **options
+	end
+
+end # module KeyMatching
+
+end # module HashUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+

data/lib/xqsr3/string_utilities/quote_if.rb

@@ -61,8 +61,6 @@ module QuoteIf
 
 		def self.string_quote_if_array_ s, options
 
-		#$stderr.puts "#{self}#{__method__}(s (#{s.class})='#{s}', options (#{options.class})='#{options}'"
-
 			s			=	s.to_s unless String === s
 
 			quotes		=	options[:quotes] || [ '"', '"' ]
@@ -70,8 +68,6 @@ module QuoteIf
 
 			quotables	=	options[:quotables] || /\s/
 
-#$stderr.puts "quotables (#{quotables.class}): [#{quotables}]"
-
 			case quotables
 			when ::String
 

data/lib/xqsr3/version.rb

@@ -5,7 +5,7 @@
 # Purpose:      Version for Xqsr3 library
 #
 # Created:      3rd April 2016
-# Updated:      1st November 2017
+# Updated:      15th November 2017
 #
 # Home:         http://github.com/synesissoftware/xqsr3
 #
@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.13.3'
+	VERSION				=	'0.14.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/hash_utilities/tc_has_match.rb

@@ -0,0 +1,100 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../lib')
+
+require 'xqsr3/hash_utilities/key_matching'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+
+class Test_Xqsr3_HashUtilities_has_match_by_module < Test::Unit::TestCase
+
+	Matching = ::Xqsr3::HashUtilities::KeyMatching
+
+	def test_against_none_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_false Matching.has_match?(h, '')
+		assert_true Matching.has_match?(h, 'def')
+		assert_false Matching.has_match?(h, 'ghi')
+		assert_true Matching.has_match?(h, :nil)
+		assert_false Matching.has_match?(h, 'nil')
+		assert_true Matching.has_match?(h, :sym)
+		assert_false Matching.has_match?(h, 'sym')
+	end
+
+	def test_against_empty_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_true Matching.has_match?(h, //)
+
+		assert_true Matching.has_match?(h, /def/)
+		assert_true Matching.has_match?(h, /de/)
+		assert_true Matching.has_match?(h, /^de/)
+		assert_false Matching.has_match?(h, /de$/)
+	end
+end
+
+
+require 'xqsr3/extensions/hash/has_match'
+
+class Test_Xqsr3_HashUtilities_has_match_by_include < Test::Unit::TestCase
+
+	def test_against_none_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_false h.has_match?('')
+		assert_true h.has_match?('def')
+		assert_false h.has_match?('ghi')
+		assert_true h.has_match?(:nil)
+		assert_false h.has_match?('nil')
+		assert_true h.has_match?(:sym)
+		assert_false h.has_match?('sym')
+	end
+
+	def test_against_empty_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_true h.has_match?(//)
+
+		assert_true h.has_match?(/def/)
+		assert_true h.has_match?(/de/)
+		assert_true h.has_match?(/^de/)
+		assert_false h.has_match?(/de$/)
+	end
+end
+
+

data/test/unit/hash_utilities/tc_match.rb

@@ -0,0 +1,130 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../lib')
+
+require 'xqsr3/hash_utilities/key_matching'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+
+class Test_Xqsr3_HashUtilities_match_by_module < Test::Unit::TestCase
+
+	Matching = ::Xqsr3::HashUtilities::KeyMatching
+
+	def test_against_none_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_nil Matching.match(h, '')
+		assert_not_nil Matching.match(h, 'def')
+		assert_nil Matching.match(h, 'ghi')
+		assert_nil Matching.match(h, :nil) # although this is matching!
+		assert_nil Matching.match(h, 'nil')
+		assert_not_nil Matching.match(h, :sym)
+		assert_nil Matching.match(h, 'sym')
+	end
+
+	def test_against_empty_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_not_nil Matching.match(h, //)
+		assert_equal h.first[1], Matching.match(h, //)
+
+		assert_equal 'def', Matching.match(h, /def/)
+		assert_equal 'def', Matching.match(h, /de/)
+		assert_equal 'def', Matching.match(h, /^de/)
+		assert_nil Matching.match(h, /de$/)
+	end
+
+	def test_hash_containing_re
+
+		h = {
+
+			/bc/ => :bc,
+			/de/ => :de,
+			:abc => :abc,
+		}
+
+		assert_nil Matching.match(h, '')
+		assert_nil Matching.match(h, :ab)
+		assert_equal :bc, Matching.match(h, :abcd)
+	end
+end
+
+
+require 'xqsr3/extensions/hash/match'
+
+class Test_Xqsr3_HashUtilities_match_by_include < Test::Unit::TestCase
+
+	def test_against_none_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_nil h.match('')
+		assert_not_nil h.match('def')
+		assert_nil h.match('ghi')
+		assert_nil h.match(:nil) # although this is matching!
+		assert_nil h.match('nil')
+		assert_not_nil h.match(:sym)
+		assert_nil h.match('sym')
+	end
+
+	def test_against_empty_re
+
+		h = {
+
+			:abc => :abc,
+			'abc' => 'abc',
+			'def' => 'def',
+			:nil => nil,
+			:sym => :sym,
+		}
+
+		assert_not_nil h.match(//)
+		assert_equal h.first[1], h.match(//)
+
+		assert_equal 'def', h.match(/def/)
+		assert_equal 'def', h.match(/de/)
+		assert_equal 'def', h.match(/^de/)
+		assert_nil h.match(/de$/)
+	end
+
+	def test_hash_containing_re
+
+		h = {
+
+			/bc/ => :bc,
+			/de/ => :de,
+			:abc => :abc,
+		}
+
+		assert_nil h.match('')
+		assert_nil h.match(:ab)
+		assert_equal :bc, h.match(:abcd)
+	end
+end
+
+

data/test/unit/hash_utilities/ts_all.rb

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_dir    =   File.expand_path(File.dirname(__FILE__))
+
+# all tc_*rb in current directory
+Dir[File.join(this_dir, 'tc_*rb')].each { |file| require file }
+
+# all ts_*rb in immediate sub-directories
+Dir[File.join(this_dir, '*', 'ts_*rb')].each { |file| require file }
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a
@@ -19,39 +19,41 @@ 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/conversion/bool_parser.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/enumerable.rb
 - lib/xqsr3/extensions/hash/deep_transform.rb
-- lib/xqsr3/extensions/io.rb
+- lib/xqsr3/extensions/hash/has_match.rb
+- lib/xqsr3/extensions/hash/match.rb
+- lib/xqsr3/extensions/hash.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/quote_if.rb
 - lib/xqsr3/extensions/string/starts_with.rb
 - lib/xqsr3/extensions/string/to_bool.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_false.rb
 - lib/xqsr3/extensions/test/unit/assert_not.rb
 - lib/xqsr3/extensions/test/unit/assert_not_eql.rb
 - lib/xqsr3/extensions/test/unit/assert_true.rb
+- lib/xqsr3/extensions/test/unit.rb
 - lib/xqsr3/hash_utilities/deep_transform.rb
+- lib/xqsr3/hash_utilities/key_matching.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/quote_if.rb
 - lib/xqsr3/string_utilities/starts_with.rb
@@ -84,6 +86,9 @@ files:
 - test/unit/extensions/string/tc_to_symbol.rb
 - test/unit/extensions/string/ts_all.rb
 - test/unit/extensions/ts_all.rb
+- test/unit/hash_utilities/tc_has_match.rb
+- test/unit/hash_utilities/tc_match.rb
+- test/unit/hash_utilities/ts_all.rb
 - test/unit/io/tc_writelines.rb
 - test/unit/io/ts_all.rb
 - test/unit/quality/tc_parameter_checking.rb
@@ -93,6 +98,8 @@ files:
 - test/unit/xml/ts_all.rb
 - test/unit/xml/utilities/tc_compare.rb
 - test/unit/xml/utilities/ts_all.rb
+- README.md
+- LICENSE
 homepage: http://github.com/synesissoftware/xqsr3
 licenses:
 - 3-clause BSD
@@ -113,7 +120,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