xqsr3 0.11.1 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b23c1bd7f01f0540f8cd11ba2a619fa6d2fb334c
-  data.tar.gz: 7b79521e19d9f76bc869a83c8003cbddec3ad576
+  metadata.gz: eed03c5b9c2f91c7de5bd5296e8f62a8476b076f
+  data.tar.gz: 8c7dca9f8d9ded07ef666f6b648db4772830edc1
 SHA512:
-  metadata.gz: 1c53ef621526a41f9f47afe099d1ff8df7dc775700a2974ecab2834a317f31fd012c98c679aa1499fb2ce696daf9f257ddf64424fa232517a6df0cff3383c212
-  data.tar.gz: bc62c09071304cb569e896217f719337038c5e888882b35ecdec4df67eb4c89202e8f6d896d12d9788918428888297fc87895b2b21dd998a737fb369008e56e1
+  metadata.gz: fb1f52836cc8d7daf89b2b04bbd9034ab643a635bf898abec355274d707acd1634161150ed0094fb03c217eb0fb6be219c942f45b6fb35af190bff5948e0916b
+  data.tar.gz: d840b9ee19383973b2f5251319f301e70ed1066197d71551e88030b1f0d50863eb39cbcf65c68737dc853926e6cec6f338023cc1ea364cebd8e4e55c6ff78eeb

data/lib/xqsr3/conversion/bool_parser.rb

@@ -0,0 +1,120 @@
+
+# ######################################################################## #
+# File:         lib/xqsr3/conversion/bool_parser.rb
+#
+# Purpose:      Definition of the ::Xqsr3::Conversion::BoolParser
+#               module
+#
+# Created:      3rd June 2017
+# Updated:      7th June 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::Conversion::ToBool
+
+=begin
+=end
+
+module Xqsr3
+module Conversion
+
+module BoolParser
+
+	private
+	def self.matches_to_ s, expr
+
+		case expr
+		when ::Regexp
+			return expr =~ s
+		else
+			return s == expr
+		end
+	end
+
+	public
+
+	DEFAULT_TRUE_VALUES		=	[ /true/i, '1' ]
+	DEFAULT_FALSE_VALUES	=	[ /false/i, '0' ]
+
+	# Attempts to parse the given String to a Boolean value, based on the
+	# given +options+
+	#
+	# === Signature
+	#
+	# * *Parameters*:
+	#   - +options+:: An options hash, containing any of the following options
+	#
+	# * *Options*:
+	#   - +:false_values+:: [::Array] An array of strings or regular
+	#     expressions against which to match for false value. Defaults to
+	#     +DEFAULT_FALSE_VALUES+
+	#   - +:true_values+:: [::Array] An array of strings or regular
+	#     expressions against which to match for true value. Defaults to
+	#     +DEFAULT_TRUE_VALUES+
+	#   - +:default_value+:: An object to be returned if matching fails.
+	#     Defaults to +nil+
+	#   - +:false_value+:: An object to be returned if matching succeeds to
+	#     match against +:false_values+.
+	#   - +:true_value+:: An object to be returned if matching succeeds to
+	#     match against +:true_values+.
+	def self.to_bool s, **options
+
+		true_values		=	options[:true_values] || DEFAULT_TRUE_VALUES
+		true_values		=	[ true_values ] unless true_values.is_a? ::Array
+		false_values	=	options[:false_values] || DEFAULT_FALSE_VALUES
+		false_values	=	[ false_values ] unless false_values.is_a? ::Array
+		default_value	=	options[:default] || nil
+		true_value		=	options[:true] || true
+		false_value		=	options[:false] || false
+
+		return true_value if true_values.any? { |v| self.matches_to_ s, v }
+		return false_value if false_values.any? { |v| self.matches_to_ s, v }
+
+		return default_value
+	end
+
+end # module BoolParser
+
+end # module Conversion
+end # module Xqsr3
+
+# ############################## end of file ############################# #
+
+
+

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

@@ -0,0 +1,12 @@
+
+require 'xqsr3/conversion/bool_parser'
+
+class String
+
+	def to_bool **options
+
+		return ::Xqsr3::Conversion::BoolParser.to_bool self, **options
+	end
+end # class String
+
+

data/lib/xqsr3/extensions/string.rb

@@ -3,5 +3,6 @@ require 'xqsr3/extensions/string/ends_with'
 require 'xqsr3/extensions/string/map_option_string'
 require 'xqsr3/extensions/string/quote_if'
 require 'xqsr3/extensions/string/starts_with'
+require 'xqsr3/extensions/string/to_bool'
 require 'xqsr3/extensions/string/to_symbol'
 

data/lib/xqsr3/extensions/test/unit/assert_false.rb

@@ -0,0 +1,19 @@
+
+module Test
+module Unit
+
+module Assertions
+
+	unless respond_to? :assert_false
+
+		def assert_false(expression, failure_message = '')
+
+			assert ::FalseClass === (expression), failure_message
+		end
+	end
+
+end # class Assertions
+end # module Unit
+end # module Test
+
+

data/lib/xqsr3/extensions/test/unit/assert_true.rb

@@ -0,0 +1,20 @@
+
+module Test
+module Unit
+
+module Assertions
+
+	unless respond_to? :assert_true
+
+		def assert_true(expression, failure_message = '')
+
+			assert ::TrueClass === (expression), failure_message
+		end
+	end
+
+end # class Assertions
+end # module Unit
+end # module Test
+
+
+

