xqsr3 0.15.3 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85fb2c4cd56ed6ce994a02e294d9c57763fbaa93
-  data.tar.gz: fe8a334773139b5ed80401ca985637fa7e9127f3
+  metadata.gz: f1b3bde5f5924163f03e47dd630d7a66fefc7b2b
+  data.tar.gz: 250d145c6f4e5df5ec8cf6da99ac4eeada2da5e3
 SHA512:
-  metadata.gz: 1f15b2cd66718fd119684f11c1f90214b4e12de9e33071f4154abc0cfdb6e8e213eb3c4027444c556f84abb81a8766d29a72274a09a00242790fb03bf58557df
-  data.tar.gz: 4787615d140647f606bcb6b225e15fb6dbf7b9a723cf87ee48187f509de1b3d3f980febdd1db30c74414b781a5da428c40085eb645e3f3fe832917c0025caee0
+  metadata.gz: 4a6d515ae16aa93e7815212fae3a869fa90e94b5fc19ed455dab28e1c5e154c11521317e590b7c30f1394a9a44ff25ae714ceb35fa8df3479d118d8562578456
+  data.tar.gz: 41df1e79b7ca6dfb5d498f333ae7099d1d40a4411aab9ce179790ad391aae21292b7df6e8327f23e8208a8f3b58b9fbccc7a76962801cd44c53d8e469208a15b

data/lib/xqsr3/array_utilities/join_with_or.rb

@@ -0,0 +1,119 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/array_utilities/join_with_or.rb
+#
+# Purpose:      Definition of the ::Xqsr3::ArrayUtilities::JoinWithOr
+#               module
+#
+# Created:      7th December 2017
+# Updated:      7th December 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.
+#
+# ######################################################################## #
+
+
+# ##########################################################
+# ::Xqsr3::ArrayUtilities::JoinWithOr
+
+=begin
+=end
+
+require 'xqsr3/quality/parameter_checking'
+
+module Xqsr3
+module ArrayUtilities
+
+module JoinWithOr
+
+	extend self
+
+	# Joins an array with grammatical appropriateness (with an 'or')
+	#
+	# === *Parameters*
+	#
+	# * *Required parameters*:
+	#   - +ar+:: [Array] The array whose contents are to be joined
+	#
+	# * *Options parameters*:
+	#   - +options+:: [Hash] Options that control the behaviour of the
+	#       method
+	#
+	# * *Options*:
+	#
+	#   - +:or+:: [String] A string that is used instead of 'or'
+	#   - +:oxford_comma+:: [boolean] Determines whether an Oxford comma
+	#       will be used. Default is +true+
+	#   - +:quote_char+ [String] The quote character. Default is empty
+	#       string
+	#   - +:separator+ [String] The separator character. Default is +','+
+	def join_with_or ar, **options
+
+		::Xqsr3::Quality::ParameterChecking.check_parameter ar, 'ar', type: ::Array, allow_nil: true
+		::Xqsr3::Quality::ParameterChecking.check_parameter options, 'options', type: ::Hash, allow_nil: false
+
+		::Xqsr3::Quality::ParameterChecking.check_parameter options[:or], ':or', type: ::String, option: true, allow_nil: true
+		::Xqsr3::Quality::ParameterChecking.check_parameter options[:oxford_comma], ':oxford_comma', types: [ ::FalseClass, ::TrueClass ], option: true, allow_nil: true
+		::Xqsr3::Quality::ParameterChecking.check_parameter options[:quote_char], ':quote_char', type: ::String, option: true, allow_nil: true
+		::Xqsr3::Quality::ParameterChecking.check_parameter options[:separator], ':separator', type: ::String, option: true, allow_nil: true
+
+		return '' if ar.nil?
+		return '' if ar.empty?
+
+		separator	=	options[:separator] || ','
+		or_word		=	options[:or] || 'or'
+		ox_comma	=	(options.has_key?(:oxford_comma) && !options[:oxford_comma]) ? '' : separator
+		quote_char	=	options[:quote_char]
+
+		ar			=	ar.map { |v| "#{quote_char}#{v}#{quote_char}" } if quote_char
+
+		case ar.size
+		when 1
+			ar[0]
+		when 2
+			"#{ar[0]} #{or_word} #{ar[1]}"
+		else
+			"#{ar[0...-1].join(separator + ' ')}#{ox_comma} #{or_word} #{ar[-1]}"
+		end
+	end
+
+end # module JoinWithOr
+
+end # module ArrayUtilities
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+
+

data/lib/xqsr3/extensions/array/join_with_or.rb

@@ -0,0 +1,12 @@
+
+require 'xqsr3/array_utilities/join_with_or'
+
+class Array
+
+	def join_with_or **options
+
+		return ::Xqsr3::ArrayUtilities::JoinWithOr.join_with_or self, **options
+	end
+end
+
+

data/lib/xqsr3/quality/parameter_checking.rb

@@ -76,7 +76,26 @@ module ParameterChecking
 
 	def self.included base
 
-		base.extend self
+
+		base.class_eval do
+
+			def self.check_parameter value, name, options = {}, &block
+
+				Util_.check_parameter value, name, options, &block
+			end
+
+			# @see check_parameter
+			#
+			# @note This is obsolete, and will be removed in a future
+			# version. Please use +check_parameter+ instead
+			def self.check_param value, name, options = {}, &block
+
+				Util_.check_parameter value, name, options, &block
+			end
+
+			private_class_method :check_param
+			private_class_method :check_parameter
+		end
 	end
 
 	# Check a given parameter (value=+value+, name=+name+) for type and value

data/lib/xqsr3/version.rb

@@ -50,7 +50,7 @@
 module Xqsr3
 
 	# Current version of the Xqsr3 library
-	VERSION				=	'0.15.3'
+	VERSION				=	'0.16.1'
 
 	private
 	VERSION_PARTS_		=	VERSION.split(/[.]/).collect { |n| n.to_i } # :nodoc:

data/test/unit/array_utilities/tc_join_with_or.rb