data/lib/xqsr3/extensions/test/unit.rb

@@ -1,5 +1,7 @@
 
 require 'xqsr3/extensions/test/unit/assert_eql'
+require 'xqsr3/extensions/test/unit/assert_false'
 require 'xqsr3/extensions/test/unit/assert_not'
 require 'xqsr3/extensions/test/unit/assert_not_eql'
+require 'xqsr3/extensions/test/unit/assert_true'
 

data/lib/xqsr3/version.rb

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

data/test/unit/conversion/tc_to_bool.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../lib')
+
+require 'xqsr3/conversion/bool_parser'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+include ::Xqsr3::Conversion
+
+class Test_Xqsr3_ConversionMultiMap < Test::Unit::TestCase
+
+	def test_parse_normal
+
+		assert_true BoolParser.to_bool 'true'
+		assert_false BoolParser.to_bool 'false'
+	end
+
+	def test_parse_custom_true_false
+
+		true_values		=	[ 'affirmative', 'yup' ]
+		false_values	=	[ 'negative', 'nope' ]
+
+		assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
+		assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
+		assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
+		assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
+		assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
+		assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
+	end
+
+	def test_parse_custom_true_false_regexes
+
+		true_values		=	[ /affirm/, /yup/ ]
+		false_values	=	[ 'negative', /no/ ]
+
+		assert_true BoolParser.to_bool 'affirmative', true_values: true_values, false_values: false_values
+		assert_true BoolParser.to_bool 'yup', true_values: true_values, false_values: false_values
+		assert_nil BoolParser.to_bool 'true', true_values: true_values, false_values: false_values
+		assert_false BoolParser.to_bool 'negative', true_values: true_values, false_values: false_values
+		assert_false BoolParser.to_bool 'nope', true_values: true_values, false_values: false_values
+		assert_nil BoolParser.to_bool 'false', true_values: true_values, false_values: false_values
+	end
+end
+

data/test/unit/conversion/ts_all.rb

@@ -0,0 +1,13 @@
+#! /usr/bin/env ruby
+#
+# executes all other tests
+
+this_file   =   File.expand_path(__FILE__)
+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 }
+

data/test/unit/extensions/string/tc_bool.tb

@@ -0,0 +1,44 @@
+#! /usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), '../../../../lib')
+
+require 'xqsr3/extensions/string/to_bool'
+
+require 'xqsr3/extensions/test/unit'
+require 'test/unit'
+
+class Test_String_to_bool < Test::Unit::TestCase
+
+	def test_parse_normal
+
+		assert_true 'true'.to_bool
+		assert_false 'false'.to_bool
+	end
+
+	def test_parse_custom_true_false
+
+		true_values		=	[ 'affirmative', 'yup' ]
+		false_values	=	[ 'negative', 'nope' ]
+
+		assert_true 'affirmative'.to_bool true_values: true_values, false_values: false_values
+		assert_true 'yup'.to_bool true_values: true_values, false_values: false_values
+		assert_nil 'true'.to_bool true_values: true_values, false_values: false_values
+		assert_false 'negative'.to_bool true_values: true_values, false_values: false_values
+		assert_false 'nope'.to_bool true_values: true_values, false_values: false_values
+		assert_nil 'false'.to_bool true_values: true_values, false_values: false_values
+	end
+
+	def test_parse_custom_true_false_regexes
+
+		true_values		=	[ /affirm/, /yup/ ]
+		false_values	=	[ 'negative', /no/ ]
+
+		assert_true 'affirmative'.to_bool true_values: true_values, false_values: false_values
+		assert_true 'yup'.to_bool true_values: true_values, false_values: false_values
+		assert_nil 'true'.to_bool true_values: true_values, false_values: false_values
+		assert_false 'negative'.to_bool true_values: true_values, false_values: false_values
+		assert_false 'nope'.to_bool true_values: true_values, false_values: false_values
+		assert_nil 'false'.to_bool true_values: true_values, false_values: false_values
+	end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xqsr3
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.1
 platform: ruby
 authors:
 - Matt Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   eXtensions by fine Quantum for Standard Ruby and 3rd-party libraries is a
@@ -24,6 +24,7 @@ files:
 - 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
@@ -39,11 +40,14 @@ files:
 - 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/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/hash_utilities/deep_transform.rb
 - lib/xqsr3/io/writelines.rb
 - lib/xqsr3/quality.rb
@@ -58,6 +62,8 @@ files:
 - test/unit/containers/tc_frequency_map.rb
 - test/unit/containers/tc_multi_map.rb
 - test/unit/containers/ts_all.rb
+- test/unit/conversion/tc_to_bool.rb
+- test/unit/conversion/ts_all.rb
 - test/unit/diagnostics/tc_exception_utilities.rb
 - test/unit/diagnostics/ts_all.rb
 - test/unit/extensions/enumerable/tc_collect_with_index.rb
@@ -69,6 +75,7 @@ files:
 - test/unit/extensions/io/ts_all.rb
 - test/unit/extensions/kernel/tc_raise_with_options.rb
 - test/unit/extensions/kernel/ts_all.rb
+- test/unit/extensions/string/tc_bool.tb
 - test/unit/extensions/string/tc_ends_with.rb
 - test/unit/extensions/string/tc_map_option_string.rb
 - test/unit/extensions/string/tc_quote_if.rb