@@ -0,0 +1,215 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../lib')
+
+require 'xqsr3/array_utilities/join_with_or'
+
+require 'xqsr3/extensions/test/unit'
+
+require 'test/unit'
+
+
+class Test_Xqsr3_ArrayUtilities_join_with_or_by_module < Test::Unit::TestCase
+
+	JoinWithOr = ::Xqsr3::ArrayUtilities::JoinWithOr
+
+	def test_default
+
+		assert_equal '', JoinWithOr.join_with_or([])
+		assert_equal 'a', JoinWithOr.join_with_or([ 'a' ])
+		assert_equal 'a or b', JoinWithOr.join_with_or([ 'a', 'b' ])
+		assert_equal 'a, b, or c', JoinWithOr.join_with_or([ 'a', 'b', 'c' ])
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, or n', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ])
+	end
+
+	def test_with_empty_options
+
+		options = {
+
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal 'a', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal 'a or b', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal 'a, b, or c', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, or n', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+
+	def test_with_custom_or
+
+		options = {
+
+			:or => 'OR',
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal 'a', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal 'a OR b', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal 'a, b, OR c', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, OR n', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+
+	def test_with_no_oxford
+
+		options = {
+
+			:oxford_comma => false,
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal 'a', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal 'a or b', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal 'a, b or c', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m or n', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+
+	def test_with_custom_quote_char
+
+		options = {
+
+			:quote_char => '"',
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal '"a"', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal '"a" or "b"', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal '"a", "b", or "c"', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal '"a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", or "n"', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+
+	def test_with_custom_separator
+
+		options = {
+
+			:separator => ';',
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal 'a', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal 'a or b', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal 'a; b; or c', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal 'a; b; c; d; e; f; g; h; i; j; k; l; m; or n', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+
+	def test_with_custom_flags
+
+		options = {
+
+			:or => 'OR',
+			:oxford_comma => false,
+			:quote_char => '"',
+			:separator => ';',
+		}
+
+		assert_equal '', JoinWithOr.join_with_or([], **options)
+		assert_equal '"a"', JoinWithOr.join_with_or([ 'a' ], **options)
+		assert_equal '"a" OR "b"', JoinWithOr.join_with_or([ 'a', 'b' ], **options)
+		assert_equal '"a"; "b" OR "c"', JoinWithOr.join_with_or([ 'a', 'b', 'c' ], **options)
+		assert_equal '"a"; "b"; "c"; "d"; "e"; "f"; "g"; "h"; "i"; "j"; "k"; "l"; "m" OR "n"', JoinWithOr.join_with_or([ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ], **options)
+	end
+end
+
+require 'xqsr3/extensions/array/join_with_or'
+
+class Test_Xqsr3_ArrayUtilities_join_with_or_by_include < Test::Unit::TestCase
+
+	include ::Xqsr3::ArrayUtilities::JoinWithOr
+
+	def test_default
+
+		assert_equal '', [].join_with_or
+		assert_equal 'a', [ 'a' ].join_with_or
+		assert_equal 'a or b', [ 'a', 'b' ].join_with_or()
+		assert_equal 'a, b, or c', [ 'a', 'b', 'c' ].join_with_or()
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, or n', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or()
+	end
+
+	def test_with_empty_options
+
+		options = {
+
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal 'a', [ 'a' ].join_with_or(**options)
+		assert_equal 'a or b', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal 'a, b, or c', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, or n', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+
+	def test_with_custom_or
+
+		options = {
+
+			:or => 'OR',
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal 'a', [ 'a' ].join_with_or(**options)
+		assert_equal 'a OR b', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal 'a, b, OR c', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m, OR n', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+
+	def test_with_no_oxford
+
+		options = {
+
+			:oxford_comma => false,
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal 'a', [ 'a' ].join_with_or(**options)
+		assert_equal 'a or b', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal 'a, b or c', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal 'a, b, c, d, e, f, g, h, i, j, k, l, m or n', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+
+	def test_with_custom_quote_char
+
+		options = {
+
+			:quote_char => '"',
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal '"a"', [ 'a' ].join_with_or(**options)
+		assert_equal '"a" or "b"', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal '"a", "b", or "c"', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal '"a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", or "n"', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+
+	def test_with_custom_separator
+
+		options = {
+
+			:separator => ';',
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal 'a', [ 'a' ].join_with_or(**options)
+		assert_equal 'a or b', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal 'a; b; or c', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal 'a; b; c; d; e; f; g; h; i; j; k; l; m; or n', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+
+	def test_with_custom_flags
+
+		options = {
+
+			:or => 'OR',
+			:oxford_comma => false,
+			:quote_char => '"',
+			:separator => ';',
+		}
+
+		assert_equal '', [].join_with_or(**options)
+		assert_equal '"a"', [ 'a' ].join_with_or(**options)
+		assert_equal '"a" OR "b"', [ 'a', 'b' ].join_with_or(**options)
+		assert_equal '"a"; "b" OR "c"', [ 'a', 'b', 'c' ].join_with_or(**options)
+		assert_equal '"a"; "b"; "c"; "d"; "e"; "f"; "g"; "h"; "i"; "j"; "k"; "l"; "m" OR "n"', [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n' ].join_with_or(**options)
+	end
+end
+
+
+

data/test/unit/array_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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.16.1
 platform: ruby
 authors:
 - Matt Wilson
@@ -19,48 +19,54 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- lib/xqsr3/array_utilities/join_with_or.rb
 - 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/array/join_with_or.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.rb
 - lib/xqsr3/extensions/hash/deep_transform.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/io.rb
+- lib/xqsr3/extensions/io/writelines.rb
+- lib/xqsr3/extensions/kernel.rb
 - lib/xqsr3/extensions/kernel/integer.rb
 - lib/xqsr3/extensions/kernel/raise_with_options.rb
-- lib/xqsr3/extensions/kernel.rb
+- lib/xqsr3/extensions/string.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/string.rb
+- lib/xqsr3/extensions/test/unit.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/parameter_checking.rb
 - lib/xqsr3/quality.rb
+- lib/xqsr3/quality/parameter_checking.rb
 - lib/xqsr3/string_utilities/ends_with.rb
 - lib/xqsr3/string_utilities/quote_if.rb
 - lib/xqsr3/string_utilities/starts_with.rb
 - lib/xqsr3/string_utilities/to_symbol.rb
 - lib/xqsr3/version.rb
 - lib/xqsr3/xml/utilities/compare.rb
+- test/unit/array_utilities/tc_join_with_or.rb
+- test/unit/array_utilities/ts_all.rb
 - test/unit/command_line_utilities/tc_map_option_string.rb
 - test/unit/command_line_utilities/ts_all.rb
 - test/unit/containers/tc_frequency_map.rb
@@ -100,8 +106,6 @@ 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
@@ -122,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: xqsr3